Documents - Get

Servicio:: Search Service

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

Recupera un documento del índice.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (uri)	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 minLength: 1	Versión de la API que se va a usar para esta operación.
$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	Tipo	Description
Accept	Accept	El encabezado Aceptar.
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.
x-ms-enable-elevated-read	boolean	Valor que habilita la lectura elevada que omite las comprobaciones de permisos de nivel de documento para la operación de consulta.
x-ms-client-request-id	string (uuid)	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	LookupDocument	La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

api-key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ámbitos

Nombre	Description
https://search.azure.com/.default

Ejemplos

SearchIndexGetDocument

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
Accept	El encabezado Aceptar.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

Accept

Enumeración

El encabezado Aceptar.

Valor	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Objeto

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

Nombre	Tipo	Description
info		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[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.