エンリッチ Webhook

エンリッチ Webhook は、企業エンティティ解決、感情分析、フィルタリングオプションの完全なセットを備えた AI 処理済みの記事データを配信します。

エンリッチ Webhook の主な機能:

完全なフィルタリング — ティッカー、国、カテゴリ、ソース、言語、クエリでフィルタリングできます
AI エンリッチメント — ペイロードには感情スコア、企業マッチ、信頼度値が含まれます
柔軟なコンテンツ — includeContent / includeEntities で記事全文や抽出エンティティをオプションで含められます
不変のタイプ — 配信タイプ（enriched または 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
最初の公開後に記事が最後に改訂された日付。記事が一度も改訂されていない場合は null。includeUpdates が有効で記事が改訂された場合に存在します。
Name
isUpdate
Type
boolean
Description
この配信が公開後の更新によってトリガーされた場合は true。includeUpdates が有効な場合にのみ存在します。
Name
language
Type
string
Description
ISO 639-1 の言語コード。例：en | de | fr
Name
sentiment
Type
string
Description
AI が生成した記事の感情。可能な値：positive | negative | neutral。
Name
confidence
Type
number
Description
感情値に対する信頼度スコア（0 ～ 1）。
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。空の場合があります。
Name
companies
Type
Company[]
Description
AI エンティティマッチングによって解決された、一致する企業オブジェクトの配列。各企業には次のフィールドが含まれます：
- companyId number — finlight 内部の企業識別子
- confidence string — エンティティマッチの信頼度スコア
- name string — 企業の正式名称
- ticker string — 主要ティッカーシンボル。例：AAPL
- exchange string — 取引所コード。例：XNAS
- country string — 主要上場国（ISO 3166-1 alpha-2）
- sector string — セクター分類。例：Technology
- industry string — 業種分類
- isin string — 主要 ISIN コード
- openfigi string — OpenFIGI 識別子
- primaryListing object — { ticker, exchangeCode, exchangeCountry }
- isins string[] — 企業の既知のすべての ISIN
- otherListings object[] — [{ ticker, exchangeCode, exchangeCountry }]

WEBHOOK配信タイプ

エンリッチ Webhook を作成する

finlight ダッシュボードで webhook を作成する際、セットアップウィザードの最初のステップで配信タイプとして Enriched を選択します。これが既定のオプションです。条件ステップには、利用可能なすべてのフィルターパラメータが表示されます。

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

Name
query
Type
string
Description
関連する記事を見つけるための検索クエリ。ブール演算子とフィールドレベルフィルタリングをサポートします。高度なクエリの構築ガイドを参照してください。
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
tickers
Type
string[]
Description
ティッカーシンボルでフィルタリングします。AI エンティティ解決によってこれらの企業に一致した記事のみが配信されます。例：["AAPL", "GOOGL", "TSLA"]。
Name
countries
Type
string[]
Description
国コードでフィルタリングします（ISO 3166-1 alpha-2）。これらの国の企業に一致した記事のみが配信されます。例：["US", "GB", "DE"]。
Name
categories
Type
string[]
Description
記事カテゴリでフィルタリングします。可能な値：markets | economy | business | politics | geopolitics | regulation | technology | energy | commodities | crypto | health | climate | security。
Name
includeContent
Type
boolean
Description
記事本文の全文をペイロードに含めます。記事全文へのアクセスを含むプランが必要です。
Name
includeEntities
Type
boolean
Description
記事内で見つかった抽出エンティティ（企業、人物、場所）を含めます。
Name
excludeEmptyContent
Type
boolean
Description
要約が空でない記事のみを配信します。低品質な記事を除外するのに役立ちます。
Name
includeUpdates
Type
boolean
Description
記事が最初の公開後に更新された際に再配信します。更新されたペイロードには isUpdate=true と revisedDate タイムスタンプが含まれます。

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",
  "sentiment": "positive",
  "confidence": 0.95,
  "images": [
    "https://www.example.com/image1.jpg",
    "https://www.example.com/image2.jpg"
  ],
  "countries": ["US"],
  "categories": ["markets", "health"],
  "companies": [
    {
      "companyId": 41494,
      "confidence": "0.9335401058197021",
      "country": "US",
      "exchange": "XNAS",
      "industry": "Biotechnology: Pharmaceutical Preparations",
      "name": "Summit Therapeutics Inc. Common Stock",
      "sector": "Health Care",
      "ticker": "SMMT",
      "isin": "US86627T1088",
      "openfigi": "BBG01PH11VP5",
      "primaryListing": {
        "ticker": "SMMT",
        "exchangeCode": "XNAS",
        "exchangeCountry": "US"
      },
      "isins": ["US86627T1088", "US86627T2088"],
      "otherListings": [
        {
          "ticker": "SMMT.L",
          "exchangeCode": "XLON",
          "exchangeCountry": "GB"
        }
      ]
    }
  ]
}

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",
  "sentiment": "positive",
  "confidence": 0.95,
  "images": [
    "https://www.example.com/image1.jpg"
  ],
  "countries": ["US"],
  "categories": ["markets"],
  "companies": []
}

EXAMPLES組み合わせフィルター

フィルタリングの例

エンリッチ Webhook はすべてのフィルターパラメータの組み合わせをサポートします。よくあるパターンを次に示します：

企業リサーチフィード:

tickers: ["AAPL", "GOOGL"]
sources: ["www.reuters.com", "www.bloomberg.com"]
includeEntities: true

速報マーケットニュース:

query: "earnings OR revenue OR guidance"
categories: ["markets", "economy"]
language: "en"

地域別・業種別フォーカス:

countries: ["US", "CA"]
query: "tech OR technology OR semiconductor"
tickers: ["NVDA", "TSMC", "AMD"]

欧州の金融ニュース:

countries: ["GB", "DE", "FR"]
sources: ["www.reuters.com", "www.ft.com"]
language: "en"

クエリ構文はブール演算子、引用符付きフレーズ、除外をサポートします：

"Apple earnings"                           simple phrase
(Apple OR iPhone) AND (earnings OR revenue)  boolean groups
Tesla NOT recall                           exclusion

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

GUIDE判断のヒント

エンリッチ Webhook を使うべき場合

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

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

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

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

Raw Webhook のフィルタリングオプションの詳細については、Raw Webhookガイドを参照してください。