Versões da API REST (Pesquisa de IA do Azure)

Artigo
04/24/2024

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

Documentos da API com controle de versão

Os documentos da API REST agora têm controle de versão. Quando você abre uma página de referência de API, um seletor de versão aparece acima do sumário.

Expanda Plano de Dados de Referência>.
Selecione uma página de referência de API.
Escolha uma versão da API no filtro suspenso no canto superior esquerdo.

Versões estáveis

Versão da API	Especificação	Atualizações de API
`2023-11-01` (Mais recente)	Especificação do Swagger	Nota sobre a versão
`2020-06-30`	Especificação do Swagger	Nota sobre a versão
`2019-05-06`	Especificação do Swagger	Adiciona tipos complexos.
`2017-11-11`	Especificação do Swagger	Adiciona habilidades e enriquecimento de IA.
`2016-09-01`	Especificação do Swagger	Adiciona indexadores.
`2015-02-28`	Sem suporte após 10-10-2020	Primeira versão disponível para o público em geral.

Versões prévias

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

Versão da API	Especificação	Atualizações de API
`2024-03-01-Preview` (Mais recente)	Especificação do Swagger	Nota sobre a versão
`2023-10-01-Preview`	Especificação do Swagger	Nota sobre a versão
`2023-07-01-Preview` (preterido)	Especificação do Swagger	Nota sobre a versão
`2021-04-30-Preview`	Especificação do Swagger	Nota sobre a versão
`2020-06-30-Preview`	Especificação do Swagger	Nota sobre a versão
`2019-05-06-Preview`	Especificação do Swagger	Nota sobre a versão
`2017-11-11-Preview`	Especificação do Swagger	Versão prévia associada à versão estável.
`2016-09-01-Preview`	Especificação do Swagger	Versão prévia associada à versão estável.
`2015-02-28-Preview` (desativado)	Sem suporte após 10-10-2020	Versão prévia associada à versão estável.
`2014-10-20-Preview` (desativado)	Sem suporte após 10-10-2020	Segunda versão prévia pública.
`2014-07-31-Preview` (desativado)	Sem suporte após 10-10-2020	Primeira versão prévia pública.

Notas de versão

2024-03-01-Preview

Esta versão de visualização se baseia adicionando 2023-10-01-preview as seguintes APIs de visualização que ajudam você a economizar espaço:

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.
Novas propriedades de quantização de vetor para compactação de vetor interna em um índice de pesquisa.
Nova propriedade armazenada booliana 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.

2023-11-01

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

Classificação semântica em solicitações Pesquisa Post.
Indexação de pesquisa vetorial em Create ou solicitações de Índice de Atualização e consultas de vetor em solicitações Pesquisa Post.

2023-10-01-Preview

Esta 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. Atualizações para as APIs de pesquisa de vetor são uma alteração interruptiva de 2023-07-01-Preview. Consulte Adicionar campos de vetor e Create uma consulta de vetor para obter ajuda de migração.

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

Create ou Atualizar Índice:

vectorSearch tem definições para algorithms, profilese vectorizers:
- algorithms continua a dar suporte hnsw e agora também dá eknnsuporte a , em referência a HNSW (Hierarchical Navigable Small World) 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 vectorSearch propriedade 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 inserir uma cadeia de caracteres de consulta de texto. Um vetorizador 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 vectorSearchProfile propriedade 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 "vectorSearchProfile": "your profile name"por e o perfil deverá ser definido para referenciar o mesmo "algorithm": "myHnsw".

Pesquisa Documentos:

vectorQueriesvectors substitui em 2023-07-01-Preview
vectorQueries.vectorsvectors.values substitui em 2023-07-01-Preview.
A consulta vetorial agora é uma estrutura polimórfica. kind deve ser especificado para indicar o tipo de consulta de 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 que especifica se é necessário fazer uma pesquisa exaustiva (força bruta) k-neighbor 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.

2023-07-01-Preview

Importante

A substituição desta versão prévia foi anunciada em 15 de abril de 2024 e será desativada em 8 de julho de 2024. Para obter ajuda com a migração, consulte Atualizar APIs REST no Azure AI Pesquisa.

Esta versão tem recursos de visualizações anteriores, além do suporte à pesquisa de vetor:

No índice de pesquisa, atribua Collection(Edm.Single) o tipo de dados em campos que contêm uma matriz de números de ponto flutuante de precisão única. Esse é o tipo de dados para o novo recurso de pesquisa de vetor, usado para armazenar uma inserção gerada por campo de documento. Também no índice de pesquisa, especifique as propriedades de configuração de vetor. Consulte Create ou Atualizar Índice para essas APIs.
As cargas de trabalho de indexação são atualizadas para aceitar dados vetoriais. Confira Adicionar, Atualizar ou Excluir Documentos.
Parâmetros de consulta para pesquisa de vetor. Consulte Pesquisa Documentos para esses parâmetros.
Obter Estatísticas de Serviço: retorna a cota e o uso do índice de vetor para o serviço.
Obter Estatísticas de Índice: retorna a cota e o uso do índice de vetor para o índice de pesquisa.

2021-04-30-Prévia

Esta versão prévia inclui todos os recursos introduzidos em 2020-06-30-Preview, além de adições às seguintes APIs:

O 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 lista.
Identidades gerenciadas para conexões de saída. Novos valores para cadeias de conexão em Create ou Atualizar Fonte de Dados dão suporte a conexões usando Microsoft Entra ID autenticação e funções em vez de credenciais ou chaves de banco de dados embutidos em código.
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 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 no Pesquisa Documentos (versão prévia).
Um parâmetro captions para, opcionalmente, solicitar legendas da pesquisa semântica no Pesquisa Documentos (versão prévia).
As configurações semânticas são especificadas em Create 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 no Pesquisa Documentos (versão prévia).

2020-06-30