Obter Estatísticas de Índice (API REST da Pesquisa de IA do Azure)
A operação Obter Estatísticas de Índice devolve da Pesquisa de IA do Azure uma contagem de documentos para o índice atual, além da utilização do armazenamento. Também pode obter estas informações a partir do portal.
Nota
As estatísticas sobre a contagem de documentos e o tamanho do armazenamento são recolhidas a cada poucos minutos e não em tempo real. Por conseguinte, as estatísticas devolvidas por esta API podem não refletir as alterações causadas pelas recentes operações de indexação.
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 do URI
| Parâmetro | Description |
|---|---|
| nome do serviço | Obrigatório. Defina-o como o nome exclusivo e definido pelo utilizador do seu serviço de pesquisa. |
| nome do índice | Obrigatório. O URI do pedido especifica o nome do índice para o qual as estatísticas devem ser devolvidas. |
| api-version | Obrigatório. A versão estável atual é api-version=2020-06-30. Veja Versões da API para obter mais versões. |
Cabeçalhos do Pedido
A tabela seguinte descreve os cabeçalhos de pedido obrigatórios e opcionais.
| Campos | Description |
|---|---|
| Content-Type | Obrigatório. Defina esta opção como application/json |
| api-key | Opcional se estiver a utilizar funções do Azure e for fornecido um token de portador no pedido, caso contrário, é necessária uma chave. Uma chave de api é uma cadeia exclusiva gerada pelo sistema que autentica o pedido no seu serviço de pesquisa. Obter pedidos para uma definição de objeto tem de incluir um campo de chave de api definido para a sua chave de administrador (em oposição a uma chave de consulta). Veja Ligar à Pesquisa de IA do Azure com a autenticação de chaves para obter detalhes. |
Corpo do Pedido
Nenhum.
Resposta
Código de Estado: "200 OK" é devolvido para obter uma resposta bem-sucedida. O corpo da resposta está no seguinte formato:
{
"documentCount": number,
"storageSize": number (size of the index in bytes)
}