Automatisk REST API-referens (Beta)

Note

Auto är tillgängligt i betaversionen för externa partner vars programprofil är aktiverad för Auto. API-ytan och kontraktet kan ändras.

Slutpunkt:POST https://api.microsoft.ai/v3/auto

Alla begäranden kräver en API-nyckel eller Microsoft Entra ID åtkomsttoken. Se Autentisering för installationsinstruktioner.

Exempelbegäran

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 Type Default Description
query Yes string - Sökfråga, från 1 till 1 000 tecken. Stöd site: och -site: operatorer.
language No string en Gränssnittsspråket ISO 639-1 med två bokstäver.
region No string US Tvåbokstavskod för marknad eller land/region.
mode No string fast fast prioriterar hastigheten. advanced prioriterar helheten.
maxResponseLength No integer 30000 Maximal total svarslängd. Värden under 1500 är fastklämda till 1500; värden över 500000 är fastklämda till 500000.
location No string - Geografisk kontext i lat:<latitude>;long:<longitude> format, till exempel lat:47.6062;long:-122.3321.
responseFilter No strängmatris - Berättigade svarstyper: web, news, timezone, weather, images, videos.

Svar

Ett lyckat bevissvar returnerar 200 OK. Varje resultat innehåller ett skrivet bevisobjekt och de citat som stöder det. Bevis som inte stöds eller är felaktiga utelämnas tillsammans med dess citat. Om varje angivet bevisresultat utelämnas är results det tomt.

AutoEvidenceResponse

Fält Type Description
results matris med AutoEvidenceResult Bevisobjekt i kombination med citat som är begränsade till det resultatet.
traceId string Korrelations-ID för felsökning och support.

AutoEvidenceResult

Fält Type Description
evidence AutoEvidence Genererade typbevis.
citations matris med AutoEvidenceCitation Citat som endast stöder detta bevisresultat.

AutoEvidence

Bevisobjektets egen type diskriminerande väljer schemat contentför .

type content
text Strängbevis som returneras för webb- och nyhetsresultat.
media/image Bildresultatobjekt.
media/video Videoresultatobjekt.
structured/weather Väderobjekt.
structured/timeZone Tidszonsobjekt.

Nyhetstextbevis kan också innehålla ett thumbnail med url, widthoch height. Strukturerat innehåll följer samma synlighetsregler för offentliga fält som motsvarande söksvar.

AutoEvidenceCitation

Fält Type Description
contentSource string Källhänvisning.
title string Källhänvisningsrubrik.
url string Källhänvisnings-URL.
lastUpdatedAt string Senast uppdaterad tidsstämpel.
crawledAt string Tidsstämpel för crawlning.
language string Innehållsspråk.
isAdult boolean Om källhänvisning innehåller innehåll för vuxna.

Exempelsvar

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

Felkoder

Statuskod Description
200 Begäran lyckades, inklusive en giltig sökning utan resultat.
400 Ogiltiga parametrar eller felaktigt JSON.
401 Autentiseringsuppgifter saknas eller är ogiltiga.
403 Den autentiserade profilen är inte aktiverad för Auto.
429 Hastighets- eller kvotgränsen har överskridits.
500 Internt tjänstfel.
503 En obligatorisk tjänst är inte tillgänglig.
504 Begäran har tidsgränsen gått ut.

Information om det delade felschemat och vägledningen för återförsök finns i Felhantering.

Relaterat innehåll

  • Uppdaterades senast