Compartir a través de

Obtener estadísticas de índice (API REST de versión preliminar)

  • Artículo

se aplica a: 2023-07-01-Preview. Esta versión ya no se admite. Actualizar inmediatamente a una versión más reciente.

Importante

2023-07-01-Preview agrega vectorIndexSize ámbito a un índice.

La operación Obtener estadísticas de índice devuelve el recuento de documentos para el índice actual, además de la cantidad de almacenamiento total utilizado por el índice hasta arriba y el almacenamiento de cantidad consumido solo por sus datos vectoriales. Un servicio de búsqueda tiene un límite general en la cantidad de almacenamiento de vectores, tal como se indica en Obtener estadísticas del servicio. La métrica "vectorIndexSize" indica la cantidad de almacenamiento de vectores que se usa para los campos vectoriales en el índice de búsqueda actual.

Nota

Las estadísticas sobre el número de documentos y el tamaño de almacenamiento se recopilan cada pocos minutos, no en tiempo real. Por lo tanto, es posible que las estadísticas devueltas por esta API no reflejen los cambios causados por las operaciones de indexación recientes.

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

Parámetros de URI

Parámetro Descripción
nombre del servicio Obligatorio. Establezca este valor en el nombre único definido por el usuario del servicio de búsqueda.
nombre de índice Obligatorio. El URI de solicitud especifica el nombre del índice para el que se deben devolver las estadísticas.
api-version Obligatorio. Consulte versiones de API para obtener más versiones.

Encabezados de solicitud

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

Campos Descripción
Tipo de contenido Obligatorio. Establezca este valor en application/json
api-key Opcional si usa roles de Azure y se proporciona un token de portador en la solicitud; de lo contrario, se requiere una clave. Una clave de API es una cadena única generada por el sistema que autentica la solicitud en el servicio de búsqueda. Las solicitudes de obtención de una definición de objeto deben incluir un campo de clave de API establecido en la clave de administración (en lugar de una clave de consulta). Consulte Conexión a Azure AI Search mediante la autenticación de claves para más información.

Cuerpo de la solicitud

Ninguno.

Respuesta

Código de estado: se devuelve "200 OK" para obtener una respuesta correcta. El cuerpo de la respuesta tiene el formato siguiente:

{  
  "documentCount": number,  
  "storageSize": number (size of the index in bytes), 
  "vectorIndexSize": number (size of the index in bytes) 
}

Si no hay campos vectoriales en el índice, "vectorIndexSize" es cero.

Consulte también