Referência da API REST de Pesquisa de Notícias

Ponto de extremidade:POST https://api.microsoft.ai/v3/search/news

Solicitação de exemplo:

curl -X POST "https://api.microsoft.ai/v3/search/news" \
  -H "host: api.microsoft.ai" \
  -H "x-apikey: <Your key>" \
  -H "content-type: application/json" \
  -d '{
    "query": "latest VC funding in tech",
    "maxResults": 10,
    "language": "en",
    "region": "US",
    "maxLength": 3000,
    "contentFormat": "passage"
  }'

Parameters

Parâmetro Required Tipo Default Description
consulta Yes cadeia - Uma consulta de pesquisa para os resultados das notícias. O comprimento máximo é de 1000 caracteres.
maxResults No inteiro 10 Número máximo de resultados a serem retornados. O valor padrão é 10. O valor máximo é 20.
linguagem No cadeia "en" Um código de idioma ISO 639-1 de 2 letras para linguagem de interface nos resultados da pesquisa. Consulte idiomas com suporte para a lista completa.
região No cadeia "US" Um código de país/região de duas letras de onde os resultados devem vir (por exemplo, "EUA", "JP", "GB", etc.). Consulte regiões com suporte para obter a lista completa.
local No cadeia - Informações de localização no formato "lat:<float>; long:<float>", por exemplo, "lat:40.753250; long:-74.003807".
formato de conteúdo No cadeia "passagem" ("texto" com acesso completo ao documento) passage retorna as partes de cada resultado mais relevantes para a consulta (recomendado para aterramento). texte htmlmarkdown retorne o documento completo e aplique-se somente a aplicativos com acesso completo a documentos; consulte Passagens e formatos de conteúdo. Defina-o em cada solicitação.
comprimento máximo No inteiro 3000 (10000 com acesso completo a documentos) Máximo de caracteres content por resultado, de 1 a 500000. Sem acesso completo ao documento, content há no máximo 3.000 caracteres. Consulte Padrões e limites. Defina-o em cada solicitação.

Formatos de conteúdo

Defina contentFormat = passage para obter as partes de cada resultado mais relevantes para a consulta, até maxLength caracteres (3000 é um bom ponto de partida). É o formato recomendado para aterramento; veja o que é passagee por que usá-lo nas perguntas frequentes. Aplicativos com acesso completo a documentos também podem solicitar o documento completo como text, html ou markdown; para outros aplicativos, esses formatos retornam HTTP 403. Consulte Passagens e formatos de conteúdo.

Cabeçalhos da solicitação

Field Tipo Description
hospedar cadeia Host para APIs de IA Microsoft: api.microsoft.ai.
x-apikey ou Autorização cadeia Sua chave de API ou Entra ID token de acesso para autenticação.
tipo de conteúdo cadeia Tipo MIME do corpo da solicitação. Use application/json.

Resposta

Resposta de notícias

Field Tipo Description
newsResults matriz de newsResult Lista de resultados do artigo de notícias.
instrumentationClickBase cadeia URL base para clicar em solicitações de ping. Acrescente um instrumentationSuffix valor de um item de resultado para formar a URL de ping completa. Presente apenas para aplicativos com o sinalizador de perfil EnableInstrumentationPing. Observação: os cliques do usuário também podem ser registrados usando o redirecionamento de URL. Quando o redirecionamento estiver habilitado, nenhuma ação será necessária para registrar cliques do usuário e instrumentationClickBase não será incluída na resposta. Consulte o guia de Instrumentação para obter instruções de instalação.
instrumentationCitationBase cadeia URL base para solicitações de ping de log llm. Acrescente um conteúdo de DADOS para formar a URL de ping completa. Presente apenas para aplicativos com o sinalizador de perfil EnableInstrumentationPing.
traceId cadeia ID de rastreamento para depuração.

newsResult

Field Tipo Description
title cadeia O título das notícias.
url cadeia A URL de origem do artigo de notícias. Para usuários da China com redirecionamento de URL habilitado, esse campo contém a mesma URL de redirecionamento que clickUrl.
domínio cadeia O host de destino para o resultado. Retornado somente para usuários da China com redirecionamento de URL habilitado.
conteúdo cadeia O conteúdo detalhado da página da Web (também conhecido como aterramento) do resultado da notícia.
miniatura objeto de miniatura A miniatura do artigo de notícias.
lastUpdatedAt cadeia A última data atualizada da notícia, no formato ISO8601 UTC.
crawledAt cadeia A última data rastreada das notícias segue ISO8601 formato.
linguagem cadeia O idioma do artigo de notícias usa o código de idioma ISO 639-1.
fonte cadeia Publisher nome, como "USA TODAY | MSN, "CNN", etc.
isAdult boolean Indica se o conteúdo é adulto.
clickUrl cadeia URL de redirecionamento que faz o proxie do clique por meio do Bing. Só está presente quando o redirecionamento de clique está habilitado.
instrumentationSuffix cadeia Sufixo a ser acrescentado à base de URL de ping de instrumentação para este item de resultado. Usado como o valor K para a URL de ping de instrumentação e o clickUrl redirecionamento. Presente quando o ping de instrumentação estiver habilitado.

Note

lastUpdatedAt campo é opcional – ou seja, você pode ver um valor vazio para esse campo.

miniatura

Field Tipo Description
url cadeia A URL da miniatura.
width inteiro Largura da miniatura, em pixels.
height inteiro Altura da miniatura, em pixels.

Note

thumbnail também é um objeto de resposta opcional – ele pode não estar disponível para determinados resultados de notícias.

Códigos de erro

Código de Status Categoria do Erro Description Causas comuns
200 Êxito O pedido foi bem-sucedido. -
400 Solicitação incorreta Parâmetros de solicitação inválidos. Campos necessários ausentes, valores de parâmetro inválidos, JSON malformado
401 Unauthorized Falha ou falha na autenticação. Chave de API inválida, cabeçalho x-apikey ausente
403 Proibido Credenciais válidas, mas permissões insuficientes. A chave de API não tem permissões necessárias
410 Sumiu (Gone) HTTPS necessário. Solicitação feita por HTTP em vez de HTTPS
415 Tipo de mídia sem suporte Não há suporte para o tipo de conteúdo. Cabeçalho de tipo de conteúdo ausente ou incorreto
429 Número Excessivo de Solicitações Limite de taxa excedido. Muitas solicitações na janela de tempo
500 Erro interno do servidor Erro de servidor inesperado. Problema temporário do servidor
503 Serviço indisponível Serviço temporariamente indisponível. Manutenção ou interrupção temporária
504 Tempo de Espera do Gateway (Gateway Timeout) A solicitação expirou. Tempo limite do serviço upstream

Para obter diretrizes detalhadas de tratamento de erros, consulte Tratamento de Erros.

Consulte também:Pesquisa deVídeosde Pesquisa | na WebProcurar | | Imagens Pesquisa | MCP

  • Última atualização em