Compartilhar 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ônimo 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 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 mapa de sinônimos Obrigatórios. O URI de solicitação especifica o nome do mapa de sinônimos a ser retornado.
api-version Obrigatórios. A versão estável atual é api-version=2020-06-30. Consulte Versões de API para obter mais versões.

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 api-key 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.

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
}

Observação

Se o mapa de sinônimos tiver uma chave de criptografia, o serviço de pesquisa deverá ter acesso à chave de criptografia para recuperar a definição do mapa de sinônimos. Sem acesso à chave de criptografia, uma Solicitação 400 Inválida é retornada. Restaurar o acesso à chave permite que o serviço de pesquisa recupere a definição do mapa de sinônimos novamente.

Confira também