Indexes - Get Statistics

Serviço:

Search Service

Versão da API:

2023-10-01-Preview

Devolve estatísticas para o índice especificado, incluindo uma contagem de documentos e a utilização do armazenamento.

GET {endpoint}/indexes('{indexName}')/search.stats?api-version=2023-10-01-Preview

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	O URL do ponto final do serviço de pesquisa.
indexName	path	True	string	O nome do índice para o qual obter estatísticas.
api-version	query	True	string	Versão da API de Cliente.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-request-id		string uuid	O ID de controlo enviado com o pedido para ajudar na depuração.

Respostas

Name	Tipo	Description
200 OK	GetIndexStatisticsResult
Other Status Codes	SearchError	Resposta de erro.

Exemplos

SearchServiceGetIndexStatistics

Pedido de amostra

HTTP

GET https://myservice.search.windows.net/indexes('hotels')/search.stats?api-version=2023-10-01-Preview

Resposta da amostra

Código de estado:

200

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

Definições

Name	Description
GetIndexStatisticsResult	Estatísticas de um determinado índice. As estatísticas são recolhidas periodicamente e não estão sempre atualizadas.
SearchError	Descreve uma condição de erro para a API.

GetIndexStatisticsResult

Estatísticas de um determinado índice. As estatísticas são recolhidas periodicamente e não estão sempre atualizadas.

Name	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 consumidos por vetores no índice.

SearchError

Descreve uma condição de erro para a API.

Name	Tipo	Description
code	string	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	SearchError[]	Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
message	string	Uma representação legível por humanos do erro.