Esta página foi traduzida automaticamente. A versão em inglês é a fonte e pode ser mais precisa ou estar mais atualizada. Ver em inglês

Webhooks enriquecidos

Os webhooks enriquecidos entregam dados de artigo processados por IA com resolução de entidades de empresa, análise de sentimento e o conjunto completo de opções de filtragem.

Principais capacidades dos webhooks enriquecidos:

  • Filtragem completa — filtre por tickers, países, categorias, fontes, idioma e query
  • Enriquecimento por IA — as cargas incluem pontuações de sentimento, correspondências de empresa e valores de confiança
  • Conteúdo flexível — inclua opcionalmente o texto completo do artigo e as entidades extraídas via includeContent / includeEntities
  • Tipo imutável — o tipo de entrega (enriched ou raw) é definido na criação e não pode ser alterado depois

Modelo de artigo

Os webhooks enriquecidos entregam a carga completa do artigo, incluindo dados de empresa gerados por IA, análise de sentimento e resolução de entidades.

  • Name
    link
    Type
    string
    Description

    URL do artigo completo.

  • Name
    source
    Type
    string
    Description

    Site de origem. Ex.: www.reuters.com

  • Name
    title
    Type
    string
    Description

    Título do artigo.

  • Name
    summary
    Type
    string
    Description

    Resumo do artigo, se disponível. Pode ser nulo.

  • Name
    publishDate
    Type
    Date
    Description

    Data de publicação como string de data ISO 8601.

  • Name
    createdAt
    Type
    Date
    Description

    Data de criação interna do artigo no sistema do finlight, como string de data ISO 8601.

  • Name
    revisedDate
    Type
    Date | null
    Description

    Data da última revisão do artigo após a publicação inicial. null quando o artigo nunca foi revisado. Presente quando includeUpdates está habilitado e o artigo foi revisado.

  • Name
    isUpdate
    Type
    boolean
    Description

    true quando esta entrega é acionada por uma atualização pós-publicação. Presente apenas quando includeUpdates está habilitado.

  • Name
    language
    Type
    string
    Description

    Código de idioma em ISO 639-1. Ex.: en | de | fr

  • Name
    sentiment
    Type
    string
    Description

    Sentimento do artigo gerado por IA. Valores possíveis: positive | negative | neutral.

  • Name
    confidence
    Type
    number
    Description

    Pontuação de confiança para o valor de sentimento, entre 0 e 1.

  • Name
    images
    Type
    string[]
    Description

    Array de URLs de imagens do artigo.

  • Name
    countries
    Type
    string[]
    Description

    Array de códigos de país no formato ISO 3166-1 alpha-2. Ex.: ["US", "GB"]. Pode estar vazio.

  • Name
    categories
    Type
    string[]
    Description

    Array de categorias do artigo. Valores possíveis: markets | economy | business | politics | geopolitics | regulation | technology | energy | commodities | crypto | health | climate | security. Pode estar vazio.

  • Name
    companies
    Type
    Company[]
    Description

    Array de objetos de empresa correspondentes, resolvidos pela correspondência de entidades por IA. Cada empresa contém os seguintes campos:

    • companyId number — identificador interno de empresa do finlight
    • confidence string — pontuação de confiança da correspondência de entidade
    • name string — nome completo da empresa
    • ticker string — símbolo de ticker principal. Ex.: AAPL
    • exchange string — código da bolsa. Ex.: XNAS
    • country string — país de listagem principal (ISO 3166-1 alpha-2)
    • sector string — classificação de setor. Ex.: Technology
    • industry string — classificação de indústria
    • isin string — código ISIN principal
    • openfigi string — identificador OpenFIGI
    • primaryListing object — { ticker, exchangeCode, exchangeCountry }
    • isins string[] — todos os ISINs conhecidos da empresa
    • otherListings object[] — [{ ticker, exchangeCode, exchangeCountry }]
WEBHOOKTipo de entrega

Criar um webhook enriquecido

Ao criar um webhook no painel do finlight, selecione Enriched como tipo de entrega no primeiro passo do assistente de configuração. Esta é a opção padrão. O passo de critérios mostrará todos os parâmetros de filtro disponíveis.

Os webhooks enriquecidos entregam apenas artigos recém-publicados que correspondem aos seus critérios. Cada entrega é uma única carga de artigo enviada como requisição HTTP POST ao seu endpoint.

  • Name
    query
    Type
    string
    Description

    Consulta de busca para encontrar artigos relevantes. Suporta operadores booleanos e filtragem em nível de campo. Consulte o guia de Criação de consultas avançadas.

  • Name
    sources
    Type
    string[]
    Description

    Limita a entrega a artigos de fontes específicas. Ex.: ["www.reuters.com", "www.cnbc.com"].

  • Name
    excludeSources
    Type
    string[]
    Description

    Exclui artigos de fontes específicas. Ex.: ["www.example.com"].

  • Name
    language
    Type
    string
    Description

    Filtra pelo idioma do artigo (ISO 639-1). O padrão é en, que retorna apenas inglês e exclui outros idiomas — consulte Idioma e cobertura.

  • Name
    tickers
    Type
    string[]
    Description

    Filtra por símbolos de ticker. Apenas os artigos associados a essas empresas pela resolução de entidades por IA serão entregues. Ex.: ["AAPL", "GOOGL", "TSLA"].

  • Name
    countries
    Type
    string[]
    Description

    Filtra por códigos de país (ISO 3166-1 alpha-2). Apenas os artigos associados a empresas desses países serão entregues. Ex.: ["US", "GB", "DE"].

  • Name
    categories
    Type
    string[]
    Description

    Filtra por categoria de artigo. Valores possíveis: markets | economy | business | politics | geopolitics | regulation | technology | energy | commodities | crypto | health | climate | security.

  • Name
    includeContent
    Type
    boolean
    Description

    Inclui o texto completo do corpo do artigo na carga. Requer um plano com acesso ao artigo completo.

  • Name
    includeEntities
    Type
    boolean
    Description

    Inclui as entidades extraídas (empresas, pessoas, locais) encontradas no artigo.

  • Name
    excludeEmptyContent
    Type
    boolean
    Description

    Entrega apenas os artigos que tenham um resumo não vazio. Útil para filtrar artigos de baixa qualidade.

  • Name
    includeUpdates
    Type
    boolean
    Description

    Reentrega os artigos quando são atualizados após a publicação inicial. As cargas atualizadas incluem isUpdate=true e uma marca de tempo 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": []
}
EXAMPLESFiltros combinados

Exemplos de filtragem

Os webhooks enriquecidos permitem combinar todos os parâmetros de filtro. Aqui estão padrões comuns:

Feed de pesquisa de empresas:

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

Notícias de mercado de última hora:

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

Foco regional por setor:

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

Notícias financeiras europeias:

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

A sintaxe de consulta suporta operadores booleanos, frases entre aspas e exclusão:

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

Consulte o guia de Criação de consultas avançadas para a referência completa da sintaxe de consulta.

GUIDEAjuda para decidir

Quando usar webhooks enriquecidos

Escolha Enriched quando você:

  • Precisa de filtragem em nível de empresa/ticker (tickers, countries, categories)
  • Quer pontuações de sentimento, valores de confiança ou resolução de entidades na carga
  • Precisa incluir o conteúdo completo do artigo ou entidades extraídas via includeContent / includeEntities
  • Está construindo monitoramento de ações, acompanhamento de resultados ou feeds de notícias específicos de setor

Escolha Raw quando você:

  • Precisa da menor latência de entrega possível
  • Está construindo um pipeline de alta taxa de transferência em que dados de enriquecimento não são necessários
  • Só precisa filtrar por palavras-chave, fontes ou idioma
  • Quer uma carga mais enxuta para reduzir a sobrecarga de processamento do seu lado

Para detalhes completos sobre as opções de filtragem de webhooks brutos, consulte o guia de Webhooks brutos.