Nota
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare ad accedere o modificare le directory.
L'accesso a questa pagina richiede l'autorizzazione. È possibile provare a modificare le directory.
Le API REST di Ricerca intelligenza artificiale di Azure supportano un set di intestazioni di richiesta/risposta HTTP comuni, riepilogate qui per riferimento:
| Intestazione della richiesta | Tipo | Descrizione |
|---|---|---|
| Accetta | Tipo di contenuto | Tipo di contenuto richiesto per la risposta. Il valore predefinito è application/json;odata.metadata=minimal. Altri valori consentiti sono application/json, application/json; odata.metadata=full, application/json; odata.metadata=none e text/plain (solo per $count). |
| api-key | string | Impostare sulla query o sulla chiave di amministrazione, a seconda dell'API. |
| authorization | string | Token di accesso OAuth 2.0 per la richiesta. Richiede la configurazione per il servizio di ricerca per l'accesso in base al ruolo. Questa intestazione di richiesta è destinata alle app client che usano Microsoft Entra ID l'autenticazione e le assegnazioni di ruolo. Il codice client deve fornire il token. È possibile usare questa intestazione di richiesta con qualsiasi versione dell'API REST supportata, purché il servizio di ricerca sia configurato per l'autenticazione del piano dati. |
| Content-Type | Content-Type | Tipo di contenuto del corpo della richiesta (PUT/POST). Il valore predefinito è application/json. |
| client-request-id | GUID | ID richiesta specificato dal chiamante facoltativo, sotto forma di GUID senza decorazioni, ad esempio parentesi graffe (ad esempio, client-request-id: 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0). Valore definito dal chiamante che identifica la richiesta fornita. Se specificato, questo valore viene incluso nelle informazioni di risposta come modo per eseguire il mapping della richiesta. |
| OData-MaxVersion | "4.0" | Specifica la versione massima del protocollo OData supportata dal client. Il valore predefinito è "4.0". |
| Prefer | "return=representation" o "return=minimal" | Usato per controllare il payload della risposta da richieste /indexes PUT e POST. Il valore predefinito è "return=representation" durante la creazione di un nuovo indice tramite POST o PUT e "return=minimal" per l'aggiornamento di un indice esistente tramite PUT. |
| return-client-request-id | true o false | Se specificato quando viene specificata l'intestazione client-request-id, indica al server di includere l'intestazione client-request-id nella risposta. Il valore predefinito è False. |
| If-Match | ETag o * | Usato per modificare una risorsa solo se la versione corrente corrisponde all'ETag specificato. Usare questa intestazione con metodi POST, PUT o DELETE per le risorse ( ad esempio indicizzatori, indici e origini dati, ma non documenti) per abilitare il controllo della concorrenza ottimistica. |
| If-None-Match | ETag o * | Usato per modificare una risorsa solo se la versione corrente non corrisponde all'ETag specificato. Usare questa intestazione con metodi POST, PUT o DELETE per le risorse ( ad esempio indicizzatori, indici e origini dati, ma non documenti) per abilitare il controllo della concorrenza ottimistica. |
| Intestazione di risposta | Tipo | Descrizione |
|---|---|---|
| client-request-id | GUID | Identificatore specificato dal chiamante nella richiesta originale, se presente. |
| Content-Type | Content-Type | Tipo di contenuto del corpo della risposta. |
| Posizione | URL | URL della definizione di indice appena creata per le richieste POST e PUT /indexes. |
| OData-Version | "4.0" | Versione del protocollo OData della risposta. |
| request-id | GUID | Identificatore univoco per l'operazione corrente. Corrisponde all'intestazione client-request-id, se specificata. In caso contrario, il valore verrà generato sul server. |
| elapsed-time | Numero | Tempo, in millisecondi, usato dal servizio per l'elaborazione della richiesta. Questo valore include solo il tempo dedicato all'elaborazione della richiesta e non include il tempo di trasferimento di rete. |
| ETag | string | Stringa opaca che rappresenta la versione corrente di una risorsa (restituita per indicizzatori, indici e origini dati, ma non documenti). Usare questa stringa nell'intestazione If-Match o If-None-Match per il controllo della concorrenza ottimistica. |