Indexes - Get Statistics

Serviço:

Search Service

Versão da API:

2024-05-01-preview

Retorna estatísticas para o índice fornecido, incluindo uma contagem de documentos e o uso de armazenamento.

GET {endpoint}/indexes('{indexName}')/search.stats?api-version=2024-05-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	A URL do ponto de extremidade do serviço de pesquisa.
indexName	path	True	string	O nome do índice para o qual recuperar estatísticas.
api-version	query	True	string	Versão da API do cliente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string uuid	A ID de rastreamento enviada com a solicitação para ajudar na depuração.

Respostas

Nome	Tipo	Description
200 OK	GetIndexStatisticsResult
Other Status Codes	ErrorResponse	Resposta de erro.

Exemplos

SearchServiceGetIndexStatistics

Solicitação de exemplo

HTTP

GET https://myservice.search.windows.net/indexes('hotels')/search.stats?api-version=2024-05-01-preview

Resposta de exemplo

Código de status:

200

{
  "documentCount": 239572,
  "storageSize": 72375920,
  "vectorIndexSize": 123456
}

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	Os detalhes do erro.
ErrorResponse	Resposta de erro
GetIndexStatisticsResult	Estatísticas para um determinado índice. As estatísticas são coletadas periodicamente e não há garantia de que estejam sempre atualizadas.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Os detalhes do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

GetIndexStatisticsResult

Estatísticas para um determinado índice. As estatísticas são coletadas periodicamente e não há garantia de que estejam sempre atualizadas.

Nome	Tipo	Description
documentCount	integer	O número de documentos no índice.
storageSize	integer	A quantidade de armazenamento em bytes consumidos pelo índice.
vectorIndexSize	integer	A quantidade de memória em bytes consumida por vetores no índice.