Documents - Get

Servicio:: Search Service

Versión de la API:: 2025-08-01-preview

Recupera un documento del índice.

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2025-08-01-preview

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	La dirección URL del punto de conexión del servicio de búsqueda.
indexName	path	True	string	El nombre del índice.
key	path	True	string	La clave del documento que se va a recuperar.
api-version	query	True	string	Versión de la API del cliente.
$select	query		string[]	Lista de nombres de campo que se van a recuperar para el documento; Cualquier campo no recuperado faltará en el documento devuelto.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string (uuid)	El identificador de seguimiento enviado con la solicitud para ayudar con la depuración.
x-ms-query-source-authorization		string	Token que identifica al usuario para el que se ejecuta la consulta. Este token se utiliza para aplicar restricciones de seguridad en los documentos.

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://previewexampleservice.search.windows.net/indexes('preview-test')/docs('1')?$select=id,description,name,category,ownerId&api-version=2025-08-01-preview

Respuesta de muestra

status code:: 200

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

Definiciones

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

ErrorAdditionalInfo

Objeto

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

Objeto

Detalle del error.

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

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.