Documento de Pesquisa (API REST da Pesquisa de IA do Azure)

  • Artigo

A operação Documento de Pesquisa obtém um documento da Pesquisa de IA do Azure. Isto é útil quando um utilizador clica num resultado de pesquisa específico e quer procurar detalhes específicos sobre esse documento. Só pode obter um documento de cada vez. Utilize a opção Procurar Documentos para obter vários documentos num único pedido.

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

Em alternativa, pode utilizar a sintaxe OData tradicional para pesquisa de chaves:

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

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 a consultar. Os parâmetros de consulta são especificados na cadeia de consulta para pedidos GET e no corpo do pedido para pedidos POST.
key Obrigatório. Um Edm.String valor que identifica exclusivamente cada documento no índice. Por vezes, a chave é referida como um ID de documento. O valor da chave é sensível às maiúsculas e 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 multi-peças que inclui um $select (opcional) e api-version=2020-06-30 (obrigatório). Para esta 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 obter. Apenas os campos marcados como recuperáveis podem ser incluídos nesta cláusula. Se não for especificado ou definido como *, todos os campos marcados como recuperáveis no esquema serão incluídos na projeção.

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.

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

Exemplos

Procure o documento que tem a chave '2':

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

Procure o documento que tem a chave '3' com a sintaxe OData:

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

Ver também