Referência automática da API REST (Beta)

Note

O Auto está disponível em versão beta para parceiros externos cujo perfil de aplicação está ativado para o Auto. A superfície da API e o contrato podem mudar.

Ponto final:POST https://api.microsoft.ai/v3/auto

Todos os pedidos requerem uma chave API ou token de acesso Microsoft Entra ID. Consulte Autenticação para instruções de configuração.

Pedido de amostra

curl -X POST "https://api.microsoft.ai/v3/auto" \
  -H "x-apikey: <Your API key>" \
  -H "content-type: application/json" \
  -d '{
    "query": "Microsoft AI announcements",
    "language": "en",
    "region": "US",
    "location": "lat:47.6062;long:-122.3321",
    "mode": "fast",
    "maxResponseLength": 30000,
    "responseFilter": ["web", "news"]
  }'

Parameters

Parameter Required Tipo Default Description
query Yes cadeia (de caracteres) - Consulta de pesquisa, de 1 a 1.000 caracteres. Suportes site: e -site: operadores.
language No cadeia (de caracteres) en Linguagem de interface ISO 639-1 de duas letras.
region No cadeia (de caracteres) US Código de mercado ou país/região de duas letras.
mode No cadeia (de caracteres) fast fast prioriza a velocidade; advanced prioriza a abrangência.
maxResponseLength No número inteiro 30000 Comprimento máximo total de resposta. Valores abaixo de 1500 são fixados em 1500; valores acima de 500000 são fixados em 500000.
location No cadeia (de caracteres) - Contexto geográfico no lat:<latitude>;long:<longitude> formato, por lat:47.6062;long:-122.3321exemplo.
responseFilter No matriz de strings - Tipos de resposta elegíveis: web, news, timezone, weather, images, . videos

Resposta

Uma resposta bem-sucedida à evidência retorna 200 OK. Cada resultado contém um objeto de evidência tipado e as citações que o apoiam. Provas não fundamentadas ou deformadas são omitidas juntamente com as suas citações. Se todos os resultados de evidência fornecidos forem omitidos, results é vazio.

AutoEvidênciaResposta

Field Tipo Description
results array de AutoEvidenceResult Itens de evidência, acompanhados de citações, ajustados a esse resultado.
traceId cadeia (de caracteres) ID de correlação para depuração e suporte.

AutoEvidenceResult

Field Tipo Description
evidence AutoEvidência Evidência datilografada gerada.
citations array de AutoEvidenceCitation Citações que apoiam apenas esta evidência resultam.

AutoEvidência

O próprio type discriminador do objeto de evidência seleciona o esquema de content.

type content
text Evidências de corda retornadas para resultados Web e Notícias.
media/image Objeto resultado da imagem.
media/video Objeto de resultado de vídeo.
structured/weather Objeto meteorológico.
structured/timeZone Objeto de fuso horário.

As evidências de texto de notícias também podem incluir um thumbnail com url, width, e height. O conteúdo estruturado segue as mesmas regras de visibilidade em campos públicos que a resposta de pesquisa correspondente.

AutoEvidênciaCitação

Field Tipo Description
contentSource cadeia (de caracteres) Fonte da citação.
title cadeia (de caracteres) Título da citação.
url cadeia (de caracteres) URL de citação.
lastUpdatedAt cadeia (de caracteres) Carimbo temporal da última atualização.
crawledAt cadeia (de caracteres) Carimbo temporal do crawl.
language cadeia (de caracteres) Linguagem de conteúdo.
isAdult boolean Se a citação contém conteúdo para adultos.

Resposta de exemplo

{
  "results": [
    {
      "evidence": {
        "type": "text",
        "content": "Microsoft announced a new set of AI capabilities."
      },
      "citations": [
        {
          "contentSource": "web",
          "url": "https://www.microsoft.com/en-us/ai",
          "title": "Microsoft AI",
          "language": "en",
          "isAdult": false
        }
      ]
    }
  ],
  "traceId": "00000000000000000000000000000000"
}

Códigos de erro

Código de estado Description
200 O pedido foi bem-sucedido, incluindo uma pesquisa válida sem resultados.
400 Parâmetros inválidos ou JSON malformado.
401 Credenciais de autenticação em falta ou inválidas.
403 O perfil autenticado não está ativado para Auto.
429 Limite de taxa ou quota ultrapassado.
500 Falha do serviço interno.
503 Um serviço obrigatório não está disponível.
504 O pedido expirou.

Para o esquema de erro partilhado e a orientação de retentativa, veja Gestão de erros.

Conteúdo relacionado

  • Última atualização a