Documento de búsqueda (API REST de Azure Cognitive Search)

La operación Buscar documento recupera un documento de Azure Cognitive Search. Esto resulta útil cuando un usuario hace clic en un resultado de búsqueda específico y desea buscar detalles específicos acerca de ese documento. Solamente se puede obtener un documento de cada vez. Use Buscar documentos para obtener varios documentos en una sola solicitud.

GET https://[service name].search.windows.net/indexes/[index name]/docs/key?[query parameters]  
  Content-Type: application/json   
  api-key: [admin or query key]     

También puede usar la sintaxis de OData tradicional para la búsqueda de claves:

GET /indexes/[index name]/docs('[key]')?[query parameters]  

Parámetros de identificador URI

Parámetro Descripción
nombre del servicio Necesario. Establézcalo en el nombre único definido por el usuario del servicio de búsqueda.
nombre de índice Necesario. El URI de la solicitud especifica el nombre del índice que se consulta. Los parámetros de consulta se especifican en la cadena de consulta para las solicitudes GET y en el cuerpo de la solicitud para las solicitudes POST.
key Necesario. Valor Edm.String que identifica de forma única cada documento del índice. La clave se conoce a veces como un identificador de documento. El valor de la clave distingue mayúsculas de minúsculas. Por ejemplo, un documento con la clave "abc" es distinto de un documento con la clave "ABC".
parámetros de consulta Construcción de varias partes que incluye un $select elemento (opcional) y api-version=2020-06-30 (obligatorio). Para esta operación, la versión de API se especifica como un parámetro de consulta.
$select=[string] es una lista de campos separados por comas que se van a recuperar. Solo los campos marcados como recuperables se pueden incluir en esta cláusula. Si no se especifica nada o se establece en *, se incluirán en la proyección todos los campos marcados como recuperables en el esquema.

Encabezados de solicitud

En la siguiente tabla se describen los encabezados de solicitud obligatorios y opcionales.

Campos Descripción
Content-Type Necesario. Establézcalo en application/json
api-key Necesario. api-key se usa para autenticar la solicitud en su servicio de búsqueda. Es un valor de cadena, único en su URL de servicio. Las solicitudes de consulta pueden especificar una clave de administrador o una clave de consulta como api-key. La clave de consulta se usa para las operaciones de solo lectura en la colección de documentos. Puede encontrar la clave de API en el panel del servicio de búsqueda en el Azure Portal.

Cuerpo de la solicitud

Ninguno.

Response

Código de estado: se devuelve "200 OK" para obtener una respuesta correcta.

{   
   field_name: field_value (fields matching the default or specified projection)   
}  

Ejemplos

Busque el documento que tiene la clave "2":

GET /indexes/hotels/docs/2?api-version=2020-06-30

Busque el documento que tiene la clave "3" con la sintaxis de OData:

GET /indexes/hotels/docs('3')?api-version=2020-06-30

Consulte también