Documents - Get

Recupera un documento dall'indice.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2023-11-01

Con parametri facoltativi:

GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2023-11-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	URL dell'endpoint del servizio di ricerca.
indexName	path	True	string	Nome dell'indice.
key	path	True	string	Chiave del documento da recuperare.
api-version	query	True	string	Versione dell'API client.
$select	query		string[]	Elenco di nomi di campo da recuperare per il documento; Qualsiasi campo non recuperato non sarà presente nel documento restituito.

Nome	Necessario	Tipo	Descrizione
x-ms-client-request-id		string (uuid)	ID di rilevamento inviato con la richiesta per facilitare il debug.

Nome	Tipo	Descrizione
200 OK	LookupDocument	Risposta contenente il documento richiesto.
Other Status Codes	SearchError	Risposta di errore.

GET https://myservice.search.windows.net/indexes('myindex')/docs('1')?$select=docId,title,description&api-version=2023-11-01

{
  "description": "Cheapest hotel in town",
  "docId": "1",
  "title": "Nice Hotel"
}

Oggetto

Descrive una condizione di errore per l'API.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	SearchError[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
message	string	Rappresentazione leggibile dell'errore.