Criar um alias de índice no Azure AI Search

Importante

Os aliases de índice estão atualmente em pré-visualização pública e disponíveis em termos de utilização suplementares.

No Azure AI Search, um alias de índice é um nome secundário que pode ser usado para fazer referência a um índice para consulta, indexação e outras operações. Você pode criar um alias que mapeia para um índice de pesquisa e substituir o nome do alias em locais onde, de outra forma, faria referência a um nome de índice. Um alias adiciona flexibilidade se você precisar alterar para qual índice seu aplicativo está apontando. Em vez de atualizar as referências em seu aplicativo, você pode apenas atualizar o mapeamento para seu alias.

O principal objetivo dos aliases de índice é facilitar o gerenciamento de seus índices de produção. Por exemplo, se você precisar fazer uma alteração na definição do índice, como editar um campo ou adicionar um novo analisador, será necessário criar um novo índice de pesquisa porque todos os índices de pesquisa são imutáveis. Isso significa que você precisa descartar e reconstruir seu índice ou criar um novo índice e, em seguida, migrar seu aplicativo para esse índice.

Em vez de descartar e reconstruir seu índice, você pode usar aliases de índice. Um fluxo de trabalho típico seria:

  1. Crie o seu índice de pesquisa
  2. Criar um alias que mapeie para o seu índice de pesquisa
  3. Fazer com que seu aplicativo envie solicitações de consulta/indexação para o alias em vez do nome do índice
  4. Quando precisar fazer uma alteração no índice que exija uma reconstrução, crie um novo índice de pesquisa
  5. Quando o novo índice estiver pronto, atualize o alias para mapear para o novo índice e as solicitações serão automaticamente roteadas para o novo índice

Criar um alias de índice

Você pode criar um alias usando a API REST de visualização, os SDKs de visualização ou por meio do portal do Azure. Um alias consiste no name alias e no nome do índice de pesquisa para o qual o alias é mapeado. Apenas um nome de indexes índice pode ser especificado na matriz.

Você pode usar o Alias Criar ou Atualizar (visualização REST) para criar um alias de índice.

POST /aliases?api-version=2023-10-01-preview
{
    "name": "my-alias",
    "indexes": ["hotel-samples-index"]
}

Enviar solicitações para um alias de índice

Depois de criar seu alias, você estará pronto para começar a usá-lo. Os aliases podem ser usados para todas as operações do documento, incluindo consulta, indexação, sugestões e preenchimento automático.

Na consulta abaixo, em vez de enviar a solicitação para a , você pode enviá-la para hotel-samples-indexmy-alias e ela será encaminhada de acordo.

POST /indexes/my-alias/docs/search?api-version=2023-10-01-preview
{
    "search": "pool spa +airport",
    "searchMode": any,
    "queryType": "simple",
    "select": "HotelId, HotelName, Category, Description",
    "count": true
}

Se você espera fazer atualizações em um índice de produção, especifique um alias em vez do nome do índice em seu aplicativo do lado do cliente. Os cenários que exigem uma reconstrução de índice são descritos em Soltar e reconstruir um índice.

Nota

Você só pode usar um alias com operações de documento ou para obter e atualizar uma definição de índice. Os aliases não podem ser usados para excluir um índice, não podem ser usados com a API Analisar Texto e não podem ser usados como o targetIndexName em um indexador.

Uma atualização de um alias pode levar até 10 segundos para se propagar pelo sistema, portanto, você deve aguardar pelo menos 10 segundos antes de executar qualquer operação no índice que foi mapeado ou recentemente mapeado para o alias.

Índices de swap

Agora, sempre que você precisar atualizar seu aplicativo para apontar para um novo índice, tudo o que você precisa fazer é atualizar o mapeamento em seu alias. PUT é necessário para atualizações conforme descrito em Criar ou atualizar alias (visualização REST).

PUT /aliases/my-alias?api-version=2023-10-01-preview
{
    "name": "my-alias",
    "indexes": ["hotel-samples-index2"]
}

Depois de fazer a atualização para o alias, as solicitações começarão automaticamente a ser roteadas para o novo índice.

Nota

Uma atualização para um alias pode levar até 10 segundos para se propagar pelo sistema, portanto, você deve esperar pelo menos 10 segundos antes de excluir o índice para o qual o alias foi mapeado anteriormente.

Consulte também