Documento di ricerca (API REST ricerca intelligenza artificiale di Azure)
L'operazione Ricerca documento recupera un documento da Ricerca intelligenza artificiale di Azure. È utile quando un utente fa clic su un risultato della ricerca e si desidera cercare dettagli specifici su tale documento. È possibile recuperare un solo documento alla volta. Usare Documenti di ricerca per ottenere più documenti in una singola richiesta.
GET https://[service name].search.windows.net/indexes/[index name]/docs/key?[query parameters]
Content-Type: application/json
api-key: [admin or query key]
In alternativa, è possibile usare la sintassi tradizionale di OData per la ricerca delle chiavi:
GET /indexes/[index name]/docs('[key]')?[query parameters]
Parametri dell'URI
| Parametro | Descrizione |
|---|---|
| nome servizio | Obbligatorio. Impostare questo valore sul nome univoco definito dall'utente del servizio di ricerca. |
| nome indice | Obbligatorio. L'URI della richiesta specifica il nome dell'indice su cui eseguire la query. I parametri di query vengono specificati nella stringa di query per le richieste GET e nel corpo della richiesta per le richieste POST. |
| Key | Obbligatorio. Valore Edm.String che identifica in modo univoco ogni documento nell'indice. La chiave viene talvolta definita ID documento. Il valore della chiave è distinzione tra maiuscole e minuscole. Ad esempio, un documento con chiave "abc" è distinto da un documento con chiave "ABC". |
| parametri di query | Costruzione a più parti che include un $select (facoltativo) e api-version=2020-06-30 (obbligatorio). Per questa operazione l'elemento api-version viene specificato come parametro di query. $select=[string] è un elenco di campi delimitati da virgole da recuperare. Solo i campi contrassegnati come recuperabili possono essere inclusi in questa clausola. Se non è specificato o se è impostato su *, nella proiezione vengono inclusi tutti i campi contrassegnati come recuperabili nello schema. |
Intestazioni richiesta
La tabella seguente descrive le intestazioni della richiesta obbligatorie e facoltative.
| Campi | Descrizione |
|---|---|
| Content-Type | Obbligatorio. Impostare il valore su application/json |
| api-key | Facoltativo se si usano ruoli di Azure e viene fornito un token di connessione nella richiesta, altrimenti è necessaria una chiave. Una chiave API è una stringa univoca generata dal sistema che autentica la richiesta al servizio di ricerca. Ottenere le richieste per una definizione dell'oggetto deve includere un campo api-key impostato sulla chiave di amministrazione , anziché una chiave di query. Per informazioni dettagliate, vedere Connettersi a Ricerca intelligenza artificiale di Azure usando l'autenticazione delle chiavi . |
Corpo della richiesta
Nessuno.
Risposta
Codice di stato: "200 OK" viene restituito per una risposta riuscita.
{
field_name: field_value (fields matching the default or specified projection)
}
Esempio
Cercare il documento con chiave '2':
GET /indexes/hotels/docs/2?api-version=2020-06-30
Cercare il documento con chiave '3' usando la sintassi di OData:
GET /indexes/hotels/docs('3')?api-version=2020-06-30