Partilhar via

Versões da API REST (Azure AI Search)

  • Artigo

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.

Captura de tela do seletor de versão.

Versões estáveis

Versão da API Especificação Atualizações da API
2024-07-01 (Mais recente) Especificação Swagger Nota de lançamento
2023-11-01 Especificação Swagger Nota de lançamento
2020-06-30 Especificação Swagger Nota de lançamento
2019-05-06 Especificação Swagger Adiciona tipos complexos.

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.

Versão da API Especificação Atualizações da API
2024-11-01-preview (Mais recente) Especificação Swagger Nota de lançamento
2024-09-01-preview Especificação Swagger Nota de lançamento
2024-05-01-preview Especificação Swagger Nota de lançamento
2024-03-01-preview Especificação Swagger Nota de lançamento
2023-10-01-preview Especificação Swagger Nota de lançamento
2023-07-01-preview (preterido) Especificação Swagger Nota de lançamento
2021-04-30-preview Especificação Swagger Nota de lançamento
2020-06-30-preview Especificação Swagger Nota de lançamento
2019-05-06-preview Especificação Swagger Nota de lançamento

Notas de versão

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

Esta pré-visualização baseia-se no 2024-09-01-preview e inclui todas as funcionalidades atualmente em pré-visualização. Você pode atualizar do 2024-09-01-preview para o 2024-11-01-preview com o mínimo de alterações de código. Para obter mais informações, consulte Atualizar as APIs REST.

Atualizar API REST aplicável
Reescrita de consulta no reranker semântico, usado para refinar consultas enviadas para o classificador L2. de Pesquisa de Documentos , o novo QueryRewritesType propriedade na solicitação.
habilidade Layout de Documento usada para analisar um documento quanto à estrutura. Criar ou atualizarSkillset, nova habilidade de DocumentIntelligenceLayoutSkill.
Identidade gerenciada para anexar um recurso multisserviço de IA do Azure. Create or Update Skillset, nova propriedade AIServicesAccountIdentity.
modo de análise Markdown, usado para indexar arquivos Markdown no Armazenamento do Azure. Criar ou Atualizar Indexador, o novo modo de marcação análise marcação.
Opções de repontuação para vetores compactados, usadas para remarcar com vetores originais em vez de vetores compactados. Aplica-se a HNSW e algoritmos vetoriais KNN exaustivos, usando compressão binária e escalar. Criar ou Atualizarde Índice , novas propriedades recoringOptions rescoring. Um novo enableRescoring mapas de propriedades para rerankWithOriginalVectors introduzido em 2024-03-01-preview.

2024-09-01-visualização

Esta pré-visualização baseia-se no 2024-05-01-preview e inclui todas as funcionalidades atualmente em pré-visualização. Você pode atualizar do 2024-05-01-preview para o 2024-09-01-preview sem a necessidade de alterações de código. Para obter mais informações, consulte Atualizar as APIs REST.

Atualizar API REST aplicável
Dimensões truncadas para modelos de incorporação de texto-3-pequeno e texto-incorporação-3-grande retreinados na quantização Matryoshka Representation Learning (MRL). Create or Update Index, novo parâmetro truncationDimension
Subpontuações ou detalhes de pontuação para descompactar resultados de pesquisa híbridos pontuados por Reciprocal Rank Fusion (RRF). de Pesquisa de Documentos, novas definições de de de depuração de e de subpontuação de consulta na resposta.
Filtragem de destino para a parte vetorial de uma consulta de pesquisa híbrida . de Pesquisa de Documentos , novo parâmetro de filterOverride em RawVectorQuery, VectorizableTextQuery, VectorizableImageUrlQuery, VectorizableImageBinaryQuery.
Fragmentação de token em habilidade Divisão de texto, em vez de apenas caracteres. Criar ou atualizarSkillset, novo parâmetro de unidade e outras propriedades relacionadas a tokens.

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.

Atualizar API REST aplicável
Geralmente disponível - tipos de dados vetoriais Criar ou atualizar de índice
Geralmente disponível - propriedades de quantização vetorial para quantização escalar ou binária interna em um índice de pesquisa. Criar ou atualizar de índice
Geralmente disponível - propriedade armazenada em um campo de vetor que determina se uma cópia extra do campo é armazenada. A cópia extra é o conteúdo recuperável desse campo. Se você não armazená-lo, o campo ainda será usado em consultas, mas não poderá ser retornado em um resultado de pesquisa. Você pode definir essa propriedade para economizar espaço em seu serviço de pesquisa ou cota vetorial em um índice de pesquisa. Criar ou atualizar de índice
Geralmente disponível - VectorizableTextQuery parâmetros para ajuste de relevância. Os parâmetros de consulta híbridos (MaxTextSizeRecall) ainda estão em visualização. Pesquisa de documentos
Geralmente disponível - AzureOpenAIEmbedding habilidade para suportar mais modelos do que apenas text-embedding-ada-002 para vetorização integrada durante a indexação. Defina o nome do modelo e as propriedades de dimensões para direcionar um modelo específico. Criar ou atualizar o conjunto de habilidades
Disponível ao público em geral - Vetorizador de incorporação do Azure OpenAI para vetorização integrada durante consultas. As propriedades do vetorizador suportam mais modelos. Criar ou atualizar de índice
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. Todas as versões

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 e inclui todos os recursos atualmente em visualizaçã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.

Atualizar API REST aplicável
Fonte de dados do indexador para arquivos e atalhos do OneLake. Criar ou atualizar de fonte de dados
Collection(Edm.Byte), um tipo de dados binários para incorporar modelos que os suportam. As definições de campo vetorial suportam esse tipo de dados. Criar ou atualizar de índice
Vários parâmetros de consulta vetoriais e híbridos para ajuste de relevância. Defina limites para excluir resultados de pontuação baixa. Consultas de vetor de peso. Para consultas híbridas, defina o máximo de documentos a serem recuperados na parte de texto de uma consulta híbrida. Pesquisa de documentos
Nova habilidade do Azure AI Vision para vetorização integrada multimodal durante a indexação. Essa habilidade chama a API multimodal do Azure AI Vision. Criar ou atualizar o conjunto de habilidades
Novo vetorizador Azure AI Vision para consultas multimodais. Um vetorizador é especificado em definições de índice, mas usado durante a execução da consulta. Criar ou atualizar de índice
Habilidade AzureOpenAIEmbedding atualizada para suportar mais modelos do que apenas text-embedding-ada-002 para vetorização integrada durante a indexação. Defina o nome do modelo e as propriedades de dimensões para direcionar um modelo específico. Criar ou atualizar o conjunto de habilidades
Vetorizador de incorporação do Azure OpenAI atualizado para vetorização integrada durante consultas. As propriedades do vetorizador suportam mais modelos. Criar ou atualizar de índice
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. Todas as versões

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.

Atualizar API REST aplicável
Novos tipos de dados estreitos para campos vetoriais se você tiver modelos de incorporação que os suportem ou lógica de quantização que produza vetores menores. Criar ou atualizar de índice
Novas propriedades de quantização vetorial para compactação vetorial interna em um índice de pesquisa. Criar ou atualizar de índice
Nova propriedade booleana armazenada em uma de campo vetorial que determina se uma cópia extra do campo é armazenada. A cópia extra é o conteúdo recuperável desse campo. Se você não armazená-lo, o campo ainda será usado em consultas, mas não poderá ser retornado em um resultado de pesquisa. Você pode definir essa propriedade para economizar espaço em seu serviço de pesquisa ou cota vetorial em um índice de pesquisa. Criar ou atualizar de índice
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. Todas as versões

2023-11-01

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

Atualizar API REST aplicável
Classificação semântica em solicitações de publicação de pesquisa. Pesquisa de documentos
Configuração de pesquisa vetorial para indexação de campos vetoriais Criar ou atualizar de índice
Consultas vetoriais em solicitações de postagem de pesquisa. Pesquisa de documentos
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. Todas as versões

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

Importante

Não use esta versão da API. A preterição desta versão de pré-visualização foi anunciada em 15 de abril de 2024 e não é mais suportada após 8 de julho de 2024. Para obter ajuda com a migração, consulte Atualizar APIs REST no Azure AI Search.

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:

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