Referenční informace k automatickému rozhraní REST API (beta verze)

Note

Automaticky je k dispozici v beta verzi pro externí partnery, jejichž profil aplikace je povolený pro automatické použití. Povrch a kontrakt rozhraní API se můžou změnit.

Koncový bod:POST https://api.microsoft.ai/v3/auto

Všechny požadavky vyžadují klíč rozhraní API nebo přístupový token Microsoft Entra ID. Pokyny k nastavení najdete v tématu Ověřování .

Ukázkový požadavek

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 Typ Výchozí Description
query Ano řetězec - Vyhledávací dotaz, od 1 do 1 000 znaků. Podporuje site: a -site: operátory.
language No řetězec en Dvoumísmenný jazyk rozhraní ISO 639-1.
region No řetězec US Dvoumísmenný trh nebo kód země/oblasti
mode No řetězec fast fast určuje prioritu rychlosti; advanced prioritizuje komplexnost.
maxResponseLength No integer 30000 Maximální celková délka odpovědi Hodnoty nižší než 1500 jsou upínací na 1500; hodnoty nad 5000000 jsou upínací na 5 00000.
location No řetězec - Geografický kontext ve lat:<latitude>;long:<longitude> formátu, například lat:47.6062;long:-122.3321.
responseFilter No pole řetězců - Způsobilé typy odpovědí: web, news, timezone, weather, images. videos

Response

Úspěšná odpověď důkazu vrátí 200 OK. Každý výsledek obsahuje jeden typ důkaz objektu a citace, které ho podporují. Nepodporovaný nebo poškozený důkaz je vynechán společně s jeho citacemi. Pokud je každý zadaný výsledek důkazu vynechán, results je prázdný.

AutoEvidenceResponse

Field Typ Description
results array of AutoEvidenceResult Položky důkazů spárované s citacemi vymezenými na tento výsledek.
traceId řetězec ID korelace pro ladění a podporu.

AutoEvidenceResult

Field Typ Description
evidence AutoEvidence Vygenerovaný typový důkaz.
citations pole AutoEvidenceCitation Citace podporující pouze tento výsledek důkazů.

AutoEvidence

Vlastní diskriminátor objektu type důkazů vybere schéma content.

type content
text Řetězcové důkazy vrácené pro výsledky webu a zpráv.
media/image Objekt výsledku obrázku
media/video Objekt výsledku videa.
structured/weather Objekt Počasí.
structured/timeZone Objekt časového pásma.

Důkazy o textu zpráv mohou obsahovat také s thumbnailurl, widtha height. Strukturovaný obsah se řídí stejnými pravidly viditelnosti veřejných polí jako odpovídající odpověď hledání.

AutoEvidenceCitation

Field Typ Description
contentSource řetězec Zdroj citace.
title řetězec Název citace.
url řetězec Adresa URL citace
lastUpdatedAt řetězec Časové razítko poslední aktualizace
crawledAt řetězec Časové razítko procházení
language řetězec Jazyk obsahu.
isAdult boolean Jestli citace obsahuje obsah pro dospělé.

Příklad odpovědi

{
  "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"
}

Kódy chyb

Stavový kód Description
200 Požadavek byl úspěšný, včetně platného hledání bez výsledků.
400 Neplatné parametry nebo poškozený formát JSON
401 Chybějící nebo neplatné přihlašovací údaje pro ověřování
403 Ověřený profil není povolený pro automatické použití.
429 Byl překročen limit rychlosti nebo kvóty.
500 Selhání interní služby.
503 Požadovaná služba není k dispozici.
504 Vypršel časový limit požadavku.

Informace o schématu sdílených chyb a opakování najdete v tématu Zpracování chyb.

Související obsah

  • Poslední aktualizace v