Обогащённые вебхуки

Обогащённые вебхуки доставляют обработанные ИИ данные статьи с разрешением сущностей компаний, анализом тональности и полным набором параметров фильтрации.

Ключевые возможности обогащённых вебхуков:

Полная фильтрация — фильтрация по тикерам, странам, категориям, источникам, языку и query
Обогащение ИИ — полезные нагрузки включают оценки тональности, совпадения компаний и значения достоверности
Гибкое содержимое — при необходимости включайте полный текст статьи и извлечённые сущности через includeContent / includeEntities
Неизменяемый тип — тип доставки (enriched или raw) задаётся при создании и не может быть изменён впоследствии

Модель статьи

Обогащённые вебхуки доставляют полную полезную нагрузку статьи, включая сгенерированные ИИ данные о компаниях, анализ тональности и разрешение сущностей.

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
Сгенерированная ИИ тональность статьи. Возможные значения: 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
Массив совпавших объектов компаний, разрешённых сопоставлением сущностей ИИ. Каждая компания содержит следующие поля:
- 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Тип доставки

При создании вебхука в панели finlight выберите Enriched в качестве типа доставки на первом шаге мастера настройки. Это вариант по умолчанию. На шаге критериев будут показаны все доступные параметры фильтра.

Обогащённые вебхуки доставляют только вновь опубликованные статьи, соответствующие вашим критериям. Каждая доставка — это полезная нагрузка одной статьи, отправляемая на ваш эндпоинт 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
Фильтрация по тикерам. Доставляются только статьи, сопоставленные этим компаниям разрешением сущностей ИИ. Напр. ["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Комбинированные фильтры

Примеры фильтрации

Обогащённые вебхуки поддерживают сочетание всех параметров фильтра. Вот распространённые шаблоны:

Лента исследования компаний:

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Помощь в выборе

Когда использовать обогащённые вебхуки

Выбирайте Enriched, когда вы:

Нуждаетесь в фильтрации на уровне компании/тикера (tickers, countries, categories)
Хотите получать в полезной нагрузке оценки тональности, значения достоверности или разрешение сущностей
Должны включать полный текст статьи или извлечённые сущности через includeContent / includeEntities
Строите мониторинг акций, отслеживание отчётностей или отраслевые новостные ленты

Выбирайте Raw, когда вы:

Нуждаетесь в максимально низкой задержке доставки
Строите высоконагруженный конвейер, где данные обогащения не требуются
Хотите фильтровать только по ключевым словам, источникам или языку
Хотите более компактную полезную нагрузку, чтобы снизить накладные расходы на обработку на своей стороне

Полные сведения о параметрах фильтрации необработанных вебхуков см. в руководстве Необработанные вебхуки.