Partilhar via

Obter Mapa de Sinónimos (API REST da Pesquisa de IA do Azure)

A operação Obter Mapa de Sinónimos obtém a definição de mapa de sinónimos a partir do Azure AI Search.

GET https://[service name].search.windows.net/synonymmaps/[synonymmap name]?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 mapa do sinónimo Obrigatório. O URI do pedido especifica o nome do mapa de sinónimos a devolver.
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: é devolvido 200 OK para uma resposta bem-sucedida.

A resposta é semelhante a exemplos em Criar Mapa de Sinónimos (API REST da Pesquisa de IA do Azure).

{
    "name" : "synonymmap1",  
    "format" : "solr",  
    "synonyms" : "United States, United States of America, USA\n
    Washington, Wash. => WA",
    "encryptionKey": null
}

Nota

Se o mapa de sinónimos tiver uma chave de encriptação, o serviço de pesquisa tem de ter acesso à chave de encriptação para obter a definição do mapa de sinónimos. Sem acesso à chave de encriptação, é devolvido um Pedido Incorreto 400. Restaurar o acesso à chave permite que o serviço de pesquisa obtenha novamente a definição do mapa de sinónimos.

Ver também