Partilhar via

Obter estatísticas de índice (Preview REST API)

  • Artigo

Aplica-se a: 2023-07-01-Preview. Esta versão não é mais suportada. Atualize imediatamente para uma versão mais recente.

Importante

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

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

Observação

As estatísticas sobre a contagem de documentos e o tamanho do armazenamento são coletadas a cada poucos minutos, não em tempo real. Portanto, as estatísticas retornadas por essa API podem não refletir 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 Necessário. Defina esse valor como o nome exclusivo definido pelo usuário do seu serviço de pesquisa.
nome do índice Necessário. O URI de solicitação especifica o nome do índice para o qual as estatísticas devem ser retornadas.
API-versão Necessário. Consulte de versões da API para obter mais versões.

Cabeçalhos de solicitação

A tabela a seguir descreve os cabeçalhos de solicitação obrigatórios e opcionais.

Campos Descrição
Tipo de conteúdo Necessário. Defina esse valor como application/json
Chave 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 no seu serviço de pesquisa. Obter solicitações para uma definição de objeto deve incluir um campo de chave de api definido para sua chave de administrador (em vez de uma chave de consulta). Consulte Conectar-se à Pesquisa de IA do Azure usando de autenticação de chave para obter detalhes.

Órgão do Pedido

Nenhuma.

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 vetoriais no índice, "vectorIndexSize" será zero.

Ver também