Documento de Pesquisa (API REST do Azure AI Search)

  • Artigo

A operação Pesquisar Documento recupera um documento do Azure AI Search. Isso é útil quando um usuário clica em um resultado de pesquisa específico e você deseja pesquisar detalhes específicos sobre esse documento. Você pode obter apenas um documento por vez. Use Pesquisar Documentos para obter vários documentos em uma única solicitação.

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

Como alternativa, você pode usar a sintaxe tradicional de OData para pesquisa de chave:

GET /indexes/[index name]/docs('[key]')?[query parameters]

Parâmetros de URI

Parâmetro Descrição
nome do serviço Obrigatórios. Defina isso como o nome exclusivo definido pelo usuário do serviço de pesquisa.
nome do índice Obrigatórios. O URI da solicitação especifica o nome do índice a ser consultado. Os parâmetros de consulta são especificados na cadeia de caracteres de consulta para solicitações GET e no corpo da solicitação para solicitações POST.
chave Obrigatórios. Um Edm.String valor que identifica exclusivamente cada documento no índice. Às vezes, a chave é chamada de ID de documento. O valor da chave diferencia maiúsculas de minúsculas. Por exemplo, um documento com a chave "abc" é distinto de um documento com a chave "ABC".
parâmetros de consulta Uma construção de várias partes que inclui um $select (opcional) e api-version=2020-06-30 (obrigatório). Para essa operação, a versão da API é especificada como um parâmetro de consulta.
$select=[string] é uma lista de campos separados por vírgulas a serem recuperados. Somente campos marcados como recuperáveis podem ser incluídos nesta cláusula. Se não for especificado ou se for definido como *, todos os campos marcados como recuperáveis no esquema serão incluídos na projeção.

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-o 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.

{   
   field_name: field_value (fields matching the default or specified projection)   
}

Exemplos

Pesquisa de documento com a chave “2”:

GET /indexes/hotels/docs/2?api-version=2020-06-30

Pesquisar o documento que tem a chave '3' usando a sintaxe de OData:

GET /indexes/hotels/docs('3')?api-version=2020-06-30

Confira também