Indexes - Get Statistics

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-11-01

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

Sample Request

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

Sample Response

{
  "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 é garantido que estejam 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 é garantido que estejam 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 série de detalhes sobre erros específicos que levaram a este erro comunicado.

message

string

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