Contar documentos (API REST da Pesquisa de IA do Azure)

  • Artigo

A operação Count Documents recupera uma contagem do número de documentos em um índice de pesquisa. A sintaxe de $count faz parte do protocolo OData.

GET https://[service name].search.windows.net/indexes/[index name]/docs/$count?api-version=[api-version]  
  Content-Type: application/json   
  api-key: [admin or query key]

Parâmetros de URI

Parâmetro Descrição
nome do serviço Obrigatórios. Defina como o nome exclusivo definido pelo usuário do serviço de pesquisa.
nome do índice Obrigatórios. O [index name] no URI de solicitação informa o serviço para retornar uma contagem de todos os itens da coleção de documentos do índice especificado.
api-version Obrigatórios. Consulte versões de API para obter uma lista de versões com suporte.

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. Definida como application/json
chave de API Opcional se você estiver usando funções do Azure, caso contrário, uma chave será necessária. A solicitação Count Documents pode especificar uma chave de administrador ou uma chave de consulta para o api-key. 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 contém o valor da contagem como um inteiro formatado como texto sem formatação.

Confira também

Azure AI Search REST APIs
Códigos de status HTTP
Sintaxe de expressão OData para a Pesquisa de IA do Azure
Resultados da pesquisa