Naslaginformatie over automatische REST API (bèta)

Note

Auto is beschikbaar in bèta voor externe partners waarvan het toepassingsprofiel is ingeschakeld voor Automatisch. Het API-oppervlak en -contract kunnen veranderen.

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

Voor alle aanvragen is een API-sleutel of Microsoft Entra ID toegangstoken vereist. Zie Verificatie voor installatie-instructies.

Voorbeeldaanvraag

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 - Zoekquery van 1 tot 1000 tekens. Ondersteunt site: en -site: operators.
language No string en Iso 639-1-interfacetaal met twee letters.
region No string US Tweeletterige markt of land-/regiocode.
mode No string fast fast geeft prioriteit aan snelheid; advanced prioriteit geeft aan uitgebreidheid.
maxResponseLength No integer 30000 Maximale totale antwoordlengte. Waarden onder 1500 worden vastgeklemd tot 1500; waarden boven 500000 worden vastgeklemd tot 5000000.
location No string - Geografische context in lat:<latitude>;long:<longitude> indeling, bijvoorbeeld lat:47.6062;long:-122.3321.
responseFilter No reeks van tekenreeksen - In aanmerking komende antwoordtypen: web, news, timezone, weather, , images. videos

Antwoord

Een geslaagd bewijsantwoord retourneert 200 OK. Elk resultaat bevat één getypt bewijsobject en de bronvermeldingen die dit ondersteunen. Niet-ondersteund of onjuist gevormd bewijs wordt samen met de bronvermeldingen weggelaten. Als elk opgegeven bewijsresultaat wordt weggelaten, results is deze leeg.

AutoEvidenceResponse

Veld Type Description
results matrix van AutoEvidenceResult Bewijsitems die zijn gekoppeld aan bronvermeldingen binnen het bereik van dat resultaat.
traceId string Correlatie-id voor foutopsporing en ondersteuning.

AutoEvidenceResult

Veld Type Description
evidence Automatisch delen Gegenereerd getypt bewijs.
citations matrix van AutoEvidenceCitation Bronvermeldingen ondersteunen alleen dit bewijsresultaat.

Automatisch delen

De eigen type discriminator van het bewijsobject selecteert het schema van content.

type content
text Tekenreeksgegevens die zijn geretourneerd voor web- en nieuwsresultaten.
media/image Afbeeldingsresultaatobject.
media/video Videoresultaatobject.
structured/weather Weerobject.
structured/timeZone Tijdzoneobject.

Nieuwsteksten kunnen ook bestaan uit een thumbnail met url, widthen height. Gestructureerde inhoud volgt dezelfde zichtbaarheidsregels voor openbare velden als het bijbehorende zoekantwoord.

AutoEvidenceCitation

Veld Type Description
contentSource string Bronvermelding.
title string Titel van bronvermelding.
url string Bronvermeldings-URL.
lastUpdatedAt string Laatst bijgewerkte tijdstempel.
crawledAt string Tijdstempel voor verkenning.
language string Inhoudstaal.
isAdult boolean Of de bronvermelding inhoud voor volwassenen bevat.

Voorbeeld van een antwoord

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

Foutcodes

Statuscode Description
200 De aanvraag is voltooid, inclusief een geldige zoekopdracht zonder resultaten.
400 Ongeldige parameters of ongeldige JSON.
401 Ontbrekende of ongeldige verificatiereferenties.
403 Het geverifieerde profiel is niet ingeschakeld voor Automatisch.
429 De limiet voor het tarief of quotum is overschreden.
500 Interne servicefout.
503 Een vereiste service is niet beschikbaar.
504 Er is een time-out opgetreden voor het verzoek.

Zie Foutafhandeling voor het schema voor gedeelde fouten en richtlijnen voor opnieuw proberen.

Verwante onderwerpen

  • Laatst bijgewerkt om