このページは機械翻訳です。英語版がソースであり、より正確または最新の場合があります。 英語で表示

Raw Webhook

Raw Webhook は、標準(エンリッチ)webhook に対する軽量で高速配信の代替手段です。記事が公開された瞬間にコアの記事データを配信し、AI エンリッチメントのパイプラインを完全にスキップします。


記事モデル

Raw Webhook は簡素化された記事ペイロードを配信します。企業エンティティ、感情スコア、AI 生成のエンリッチメントは含まれません。

  • Name
    link
    Type
    string
    Description

    記事全文への URL。

  • Name
    source
    Type
    string
    Description

    ソースのウェブサイト。例:www.reuters.com

  • Name
    title
    Type
    string
    Description

    記事のタイトル。

  • Name
    summary
    Type
    string
    Description

    記事の要約(ある場合)。null になることがあります。

  • Name
    publishDate
    Type
    Date
    Description

    公開日(ISO 8601 形式の日付文字列)。

  • Name
    createdAt
    Type
    Date
    Description

    finlight システムにおける記事の内部作成日(ISO 8601 形式の日付文字列)。

  • Name
    revisedDate
    Type
    Date | null
    Description

    最初の公開後に記事が最後に改訂された日付。記事が一度も改訂されていない場合は nullincludeUpdates が有効で記事が改訂された場合に存在します。

  • Name
    isUpdate
    Type
    boolean
    Description

    この配信が公開後の更新によってトリガーされた場合は trueincludeUpdates が有効な場合にのみ存在します。

  • Name
    language
    Type
    string
    Description

    ISO 639-1 の言語コード。例:en | de | fr

  • Name
    images
    Type
    string[]
    Description

    記事の画像 URL の配列。

  • Name
    countries
    Type
    string[]
    Description

    ISO 3166-1 alpha-2 形式の国コードの配列。例:["US", "GB"]。空の場合があります。

  • Name
    categories
    Type
    string[]
    Description

    記事カテゴリの配列。可能な値:markets | economy | business | politics | geopolitics | regulation | technology | energy | commodities | crypto | health | climate | security。空の場合があります。


WEBHOOK配信タイプ

Raw Webhook を作成する

finlight ダッシュボードで webhook を作成する際、セットアップウィザードの最初のステップで配信タイプとして Raw を選択します。すると条件ステップには、サポートされる 4 つのフィルターパラメータのみが表示されます。

Raw Webhook は、あなたの条件に一致する新しく公開された記事のみを配信します。各配信は、HTTP POST リクエストとしてエンドポイントに送信される単一の記事ペイロードです。

  • Name
    query
    Type
    string
    Description

    関連する記事を見つけるための検索クエリ。sourcetitlesummary フィールドのフィールドレベルフィルタリングをサポートします。下記のquery のフィールドレベルフィルタリングを参照してください。

  • Name
    sources
    Type
    string[]
    Description

    配信を特定のソースの記事に限定します。例:["www.reuters.com", "www.cnbc.com"]。有効な値はソースエンドポイントを参照してください。

  • Name
    excludeSources
    Type
    string[]
    Description

    特定のソースの記事を除外します。例:["www.example.com"]

  • Name
    language
    Type
    string
    Description

    記事の言語でフィルタリングします(ISO 639-1)。既定は en で、英語のみを返し他の言語を除外します言語とカバレッジを参照してください。

  • Name
    includeUpdates
    Type
    boolean
    Description

    記事が最初の公開後に更新された際に再配信します。更新されたペイロードには isUpdate=truerevisedDate タイムスタンプが含まれます。

Response

{
  "link": "https://www.example.com/article1",
  "source": "www.example.com",
  "title": "Stock Market Hits New Highs",
  "summary": "A brief summary of the article...",
  "publishDate": "2023-10-01T12:34:56Z",
  "createdAt": "2023-10-01T12:35:10Z",
  "language": "en",
  "images": [
    "https://www.example.com/image1.jpg",
    "https://www.example.com/image2.jpg"
  ],
  "countries": ["US"],
  "categories": ["markets"]
}

Response (includeUpdates: true)

{
  "link": "https://www.example.com/article1",
  "source": "www.example.com",
  "title": "Stock Market Hits New Highs — Updated",
  "summary": "An updated summary of the article...",
  "publishDate": "2023-10-01T12:34:56Z",
  "createdAt": "2023-10-01T12:35:10Z",
  "revisedDate": "2023-10-02T08:00:00Z",
  "isUpdate": true,
  "language": "en",
  "images": [
    "https://www.example.com/image1.jpg"
  ],
  "countries": ["US"],
  "categories": ["markets"]
}

query のフィールドレベルフィルタリング

Raw Webhook の query パラメータは、次のフィールドに限定したフィールドレベルフィルタリングをサポートします:

  • source - 記事のソースドメインでフィルタリング
  • title - 記事タイトルの内容でフィルタリング
  • summary - 記事要約の内容でフィルタリング

例:

query=title:Nvidia

タイトルに「Nvidia」を含む記事を配信します。

query=summary:earnings +title:Tesla

要約に「earnings」が含まれ、タイトルに「Tesla」を含む記事を配信します。

query=source:www.reuters.com -crypto

Reuters の記事を配信し、「crypto」に言及するものを除外します。

クエリ構文の完全なリファレンスについては、高度なクエリの構築ガイドを参照してください。


GUIDE判断のヒント

Raw Webhook を使うべき場合

次の場合は Raw を選びます:

  • 可能な限り低い配信レイテンシが必要
  • エンリッチメントデータが不要な高スループットのパイプラインを構築している
  • キーワード、ソース、言語のみでフィルタリングできればよい
  • 自分側の処理オーバーヘッドを減らすために、よりスリムなペイロードが欲しい

次の場合は Enriched を選びます:

  • 企業/ティッカーレベルのフィルタリングが必要(tickerscountriescategories
  • ペイロードに感情スコア、信頼度値、エンティティ解決が欲しい
  • includeContent / includeEntities で記事全文や抽出エンティティを含める必要がある
  • 株式モニタリング、決算追跡、業界別ニュースフィードを構築している

エンリッチ webhook のフィルタリングオプションの詳細については、フィルタリング条件ガイドを参照してください。