Obter estatísticas de índice (API REST de versão prévia)

  • Artigo

Aplica-se a: 2023-07-01-Preview

Importante

2023-07-01-Preview adiciona vectorIndexSize com escopo a um índice.

A operação Obter Estatísticas de Índice retorna a contagem de documentos para o índice atual, além da quantidade de armazenamento total usada pelo índice total e a quantidade de armazenamento consumida apenas por seus dados de vetor. Um serviço de pesquisa tem um limite geral na quantidade de armazenamento de vetor, conforme relatado por Obter Estatísticas de Serviço. A métrica "vectorIndexSize" informa quanto armazenamento de vetor é usado para campos de vetor no índice de pesquisa atual.

Observação

As estatísticas de tamanho de armazenamento e contagem de documentos são coletadas a cada poucos minutos, não em tempo real. Portanto, talvez as estatísticas retornadas por essa API não reflitam as alterações causadas por operações de indexação recentes.

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 Descrição
nome do serviço Obrigatórios. Defina esse valor como o nome exclusivo definido pelo usuário do serviço de pesquisa.
nome do índice Obrigatórios. O URI de solicitação especifica o nome do índice para o qual as estatísticas devem ser retornadas.
api-version Obrigatórios. A versão estável atual é api-version=2020-06-30. Confira Versões de API para obter mais versões.

Cabeçalhos de solicitação

A tabela a seguir descreve os cabeçalhos de solicitação necessários e opcionais

Campos Descrição
Tipo de conteúdo Obrigatórios. Defina esse valor como application/json
chave de API Opcional se você estiver usando funções do Azure e um token de portador for fornecido na solicitação, caso contrário, uma chave será necessária. Uma chave de api é uma cadeia de caracteres exclusiva gerada pelo sistema que autentica a solicitação para o serviço de pesquisa. Obter solicitações para uma definição de objeto deve incluir um campo de chave de api definido como sua chave de administrador (em vez de uma chave de consulta). Confira Conectar-se ao Azure AI Search usando a autenticação de chave para obter detalhes.

Corpo da solicitação

Nenhum.

Resposta

Código de status: "200 OK" é retornado para uma resposta bem-sucedida. O corpo da resposta está no seguinte formato:

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

Se não houver campos de vetor no índice, "vectorIndexSize" será zero.

Confira também