Documents - Get

Servicio:

Search Service

Versión de la API:

2024-07-01

Recupera un documento del índice.

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

Con parámetros opcionales:

GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2024-07-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.

Encabezado de la solicitud

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

Respuestas

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

Ejemplos

SearchIndexGetDocument

Solicitud de ejemplo

HTTP

GET https://exampleservice.search.windows.net/indexes('getdocumentexample')/docs('1')?$select=docId,title,description&api-version=2024-07-01

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.