Compartilhar via


Atualizar mapa de sinônimos (API REST do Azure AI Search)

Substitui uma definição de mapa de sinônimo existente por uma versão revisada.

PUT 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 da solicitação especifica o nome do mapa de sinônimos a ser atualizado.
api-version Obrigatórios. A versão estável atual é api-version=2020-06-30. Confira 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. As solicitações de atualização devem incluir um api-key cabeçalho 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

A sintaxe do corpo da solicitação é a mesma de Criar Mapa de Sinônimos.

Ao atualizar um mapa de sinônimos existente, toda a definição é substituída pelo conteúdo do corpo da solicitação. Em geral, o melhor padrão a ser usado para atualizações é recuperar a definição com um GET, modificá-la e atualizá-la com PUT.

Resposta

Para uma solicitação bem-sucedida, "201 Criado" se um novo mapa de sinônimo foi criado e "204 Sem Conteúdo" se um mapa de sinônimos existente foi atualizado

Por padrão, o corpo da resposta estará vazio. No entanto, se o cabeçalho da Prefer solicitação estiver definido return=representationcomo , o corpo da resposta conterá o JSON para o mapa de sinônimos que foi atualizado ou criado. Nesse caso, o código de status de êxito será "201 Criado" se um novo mapa de sinônimos tiver sido criado e "200 OK" se um mapa de sinônimos existente tiver sido atualizado.

Confira também