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

Note

O auto está disponível na versão beta para parceiros externos cujo perfil de aplicativo está habilitado para o Auto. A superfície da API e o contrato podem mudar.

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

Todas as solicitações exigem uma chave de API ou um token de acesso Microsoft Entra ID. Consulte Autenticação para obter instruções de instalação.

Solicitação de exemplo

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

Parâmetro Required Tipo Default Description
query Yes cadeia - Consulta de pesquisa, de 1 a 1.000 caracteres. Suportes site: e -site: operadores.
language No cadeia en Linguagem de interface ISO 639-1 de duas letras.
region No cadeia US Código de mercado de duas letras ou país/região.
mode No cadeia fast fast prioriza a velocidade; advanced prioriza a integralidade.
maxResponseLength No inteiro 30000 Comprimento máximo total da resposta. Os valores abaixo de 1500 são fixados em 1500; os valores acima de 500000 são fixados em 500000.
location No cadeia - Contexto geográfico em lat:<latitude>;long:<longitude> formato, por exemplo lat:47.6062;long:-122.3321.
responseFilter No Matriz de cadeias de caracteres - Tipos de resposta qualificados: web, , news, timezone, weather, images, videos.

Resposta

Uma resposta de evidência bem-sucedida retorna 200 OK. Cada resultado contém um objeto de evidência tipado e as citações que dão suporte a ele. Evidências sem suporte ou malformadas são omitidas junto com suas citações. Se cada resultado de evidência fornecido for omitido, results estará vazio.

AutoEvidenceResponse

Field Tipo Description
results matriz de AutoEvidenceResult Itens de evidência emparelhados com citações com escopo para esse resultado.
traceId cadeia ID de correlação para depuração e suporte.

AutoEvidenceResult

Field Tipo Description
evidence AutoEvidência Evidência digitada gerada.
citations matriz de AutoEvidenceCitation Citações que dão suporte apenas a esse resultado de evidência.

AutoEvidência

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

type content
text Evidência de cadeia de caracteres retornada para resultados da Web e notícias.
media/image Objeto de resultado da imagem.
media/video Objeto de resultado de vídeo.
structured/weather Objeto weather.
structured/timeZone Objeto de fuso horário.

As evidências de texto de notícias também podem incluir um thumbnail com url, widthe height. O conteúdo estruturado segue as mesmas regras de visibilidade de campo público que sua resposta de pesquisa correspondente.

AutoEvidenceCitation

Field Tipo Description
contentSource cadeia Fonte de citação.
title cadeia Título da citação.
url cadeia URL de citação.
lastUpdatedAt cadeia Carimbo de data/hora atualizado pela última vez.
crawledAt cadeia Carimbo de data/hora de rastreamento.
language cadeia Linguagem de conteúdo.
isAdult boolean Se a citação contém conteúdo adulto.

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 status Description
200 A solicitação foi bem-sucedida, incluindo uma pesquisa válida sem resultados.
400 Parâmetros inválidos ou JSON malformado.
401 Credenciais de autenticação ausentes ou inválidas.
403 O perfil autenticado não está habilitado para Auto.
429 Taxa ou limite de cota excedido.
500 Falha de serviço interno.
503 Um serviço necessário não está disponível.
504 A solicitação atingiu o tempo limite.

Para obter o esquema de erro compartilhado e as diretrizes de repetição, consulte Tratamento de erro.

Conteúdo relacionado

  • Última atualização em