Indexes - Get Statistics

Retorna estatísticas para o índice fornecido, incluindo uma contagem de documentos e uso de 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

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 do Pedido

Name Necessário Tipo Description
x-ms-client-request-id

string (uuid)

O ID de rastreamento enviado com a solicitação para ajudar com a depuração.

Respostas

Name Tipo Description
200 OK

GetIndexStatisticsResult

Other Status Codes

SearchError

Resposta de erro.

Exemplos

SearchServiceGetIndexStatistics

Pedido de amostra

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

Resposta da amostra

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

Definições

Name Description
GetIndexStatisticsResult

Estatísticas para um determinado índice. As estatísticas são recolhidas periodicamente e não é garantido que estejam sempre up-todata.

SearchError

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

GetIndexStatisticsResult

Estatísticas para um determinado índice. As estatísticas são recolhidas periodicamente e não é garantido que estejam sempre up-todata.

Name Tipo Description
documentCount

integer (int64)

O número de documentos no índice.

storageSize

integer (int64)

A quantidade de armazenamento em bytes consumida pelo índice.

vectorIndexSize

integer (int64)

A quantidade de memória em bytes consumida por vetores no índice.

SearchError

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

Name Tipo Description
code

string

Um de um conjunto de códigos de erro definido pelo servidor.

details

SearchError[]

Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.

message

string

Uma representação legível por humanos do erro.