Documents - Get

Recupera un documento del índice.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Dirección URL del punto de conexión del servicio de búsqueda.
indexName	path	True	string	Nombre del índice.
key	path	True	string	Clave del documento que se va a recuperar.
api-version	query	True	string	Versión de api de cliente.
$select	query		string[]	Lista de nombres de campo que se van a recuperar para el documento; Faltará cualquier campo que no se recupere del documento devuelto.

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string (uuid)	Identificador de seguimiento enviado con la solicitud para ayudar con la depuración.

Nombre	Tipo	Description
200 OK	LookupDocument	Respuesta que contiene el documento solicitado.
Other Status Codes	SearchError	Respuesta de error.

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

Objeto

Describe una condición de error para la API.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	SearchError[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
message	string	Representación legible del error.