Versões da API REST (Azure AI Search)
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 pasta
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-05-01-preview (mais recente) |
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-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, portanto, ele também tem a quantização escalar, tipos de dados estreitos e opções de armazenamento introduzidas nessa versão.
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:
vectorSearchtem definições paraalgorithms,profilesevectorizers:algorithmscontinua a dar suporte ahnswe agora também dá suporte aeknn, 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 substituialgorithmConfigurationsdentro da propriedadevectorSearchem 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,
vectorSearchProfilesubstituivectorSearchConfiguration. A propriedadevectorSearchProfileespecifica 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
vectorSearchProfiledesde que o perfil especifique exatamente o mesmo algoritmo especificado anteriormente emvectorSearchConfiguration. 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".
-
vectorQueriessubstituivectorsem 2023-07-01-Preview -
vectorQueries.vectorssubstituivectors.valuesem 2023-07-01-Preview. - A consulta vetor agora é uma estrutura polimórfica.
kinddeve 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:
- 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 em Criar ou Atualizar Fonte de Dados dão suporte a conexões usando a autenticação e as funções da ID do Microsoft Entra em vez de credenciais ou chaves de banco de dados codificadas.
- O suporte à identidade gerenciada também tem suporte para conexões de cofre de chaves, para soluções de pesquisa que complementam a criptografia padrão com de criptografia gerenciada pelo cliente.
- Mais idiomas para a habilidade cognitiva de Tradução de Texto.
- Mais queryLanguages para pesquisa semântica e verificador ortográfico em Documentos de Pesquisa (versão prévia).
- Um parâmetro de legendas para, opcionalmente, solicitar legendas da pesquisa semântica em Documentos de Pesquisa (versão prévia).
- 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, realces e respostas.
- Um parâmetro semanticConfiguration necessário para consultas semânticas em Documentos de Pesquisa (versão prévia).
- 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
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.