Condividi tramite

Documents - Get

  • Riferimento
Servizio:
Search Service
Versione API:
2024-09-01-preview

Recupera un documento dall'indice.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2024-09-01-preview
Con parametri facoltativi: 
GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2024-09-01-preview

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.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
x-ms-client-request-id

string

uuid

ID di rilevamento inviato con la richiesta per facilitare il debug.

Risposte

Nome Tipo Descrizione
200 OK

LookupDocument

Risposta contenente il documento richiesto.
Other Status Codes

ErrorResponse

Risposta di errore.

Esempio

SearchIndexGetDocument

Esempio di richiesta

GET https://previewexampleservice.search.windows.net/indexes('preview-test')/docs('1')?$select=id,description,name,category,ownerId&api-version=2024-09-01-preview

Risposta di esempio

Codice di stato:
200 
{
  "id": "1",
  "name": "test",
  "description": "test1 hello",
  "category": "purple",
  "ownerId": "sam"
}

Definizioni

Nome Descrizione
ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail

Dettagli dell'errore.
ErrorResponse

Risposta di errore

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.
type

string

Tipo di informazioni aggiuntive.

ErrorDetail

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.
code

string

Codice di errore.
details

ErrorDetail[]

Dettagli dell'errore.
message

string

Messaggio di errore.
target

string

Destinazione dell'errore.

ErrorResponse

Risposta di errore

Nome Tipo Descrizione
error

ErrorDetail

Oggetto error.