Compartilhar via

Versões da API REST (Azure AI Search)

  • Artigo

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

Documentos de API com versão

Os documentos da API REST agora estão em versão. Quando você abre uma página de referência de API, um seletor de versão aparece acima do sumário. Verifique se a referência à API é da pastadata plane de referência do .

Captura de tela do seletor de versão.

Versões estáveis

Versão da API Especificação Atualizações de API
2024-07-01 (mais recente) de especificação do Swagger nota de versão
2023-11-01 de especificação do Swagger nota de versão
2020-06-30 de especificação do Swagger nota de versão
2019-05-06 de especificação do Swagger Adiciona tipos complexos.

Versões de visualização

As versões prévias são lançadas para testar novas funcionalidades, coletar comentários e descobrir e corrigir problemas. As APIs de visualização estão disponíveis em Termos de Uso Complementares para o Microsoft Azure Previews.

Versão da API Especificação Atualizações de API
2024-11-01-preview (mais recente) de especificação do Swagger nota de versão
2024-09-01-preview de especificação do Swagger nota de versão
2024-05-01-preview de especificação do Swagger nota de versão
2024-03-01-preview de especificação do Swagger nota de versão
2023-10-01-preview de especificação do Swagger nota de versão
2023-07-01-preview (preterido) de especificação do Swagger nota de versão
2021-04-30-preview de especificação do Swagger nota de versão
2020-06-30-preview de especificação do Swagger nota de versão
2019-05-06-preview de especificação do Swagger nota de versão

Notas sobre a versão

2024-11-01-preview

Esta visualização se baseia no 2024-09-01-preview e inclui todos os recursos de atualmente na versão prévia. Você pode atualizar de 2024-09-01-preview para 2024-11-01-preview com alterações mínimas de código. Para obter mais informações, consulte Atualizar as APIs REST.

Atualização API REST aplicável
regravação de consulta node reclassificador semântico, usado para refinar consultas enviadas ao classificador L2. de Documentos de Pesquisa, nova propriedade QueryRewritesType na solicitação.
de habilidade do Layout de Documento usado para analisar um documento para estrutura. criar ou atualizarde conjunto de habilidades, nova habilidade de DocumentIntelligenceLayoutSkill.
Identidade gerenciada para anexar um recurso multissserviço de IA do Azure. criar ou atualizardo Conjunto de Habilidades, nova propriedade AIServicesAccountIdentity .
modo de análise markdown, usado para indexar arquivos Markdown no Armazenamento do Azure. criar ou atualizardo Indexador, novo modo de análise de de markdown de .
opções de recortação para vetores compactados, usadas para recortar com vetores originais em vez de vetores compactados. Aplica-se a algoritmos de vetor HNSW e KNN exaustivos, usando compactação binária e escalar. criar ou atualizarde índice, novas propriedades rescoringOptions. Uma nova propriedade enableRescoring é mapeada para rerankWithOriginalVectors introduzida em 2024-03-01-preview.

2024-09-01-preview

Esta visualização se baseia no 2024-05-01-preview e inclui todos os recursos de atualmente na versão prévia. Você pode atualizar de 2024-05-01-preview para 2024-09-01-preview sem nenhuma alteração de código necessária. Para obter mais informações, consulte Atualizar as APIs REST.

Atualização API REST aplicável
dimensões truncadas para modelos de conversão de texto-3-small e text-embedding-3-large retreinados na quantização de MRL (Matryoshka Representation Learning). criar ou atualizarde índice, novo parâmetro truncationDimension
Subpasta ou detalhes de pontuação para desempacotar resultados de pesquisa híbrida pontuados por RRF (Reciprocal Rank Fusion). de Documentos de Pesquisa, novas definições de parâmetro de de depuração de e subscore de consulta na resposta.
Filtragem de destino para a parte de vetor de uma consulta de pesquisa híbrida . de Documentos de Pesquisa, novo parâmetro filterOverride noRawVectorQuery,VectorizableTextQuery, VectorizableImageUrlQuery, VectorizableImageBinaryQuery.
Agrupamento de token em de habilidade de Divisão de Texto, em vez de apenas caracteres. criar ou atualizarde conjunto de habilidades, nova unidade parâmetro e outras propriedades relacionadas a token.

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 no do Azure AI Search para obter detalhes.

Atualização API REST aplicável
Disponibilidade geral – tipos de dados de vetor criar ou atualizar o índice
Disponível em geral - propriedades de quantização de vetor para quantização escalar ou binária interna em um índice de pesquisa. criar ou atualizar o índice
Disponível em geral - de 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 conservar espaço em seu serviço de pesquisa ou cota de vetor em um índice de pesquisa. criar ou atualizar o índice
Disponibilidade geral – parâmetros VectorizableTextQuery para ajuste de relevância. Os parâmetros de consulta híbrida (MaxTextSizeRecall) ainda estão em versão prévia. pesquisar documentos
Disponibilidade geral – habilidade do AzureOpenAIEmbedding para dar suporte a 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 de conjunto de habilidades
Disponibilidade geral – vetor de inserção do Azure OpenAI para vetorização integrada durante consultas. As propriedades do vetorizer dão suporte a mais modelos. criar ou atualizar o í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 significativa para o código do cliente que lê as informações de conexão para obter detalhes. Todas as versões

2024-05-01-preview

Esta versão prévia adiciona suporte para indexação onelake, ajuste de relevância e integração mais profunda com mais modelos de inserção durante indexação e consultas. Ele se baseia no 2024-03-01-preview e inclui todos os recursos de atualmente na versão prévia.

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

Estas são as atualizações nesta versão prévia. Também recomendamos Novidades no Azure AI Search.

Atualização 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ário para inserir modelos que dão suporte a eles. As definições de campo de vetor dão suporte a esse tipo de dados. criar ou atualizar o índice
Vários parâmetros de consulta vetor e híbrida para ajuste de relevância. Defina limites para excluir resultados de baixa pontuação. 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. pesquisar documentos
Nova habilidade da Visão de IA do Azure para vetorização integrada multimodal durante a indexação. Essa habilidade chama a API multimodal da Visão de IA do Azure. criar ou atualizar de conjunto de habilidades
Novo vetorizador da Visão de IA do Azure para consultas multimodal. Um vetorizador é especificado em definições de índice, mas usado durante a execução da consulta. criar ou atualizar o índice
Atualização da habilidade AzureOpenAIEmbedding para dar suporte a 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 de conjunto de habilidades
Vetorizador de inserção do Azure OpenAI atualizado para vetorização integrada durante consultas. As propriedades do vetorizer dão suporte a mais modelos. criar ou atualizar o í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 significativa para o código do cliente que lê as informações de conexão para obter detalhes. Todas as versões

2024-03-01-preview

Esta versão de visualização se baseia em 2023-10-01-preview adicionando APIs de visualização que melhoram o armazenamento de vetores. Consulte Novidades no do Azure AI Search para obter detalhes.

Atualização API REST aplicável
Novos tipos de dados estreitos para campos de vetor se você tiver modelos de inserção que dão suporte a eles ou à lógica de quantização que gera vetores menores. criar ou atualizar o índice
Novas propriedades de quantização de vetor para compactação de vetor interno em um índice de pesquisa. criar ou atualizar o índice
Nova propriedade booliana 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 conservar espaço em seu serviço de pesquisa ou cota de vetor em um índice de pesquisa. criar ou atualizar o í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 significativa para o código do cliente que lê as informações de conexão para obter detalhes. Todas as versões

2023-11-01

Esta versão fornece recursos disponíveis em geral. Consulte Novidades no do Azure AI Search para obter detalhes.

Atualização API REST aplicável
Classificação semântica em solicitações de Postagem de Pesquisa. pesquisar documentos
Configuração de pesquisa de vetor para indexação de campos de vetor criar ou atualizar o índice
Consultas de vetor em solicitações de Postagem de Pesquisa. pesquisar 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 significativa para o código do cliente que lê as informações de conexão para obter detalhes. Todas as versões

2023-10-01-preview

Essa versão inclui todos os recursos introduzidos nas versões prévias anteriores, além de adições e modificações nas APIs de pesquisa de vetor. As atualizações das APIs de pesquisa de vetor são uma alteração significativa de 2023-07-01-Preview. Consulte Adicionar campos de vetor e Criar uma consulta de vetor para obter ajuda de migração.

Se você planeja usar a nova funcionalidade de pré-filtragem, deve usar um índice criado após 2023-10-01.

criar ou atualizarde índice:

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

    • algorithms continua a dar suporte a hnsw e agora também dá suporte a eknn, em referência a HNSW (Navigable Small World) hierárquico e eKNN (vizinhos K-mais próximos). Na seção de algoritmo, você pode definir várias combinações nomeadas de parâmetros HNSW e eKNN. Isso 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 e EKNN-1. Um perfil pode especificar HNSW-1.

    • vectorizers é definido em um índice, mas usado no momento da consulta para inserir uma cadeia de caracteres de consulta de texto. Um vetor faz referência a um modelo de inserção. O serviço de pesquisa faz uma chamada para o modelo de inserçã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 de vetor.

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

  • Em índices criados antes dessa versão da API, ao chamar a API 2023-10-01-Preview, em sua solicitação, você deve alterar o campo para especificar um vectorSearchProfile desde que o perfil especifique exatamente o mesmo algoritmo especificado anteriormente em 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 referenciar o mesmo "algorithm": "myHnsw".

pesquisar documentos:

  • vectorQueries substitui vectors em 2023-07-01-Preview
  • vectorQueries.vectors substitui vectors.values em 2023-07-01-Preview.
  • A consulta vetor agora é uma estrutura polimórfica. kind deve ser especificado para indicar o tipo de consulta vetor 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 inserção de vetor.
  • "exhaustive": "true" é uma nova propriedade especifica se uma pesquisa completa (força bruta) k-vizinho mais próxima em todos os vetores dentro do índice de vetor.
  • 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 significativa para o código do cliente que lê as informações de conexão para obter detalhes.

2023-07-01-preview

Importante

Não use esta versão da API. A substituição dessa versão prévia foi anunciada em 15 de abril de 2024 e não tem mais suporte 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 o suporte ao vetor e usa uma configuração de vetor 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. Esse é o tipo de dados para vetores, usado para armazenar uma inserção gerada por campo de documento. O índice de pesquisa também especifica as propriedades de configuração de vetor. Consulte criar ou atualizar de índice para essas APIs.
  • Cargas de trabalho de indexação atualizadas para aceitar dados de vetor. Consulte Adicionar, Atualizar ou Excluir Documentos.
  • Adição de parâmetros de consulta para pesquisa de vetor. Consulte de Documentos de Pesquisa para obter esses parâmetros.
  • Obterde Estatísticas de Serviço: retorna a cota de índice de vetor e o uso para o 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 significativa para o código do cliente que lê as informações de conexão para obter detalhes.

2021-04-30-preview

Esta versão prévia inclui todos os recursos introduzidos 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)
  • Repositórios de conhecimento
  • Fonte de dados do indexador do Azure Data Lake Storage (ADLS) Gen2
  • Habilidade de Pesquisa de Entidade Personalizada
  • Indexadores em execução em um sistema ou identidade gerenciada pelo usuário por meio da 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 significativa para o código do cliente que lê as informações de conexão para obter detalhes.

2020-06-30-preview

Esta versão prévia inclui todos os recursos introduzidos no 2019-05-06-Preview, além das seguintes adições:

  • Pesquisa semântica, um recurso premium que é executado nos serviços de camada Standard 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 do Gremlin do Cosmos DB
  • Fonte de dados do indexador para o SharePoint Online
  • Propriedade Normalizer para normalização de texto, para filtragem, facetação e classificação sem diferenciação de 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 entidade (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 significativa para o código do cliente que lê as informações de conexão para obter detalhes.

2019-05-06-preview

  • Suporte à fonte de dados do indexador para a API do MongoDB do Cosmos DB
  • Fonte de dados do indexador para exclusão reversível no Armazenamento de Blobs
  • parâmetro featuresMode que retorna informações detalhadas sobre uma pontuação de relevância
  • Habilidade cognitiva do AML (Azure Machine Learning)
  • Habilidade cognitiva de detecçã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 significativa para o código do cliente que lê as informações de conexão para obter detalhes.

Consulte também