Recuento de documentos (API REST de Azure AI Search)

La operación Count Documents recupera un recuento del número de documentos de un índice de búsqueda. La sintaxis $count forma parte del protocolo OData.

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

Parámetros de identificador URI

Parámetro	Descripción
nombre del servicio	Necesario. Establezca en el nombre único definido por el usuario del servicio de búsqueda.
nombre de índice	Necesario. El [index name] en el URI de solicitud indica al servicio que devuelva un recuento de todos los elementos de la colección de documentos del índice especificado.
api-version	Necesario. Consulte Versiones de API para obtener una lista de las versiones admitidas.

Encabezados de solicitud

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

Campos	Descripción
Content-Type	Necesario. Establézcala en application/json
api-key	Opcional si usa roles de Azure; de lo contrario, se requiere una clave. La solicitud Count Documents puede especificar una clave de administrador o una clave de consulta para .api-key Consulte Conexión a Azure AI Search mediante la autenticación de claves para más información.

Cuerpo de la solicitud

Ninguno.

Response

Código de estado: al obtener una respuesta correcta, se visualiza 200 Correcto.

El cuerpo de la respuesta contiene el valor de recuento como un entero con formato de texto sin formato.

Consulte también

API REST de Azure AI Search
Códigos de estado HTTP
Sintaxis de expresiones de OData para Azure AI Search
Resultados de la búsqueda