Versões da API REST (Azure AI Search)

Este artigo lista as versões atuais e anteriores das APIs REST de Pesquisa para o Azure AI Search.

Documentos de API versionados

Os documentos da API REST agora estão versionados. Quando você abre uma página de referência de API, um seletor de versão aparece acima do índice. Verifique se a referência da API é da pasta ReferenceData Plane.

Versões estáveis

Versões de pré-visualização

As versões de pré-visualização são disponibilizadas para testar novas funcionalidades, recolher feedback e descobrir e corrigir problemas. As APIs de pré-visualização estão disponíveis em Termos de Utilização Suplementares para Pré-visualizações do Microsoft Azure.

Notas de versão

2024-07-01

Esta versão fornece atualizações geralmente disponíveis para vetorização integrada (habilidades e vetorizadores), quantização escalar e quantização binária. Consulte Novidades na Pesquisa de IA do Azure para obter detalhes.

2024-05-01-pré-visualização

Esta visualização adiciona suporte para indexação OneLake, ajuste de relevância e integração mais profunda com mais modelos de incorporação durante a indexação e consultas. Ele se baseia no 2024-03-01-preview, por isso também tem a quantização escalar, tipos de dados estreitos e opções de armazenamento introduzidas nessa versão.

Para atualizar do 2024-03-01-preview ou 2023-10-01-preview, atualize a habilidade AzureOpenAIEmbedding ou vetorizador para incluir o nome e as dimensões do modelo. Para atualizar a partir de 2023-07-01-preview (preterido) ou para obter instruções passo a passo, consulte Atualizar APIs REST.

Aqui estão as atualizações nesta visualização. Também recomendamos Novidades no Azure AI Search.

2024-03-01-visualização

Esta versão de pré-visualização baseia-se em 2023-10-01-preview adicionando APIs de pré-visualização que melhoram o armazenamento vetorial. Consulte Novidades na Pesquisa de IA do Azure para obter detalhes.

2023-11-01

Esta versão fornece recursos geralmente disponíveis. Consulte Novidades na Pesquisa de IA do Azure para obter detalhes.

2023-10-01-visualização

Esta versão inclui todos os recursos introduzidos em visualizações anteriores, além de adições e modificações nas APIs de pesquisa vetorial. As atualizações das APIs de pesquisa vetorial são uma mudança radical a partir de 2023-07-01-Preview. Consulte Adicionar campos vetoriais e Criar um de consulta vetorial para obter ajuda sobre migração.

Se você planeja usar o novo recurso de pré-filtragem, deverá usar um índice criado após 2023-10-01.

Criar ou atualizar índice:

• vectorSearch tem definições para algorithms, profilese vectorizers:

  • algorithms continua a apoiar hnsw e agora também suporta eknn, em referência ao Hierarchical Navigable Small World (HNSW) e ao exaustivo K-nearest neighbors (eKNN). Dentro da seção de algoritmo, você pode definir várias combinações nomeadas de parâmetros HNSW e eKNN. Esta substitui algorithmConfigurations dentro da propriedade vectorSearch em 2023-07-01-Preview.

  • profiles é uma nova definição que especifica a configuração do algoritmo. Por exemplo, suponha que você tenha configurações de algoritmo chamadas HNSW-1, HSNW-2, eKNN-1. Um perfil pode especificar HNSW-1.

  • vectorizers é definido em um índice, mas usado no momento da consulta para incorporar uma cadeia de caracteres de consulta de texto. Um vetorizador faz referência a um modelo de incorporação. O serviço de pesquisa faz uma chamada para o modelo de incorporação para vetorizar a cadeia de caracteres de consulta de texto e, em seguida, passa o resultado para o mecanismo de pesquisa para uma consulta vetorial.

• Em campos vetoriais, vectorSearchProfile substitui vectorSearchConfiguration. A propriedade vectorSearchProfile especifica qual perfil de pesquisa vetorial usar no campo.

• Em índices criados antes desta versão da API, ao chamar a API 2023-10-01-Preview, em sua solicitação, você deve alterar o campo para especificar uma vectorSearchProfile, desde que o perfil especifique exatamente o mesmo algoritmo especificado anteriormente no vectorSearchConfiguration. Por exemplo, se a definição de campo existente especificar "vectorSearchConfiguration": "myHnsw", você deverá substituí-la por "vectorSearchProfile": "your profile name", e o perfil deverá ser definido para fazer referência à mesma "algorithm": "myHnsw".

Pesquisar documentos:

• vectorQueries substitui vectors em 2023-07-01-Preview
• vectorQueries.vectors substitui vectors.values em 2023-07-01-Preview.
• A consulta vetorial é agora uma estrutura polimórfica. kind deve ser especificado para indicar o tipo de consulta vetorial que está sendo solicitada. "kind": "vector" significa que a consulta é um vetor, portanto, o chamador já deve ter vetorizado a cadeia de caracteres de consulta de pesquisa em uma incorporação vetorial.
• "exhaustive": "true" é uma nova propriedade especifica se deve ser feita uma pesquisa exaustiva (força bruta) de vizinhos k-nearest em todos os vetores dentro do índice de vetores.
• vectorFilterMode é um novo parâmetro para especificar pré-filtragem (padrão para índices criados após 2023-10-01) ou pós-filtragem (padrão em índices anteriores) na consulta.

A partir de 29 de março de 2024: as respostas GET não retornam mais cadeias de conexão ou chaves. Consulte Alteração de quebra para o código do cliente que lê informações de conexão para obter detalhes.

2023-07-01-visualização

Esta versão introduziu suporte vetorial e usa uma configuração vetorial que é incompatível com versões mais recentes da API.

• Adicionado um tipo de dados Collection(Edm.Single) em campos que contêm uma matriz de números de ponto flutuante de precisão única. Este é o tipo de dados para vetores, usado para armazenar uma incorporação gerada por campo de documento. O índice de pesquisa também especifica as propriedades de configuração do vetor. Consulte Criar ou atualizar de índice para essas APIs.
• Cargas de trabalho de indexação atualizadas para aceitar dados vetoriais. Consulte Adicionar, atualizar ou excluir documentos.
• Adicionados parâmetros de consulta para pesquisa vetorial. Consulte Pesquisar documentos para obter esses parâmetros.
• Obter estatísticas de serviço: retorna a cota de índice de vetor e o uso do serviço.
• Obter estatísticas de índice: retorna a cota de índice de vetor e o uso para o índice de pesquisa.
• A partir de 29 de março de 2024: as respostas GET não retornam mais cadeias de conexão ou chaves. Consulte Alteração de quebra para o código do cliente que lê informações de conexão para obter detalhes.

2021-04-30-pré-visualização

Esta versão de pré-visualização inclui todas as funcionalidades introduzidas no 2020-06-30-Preview, além de adições às seguintes APIs:

• alias de índice adiciona um nome secundário usado para referenciar índices em solicitações de consulta e indexação. As operações de alias incluem criar, atualizar, excluir, obter e listar.
• Identidades gerenciadas para conexões de saída. Novos valores para cadeias de conexão no Criar ou Atualizar Fonte de Dados oferecem suporte a conexões usando a autenticação e funções do Microsoft Entra ID em vez de credenciais ou chaves de banco de dados codificadas.
• O suporte de identidade gerenciada também é suportado para conexões de cofre de chaves, para soluções de pesquisa que complementam a criptografia padrão com criptografia gerenciada pelo cliente.
• Mais idiomas para a habilidade cognitiva de Tradução de Texto.
• Mais queryLanguages para pesquisa semântica e ortografia em Pesquisar Documentos (visualização).
• Um parâmetro captions para, opcionalmente, solicitar legendas da pesquisa semântica no Search Documents (visualização).
• Configurações semânticas são especificadas em Criar ou Atualizar Índice . Uma configuração semântica determina quais campos devem ser usados para classificação semântica, legendas, destaques e respostas.
• Um parâmetro semanticConfiguration necessário para consultas semânticas em Pesquisar Documentos (visualização).
• A partir de 29 de março de 2024: as respostas GET não retornam mais cadeias de conexão ou chaves. Consulte Alteração de quebra para o código do cliente que lê informações de conexão para obter detalhes.

2020-06-30

Esta versão fornece recursos geralmente disponíveis, incluindo:

• Controle de acesso baseado em função do Azure para operações de plano de dados
• Pontuação de relevância (BM25)
• Armazenamentos de conhecimento
• Fonte de dados do indexador para o Azure Data Lake Storage (ADLS) Gen2
• Habilidade de pesquisa de entidade personalizada
• Indexadores em execução sob um sistema ou identidade gerenciada pelo usuário por meio do ID do Microsoft Entra
• A partir de 29 de março de 2024: as respostas GET não retornam mais cadeias de conexão ou chaves. Consulte Alteração de quebra para o código do cliente que lê informações de conexão para obter detalhes.

2020-06-30-pré-visualização

Esta versão de pré-visualização inclui todas as funcionalidades introduzidas em 2019-05-06-Preview, além das seguintes adições:

• Pesquisa semântica, um recurso premium que é executado em serviços de camada padrão e que invoca a classificação semântica.
• Fonte de dados do indexador para conectores do Power Query
• Fonte de dados do indexador para MySQL
• Fonte de dados do indexador para a API Gremlin do Cosmos DB
• Fonte de dados do indexador para o SharePoint Online
• Propriedade Normalizer para normalização de texto, para filtragem, facetagem e classificação que não diferenciam maiúsculas de minúsculas
• Redefinir documentos para indexação baseada em indexador para atualizar especificamente documentos específicos por ID
• Habilidade cognitiva de vinculação de entidade (v3)
• Habilidade cognitiva de Reconhecimento de Entidades (v3)
• Habilidade cognitiva de Análise de Sentimento (v3)
• A partir de 29 de março de 2024: as respostas GET não retornam mais cadeias de conexão ou chaves. Consulte Alteração de quebra para o código do cliente que lê informações de conexão para obter detalhes.

2019-05-06-pré-visualização

• Suporte de fonte de dados do indexador para a API MongoDB do Cosmos DB
• Fonte de dados do indexador para exclusão suave no Armazenamento de Blobs
• parâmetro featuresMode que retorna informações detalhadas sobre uma pontuação de relevância
• Habilidade cognitiva do Azure Machine Learning (AML)
• Habilidade cognitiva de deteção de identificação pessoal
• Armazenar documentos enriquecidos em cache para preservar e reutilizar o processamento de imagens (e outros enriquecimentos de IA)
• A partir de 29 de março de 2024: as respostas GET não retornam mais cadeias de conexão ou chaves. Consulte Alteração de quebra para o código do cliente que lê informações de conexão para obter detalhes.

Ver também

• Criar um serviço de pesquisa
• Guia de início rápido: criar um índice de Pesquisa de IA do Azure usando APIs REST