Auto REST API-referencia (bétaverzió)

Note

Az Auto bétaverzióban érhető el azoknak a külső partnereknek, akiknek az alkalmazásprofilja engedélyezve van az Automatikushoz. Az API felülete és a szerződés változhat.

Végpont:POST https://api.microsoft.ai/v3/auto

Minden kéréshez API-kulcsra vagy Microsoft Entra ID hozzáférési jogkivonatra van szükség. A beállítási utasításokért tekintse meg a hitelesítést.

Mintakérés

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

Paraméter Required Típus Default Description
query Yes karakterlánc - Keresési lekérdezés 1 és 1000 karakter között. Támogatja site: és -site: operátorok.
language No karakterlánc en Kétbetűs ISO 639-1 felületi nyelv.
region No karakterlánc US Kétbetűs piac vagy ország/régió kódja.
mode No karakterlánc fast fast rangsorolja a sebességet; advanced rangsorolja az átfogóságot.
maxResponseLength No egész szám 30000 Maximális válaszhossz. Az 1500 alatti értékek 1500-ra vannak rögzítve; az 5000000 feletti értékek 5000000-hez vannak rögzítve.
location No karakterlánc - Földrajzi környezet formátuma lat:<latitude>;long:<longitude> , például lat:47.6062;long:-122.3321.
responseFilter No sztringek tömbje - Jogosult választípusok: web, news, timezone, weather, images. videos

Response

A sikeres bizonyíték válasz visszaadja 200 OK. Minden eredmény egy beírt bizonyítékobjektumot és az azt támogató idézeteket tartalmazza. A nem támogatott vagy hibásan formázott bizonyítékokat az idézetekkel együtt kihagyják. Ha minden megadott bizonyíték eredménye hiányzik, results üres.

AutoEvidenceResponse

Field Típus Description
results Az AutoEvidenceResult tömbje Az eredményre hatókörrel rendelkező idézetekkel párosított bizonyítékelemek.
traceId karakterlánc Korrelációs azonosító a hibakereséshez és a támogatáshoz.

AutoEvidenceResult

Field Típus Description
evidence Automatikus felosztás Generált gépelt bizonyíték.
citations Az AutoEvidenceCitation tömbje Csak ezt a bizonyítékot alátámasztó idézetek.

Automatikus felosztás

A bizonyítékobjektum saját type diszkriminatívja kiválasztja a sémát content.

type content
text A webes és a hírek eredményeihez visszaadott sztringek.
media/image Kép eredményobjektuma.
media/video Videoeredmény-objektum.
structured/weather Időjárási objektum.
structured/timeZone Időzóna objektum.

A hírek szövegének bizonyítékai közé tartozhat a thumbnail with url, widthés heighta . A strukturált tartalom ugyanazokat a nyilvános mező láthatósági szabályokat követi, mint a megfelelő keresési válasz.

AutoEvidenceCitation

Field Típus Description
contentSource karakterlánc Idézet forrása.
title karakterlánc Idézet címe.
url karakterlánc Idézet URL-címe.
lastUpdatedAt karakterlánc Legutóbb frissített időbélyeg.
crawledAt karakterlánc Bejárási időbélyeg.
language karakterlánc Tartalom nyelve.
isAdult boolean Azt jelzi, hogy az idézet felnőtt tartalmat tartalmaz-e.

Példa válasz

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

Hibakódok

Állapotkód Description
200 A kérés sikeres volt, beleértve egy érvényes keresést, találatok nélkül.
400 Érvénytelen paraméterek vagy hibásan formázott JSON.
401 Hiányzó vagy érvénytelen hitelesítési hitelesítő adatok.
403 A hitelesített profil nincs engedélyezve az Automatikushoz.
429 Túllépte a sebesség- vagy kvótakorlátot.
500 Belső szolgáltatáshiba.
503 A szükséges szolgáltatás nem érhető el.
504 A kérés túllépte az időkorlátot.

A megosztott hibaséma és az újrapróbálkozási útmutatóért tekintse meg a Hibakezelés című témakört.

Kapcsolódó tartalom

  • Utolsó frissítés időpontja: