Versões da API REST (Azure AI Pesquisa)

Artigo
04/04/2024

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

Documentos da API com versão

Os documentos da API REST têm agora o controlo de versões. Quando abre uma página de referência da API, é apresentado um seletor de versões acima do índice.

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

Versões estáveis

Versão da API	Especificação	Atualizações da API
`2023-11-01` (Mais recente)	Especificação do Swagger	Nota de versão
`2020-06-30`	Especificação do Swagger	Nota de versão
`2019-05-06`	Especificação do Swagger	Adiciona tipos complexos.
`2017-11-11`	Especificação do Swagger	Adiciona conjuntos de competências e melhoramento de IA.
`2016-09-01`	Especificação do Swagger	Adiciona indexadores.
`2015-02-28`	Não suportado após 10-10-2020	Primeira versão geralmente disponível.

Versões de pré-visualização

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

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

Notas de versão

2024-03-01-Preview

Esta versão de pré-visualização baseia-se ao 2023-10-01-preview adicionar as seguintes APIs de pré-visualização que o ajudam a poupar espaço:

Novos tipos de dados estreitos para campos de vetor se tiver modelos de incorporação que os suportem ou lógica de quantização que produz vetores mais pequenos.
Novas propriedades de quantização de vetor para compressão de vetor incorporada num índice de pesquisa.
Nova propriedade booleana armazenada num campo de vetor que determina se é armazenada uma cópia extra do campo. A cópia extra é o conteúdo recuperável desse campo. Se não o armazenar, o campo continua a ser utilizado em consultas, mas não pode ser devolvido num resultado de pesquisa. Pode definir esta propriedade para poupar espaço no seu serviço de pesquisa ou quota de vetor num índice de pesquisa.

2023-11-01

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

Classificação semântica no Pesquisa Pedidos post.
Indexação de pesquisa de vetor em Pedidos de Criação ou Atualização do Índice e consultas de vetor no Pesquisa pedidos Post.

2023-10-01-Preview

Esta versão inclui todas as funcionalidades introduzidas em pré-visualizações anteriores, além de adições e modificações às APIs de pesquisa de vetores. Atualizações para as APIs de pesquisa de vetores são uma alteração interruptiva de 2023-07-01-Preview. Veja Adicionar campos de vetor e Criar uma consulta de vetor para obter ajuda de migração.

Se planeia utilizar a nova capacidade de pré-filtragem, tem de utilizar um índice criado após 2023-10-01.

Criar ou Atualizar Índice:

vectorSearch tem definições para algorithms, profilese vectorizers:
- algorithms continua a suportar hnsw e agora também suporta , em referência ao HNSW (Hierarchical Navigable Small World) e aos vizinhos eknnK mais próximos exaustivos (eKNN). Na secção algoritmo, pode definir várias combinações nomeadas de parâmetros HNSW e eKNN. Isto 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 tem configurações de algoritmo com o nome HNSW-1, HSNW-2 eKNN-1. Um perfil pode especificar HNSW-1.
- vectorizers está visível, mas atualmente ignorado.
Em campos de vetor, vectorSearchProfile substitui vectorSearchConfiguration. A vectorSearchProfile propriedade especifica o perfil de pesquisa de vetor a utilizar no campo.
Nos índices criados antes desta versão da API, ao chamar a API 2023-10-01-Preview, no seu pedido, tem de alterar o campo para especificar um vectorSearchProfile , desde que o perfil especifique o mesmo algoritmo especificado anteriormente no vectorSearchConfiguration. Por exemplo, se a definição de campo existente especificar "vectorSearchConfiguration": "myHnsw", tem de substituí-la "vectorSearchProfile": "your profile name"por e o perfil tem de 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 vetor é agora uma estrutura polimórfica. kind tem de ser especificado para indicar o tipo de consulta de vetor que está a ser pedida.
- "kind": "vector" significa que a consulta é um vetor, pelo que o autor da chamada já deve ter vetorizado a cadeia de consulta de pesquisa numa incorporação de vetor.
"exhaustive": "true" é uma nova propriedade especifica se deve fazer uma pesquisa exaustiva (força bruta) k vizinho mais próxima em todos os vetores dentro do índice de vetor.
vectorFilterMode é um novo parâmetro para especificar o pré-filtro (predefinição para índices criados após 2023-10-01) ou pós-filtro (predefinição nos índices anteriores) na consulta.

2023-07-01-Preview

Esta versão inclui todas as funcionalidades introduzidas em pré-visualizações anteriores, além do suporte de pesquisa de vetores:

No índice de pesquisa, atribua Collection(Edm.Single) o tipo de dados em campos que contenham uma matriz de números de vírgula flutuante de precisão única. Este é o tipo de dados para a nova capacidade de pesquisa de vetores, utilizada para armazenar uma incorporação gerada por campo de documento. Também no índice de pesquisa, especifique as propriedades de configuração do vetor. Veja Criar ou Atualizar Índice para estas APIs.
As cargas de trabalho de indexação são atualizadas para aceitar dados de vetor. Consulte Adicionar, Atualizar ou Eliminar Documentos.
Parâmetros de consulta para pesquisa de vetores. Veja Pesquisa Documentos para estes parâmetros.
Obter Estatísticas de Serviço: devolve a quota do índice de vetor e a utilização do serviço.
Obter Estatísticas de Índice: devolve a quota do índice de vetor e a utilização do índice de pesquisa.

2021-04-30-Preview

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

O alias de índice adiciona um nome secundário utilizado para referenciar índices em pedidos de consulta e indexação. As operações de alias incluem criar, atualizar, eliminar, obter e lista.
Identidades geridas para ligações de saída. Os novos valores para cadeias de ligação em Criar ou Atualizar Origem de Dados suportam ligações com Microsoft Entra ID autenticação e funções em vez de credenciais ou chaves de base de dados codificadas.
O suporte de identidade gerida também é suportado para ligações do cofre de chaves, para soluções de pesquisa que complementam a encriptação predefinida com encriptação gerida pelo cliente.
Mais idiomas para a competência cognitiva de Tradução de Texto.
Mais consultasLanguages para pesquisa semântica e ortográfico no Pesquisa Documents (pré-visualização).
Um parâmetro de legendas para solicitar opcionalmente legendas da pesquisa semântica em Documentos Pesquisa (pré-visualização).
As configurações semânticas são especificadas em Criar ou Atualizar Índice. Uma configuração semântica determina que campos devem ser utilizados para classificação semântica, legendas, destaques e respostas.
Um parâmetro semânticoConfiguration necessário para consultas semânticas no Pesquisa Documents (pré-visualização).

2020-06-30