Atualizar Indexador (API REST do Azure AI Search)

  • Artigo

Você pode atualizar uma definição de indexador existente usando uma solicitação HTTP PUT. Especifique o nome do indexador a ser atualizado no URI de solicitação:

PUT https://[service name].search.windows.net/indexers/[indexer name]?api-version=[api-version]  
    Content-Type: application/json  
    api-key: [admin key]

A atualização de uma definição de indexador não a executa automaticamente, mas dependendo das modificações e da fonte de dados associada, uma redefinição e execução podem ser necessárias.

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 indexador Obrigatórios. O URI de solicitação especifica o nome do indexador a ser atualizado.
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. 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 que para Criar Indexador.

Ao atualizar um indexador 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 do indexador com um GET, modificá-la e atualizá-la com PUT.

Resposta

Para uma solicitação bem-sucedida: 201 Criado se um novo indexador for criado e 204 sem Conteúdo se um indexador existente for atualizado.

Confira também