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

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

Pedido 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

Parameter Required Tipo Default Description
consulta Yes cadeia (de caracteres) - Uma pesquisa para os resultados das notícias. O comprimento máximo é de 1000 caracteres.
maxResultados No número inteiro 10 Número máximo de resultados a retornar. O padrão é 10. O valor máximo é 20.
linguagem No cadeia (de caracteres) "en" Um código de língua ISO 639-1 de 2 letras para a linguagem de interface nos resultados de pesquisa. Consulte Linguagens Suportadas para a lista completa.
região No cadeia (de caracteres) "US" Um código de país/região de 2 letras para indicar de onde devem vir os resultados (por exemplo, "EUA", "JP", "GB", etc.). Consulte Regiões Suportadas para a lista completa.
localização No cadeia (de caracteres) - Informação de localização no formato "lat:<float>; long:<float>", por exemplo, "lat:40.753250; long:-74.003807".
contentFormat No cadeia (de caracteres) "passagem" ("texto" com acesso completo ao documento) passage devolve as partes de cada resultado mais relevantes para a consulta (recomendado para aterramento). text, html e markdown devolver o documento completo e aplicar-se apenas a aplicações com acesso completo ao documento; ver Passagens e formatos de conteúdo. Define-o em todos os pedidos.
comprimento máximo No número inteiro 3000 (10000 com acesso completo ao documento) Número máximo de caracteres por content resultado, de 1 a 500000. Sem acesso completo a documentos, content são no máximo 3000 caracteres. Veja Padrões e limites. Define-o em todos os pedidos.

Formatos de conteúdo

Define 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 é passage, e por que usá-lo? na FAQ. Aplicações com acesso total a documentos também podem solicitar o documento completo como text, html ou markdown; para outras aplicações, esses formatos retornam HTTP 403. Ver Passagens e formatos de conteúdo.

Cabeçalhos dos Pedidos

Field Tipo Description
alojar cadeia (de caracteres) Alojamento para APIs de IA da Microsoft: api.microsoft.ai.
x-apikey ou Autorização cadeia (de caracteres) A sua chave API ou token de acesso do Entra ID para autenticação.
tipo de conteúdo cadeia (de caracteres) Tipo MIME do corpo do pedido. Utilize application/json.

Resposta

Resposta das Notícias

Field Tipo Description
notíciasResultados variedade de notíciasResultado Lista de resultados de artigos de notícias.
instrumentaçãoClickBase cadeia (de caracteres) URL base para pedidos de ping de clique. Adicione um instrumentationSuffix valor a partir de um item de resultado para formar o URL completo do ping. Está presente apenas para aplicações com a flag de perfil EnableInstrumentationPing. Nota: Os cliques do utilizador também podem ser registados usando redirecionamento de URL. Quando o redirecionamento está ativado, não é necessária qualquer ação para registar os cliques do Utilizador, e instrumentationClickBase não será incluído na resposta. Consulte o guia de instrumentação para instruções de configuração.
instrumentaçãoCitaçãoBase cadeia (de caracteres) URL base para pedidos de ping de registo LLM. Adicione um payload DATA para formar o URL completo do ping. Está presente apenas para aplicações com a flag de perfil EnableInstrumentationPing.
traceId cadeia (de caracteres) ID de rastreio para depuração.

notíciasResultado

Field Tipo Description
title cadeia (de caracteres) O título da notícia.
url cadeia (de caracteres) A URL de origem do artigo de notícias. Para utilizadores da China com redirecionamento de URL ativada, este campo contém o mesmo URL de redirecionamento que clickUrl.
domínio cadeia (de caracteres) O anfitrião de destino para o resultado. Devolvido apenas para utilizadores chineses com redirecionamento de URL ativado.
conteúdo cadeia (de caracteres) O conteúdo detalhado da página web (também conhecido como fundamentação) do resultado da notícia.
miniatura Objeto miniatura A miniatura do artigo de notícias.
lastUpdatedAt cadeia (de caracteres) A última data de atualização das notícias, em formato UTC ISO8601.
rastejou cadeia (de caracteres) A última data rastreada das notícias segue ISO8601 formato.
linguagem cadeia (de caracteres) A redação do artigo de notícias utiliza o código linguístico ISO 639-1.
origem cadeia (de caracteres) Nome da Publisher, como "USA TODAY | MSN", "CNN", etc.
éAdulto boolean Indica se o conteúdo é para adultos.
clickUrl cadeia (de caracteres) URL de redirecionamento que proxie o clique através do Bing. Só está presente quando o redirecionamento por clique está ativado.
InstrumentaçãoSufixo cadeia (de caracteres) Sufixo para anexar à base de URL de ping da instrumentação para este item de resultado. Usado como valor K tanto para o ping URL da instrumentação como para o clickUrl redirecionamento. Presente quando o ping de instrumentação estiver ativado.

Note

lastUpdatedAt O campo é opcional – ou seja, pode ver um valor vazio para este campo.

miniatura

Field Tipo Description
url cadeia (de caracteres) O URL da miniatura.
width número inteiro Largura da miniatura, em pixels.
height número inteiro Altura da miniatura, em pixels.

Note

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

Códigos de erro

Código de estado Categoria de Erro Description Causas Comuns
200 Sucesso O pedido foi bem-sucedido. -
400 Pedido Incorreto Parâmetros de pedido inválidos. Campos obrigatórios em falta, valores de parâmetros inválidos, JSON mal formado
401 Não autorizado Autenticação falhada ou em falta. Chave API inválida, falta do cabeçalho x-apikey
403 Proibido Credenciais válidas mas permissões insuficientes. A chave API não tem as permissões necessárias
410 Desapareceu HTTPS necessário. Pedido feito por HTTP em vez de HTTPS
415 Tipo de Media Não Suportado Tipo de conteúdo não suportado. Cabeçalho de tipo de conteúdo em falta ou incorreto
429 Demasiados Pedidos Limite de taxa ultrapassado. Demasiados pedidos numa janela temporal
500 Erro interno do servidor Erro inesperado do servidor. Problema temporário com o servidor
503 Serviço Indisponível Serviço temporariamente indisponível. Manutenção ou interrupção temporária
504 Tempo limite do gateway O tempo limite da solicitação expirou. Tempo de extinção do serviço a montante

Para orientações detalhadas sobre o tratamento de erros, consulte Gestão de Erros.

Ver também:Pesquisa | na Web Vídeos Pesquisa | Pesquisa | Imagens Pesquisa | MCP

  • Última atualização a