Informazioni di riferimento sulle API REST auto (Beta)

Note

Auto è disponibile in versione beta per i partner esterni il cui profilo applicazione è abilitato per Auto. La superficie dell'API e il contratto potrebbero cambiare.

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

Tutte le richieste richiedono una chiave API o un token di accesso Microsoft Entra ID. Per istruzioni sull'installazione , vedere Autenticazione.

Esempio di richiesta

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

Parametro Required Type Default Description
query Yes string - Query di ricerca, da 1 a 1.000 caratteri. Supporta site: gli operatori e -site: .
language No string en Linguaggio dell'interfaccia ISO 639-1 a due lettere.
region No string US Codice di mercato a due lettere o paese/area geografica.
mode No string fast fast assegna priorità alla velocità; advanced assegna priorità alla completezza.
maxResponseLength No integer 30000 Lunghezza massima della risposta totale. I valori inferiori a 1500 sono bloccati a 1500; i valori superiori a 500000 sono bloccati a 500000.
location No string - Contesto geografico in lat:<latitude>;long:<longitude> formato, ad esempio lat:47.6062;long:-122.3321.
responseFilter No matrice di stringhe - Tipi di risposta idonei: web, news, weathertimezone, , images, videos.

Risposta

Una risposta di evidenza riuscita restituisce 200 OK. Ogni risultato contiene un oggetto evidenza tipizzato e le citazioni che lo supportano. Le prove non supportate o non valide vengono omesse insieme alle relative citazioni. Se ogni risultato dell'evidenza fornito viene omesso, results è vuoto.

AutoEvidenceResponse

Field Type Description
results matrice di AutoEvidenceResult Elementi di evidenza associati a citazioni con ambito a tale risultato.
traceId string ID di correlazione per il debug e il supporto.

AutoEvidenceResult

Field Type Description
evidence AutoEvidence Evidenza tipizzata generata.
citations matrice di AutoEvidenceCitation Citazioni che supportano solo questo risultato di prove.

AutoEvidence

Il discriminante dell'oggetto type evidenza seleziona lo schema di content.

type content
text Evidenza stringa restituita per i risultati web e notizie.
media/image Oggetto risultato immagine.
media/video Oggetto risultato video.
structured/weather Oggetto Meteo.
structured/timeZone Oggetto fuso orario.

L'evidenza del testo delle notizie può includere anche un oggetto thumbnail con url, widthe height. Il contenuto strutturato segue le stesse regole di visibilità dei campi pubblici della risposta di ricerca corrispondente.

AutoEvidenceCitation

Field Type Description
contentSource string Origine citazione.
title string Titolo della citazione.
url string URL di citazione.
lastUpdatedAt string Timestamp dell'ultimo aggiornamento.
crawledAt string Timestamp di ricerca per indicizzazione.
language string Lingua del contenuto.
isAdult boolean Indica se la citazione contiene contenuto per adulti.

Risposta di esempio

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

Codici di errore

Codice di stato Description
200 La richiesta ha avuto esito positivo, inclusa una ricerca valida senza risultati.
400 Parametri non validi o JSON in formato non valido.
401 Credenziali di autenticazione mancanti o non valide.
403 Il profilo autenticato non è abilitato per Auto.
429 È stato superato il limite di velocità o quota.
500 Errore interno del servizio.
503 Un servizio obbligatorio non è disponibile.
504 Timeout della richiesta.

Per informazioni sullo schema di errore condiviso e sul nuovo tentativo, vedere Gestione degli errori.

Contenuti correlati

  • Ultimo aggiornamento: