Versiones de la API REST (Azure AI Search)
En este artículo se enumeran las versiones actuales y anteriores de las API REST de búsqueda para Azure AI Search.
Documentos de API con versiones
Los documentos de la API REST ahora tienen versiones. Al abrir una página de referencia de API, aparece un selector de versiones encima de la tabla de contenido. Asegúrese de que la referencia de API procede de la carpeta referencia de >plano de datos.
Versiones estables
| Versión de API | Especificación | Actualizaciones de API |
|---|---|---|
2024-07-01 (más reciente) |
de especificación de Swagger | nota de la versión |
2023-11-01 |
de especificación de Swagger | nota de la versión |
2020-06-30 |
de especificación de Swagger | nota de la versión |
2019-05-06 |
de especificación de Swagger | Agrega tipos complejos. |
Versiones preliminares
Las versiones preliminares se publican para probar nuevas funcionalidades, recopilar comentarios y detectar y corregir problemas. Las API en versión preliminar están disponibles en Términos de uso complementarios para las versiones preliminares de Microsoft Azure.
| Versión de API | Especificación | Actualizaciones de API |
|---|---|---|
2024-05-01-preview (más reciente) |
de especificación de Swagger | nota de la versión |
2024-03-01-preview |
de especificación de Swagger | nota de la versión |
2023-10-01-preview |
de especificación de Swagger | nota de la versión |
2023-07-01-preview (en desuso) |
de especificación de Swagger | nota de la versión |
2021-04-30-preview |
de especificación de Swagger | nota de la versión |
2020-06-30-preview |
de especificación de Swagger | nota de la versión |
2019-05-06-preview |
de especificación de Swagger | nota de la versión |
Notas
2024-07-01
Esta versión proporciona actualizaciones disponibles con carácter general para la vectorización integrada (aptitudes y vectorizadores), la cuantificación escalar y la cuantificación binaria. Consulte Novedades de Azure AI Search para más información.
| Actualizar | API REST aplicable |
|---|---|
| Disponibilidad general: tipos de datos vectoriales de | crear o actualizar de índice |
| Disponible con carácter general: propiedades de cuantificación de vectores para la cuantificación escalar o binaria integrada en un índice de búsqueda. | crear o actualizar de índice |
| Disponible con carácter general: de propiedad almacenada en un campo de vector de que determina si se almacena una copia adicional del campo. La copia adicional es el contenido recuperable de ese campo. Si no lo almacena, el campo se sigue usando en las consultas, pero no se puede devolver en un resultado de búsqueda. Puede establecer esta propiedad para conservar espacio en el servicio de búsqueda o la cuota de vectores en un índice de búsqueda. | crear o actualizar de índice |
| Disponible con carácter general: parámetros vectorizableTextQuery para el ajuste de relevancia. Los parámetros de consulta híbrida (MaxTextSizeRecall) siguen en versión preliminar. | buscar documentos |
| Disponibilidad general: aptitud AzureOpenAIEmbedding para admitir más modelos que simplemente la inserción de texto-ada-002 para la vectorización integrada durante la indexación. Establezca las propiedades de nombre y dimensiones del modelo para establecer como destino un modelo específico. | crear o actualizar del conjunto de aptitudes |
| Disponible con carácter general: vectorizador de inserción de Azure OpenAI para la vectorización integrada durante las consultas. Las propiedades del vectorizador admiten más modelos. | crear o actualizar de índice |
| A partir del 29 de marzo de 2024: las respuestas GET ya no devuelven cadenas de conexión ni claves. Consulte Cambio importante para el código de cliente que lee la información de conexión para obtener más información. | Todas las versiones |
2024-05-01-preview
Esta versión preliminar agrega compatibilidad con la indexación de OneLake, la optimización de relevancia y una integración más profunda con más modelos de inserción durante la indexación y las consultas. Se basa en el 2024-03-01-preview, por lo que también tiene las opciones de cuantificación escalar, tipos de datos estrechos y almacenamiento introducidas en esa versión.
Para actualizar desde 2024-03-01-preview o 2023-10-01-preview, actualice la aptitud o vectorizador AzureOpenAIEmbedding para incluir el nombre y las dimensiones del modelo. Para actualizar desde 2023-07-01-preview (en desuso) o para obtener instrucciones paso a paso, consulte Actualizar API rest.
Estas son las actualizaciones de esta versión preliminar. También se recomienda novedades de Azure AI Search.
| Actualizar | API REST aplicable |
|---|---|
| Origen de datos del indexador para archivos y accesos directos de OneLake. | crear o actualizar de origen de datos |
Collection(Edm.Byte), un tipo de datos binario para insertar modelos que los admitan. Las definiciones de campo vectorial admiten este tipo de datos. |
crear o actualizar de índice |
| Varios parámetros de consulta híbrida y vector para el ajuste de relevancia. Establezca umbrales para excluir resultados de puntuación bajos. Consultas vectoriales de peso. En el caso de las consultas híbridas, establezca el número máximo de documentos que se recuperarán en la parte de texto de una consulta híbrida. | buscar documentos |
| Nueva aptitud de Azure AI Vision para la vectorización integrada vectorial durante la indexación. Esta aptitud llama a la API multimodal de Azure AI Vision. | crear o actualizar del conjunto de aptitudes |
| Nuevo vectorizador de Azure AI Vision para consultas vectoriales. Se especifica un vectorizador en las definiciones de índice, pero se usa durante la ejecución de la consulta. | crear o actualizar de índice |
| Se ha actualizado la aptitud AzureOpenAIEmbedding para admitir más modelos que simplemente la inserción de texto-ada-002 para la vectorización integrada durante la indexación. Establezca las propiedades de nombre y dimensiones del modelo para establecer como destino un modelo específico. | crear o actualizar del conjunto de aptitudes |
| Se ha actualizado el vectorizador de inserción de Azure OpenAI para la vectorización integrada durante las consultas. Las propiedades del vectorizador admiten más modelos. | crear o actualizar de índice |
| A partir del 29 de marzo de 2024: las respuestas GET ya no devuelven cadenas de conexión ni claves. Consulte Cambio importante para el código de cliente que lee la información de conexión para obtener más información. | Todas las versiones |
2024-03-01-preview
Esta versión preliminar se basa en 2023-10-01-preview mediante la adición de API de versión preliminar que mejoran el almacenamiento de vectores. Consulte Novedades de Azure AI Search para más información.
| Actualizar | API REST aplicable |
|---|---|
| Nuevos tipos de datos estrechos para campos vectoriales si tiene modelos de inserción que los admiten o la lógica de cuantificación que genera vectores más pequeños. | crear o actualizar de índice |
| Nuevas propiedades de cuantificación de vectores para la compresión vectorial integrada en un índice de búsqueda. | crear o actualizar de índice |
| Nuevo |
crear o actualizar de índice |
| A partir del 29 de marzo de 2024: las respuestas GET ya no devuelven cadenas de conexión ni claves. Consulte Cambio importante para el código de cliente que lee la información de conexión para obtener más información. | Todas las versiones |
2023-11-01
Esta versión proporciona características disponibles con carácter general. Consulte Novedades de Azure AI Search para más información.
| Actualizar | API REST aplicable |
|---|---|
| Clasificación semántica en solicitudes post de búsqueda. | buscar documentos |
| Configuración de búsqueda de vectores para campos vectoriales de indexación | crear o actualizar de índice |
| Consultas vectoriales en solicitudes post de búsqueda. | buscar documentos |
| A partir del 29 de marzo de 2024: las respuestas GET ya no devuelven cadenas de conexión ni claves. Consulte Cambio importante para el código de cliente que lee la información de conexión para obtener más información. | Todas las versiones |
2023-10-01-preview
Esta versión incluye todas las características introducidas en versiones preliminares anteriores, además de adiciones y modificaciones a las API de búsqueda vectorial. Las actualizaciones de las API de búsqueda de vectores son un cambio importante de 2023-07-01-Preview. Consulte Agregar campos vectoriales y Crear una consulta de vectores para obtener ayuda para la migración.
Si planea usar la nueva funcionalidad de prefiltro, debe usar un índice creado después de 2023-10-01.
vectorSearchtiene definiciones paraalgorithms,profilesyvectorizers:algorithmssigue admitiendohnswy ahora también admiteeknn, en referencia a Jerárquicos Navigable Small World (HNSW) y a vecinos más cercanos de K (eKNN). En la sección algoritmo, puede definir varias combinaciones con nombre de parámetros HNSW y eKNN. Esto reemplazaalgorithmConfigurationsdentro de la propiedadvectorSearchen 2023-07-01-Preview.profileses una nueva definición que especifica la configuración del algoritmo. Por ejemplo, supongamos que tiene configuraciones de algoritmo denominadas HNSW-1, HSNW-2, eKNN-1. Un perfil puede especificar HNSW-1.vectorizersse define en un índice, pero se usa en el momento de la consulta para insertar una cadena de consulta de texto. Un vectorizador hace referencia a un modelo de inserción. El servicio de búsqueda realiza una llamada al modelo de inserción para vectorizar la cadena de consulta de texto y, a continuación, pasa el resultado al motor de búsqueda para una consulta vectorial.
En los campos vectoriales,
vectorSearchProfilereemplazavectorSearchConfiguration. La propiedadvectorSearchProfileespecifica qué perfil de búsqueda vectorial se va a usar en el campo.En los índices creados antes de esta versión de API, al llamar a la API 2023-10-01-Preview, en la solicitud, debe cambiar el campo para especificar un
vectorSearchProfilesiempre que el perfil especifique el mismo algoritmo exacto especificado anteriormente envectorSearchConfiguration. Por ejemplo, si la definición de campo existente especifica"vectorSearchConfiguration": "myHnsw", debe reemplazarla por"vectorSearchProfile": "your profile name"y el perfil debe definirse para hacer referencia al mismo"algorithm": "myHnsw".
-
vectorQueriesreemplazavectorsen 2023-07-01-Preview -
vectorQueries.vectorsreemplazavectors.valuesen 2023-07-01-Preview. - La consulta vectorial es ahora una estructura polimórfica.
kinddebe especificarse para indicar el tipo de consulta vectorial que se solicita."kind": "vector"significa que la consulta es un vector, por lo que el autor de la llamada debería haber vectorizado la cadena de consulta de búsqueda en una inserción vectorial. -
"exhaustive": "true"es una nueva propiedad especifica si se debe realizar una búsqueda exhaustiva (fuerza bruta) k-nearest vecino en todos los vectores del índice de vectores. -
vectorFilterModees un nuevo parámetro para especificar el prefiltro (valor predeterminado para los índices creados después de 2023-10-01) o postfiltro (valor predeterminado en los índices anteriores) de la consulta.
A partir del 29 de marzo de 2024: las respuestas GET ya no devuelven cadenas de conexión ni claves. Consulte Cambio importante para el código de cliente que lee la información de conexión para obtener más información.
2023-07-01-preview
Importante
No usar esta versión de API. La desuso de esta versión preliminar se anunció el 15 de abril de 2024 y ya no se admite después del 8 de julio de 2024. Para obtener ayuda con la migración, consulte Actualización de las API REST en Azure AI Search.
Esta versión introdujo compatibilidad con vectores y usa una configuración de vector que no es compatible con las versiones más recientes de la API.
- Se agregó un
Collection(Edm.Single)tipo de datos en los campos que contienen una matriz de números de punto flotante de precisión sencilla. Este es el tipo de datos para los vectores, que se usa para almacenar una inserción generada por campo de documento. El índice de búsqueda también especifica las propiedades de configuración de vectores. Consulte Crear o actualizar de índice para estas API. - Se han actualizado las cargas de trabajo de indexación para aceptar datos vectoriales. Consulte agregar, actualizar o eliminar documentos.
- Se han agregado parámetros de consulta para la búsqueda vectorial. Consulte de documentos de búsqueda para estos parámetros.
- Obtener estadísticas de servicio: devuelve la cuota de índice de vectores y el uso del servicio.
- Obtener estadísticas de índice: devuelve la cuota de índice de vectores y el uso del índice de búsqueda.
- A partir del 29 de marzo de 2024: las respuestas GET ya no devuelven cadenas de conexión ni claves. Consulte Cambio importante para el código de cliente que lee la información de conexión para obtener más información.
2021-04-30-preview
Esta versión preliminar incluye todas las características introducidas en 2020-06-30-Preview, además de las siguientes API:
- alias de índice agrega un nombre secundario que se usa para hacer referencia a índices en solicitudes de consulta e indexación. Las operaciones de alias incluyen crear, actualizar, eliminar, obtener y enumerar.
- identidades administradas para conexiones salientes. Los nuevos valores de las cadenas de conexión de Crear o actualizar origen de datos admiten conexiones mediante la autenticación y los roles de Microsoft Entra ID en lugar de credenciales o claves de base de datos codificadas de forma rígida.
- También se admite la compatibilidad con identidades administradas para las conexiones del almacén de claves, para soluciones de búsqueda que complementan el cifrado predeterminado con cifrado administrado por el cliente.
- Más idiomas para la aptitud cognitiva Traducción de texto.
- Más queryLanguages para la búsqueda semántica y el corrector ortográfico en Buscar documentos (versión preliminar).
- Parámetro captions para solicitar títulos de búsqueda semántica opcionalmente en Buscar documentos (versión preliminar).
- las configuraciones semánticas se especifican en Crear o actualizar índice. Una configuración semántica determina qué campos se deben usar para la clasificación semántica, los títulos, los resaltados y las respuestas.
- Parámetro semanticConfiguration que es necesario para las consultas semánticas en Search Documents (versión preliminar).
- A partir del 29 de marzo de 2024: las respuestas GET ya no devuelven cadenas de conexión ni claves. Consulte Cambio importante para el código de cliente que lee la información de conexión para obtener más información.
2020-06-30
Esta versión proporciona características disponibles con carácter general, entre las que se incluyen:
- Control de acceso basado en rol de Azure para las operaciones del plano de datos
- Puntuación de relevancia (BM25)
- Almacenes de conocimiento
- Origen de datos del indexador para Azure Data Lake Storage (ADLS) Gen2
- Aptitud de búsqueda de entidades personalizadas
- Indexadores que se ejecutan en una identidad administrada por el usuario o un sistema a través de Microsoft Entra ID
- A partir del 29 de marzo de 2024: las respuestas GET ya no devuelven cadenas de conexión ni claves. Consulte Cambio importante para el código de cliente que lee la información de conexión para obtener más información.
2020-06-30-preview
Esta versión preliminar incluye todas las características introducidas en 2019-05-06-Preview, además de las siguientes adiciones:
- Búsqueda semántica, una característica premium que se ejecuta en los servicios de nivel Estándar y que invoca la clasificación semántica.
- Origen de datos del indexador para conectores de Power Query
- Origen de datos del indexador para MySQL
- Origen de datos del indexador para Gremlin API de Cosmos DB
- Origen de datos del indexador para SharePoint Online
- Propiedad Normalizer para la normalización de texto, para el filtrado sin distinción entre mayúsculas y minúsculas, el facetado y la ordenación
- Restablecer documentos para la indexación basada en indexadores para actualizar específicamente documentos específicos por identificador
- Aptitud cognitiva vinculación de entidades (v3)
- Aptitud cognitiva reconocimiento de entidades (v3)
- Aptitud cognitiva Análisis de sentimiento (v3)
- A partir del 29 de marzo de 2024: las respuestas GET ya no devuelven cadenas de conexión ni claves. Consulte Cambio importante para el código de cliente que lee la información de conexión para obtener más información.
2019-05-06-preview
- Compatibilidad con orígenes de datos del indexador para mongoDB API de Cosmos DB
- Origen de datos del indexador para la eliminación temporal en Blob Storage
- Parámetro featuresMode que devuelve información detallada sobre una puntuación de relevancia
- Aptitud cognitiva de Azure Machine Learning (AML)
- Aptitud cognitiva de detección de identificación personal
- Almacenar en caché documentos enriquecidos para conservar y reutilizar el procesamiento de imágenes (y otros enriquecimientos con IA)
- A partir del 29 de marzo de 2024: las respuestas GET ya no devuelven cadenas de conexión ni claves. Consulte Cambio importante para el código de cliente que lee la información de conexión para obtener más información.