Documents - Search Post
Busca documentos en el índice.
POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2026-08-01-previewParámetros de identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
La dirección URL del punto de conexión del servicio de búsqueda. |
|
index
|
path | True |
string |
El nombre del índice. |
|
api-version
|
query | True |
string minLength: 1 |
Versión de la API que se va a usar para esta operación. |
Encabezado de la solicitud
| Nombre | Requerido | Tipo | Description |
|---|---|---|---|
| Accept |
El encabezado Aceptar. |
||
| x-ms-query-source-authorization |
string |
Token que identifica al usuario para el que se ejecuta la consulta. Este token se utiliza para aplicar restricciones de seguridad en los documentos. |
|
| x-ms-enable-elevated-read |
boolean |
Valor que habilita la lectura elevada que omite las comprobaciones de permisos de nivel de documento para la operación de consulta. |
|
| x-ms-client-request-id |
string (uuid) |
Identificador de cadena globalmente único y generado por el cliente para la solicitud. |
Cuerpo de la solicitud
| Nombre | Tipo | Description |
|---|---|---|
| answers |
Valor que especifica si las respuestas se deben devolver como parte de la respuesta de búsqueda. |
|
| captions |
Valor que especifica si se deben devolver títulos como parte de la respuesta de búsqueda. |
|
| count |
boolean |
Valor que especifica si se va a capturar el recuento total de resultados. El valor predeterminado es falso. Establecer este valor en true puede tener un impacto en el rendimiento. Tenga en cuenta que el recuento devuelto es una aproximación. |
| debug |
Habilita una herramienta de depuración que se puede usar para explorar más a fondo los resultados reclasificados. |
|
| facets |
string[] |
Lista de expresiones de faceta que se van a aplicar a la consulta de búsqueda. Cada expresión de faceta contiene un nombre de campo, seguido opcionalmente de una lista separada por comas de pares nombre:valor. |
| filter |
string |
Expresión de $filter de OData que se va a aplicar a la consulta de búsqueda. |
| highlight |
string |
Lista separada por comas de nombres de campo que se usarán para los resaltados de aciertos. Solo se pueden usar campos que se pueden buscar para el resaltado de aciertos. |
| highlightPostTag |
string |
Etiqueta de cadena que se anexa a los resaltados de aciertos. Debe establecerse con highlightPreTag. El valor predeterminado es </em>. |
| highlightPreTag |
string |
Etiqueta de cadena que se antepone para alcanzar los resaltados. Debe establecerse con highlightPostTag. El valor predeterminado es <em>. |
| hybridSearch |
Parámetros de consulta para configurar comportamientos de búsqueda híbrida. |
|
| minimumCoverage |
number (double) |
Número comprendido entre 0 y 100 que indica el porcentaje del índice que debe estar cubierto por una consulta de búsqueda para que la consulta se notifique como correcta. Este parámetro puede ser útil para garantizar la disponibilidad de búsqueda incluso para los servicios con una sola réplica. El valor predeterminado es 100. |
| orderby |
string |
La lista separada por comas de OData $orderby expresiones por las que ordenar los resultados. Cada expresión puede ser un nombre de campo o una llamada a las funciones geo.distance() o search.score(). Cada expresión puede ir seguida de asc para indicar ascendente o desc para indicar descendente. El valor predeterminado es orden ascendente. Los empates se romperán con las puntuaciones de coincidencia de documentos. Si no se especifica ningún $orderby, el criterio de ordenación predeterminado es descendente por puntuación de coincidencia de documento. Puede haber como máximo 32 $orderby cláusulas. |
| queryLanguage |
Valor que especifica el idioma de la consulta de búsqueda. |
|
| queryRewrites |
Valor que especifica si se deben generar reescrituras de consulta para aumentar la consulta de búsqueda. |
|
| queryType |
Valor que especifica la sintaxis de la consulta de búsqueda. El valor predeterminado es "simple". Use "full" si la consulta usa la sintaxis de consulta de Lucene. |
|
| scoringParameters |
string[] |
La lista de valores de parámetro que se van a usar en las funciones de puntuación (por ejemplo, referencePointParameter) mediante el formato name-values. Por ejemplo, si el perfil de puntuación define una función con un parámetro denominado "mylocation", la cadena de parámetro sería "mylocation--122.2,44.8" (sin las comillas). |
| scoringProfile |
string |
Nombre de un perfil de puntuación para evaluar las puntuaciones de coincidencia para los documentos coincidentes con el fin de ordenar los resultados. |
| scoringStatistics |
Valor que especifica si queremos calcular las estadísticas de puntuación (como la frecuencia del documento) globalmente para obtener una puntuación más coherente o localmente, para una menor latencia. El valor predeterminado es 'local'. Utilice "global" para agregar estadísticas de puntuación globalmente antes de puntuar. El uso de estadísticas de puntuación global puede aumentar la latencia de las consultas de búsqueda. |
|
| search |
string |
Una expresión de consulta de búsqueda de texto completo; Utilice "*" u omita este parámetro para que coincida con todos los documentos. |
| searchFields |
string |
Lista separada por comas de nombres de campo a los que se va a definir el ámbito de la búsqueda de texto completo. Cuando se usa la búsqueda por campos (fieldName:searchExpression) en una consulta completa de Lucene, los nombres de campo de cada expresión de búsqueda con campos tienen prioridad sobre los nombres de campo enumerados en este parámetro. |
| searchMode |
Valor que especifica si alguno o todos los términos de búsqueda deben coincidir para contar el documento como una coincidencia. |
|
| select |
string |
La lista separada por comas de campos que se van a recuperar. Si no se especifica, se incluyen todos los campos marcados como recuperables en el esquema. |
| semanticConfiguration |
string |
Nombre de una configuración semántica que se usará al procesar documentos para consultas de tipo semántico. |
| semanticErrorHandling |
Permite al usuario elegir si una llamada semántica debe fallar por completo (comportamiento predeterminado / actual) o devolver resultados parciales. |
|
| semanticFields |
string |
La lista separada por comas de nombres de campo utilizados para la clasificación semántica. |
| semanticMaxWaitInMilliseconds |
integer (int32) minimum: 700 |
Permite al usuario establecer un límite superior en la cantidad de tiempo que tarda el enriquecimiento semántico en finalizar el procesamiento antes de que se produzca un error en la solicitud. |
| semanticQuery |
string |
Permite establecer una consulta de búsqueda independiente que se usará únicamente para el reranking semántico, los subtítulos semánticos y las respuestas semánticas. Resulta útil para escenarios en los que es necesario usar consultas diferentes entre la fase de recuperación y clasificación base y la fase semántica L2. |
| sessionId |
string |
Un valor que se utilizará para crear una sesión fija, que puede ayudar a obtener resultados más consistentes. Siempre que se use el mismo sessionId, se realizará un intento de mejor esfuerzo para tener como destino el mismo conjunto de réplicas. Tenga cuidado de que reutilizar los mismos valores sessionID repetidamente puede interferir con el equilibrio de carga de las solicitudes entre réplicas y afectar negativamente al rendimiento del servicio de búsqueda. El valor usado como sessionId no puede comenzar con un carácter '_'. |
| skip |
integer (int32) |
Número de resultados de búsqueda que se van a omitir. Este valor no puede ser mayor que 100 000. Si necesita examinar documentos en secuencia, pero no puede usar omitir debido a esta limitación, considere la posibilidad de usar orderby en una clave totalmente ordenada y filtrar con una consulta de intervalo en su lugar. |
| speller |
Un valor que especifica el tipo de persona que escribe para corregir términos individuales de búsqueda en la escritura. |
|
| top |
integer (int32) |
Número de resultados de búsqueda que se van a recuperar. Esto se puede usar junto con $skip para implementar la paginación del lado cliente de los resultados de búsqueda. Si los resultados se truncan debido a la paginación del lado servidor, la respuesta incluirá un token de continuación que se puede usar para emitir otra solicitud de búsqueda para la página siguiente de resultados. |
| vectorFilterMode |
Determina si los filtros se aplican o no antes o después de realizar la búsqueda vectorial. El valor predeterminado es 'preFilter' para los nuevos índices. |
|
| vectorQueries | VectorQuery[]: |
Los parámetros de consulta para las consultas de búsqueda híbrida y vectorial. |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK |
La solicitud se ha realizado correctamente. |
|
| Other Status Codes |
Correcto |
|
| Other Status Codes |
Una respuesta de error inesperada. |
Seguridad
api-key
Tipo:
apiKey
En:
header
OAuth2Auth
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Ámbitos
| Nombre | Description |
|---|---|
| https://search.azure.com/.default |
Ejemplos
|
Search |
|
Search |
|
Search |
SearchIndexSearchDocumentsPost
Solicitud de ejemplo
POST https://typespecpreviewexampleservice.search.windows.net/indexes('preview-test')/docs/search.post.search?api-version=2026-08-01-preview
{
"count": true,
"facets": [
"ownerId",
"price,metric:sum,default:10"
],
"filter": "category eq 'purple' or category eq 'pink'",
"highlight": "category",
"highlightPostTag": "</em>",
"highlightPreTag": "</em>",
"minimumCoverage": 100,
"orderby": "",
"queryType": "semantic",
"scoringStatistics": "global",
"sessionId": "mysessionid",
"scoringParameters": [
"categoryTag:desiredCategoryValue"
],
"scoringProfile": "stringFieldBoost",
"debug": "vector",
"search": "purple",
"searchFields": "id,name,description,category,ownerId",
"searchMode": "any",
"queryLanguage": "en-us",
"speller": "lexicon",
"select": "id,name,description,category,ownerId",
"skip": 0,
"top": 10,
"semanticConfiguration": "testconfig",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 5000,
"semanticQuery": "find all purple",
"answers": "extractive",
"captions": "extractive",
"queryRewrites": "generative",
"semanticFields": "",
"vectorQueries": [
{
"k": 50,
"fields": "vector22, vector1b",
"oversampling": 20,
"weight": 1,
"threshold": {
"kind": "vectorSimilarity",
"value": 0.984
},
"filterOverride": "ownerId eq 'sam'",
"kind": "vector",
"vector": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
]
}
],
"vectorFilterMode": "preFilter",
"hybridSearch": {
"maxTextRecallSize": 100,
"countAndFacetMode": "countAllResults"
}
}
Respuesta de muestra
{
"@odata.count": 27,
"@search.coverage": 100,
"@search.facets": {
"ownerId": [
{
"count": 16,
"value": "sam"
},
{
"count": 8,
"value": "ryan"
},
{
"count": 3,
"value": "benny"
}
],
"price": [
{
"sum": 320
}
]
},
"@search.answers": [],
"value": [
{
"@search.score": 0.015625,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7178425788879395,
"@search.rerankerBoostedScore": 1.7178425788879395,
"@search.captions": [
{
"text": "test10 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 27.725889205932617
},
"vectors": [
{}
]
}
}
},
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.012820512987673283,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7107532024383545,
"@search.rerankerBoostedScore": 1.7107532024383545,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "empty-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011627906933426857,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7107532024383545,
"@search.rerankerBoostedScore": 1.7107532024383545,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "no-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011904762126505375,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6990556716918945,
"@search.rerankerBoostedScore": 1.6990556716918945,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6951565742492676,
"@search.rerankerBoostedScore": 1.6951565742492676,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.693029761314392,
"@search.rerankerBoostedScore": 1.693029761314392,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01666666753590107,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6909029483795166,
"@search.rerankerBoostedScore": 1.6909029483795166,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 39.23316955566406
},
"vectors": [
{}
]
}
}
},
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6777875423431396,
"@search.rerankerBoostedScore": 1.6777875423431396,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013888888992369175,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6650266647338867,
"@search.rerankerBoostedScore": 1.6650266647338867,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 23.01456642150879
},
"vectors": [
{}
]
}
}
},
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012658228166401386,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6607730388641357,
"@search.rerankerBoostedScore": 1.6607730388641357,
"@search.captions": [
{
"text": "test11 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "11",
"name": "test",
"description": "test11 hello",
"category": "purple",
"ownerId": "sam"
}
]
}{
"@odata.count": 27,
"@search.coverage": 100,
"@search.facets": {
"ownerId": [
{
"count": 16,
"value": "sam"
},
{
"count": 8,
"value": "ryan"
},
{
"count": 3,
"value": "benny"
}
],
"price": [
{
"sum": 320
}
]
},
"@search.answers": [],
"value": [
{
"@search.score": 0.015625,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7178425788879395,
"@search.rerankerBoostedScore": 1.7178425788879395,
"@search.captions": [
{
"text": "test10 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 27.725889205932617
},
"vectors": [
{}
]
}
}
},
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.012820512987673283,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7107532024383545,
"@search.rerankerBoostedScore": 1.7107532024383545,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "empty-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011627906933426857,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7107532024383545,
"@search.rerankerBoostedScore": 1.7107532024383545,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "no-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.011904762126505375,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6990556716918945,
"@search.rerankerBoostedScore": 1.6990556716918945,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6951565742492676,
"@search.rerankerBoostedScore": 1.6951565742492676,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.693029761314392,
"@search.rerankerBoostedScore": 1.693029761314392,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01666666753590107,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6909029483795166,
"@search.rerankerBoostedScore": 1.6909029483795166,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 39.23316955566406
},
"vectors": [
{}
]
}
}
},
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6777875423431396,
"@search.rerankerBoostedScore": 1.6777875423431396,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013888888992369175,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6650266647338867,
"@search.rerankerBoostedScore": 1.6650266647338867,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 23.01456642150879
},
"vectors": [
{}
]
}
}
},
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012658228166401386,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6607730388641357,
"@search.rerankerBoostedScore": 1.6607730388641357,
"@search.captions": [
{
"text": "test11 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 6.500757217407227
},
"vectors": [
{}
]
}
}
},
"id": "11",
"name": "test",
"description": "test11 hello",
"category": "purple",
"ownerId": "sam"
}
]
}SearchIndexSearchDocumentsPostOsV2
Solicitud de ejemplo
POST https://previewexampleservice.search.windows.net/indexes('preview-test')/docs/search.post.search?api-version=2026-08-01-preview
{
"count": true,
"facets": [
"ownerId",
"price,metric:sum,default:10"
],
"filter": "category eq 'purple' or category eq 'pink'",
"highlight": "category",
"highlightPostTag": "</em>",
"highlightPreTag": "</em>",
"minimumCoverage": 100,
"queryType": "semantic",
"scoringStatistics": "global",
"sessionId": "mysessionid",
"scoringParameters": [
"categoryTag:desiredCategoryValue"
],
"scoringProfile": "stringFieldBoost",
"debug": "vector",
"search": "purple",
"searchFields": "id,name,description,category,ownerId",
"searchMode": "any",
"queryLanguage": "en-us",
"speller": "lexicon",
"select": "id,name,description,category,ownerId",
"skip": 0,
"top": 10,
"semanticConfiguration": "testconfig",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 5000,
"semanticQuery": "find all purple",
"answers": "extractive",
"captions": "extractive",
"queryRewrites": "generative",
"vectorQueries": [
{
"vector": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
],
"kind": "vector",
"k": 50,
"fields": "vector22, vector1b",
"oversampling": 20,
"weight": 1,
"threshold": {
"value": 0.984,
"kind": "vectorSimilarity"
},
"filterOverride": "ownerId eq 'sam'"
}
],
"vectorFilterMode": "preFilter",
"hybridSearch": {
"maxTextRecallSize": 100,
"countAndFacetMode": "countAllResults"
}
}
Respuesta de muestra
{
"@odata.count": 27,
"@search.coverage": 100,
"@search.facets": {
"ownerId": [
{
"count": 16,
"value": "sam"
},
{
"count": 8,
"value": "ryan"
},
{
"count": 3,
"value": "benny"
}
],
"price": [
{
"sum": 320
}
]
},
"@search.answers": [],
"value": [
{
"@search.score": 0.012987012974917889,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7178425788879395,
"@search.rerankerBoostedScore": 1.7178425788879395,
"@search.captions": [
{
"text": "test10 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 15.319689750671387
},
"vectors": [
{}
]
}
}
},
"id": "10",
"name": "test",
"description": "test10 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.013333333656191826,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 18.800146102905273
},
"vectors": [
{}
]
}
}
},
"id": "no-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012195121496915817,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.7079174518585205,
"@search.rerankerBoostedScore": 1.7079174518585205,
"@search.captions": [
{
"text": "no vector.",
"highlights": "</em>no vector.</em>"
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 15.319689750671387
},
"vectors": [
{}
]
}
}
},
"id": "empty-vectors",
"name": "test",
"description": "no vector",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.012345679104328156,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6994102001190186,
"@search.rerankerBoostedScore": 1.6994102001190186,
"@search.captions": [
{
"text": "test4 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 15.319689750671387
},
"vectors": [
{}
]
}
}
},
"id": "4",
"name": "test",
"description": "test4 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.0117647061124444,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6937386989593506,
"@search.rerankerBoostedScore": 1.6937386989593506,
"@search.captions": [
{
"text": "test2 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 11.507283210754395
},
"vectors": [
{}
]
}
}
},
"id": "2",
"name": "test",
"description": "test2 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013698630034923553,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6923208236694336,
"@search.rerankerBoostedScore": 1.6923208236694336,
"@search.captions": [
{
"text": "test5 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 21.559860229492188
},
"vectors": [
{}
]
}
}
},
"id": "5",
"name": "test",
"description": "test5 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.013513513840734959,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.691611886024475,
"@search.rerankerBoostedScore": 1.691611886024475,
"@search.captions": [
{
"text": "test7 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 18.800146102905273
},
"vectors": [
{}
]
}
}
},
"id": "7",
"name": "test",
"description": "test7 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.01315789483487606,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6781420707702637,
"@search.rerankerBoostedScore": 1.6781420707702637,
"@search.captions": [
{
"text": "test0 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 15.319689750671387
},
"vectors": [
{}
]
}
}
},
"id": "0",
"name": "test",
"description": "test0 hello",
"category": "purple",
"ownerId": "benny"
},
{
"@search.score": 0.015625,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6653810739517212,
"@search.rerankerBoostedScore": 1.6653810739517212,
"@search.captions": [
{
"text": "test8 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 33.067142486572266
},
"vectors": [
{}
]
}
}
},
"id": "8",
"name": "test",
"description": "test8 hello",
"category": "purple",
"ownerId": "sam"
},
{
"@search.score": 0.016393441706895828,
"@search.highlights": {
"category": [
"</em>purple</em>"
]
},
"@search.rerankerScore": 1.6618363857269287,
"@search.rerankerBoostedScore": 1.6618363857269287,
"@search.captions": [
{
"text": "test11 hello.",
"highlights": ""
}
],
"@search.documentDebugInfo": {
"vectors": {
"subscores": {
"documentBoost": 1,
"text": {
"searchScore": 33.067142486572266
},
"vectors": [
{}
]
}
}
},
"id": "11",
"name": "test",
"description": "test11 hello",
"category": "purple",
"ownerId": "sam"
}
]
}{
"value": []
}SearchIndexSearchDocumentsSemanticPost
Solicitud de ejemplo
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2026-08-01-preview
{
"count": true,
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"queryType": "semantic",
"search": "how do clouds form",
"semanticConfiguration": "my-semantic-config",
"answers": "extractive|count-3",
"captions": "extractive|highlight-true",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 780
}
Respuesta de muestra
{
"@odata.count": 25,
"@search.answers": [
{
"key": "4123",
"text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case), but not where it is descending (over the river).",
"highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case), but not where it is<em> descending</em> (over the river).",
"score": 0.94639826
}
],
"@search.nextPageParameters": {
"count": true,
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"queryType": "semantic",
"search": "how do clouds form",
"semanticConfiguration": "my-semantic-config",
"answers": "extractive|count-3",
"captions": "extractive|highlight-true",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 780,
"skip": 2,
"top": 8
},
"value": [
{
"@search.score": 0.5479723,
"@search.rerankerScore": 1.0321671911515296,
"@search.captions": [
{
"text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
"highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
}
],
"id": "4123",
"title": "Earth Atmosphere",
"content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
"locations": [
"Pacific Northwest",
"North America",
"Vancouver"
]
}
],
"@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2025-05-01-preview"
}{
"@odata.count": 25,
"@search.answers": [
{
"key": "4123",
"text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case), but not where it is descending (over the river).",
"highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case), but not where it is<em> descending</em> (over the river).",
"score": 0.94639826
}
],
"@search.nextPageParameters": {
"count": true,
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"queryType": "semantic",
"search": "how do clouds form",
"semanticConfiguration": "my-semantic-config",
"answers": "extractive|count-3",
"captions": "extractive|highlight-true",
"semanticErrorHandling": "partial",
"semanticMaxWaitInMilliseconds": 780,
"skip": 2,
"top": 8
},
"value": [
{
"@search.score": 0.5479723,
"@search.rerankerScore": 1.0321671911515296,
"@search.captions": [
{
"text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
"highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
}
],
"id": "4123",
"title": "Earth Atmosphere",
"content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
"locations": [
"Pacific Northwest",
"North America",
"Vancouver"
]
}
],
"@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2025-05-01-preview"
}Definiciones
| Nombre | Description |
|---|---|
| Accept |
El encabezado Aceptar. |
|
Debug |
Contiene información de depuración que se puede usar para explorar aún más los resultados de la búsqueda. |
|
Document |
Contiene información de depuración que se puede usar para explorar aún más los resultados de la búsqueda. |
|
Error |
Información adicional sobre el error de administración de recursos. |
|
Error |
Detalle del error. |
|
Error |
Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData). |
|
Hybrid |
Determina si el recuento y las facetas deben incluir todos los documentos que coincidan con la consulta de búsqueda o solo los documentos que se recuperan dentro de la ventana "maxTextRecallSize". El valor predeterminado es 'countAllResults'. |
|
Hybrid |
Parámetros de consulta para configurar comportamientos de búsqueda híbrida. |
|
Query |
Una respuesta es un pasaje de texto extraído del contenido de los documentos más relevantes que coinciden con la consulta. Las respuestas se extraen de los resultados principales de la búsqueda. Los candidatos de respuesta se puntuan y se seleccionan las principales respuestas. |
|
Query |
Este parámetro solo es válido si el tipo de consulta es |
|
Query |
Los títulos son los pasajes más representativos del documento relativamente a la consulta de búsqueda. A menudo se usan como resumen de documentos. Los títulos solo se devuelven para las consultas de tipo |
|
Query |
Este parámetro solo es válido si el tipo de consulta es |
|
Query |
Habilita una herramienta de depuración que se puede usar para explorar más a fondo los resultados de la búsqueda. Puede habilitar varios modos de depuración simultáneamente separándolos con un | carácter, por ejemplo: semantic|queryRewrites. |
|
Query |
Idioma de la consulta. |
|
Query |
Cadenas concatenadas sin procesar que se enviaron al proceso de enriquecimiento semántico. |
|
Query |
Descripción de los campos que se enviaron al proceso de enriquecimiento semántico, así como cómo se usaron |
|
Query |
Desglose de las subscores entre los componentes de consulta de texto y vector de la consulta de búsqueda de este documento. Cada consulta vectorial se muestra como un objeto independiente en el mismo orden en que se recibieron. |
|
Query |
Contiene información de depuración específica de las reescrituras de consultas. |
|
Query |
Este parámetro solo es válido si el tipo de consulta es |
|
Query |
Contiene información de depuración específica de las reescrituras de consultas. |
|
Query |
Mejore la recuperación de búsqueda mediante la corrección ortográfica de términos de consulta de búsqueda individuales. |
|
Query |
Especifica la sintaxis de la consulta de búsqueda. El valor predeterminado es "simple". Use 'full' si su consulta usa la sintaxis de consulta de Lucene y 'semántica' si no se necesita la sintaxis de consulta. |
|
Scoring |
Valor que especifica si queremos calcular las estadísticas de puntuación (como la frecuencia del documento) globalmente para obtener una puntuación más coherente o localmente, para una menor latencia. El valor predeterminado es 'local'. Utilice "global" para agregar estadísticas de puntuación globalmente antes de puntuar. El uso de estadísticas de puntuación global puede aumentar la latencia de las consultas de búsqueda. |
|
Search |
Respuesta que contiene los resultados de búsqueda de un índice. |
|
Search |
Especifica si alguno o todos los términos de búsqueda deben coincidir para contar el documento como una coincidencia. |
|
Search |
Parámetros para filtrar, ordenar, facetar, paginar y otros comportamientos de consulta de búsqueda. |
|
Search |
Contiene un documento encontrado por una consulta de búsqueda, además de metadatos asociados. |
|
Search |
Los resultados de la consulta vectorial se filtrarán según el ' |
|
Semantic |
Contiene información de depuración específica de las solicitudes de clasificación semántica. |
|
Semantic |
Permite al usuario elegir si una llamada semántica falla completamente o devolver resultados parciales. |
|
Semantic |
Razón por la que se devolvió una respuesta parcial para una solicitud de clasificación semántica. |
|
Semantic |
La forma en que se utilizó el campo para el proceso de enriquecimiento semántico. |
|
Semantic |
Tipo de reescritura de consultas que se usó para esta solicitud. |
|
Semantic |
Tipo de respuesta parcial que se devolvió para una solicitud de clasificación semántica. |
|
Single |
Resultado de un campo de vector único. Ambas |
|
Text |
Puntuación bm25 o clásica para la parte de texto de la consulta. |
|
Vector |
Determina si los filtros se aplican o no antes o después de realizar la búsqueda vectorial. |
|
Vectorizable |
Los parámetros de consulta que se van a usar para la búsqueda vectorial cuando se proporciona un binario codificado en base 64 de una imagen que debe vectorizarse. |
|
Vectorizable |
Los parámetros de consulta que se van a usar para la búsqueda vectorial cuando se proporciona una dirección URL que representa un valor de imagen que debe vectorizarse. |
|
Vectorizable |
Los parámetros de consulta que se van a usar para la búsqueda vectorial cuando se proporciona un valor de texto que debe vectorizarse. |
|
Vectorized |
Parámetros de consulta que se usarán para la búsqueda vectorial cuando se proporciona un valor de vector sin formato. |
|
Vector |
El tipo de consulta vectorial que se está realizando. |
|
Vectors |
"Contiene información de depuración específica para búsqueda vectorial e híbrida.") |
|
Vector |
Los resultados de la consulta vectorial se filtrarán en función de la métrica de similitud de vectores. Tenga en cuenta que esta es la definición canónica de la métrica de similitud, no la versión de "distancia". La dirección del umbral (mayor o menor) se elegirá automáticamente según la métrica utilizada por el campo. |
|
Vector |
El tipo de umbral que se usa para filtrar consultas vectoriales. |
Accept
El encabezado Aceptar.
| Valor | Description |
|---|---|
| application/json;odata.metadata=none |
DebugInfo
Contiene información de depuración que se puede usar para explorar aún más los resultados de la búsqueda.
| Nombre | Tipo | Description |
|---|---|---|
| queryRewrites |
Contiene información de depuración específica de las reescrituras de consultas. |
DocumentDebugInfo
Contiene información de depuración que se puede usar para explorar aún más los resultados de la búsqueda.
| Nombre | Tipo | Description |
|---|---|---|
| innerHits |
object |
Contiene información de depuración específica de vectores coincidentes dentro de una colección de tipos complejos. |
| semantic |
Contiene información de depuración específica de las solicitudes de clasificación semántica. |
|
| vectors |
Contiene información de depuración específica del vector y la búsqueda híbrida. |
ErrorAdditionalInfo
Información adicional sobre el error de administración de recursos.
| Nombre | Tipo | Description |
|---|---|---|
| info |
Información adicional. |
|
| type |
string |
Tipo de información adicional. |
ErrorDetail
Detalle del error.
| Nombre | Tipo | Description |
|---|---|---|
| additionalInfo |
Información adicional del error. |
|
| code |
string |
Código de error. |
| details |
Detalles del error. |
|
| message |
string |
El mensaje de error. |
| target |
string |
Destino del error. |
ErrorResponse
Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).
| Nombre | Tipo | Description |
|---|---|---|
| error |
Objeto de error. |
HybridCountAndFacetMode
Determina si el recuento y las facetas deben incluir todos los documentos que coincidan con la consulta de búsqueda o solo los documentos que se recuperan dentro de la ventana "maxTextRecallSize". El valor predeterminado es 'countAllResults'.
| Valor | Description |
|---|---|
| countRetrievableResults |
Solo incluya documentos que coincidan dentro de la ventana de recuperación 'maxTextRecallSize' al calcular 'count' y 'facets'. |
| countAllResults |
Incluya todos los documentos que coincidió con la consulta de búsqueda al calcular "recuento" y "facetas", independientemente de si esos documentos están o no dentro de la ventana de recuperación "maxTextRecallSize". |
HybridSearch
Parámetros de consulta para configurar comportamientos de búsqueda híbrida.
| Nombre | Tipo | Description |
|---|---|---|
| countAndFacetMode |
Determina si el recuento y las facetas deben incluir todos los documentos que coincidan con la consulta de búsqueda o solo los documentos que se recuperan dentro de la ventana "maxTextRecallSize". |
|
| maxTextRecallSize |
integer (int32) |
Determina el número máximo de documentos que debe recuperar la parte de consulta de texto de una solicitud de búsqueda híbrida. Esos documentos se combinarán con los documentos que coincidan con las consultas vectoriales para producir una única lista final de resultados. La elección de un valor maxTextRecallSize mayor permitirá recuperar y paginar más documentos (mediante los parámetros top y skip), a costa de una mayor utilización de recursos y una mayor latencia. El valor debe estar entre 1 y 10.000. El valor predeterminado es 1000. |
QueryAnswerResult
Una respuesta es un pasaje de texto extraído del contenido de los documentos más relevantes que coinciden con la consulta. Las respuestas se extraen de los resultados principales de la búsqueda. Los candidatos de respuesta se puntuan y se seleccionan las principales respuestas.
| Nombre | Tipo | Description |
|---|---|---|
| highlights |
string |
Mismo pasaje de texto que en la propiedad Text con frases de texto resaltadas más relevantes para la consulta. |
| key |
string |
Clave del documento del que se extrajo la respuesta. |
| score |
number (double) |
El valor de puntuación representa la importancia de la respuesta a la consulta en relación con otras respuestas devueltas para la consulta. |
| text |
string |
El pasaje de texto extraído del contenido del documento como respuesta. |
QueryAnswerType
Este parámetro solo es válido si el tipo de consulta es semantic. Si se establece, la consulta devuelve respuestas extraídas de los pasajes clave de los documentos clasificados más altos. El número de respuestas devueltas se puede configurar agregando el carácter | de barra vertical seguido de la count-<number of answers> opción después del valor del parámetro de respuestas, como extractive|count-3. El recuento predeterminado es 1. El umbral de confianza se puede configurar anexando el carácter | de barra vertical seguido de la threshold-<confidence threshold> opción después del valor del parámetro de respuestas, como extractive|threshold-0.9. El umbral predeterminado es 0,7. La longitud máxima de caracteres de las respuestas se puede configurar agregando el carácter de barra vertical '|' seguido del 'count-number< de longitud máxima de caracteres>', como 'extractive|maxcharlength-600'.
| Valor | Description |
|---|---|
| none |
No devuelva respuestas para la consulta. |
| extractive |
Extrae candidatos de respuesta del contenido de los documentos devueltos en respuesta a una consulta expresada como una pregunta en lenguaje natural. |
QueryCaptionResult
Los títulos son los pasajes más representativos del documento relativamente a la consulta de búsqueda. A menudo se usan como resumen de documentos. Los títulos solo se devuelven para las consultas de tipo semantic.
| Nombre | Tipo | Description |
|---|---|---|
| highlights |
string |
Mismo pasaje de texto que en la propiedad Text con frases resaltadas más relevantes para la consulta. |
| text |
string |
Un pasaje de texto representativo extraído del documento más relevante para la consulta de búsqueda. |
QueryCaptionType
Este parámetro solo es válido si el tipo de consulta es semantic. Si se establece, la consulta devuelve títulos extraídos de los pasajes clave de los documentos clasificados más altos. Cuando Subtítulos se establece en extractive, el resaltado está habilitado de forma predeterminada y se puede configurar agregando el carácter | de barra vertical seguido de la highlight-<true/false> opción, como extractive|highlight-true. Tiene como valor predeterminado None. La longitud máxima de caracteres de los subtítulos se puede configurar agregando el carácter de barra vertical '|' seguido del 'count-number< de longitud máxima de caracteres>', como 'extractive|maxcharlength-600'.
| Valor | Description |
|---|---|
| none |
No devuelva subtítulos para la consulta. |
| extractive |
Extrae títulos de los documentos coincidentes que contienen pasajes relevantes para la consulta de búsqueda. |
QueryDebugMode
Habilita una herramienta de depuración que se puede usar para explorar más a fondo los resultados de la búsqueda. Puede habilitar varios modos de depuración simultáneamente separándolos con un | carácter, por ejemplo: semantic|queryRewrites.
| Valor | Description |
|---|---|
| disabled |
No se devolverá información de depuración de consultas. |
| semantic |
Permite al usuario explorar aún más sus resultados reranked. |
| vector |
Permite al usuario explorar aún más los resultados de la consulta híbrida y vectorial. |
| queryRewrites |
Permite al usuario explorar la lista de reescrituras de consultas generadas para su solicitud de búsqueda. |
| innerHits |
Permite al usuario recuperar información de puntuación sobre vectores coincidentes dentro de una colección de tipos complejos. |
| all |
Active todas las opciones de depuración. |
QueryLanguage
Idioma de la consulta.
| Valor | Description |
|---|---|
| none |
Idioma de consulta no especificado. |
| en-us |
Consulta el valor del idioma para inglés (Estados Unidos). |
| en-gb |
Valor de idioma de consulta para inglés (Gran Bretaña). |
| en-in |
Valor de idioma de consulta para inglés (India). |
| en-ca |
Valor de idioma de consulta para inglés (Canadá). |
| en-au |
Valor de idioma de consulta para inglés (Australia). |
| fr-fr |
Valor de idioma de consulta para francés (Francia). |
| fr-ca |
Valor de idioma de consulta para francés (Canadá). |
| de-de |
Valor de idioma de consulta para alemán (Alemania). |
| es-es |
Valor del idioma de consulta para español (España). |
| es-mx |
Valor del idioma de consulta para español (México). |
| zh-cn |
Valor de idioma de consulta para chino (China). |
| zh-tw |
Valor de idioma de consulta para chino (Taiwán). |
| pt-br |
Valor de idioma de consulta para portugués (Brasil). |
| pt-pt |
Valor del idioma de consulta para portugués (Portugal). |
| it-it |
Valor de idioma de consulta para italiano (Italia). |
| ja-jp |
Valor del idioma de consulta para japonés (Japón). |
| ko-kr |
Valor de idioma de consulta para coreano (Corea). |
| ru-ru |
Valor de idioma de consulta para ruso (Rusia). |
| cs-cz |
Valor de idioma de consulta para checo (República Checa). |
| nl-be |
Valor del idioma de consulta para el neerlandés (Bélgica). |
| nl-nl |
Valor del idioma de consulta para el neerlandés (Países Bajos). |
| hu-hu |
Valor de idioma de consulta para húngaro (Hungría). |
| pl-pl |
Valor de idioma de consulta para Polaco (Polonia). |
| sv-se |
Valor del idioma de consulta para sueco (Suecia). |
| tr-tr |
Valor de idioma de consulta para turco (Turquía). |
| hi-in |
Valor del idioma de consulta para el hindi (India). |
| ar-sa |
Valor de idioma de consulta para árabe (Arabia Saudita). |
| ar-eg |
Valor de idioma de consulta para árabe (Egipto). |
| ar-ma |
Valor de idioma de consulta para árabe (Marruecos). |
| ar-kw |
Valor de idioma de consulta para árabe (Kuwait). |
| ar-jo |
Valor de idioma de consulta para árabe (Jordania). |
| da-dk |
Valor del idioma de consulta para danés (Dinamarca). |
| no-no |
Valor de idioma de consulta para noruego (Noruega). |
| bg-bg |
Valor de idioma de consulta para búlgaro (Bulgaria). |
| hr-hr |
Valor de idioma de consulta para croata (Croacia). |
| hr-ba |
Valor de idioma de consulta para croata (Bosnia y Herzegovina). |
| ms-my |
Valor del idioma de consulta para Malayo (Malasia). |
| ms-bn |
Valor del idioma de consulta para malayo (Brunei Darussalam). |
| sl-sl |
Valor del idioma de consulta para el esloveno (Eslovenia). |
| ta-in |
Valor del idioma de consulta para tamil (India). |
| vi-vn |
Valor de idioma de consulta para vietnamita (Vietnam). |
| el-gr |
Valor de idioma de consulta para griego (Grecia). |
| ro-ro |
Valor de idioma de consulta para rumano (Rumanía). |
| is-is |
Valor del idioma de consulta para islandés (Islandia). |
| id-id |
Valor de idioma de consulta para indonesio (Indonesia). |
| th-th |
Valor de idioma de consulta para tailandés (Tailandia). |
| lt-lt |
Valor de idioma de consulta para lituano (Lituania). |
| uk-ua |
Valor de idioma de consulta para ucraniano (Ucrania). |
| lv-lv |
Valor de idioma de consulta para letón (Letonia). |
| et-ee |
Valor del idioma de consulta para estonio (Estonia). |
| ca-es |
Valor de idioma de consulta para catalán. |
| fi-fi |
Valor del idioma de consulta para finlandés (Finlandia). |
| sr-ba |
Valor de idioma de consulta para serbio (Bosnia y Herzegovina). |
| sr-me |
Valor de idioma de consulta para serbio (Montenegro). |
| sr-rs |
Valor de idioma de consulta para serbio (Serbia). |
| sk-sk |
Valor de idioma de consulta para Eslovaco (Eslovaquia). |
| nb-no |
Valor de idioma de consulta para noruego (Noruega). |
| hy-am |
Valor de idioma de consulta para armenio (Armenia). |
| bn-in |
Valor de idioma de consulta para bengalí (India). |
| eu-es |
Valor de idioma de consulta para euskera. |
| gl-es |
Valor de idioma de consulta para gallego. |
| gu-in |
Valor del idioma de consulta para Gujarati (India). |
| he-il |
Valor de idioma de consulta para hebreo (Israel). |
| ga-ie |
Valor de idioma de consulta para irlandés (Irlanda). |
| kn-in |
Valor del idioma de consulta para Kannada (India). |
| ml-in |
Valor del idioma de consulta para malayalam (India). |
| mr-in |
Valor del idioma de consulta para Marathi (India). |
| fa-ae |
Valor del idioma de consulta para el persa (Emiratos Árabes Unidos). |
| pa-in |
Valor de idioma de consulta para Punjabi (India). |
| te-in |
Valor del idioma de consulta para Telugu (India). |
| ur-pk |
Valor de idioma de consulta para urdu (Pakistán). |
QueryResultDocumentRerankerInput
Cadenas concatenadas sin procesar que se enviaron al proceso de enriquecimiento semántico.
| Nombre | Tipo | Description |
|---|---|---|
| content |
string |
Las cadenas concatenadas sin procesar para los campos de contenido que se usaron para el enriquecimiento semántico. |
| keywords |
string |
Las cadenas concatenadas sin procesar para los campos de palabras clave que se usaron para el enriquecimiento semántico. |
| title |
string |
Cadena sin formato para el campo de título que se usó para el enriquecimiento semántico. |
QueryResultDocumentSemanticField
Descripción de los campos que se enviaron al proceso de enriquecimiento semántico, así como cómo se usaron
| Nombre | Tipo | Description |
|---|---|---|
| name |
string |
Nombre del campo que se envió al proceso de enriquecimiento semántico |
| state |
La forma en que se usó el campo para el proceso de enriquecimiento semántico (totalmente usado, parcialmente usado o no utilizado) |
QueryResultDocumentSubscores
Desglose de las subscores entre los componentes de consulta de texto y vector de la consulta de búsqueda de este documento. Cada consulta vectorial se muestra como un objeto independiente en el mismo orden en que se recibieron.
| Nombre | Tipo | Description |
|---|---|---|
| documentBoost |
number (double) |
Puntuación bm25 o clásica para la parte de texto de la consulta. |
| text |
Puntuación bm25 o clásica para la parte de texto de la consulta. |
|
| vectors |
<string,
Single |
La similitud vectorial y |
QueryRewritesDebugInfo
Contiene información de depuración específica de las reescrituras de consultas.
| Nombre | Tipo | Description |
|---|---|---|
| text |
Lista de reescrituras de consultas generadas para la consulta de texto. |
|
| vectors |
Lista de reescrituras de consulta generadas para las consultas de texto vectorizables. |
QueryRewritesType
Este parámetro solo es válido si el tipo de consulta es semantic. Cuando QueryRewrites se establece en generative, los términos de consulta se envían a un modelo de generación que generará 10 reescrituras (predeterminadas) para ayudar a aumentar la recuperación de la solicitud. El recuento solicitado se puede configurar anexando el carácter | de barra vertical seguido de la count-<number of rewrites> opción, como generative|count-3. Tiene como valor predeterminado None.
| Valor | Description |
|---|---|
| none |
No genere reescrituras de consultas adicionales para esta consulta. |
| generative |
Genere términos de consulta alternativos para aumentar la recuperación de una solicitud de búsqueda. |
QueryRewritesValuesDebugInfo
Contiene información de depuración específica de las reescrituras de consultas.
| Nombre | Tipo | Description |
|---|---|---|
| inputQuery |
string |
El texto de entrada del modelo de reescritura de consultas generativas. Puede haber casos en los que la consulta del usuario y la entrada al modelo generativo no sean idénticas. |
| rewrites |
string[] |
Lista de reescrituras de consultas. |
QuerySpellerType
Mejore la recuperación de búsqueda mediante la corrección ortográfica de términos de consulta de búsqueda individuales.
| Valor | Description |
|---|---|
| none |
Corrector ortográfico no habilitado. |
| lexicon |
El corrector ortográfico corrige términos de consulta individuales mediante un léxico estático para el idioma especificado por el parámetro queryLanguage. |
QueryType
Especifica la sintaxis de la consulta de búsqueda. El valor predeterminado es "simple". Use 'full' si su consulta usa la sintaxis de consulta de Lucene y 'semántica' si no se necesita la sintaxis de consulta.
| Valor | Description |
|---|---|
| simple |
Usa la sintaxis de consulta simple para las búsquedas. El texto de búsqueda se interpreta utilizando un lenguaje de consulta simple que permite símbolos como +, * y "". Las consultas se evalúan en todos los campos que se pueden buscar de forma predeterminada, a menos que se especifique el parámetro searchFields. |
| full |
Utiliza la sintaxis de consulta completa de Lucene para las búsquedas. El texto de búsqueda se interpreta utilizando el lenguaje de consulta Lucene que permite búsquedas ponderadas y específicas de campo, así como otras funciones avanzadas. |
| semantic |
Más adecuado para consultas expresadas en lenguaje natural en lugar de palabras clave. Mejora la precisión de los resultados de búsqueda al volver a clasificar los principales resultados de búsqueda mediante un modelo de clasificación entrenado en el corpus web. |
ScoringStatistics
Valor que especifica si queremos calcular las estadísticas de puntuación (como la frecuencia del documento) globalmente para obtener una puntuación más coherente o localmente, para una menor latencia. El valor predeterminado es 'local'. Utilice "global" para agregar estadísticas de puntuación globalmente antes de puntuar. El uso de estadísticas de puntuación global puede aumentar la latencia de las consultas de búsqueda.
| Valor | Description |
|---|---|
| local |
Las estadísticas de puntuación se calcularán localmente para una latencia más baja. |
| global |
Las estadísticas de puntuación se calcularán globalmente para una puntuación más consistente. |
SearchDocumentsResult
Respuesta que contiene los resultados de búsqueda de un índice.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.count |
integer (int64) |
Recuento total de resultados encontrados por la operación de búsqueda o null si no se solicitó el recuento. Si está presente, el recuento puede ser mayor que el número de resultados en esta respuesta. Esto puede suceder si usa los parámetros $top o $skip, o si la consulta no puede devolver todos los documentos solicitados en una sola respuesta. |
| @odata.nextLink |
string |
Dirección URL de continuación devuelta cuando la consulta no puede devolver todos los resultados solicitados en una sola respuesta. Puede utilizar esta URL para formular otra solicitud de búsqueda GET o POST para obtener la siguiente parte de la respuesta de búsqueda. Asegúrese de usar el mismo verbo (GET o POST) que la solicitud que produjo esta respuesta. |
| @search.answers |
Resultados de la consulta de respuestas para la operación de búsqueda; null si no se especificó el parámetro de consulta de respuestas o se estableció en "none". |
|
| @search.coverage |
number (double) |
Valor que indica el porcentaje del índice que se incluyó en la consulta, o null si no se especificó minimumCoverage en la solicitud. |
| @search.debug |
Depurar información que se aplica a los resultados de búsqueda en su conjunto. |
|
| @search.facets |
object |
Los resultados de la consulta de faceta para la operación de búsqueda, organizados como una colección de cubos para cada campo con facetas; null si la consulta no incluye ninguna expresión de faceta. |
| @search.nextPageParameters |
Continuación de la carga JSON que se devuelve cuando la consulta no puede devolver todos los resultados solicitados en una sola respuesta. Puedes usar este JSON junto con |
|
| @search.semanticPartialResponseReason |
Razón por la que se devolvió una respuesta parcial para una solicitud de clasificación semántica. |
|
| @search.semanticPartialResponseType |
Tipo de respuesta parcial que se devolvió para una solicitud de clasificación semántica. |
|
| @search.semanticQueryRewritesResultType |
Tipo de reescritura de consulta que se usó para recuperar documentos. |
|
| value |
Secuencia de resultados devueltos por la consulta. |
SearchMode
Especifica si alguno o todos los términos de búsqueda deben coincidir para contar el documento como una coincidencia.
| Valor | Description |
|---|---|
| any |
Cualquiera de los términos de búsqueda debe coincidir para contar el documento como una coincidencia. |
| all |
Todos los términos de búsqueda deben coincidir para contar el documento como una coincidencia. |
SearchRequest
Parámetros para filtrar, ordenar, facetar, paginar y otros comportamientos de consulta de búsqueda.
| Nombre | Tipo | Description |
|---|---|---|
| answers |
Valor que especifica si las respuestas se deben devolver como parte de la respuesta de búsqueda. |
|
| captions |
Valor que especifica si se deben devolver títulos como parte de la respuesta de búsqueda. |
|
| count |
boolean |
Valor que especifica si se va a capturar el recuento total de resultados. El valor predeterminado es falso. Establecer este valor en true puede tener un impacto en el rendimiento. Tenga en cuenta que el recuento devuelto es una aproximación. |
| debug |
Habilita una herramienta de depuración que se puede usar para explorar más a fondo los resultados reclasificados. |
|
| facets |
string[] |
Lista de expresiones de faceta que se van a aplicar a la consulta de búsqueda. Cada expresión de faceta contiene un nombre de campo, seguido opcionalmente de una lista separada por comas de pares nombre:valor. |
| filter |
string |
Expresión de $filter de OData que se va a aplicar a la consulta de búsqueda. |
| highlight |
string |
Lista separada por comas de nombres de campo que se usarán para los resaltados de aciertos. Solo se pueden usar campos que se pueden buscar para el resaltado de aciertos. |
| highlightPostTag |
string |
Etiqueta de cadena que se anexa a los resaltados de aciertos. Debe establecerse con highlightPreTag. El valor predeterminado es </em>. |
| highlightPreTag |
string |
Etiqueta de cadena que se antepone para alcanzar los resaltados. Debe establecerse con highlightPostTag. El valor predeterminado es <em>. |
| hybridSearch |
Parámetros de consulta para configurar comportamientos de búsqueda híbrida. |
|
| minimumCoverage |
number (double) |
Número comprendido entre 0 y 100 que indica el porcentaje del índice que debe estar cubierto por una consulta de búsqueda para que la consulta se notifique como correcta. Este parámetro puede ser útil para garantizar la disponibilidad de búsqueda incluso para los servicios con una sola réplica. El valor predeterminado es 100. |
| orderby |
string |
La lista separada por comas de OData $orderby expresiones por las que ordenar los resultados. Cada expresión puede ser un nombre de campo o una llamada a las funciones geo.distance() o search.score(). Cada expresión puede ir seguida de asc para indicar ascendente o desc para indicar descendente. El valor predeterminado es orden ascendente. Los empates se romperán con las puntuaciones de coincidencia de documentos. Si no se especifica ningún $orderby, el criterio de ordenación predeterminado es descendente por puntuación de coincidencia de documento. Puede haber como máximo 32 $orderby cláusulas. |
| queryLanguage |
Valor que especifica el idioma de la consulta de búsqueda. |
|
| queryRewrites |
Valor que especifica si se deben generar reescrituras de consulta para aumentar la consulta de búsqueda. |
|
| queryType |
Valor que especifica la sintaxis de la consulta de búsqueda. El valor predeterminado es "simple". Use "full" si la consulta usa la sintaxis de consulta de Lucene. |
|
| scoringParameters |
string[] |
La lista de valores de parámetro que se van a usar en las funciones de puntuación (por ejemplo, referencePointParameter) mediante el formato name-values. Por ejemplo, si el perfil de puntuación define una función con un parámetro denominado "mylocation", la cadena de parámetro sería "mylocation--122.2,44.8" (sin las comillas). |
| scoringProfile |
string |
Nombre de un perfil de puntuación para evaluar las puntuaciones de coincidencia para los documentos coincidentes con el fin de ordenar los resultados. |
| scoringStatistics |
Valor que especifica si queremos calcular las estadísticas de puntuación (como la frecuencia del documento) globalmente para obtener una puntuación más coherente o localmente, para una menor latencia. El valor predeterminado es 'local'. Utilice "global" para agregar estadísticas de puntuación globalmente antes de puntuar. El uso de estadísticas de puntuación global puede aumentar la latencia de las consultas de búsqueda. |
|
| search |
string |
Una expresión de consulta de búsqueda de texto completo; Utilice "*" u omita este parámetro para que coincida con todos los documentos. |
| searchFields |
string |
Lista separada por comas de nombres de campo a los que se va a definir el ámbito de la búsqueda de texto completo. Cuando se usa la búsqueda por campos (fieldName:searchExpression) en una consulta completa de Lucene, los nombres de campo de cada expresión de búsqueda con campos tienen prioridad sobre los nombres de campo enumerados en este parámetro. |
| searchMode |
Valor que especifica si alguno o todos los términos de búsqueda deben coincidir para contar el documento como una coincidencia. |
|
| select |
string |
La lista separada por comas de campos que se van a recuperar. Si no se especifica, se incluyen todos los campos marcados como recuperables en el esquema. |
| semanticConfiguration |
string |
Nombre de una configuración semántica que se usará al procesar documentos para consultas de tipo semántico. |
| semanticErrorHandling |
Permite al usuario elegir si una llamada semántica debe fallar por completo (comportamiento predeterminado / actual) o devolver resultados parciales. |
|
| semanticFields |
string |
La lista separada por comas de nombres de campo utilizados para la clasificación semántica. |
| semanticMaxWaitInMilliseconds |
integer (int32) minimum: 700 |
Permite al usuario establecer un límite superior en la cantidad de tiempo que tarda el enriquecimiento semántico en finalizar el procesamiento antes de que se produzca un error en la solicitud. |
| semanticQuery |
string |
Permite establecer una consulta de búsqueda independiente que se usará únicamente para el reranking semántico, los subtítulos semánticos y las respuestas semánticas. Resulta útil para escenarios en los que es necesario usar consultas diferentes entre la fase de recuperación y clasificación base y la fase semántica L2. |
| sessionId |
string |
Un valor que se utilizará para crear una sesión fija, que puede ayudar a obtener resultados más consistentes. Siempre que se use el mismo sessionId, se realizará un intento de mejor esfuerzo para tener como destino el mismo conjunto de réplicas. Tenga cuidado de que reutilizar los mismos valores sessionID repetidamente puede interferir con el equilibrio de carga de las solicitudes entre réplicas y afectar negativamente al rendimiento del servicio de búsqueda. El valor usado como sessionId no puede comenzar con un carácter '_'. |
| skip |
integer (int32) |
Número de resultados de búsqueda que se van a omitir. Este valor no puede ser mayor que 100 000. Si necesita examinar documentos en secuencia, pero no puede usar omitir debido a esta limitación, considere la posibilidad de usar orderby en una clave totalmente ordenada y filtrar con una consulta de intervalo en su lugar. |
| speller |
Un valor que especifica el tipo de persona que escribe para corregir términos individuales de búsqueda en la escritura. |
|
| top |
integer (int32) |
Número de resultados de búsqueda que se van a recuperar. Esto se puede usar junto con $skip para implementar la paginación del lado cliente de los resultados de búsqueda. Si los resultados se truncan debido a la paginación del lado servidor, la respuesta incluirá un token de continuación que se puede usar para emitir otra solicitud de búsqueda para la página siguiente de resultados. |
| vectorFilterMode |
Determina si los filtros se aplican o no antes o después de realizar la búsqueda vectorial. El valor predeterminado es 'preFilter' para los nuevos índices. |
|
| vectorQueries | VectorQuery[]: |
Los parámetros de consulta para las consultas de búsqueda híbrida y vectorial. |
SearchResult
Contiene un documento encontrado por una consulta de búsqueda, además de metadatos asociados.
| Nombre | Tipo | Description |
|---|---|---|
| @search.captions |
Los títulos son los pasajes más representativos del documento relativamente a la consulta de búsqueda. A menudo se usan como resumen de documentos. Los subtítulos solo se devuelven para consultas de tipo 'semántica'. |
|
| @search.documentDebugInfo |
Contiene información de depuración que se puede usar para explorar aún más los resultados de la búsqueda. |
|
| @search.highlights |
object |
Fragmentos de texto del documento que indican los términos de búsqueda coincidentes, organizados por cada campo aplicable; null si el resaltado de visitas no estaba habilitado para la consulta. |
| @search.rerankerBoostedScore |
number (double) |
La puntuación de relevancia calculada aumentando la puntuación de Reranker. Los resultados de búsqueda se ordenan por RerankerScore/RerankerBoostedScore según useScoringProfileBoostedRanking en la Configuración Semántica. RerankerBoostedScore solo se devuelve para consultas de tipo 'semántica'. |
| @search.rerankerScore |
number (double) |
La puntuación de relevancia calculada por el clasificador semántico para los principales resultados de búsqueda. Los resultados de la búsqueda se ordenan primero por RerankerScore y luego por Score. RerankerScore solo se devuelve para consultas de tipo 'semántica'. |
| @search.score |
number (double) |
La puntuación de relevancia del documento en comparación con otros documentos devueltos por la consulta. |
SearchScoreThreshold
Los resultados de la consulta vectorial se filtrarán según el '
| Nombre | Tipo | Description |
|---|---|---|
| kind |
string:
search |
Tipo de umbral. |
| value |
number (double) |
El umbral se filtrará según el ' |
SemanticDebugInfo
Contiene información de depuración específica de las solicitudes de clasificación semántica.
| Nombre | Tipo | Description |
|---|---|---|
| contentFields |
Los campos de contenido que se enviaron al proceso de enriquecimiento semántico, así como la forma en que se usaron |
|
| keywordFields |
Los campos de palabras clave que se enviaron al proceso de enriquecimiento semántico, así como la forma en que se usaron |
|
| rerankerInput |
Cadenas concatenadas sin procesar que se enviaron al proceso de enriquecimiento semántico. |
|
| titleField |
El campo de título que se envió al proceso de enriquecimiento semántico, así como la forma en que se usó |
SemanticErrorMode
Permite al usuario elegir si una llamada semántica falla completamente o devolver resultados parciales.
| Valor | Description |
|---|---|
| partial |
Si se produce un error en el procesamiento semántico, los resultados parciales siguen devolviendo. La definición de resultados parciales depende del error del paso semántico y del motivo del error. |
| fail |
Si hay una excepción durante el paso de procesamiento semántico, se producirá un error en la consulta y se devolverá el código HTTP adecuado en función del error. |
SemanticErrorReason
Razón por la que se devolvió una respuesta parcial para una solicitud de clasificación semántica.
| Valor | Description |
|---|---|
| maxWaitExceeded |
Si |
| capacityOverloaded |
La solicitud se limitó. Solo se devolvieron los resultados base. |
| transient |
Error al menos en un paso del proceso semántico. |
SemanticFieldState
La forma en que se utilizó el campo para el proceso de enriquecimiento semántico.
| Valor | Description |
|---|---|
| used |
El campo se utilizó completamente para el enriquecimiento semántico. |
| unused |
El campo no se usó para el enriquecimiento semántico. |
| partial |
El campo se utilizó parcialmente para el enriquecimiento semántico. |
SemanticQueryRewritesResultType
Tipo de reescritura de consultas que se usó para esta solicitud.
| Valor | Description |
|---|---|
| originalQueryOnly |
Las reescrituras de consultas no se generaron correctamente para esta solicitud. Solo se usó la consulta original para recuperar los resultados. |
SemanticSearchResultsType
Tipo de respuesta parcial que se devolvió para una solicitud de clasificación semántica.
| Valor | Description |
|---|---|
| baseResults |
Resultados sin enriquecimiento semántico ni reeranking. |
| rerankedResults |
Los resultados se han vuelto a cambiar con el modelo de reranker y incluirán subtítulos semánticos. No incluirán respuestas, resaltados de respuestas ni resaltados de subtítulos. |
SingleVectorFieldResult
Resultado de un campo de vector único. Ambas
| Nombre | Tipo | Description |
|---|---|---|
| searchScore |
number (double) |
El |
| vectorSimilarity |
number (double) |
La puntuación de similitud vectorial para este documento. Tenga en cuenta que esta es la definición canónica de la métrica de similitud, no la versión de "distancia". Por ejemplo, similitud de coseno en lugar de distancia de coseno. |
TextResult
Puntuación bm25 o clásica para la parte de texto de la consulta.
| Nombre | Tipo | Description |
|---|---|---|
| searchScore |
number (double) |
Puntuación bm25 o clásica para la parte de texto de la consulta. |
VectorFilterMode
Determina si los filtros se aplican o no antes o después de realizar la búsqueda vectorial.
| Valor | Description |
|---|---|
| postFilter |
El filtro se aplicará después de que se devuelva el conjunto candidato de resultados vectoriales. Dependiendo de la selectividad del filtro, esto puede dar lugar a menos resultados de los solicitados por el parámetro 'k'. |
| preFilter |
El filtro se aplicará antes de la consulta de búsqueda. |
| strictPostFilter |
El filtro se aplicará después de que se devuelva el conjunto global de resultados vectoriales de k candidatos. Esto dará como resultado menos resultados que los solicitados por el parámetro 'k'. |
VectorizableImageBinaryQuery
Los parámetros de consulta que se van a usar para la búsqueda vectorial cuando se proporciona un binario codificado en base 64 de una imagen que debe vectorizarse.
| Nombre | Tipo | Description |
|---|---|---|
| base64Image |
string |
El binario codificado en base 64 de una imagen que se va a vectorizar para realizar una consulta de búsqueda vectorial. |
| exhaustive |
boolean |
Cuando es true, desencadena una búsqueda de vecino k-más cercana exhaustiva en todos los vectores del índice de vectores. Resulta útil para escenarios en los que las coincidencias exactas son críticas, como determinar los valores de verdad del suelo. |
| fields |
string |
Campos vectoriales de tipo Collection(Edm.Single) que se van a incluir en el vector buscado. |
| filterOverride |
string |
Expresión de filtro de OData que se va a aplicar a esta consulta vectorial específica. Si no se define ninguna expresión de filtro en el nivel de vector, la expresión definida en el parámetro de filtro de nivel superior se usa en su lugar. |
| k |
integer (int32) |
Número de vecinos más cercanos para devolver como top hits. |
| kind |
string:
image |
Tipo de consulta. |
| oversampling |
number (double) |
Factor de sobremuestreo. El valor mínimo es 1. Reemplaza el parámetro "defaultOversampling" configurado en la definición de índice. Solo se puede establecer cuando "rerankWithOriginalVectors" es true. Este parámetro solo se permite cuando se usa un método de compresión en el campo vectorial subyacente. |
| perDocumentVectorLimit |
integer (int32) |
Controla cuántos vectores se pueden hacer coincidir de cada documento en una consulta de búsqueda de vectores. Establecerlo en 1 asegura que se coincida como máximo un vector por documento, lo que garantiza que los resultados provengan de documentos distintos. Establecerlo en 0 (ilimitado) permite que se coincidan varios vectores relevantes del mismo documento. El valor predeterminado es 0. |
| threshold | VectorThreshold: |
Umbral usado para las consultas vectoriales. Tenga en cuenta que esto solo se puede establecer si todos los campos usan la misma métrica de similitud. |
| weight |
number (float) |
Peso relativo de la consulta vectorial en comparación con otra consulta vectorial o la consulta de texto dentro de la misma solicitud de búsqueda. Este valor se usa al combinar los resultados de varias listas de clasificación generadas por las diferentes consultas vectoriales o los resultados recuperados a través de la consulta de texto. Cuanto mayor sea el peso, más alto serán los documentos que coincidan con esa consulta en la clasificación final. El valor predeterminado es 1,0 y el valor debe ser un número positivo mayor que cero. |
VectorizableImageUrlQuery
Los parámetros de consulta que se van a usar para la búsqueda vectorial cuando se proporciona una dirección URL que representa un valor de imagen que debe vectorizarse.
| Nombre | Tipo | Description |
|---|---|---|
| exhaustive |
boolean |
Cuando es true, desencadena una búsqueda de vecino k-más cercana exhaustiva en todos los vectores del índice de vectores. Resulta útil para escenarios en los que las coincidencias exactas son críticas, como determinar los valores de verdad del suelo. |
| fields |
string |
Campos vectoriales de tipo Collection(Edm.Single) que se van a incluir en el vector buscado. |
| filterOverride |
string |
Expresión de filtro de OData que se va a aplicar a esta consulta vectorial específica. Si no se define ninguna expresión de filtro en el nivel de vector, la expresión definida en el parámetro de filtro de nivel superior se usa en su lugar. |
| k |
integer (int32) |
Número de vecinos más cercanos para devolver como top hits. |
| kind |
string:
image |
Tipo de consulta. |
| oversampling |
number (double) |
Factor de sobremuestreo. El valor mínimo es 1. Reemplaza el parámetro "defaultOversampling" configurado en la definición de índice. Solo se puede establecer cuando "rerankWithOriginalVectors" es true. Este parámetro solo se permite cuando se usa un método de compresión en el campo vectorial subyacente. |
| perDocumentVectorLimit |
integer (int32) |
Controla cuántos vectores se pueden hacer coincidir de cada documento en una consulta de búsqueda de vectores. Establecerlo en 1 asegura que se coincida como máximo un vector por documento, lo que garantiza que los resultados provengan de documentos distintos. Establecerlo en 0 (ilimitado) permite que se coincidan varios vectores relevantes del mismo documento. El valor predeterminado es 0. |
| threshold | VectorThreshold: |
Umbral usado para las consultas vectoriales. Tenga en cuenta que esto solo se puede establecer si todos los campos usan la misma métrica de similitud. |
| url |
string |
Dirección URL de una imagen que se va a vectorizar para realizar una consulta de búsqueda vectorial. |
| weight |
number (float) |
Peso relativo de la consulta vectorial en comparación con otra consulta vectorial o la consulta de texto dentro de la misma solicitud de búsqueda. Este valor se usa al combinar los resultados de varias listas de clasificación generadas por las diferentes consultas vectoriales o los resultados recuperados a través de la consulta de texto. Cuanto mayor sea el peso, más alto serán los documentos que coincidan con esa consulta en la clasificación final. El valor predeterminado es 1,0 y el valor debe ser un número positivo mayor que cero. |
VectorizableTextQuery
Los parámetros de consulta que se van a usar para la búsqueda vectorial cuando se proporciona un valor de texto que debe vectorizarse.
| Nombre | Tipo | Description |
|---|---|---|
| exhaustive |
boolean |
Cuando es true, desencadena una búsqueda de vecino k-más cercana exhaustiva en todos los vectores del índice de vectores. Resulta útil para escenarios en los que las coincidencias exactas son críticas, como determinar los valores de verdad del suelo. |
| fields |
string |
Campos vectoriales de tipo Collection(Edm.Single) que se van a incluir en el vector buscado. |
| filterOverride |
string |
Expresión de filtro de OData que se va a aplicar a esta consulta vectorial específica. Si no se define ninguna expresión de filtro en el nivel de vector, la expresión definida en el parámetro de filtro de nivel superior se usa en su lugar. |
| k |
integer (int32) |
Número de vecinos más cercanos para devolver como top hits. |
| kind |
string:
text |
Tipo de consulta. |
| oversampling |
number (double) |
Factor de sobremuestreo. El valor mínimo es 1. Reemplaza el parámetro "defaultOversampling" configurado en la definición de índice. Solo se puede establecer cuando "rerankWithOriginalVectors" es true. Este parámetro solo se permite cuando se usa un método de compresión en el campo vectorial subyacente. |
| perDocumentVectorLimit |
integer (int32) |
Controla cuántos vectores se pueden hacer coincidir de cada documento en una consulta de búsqueda de vectores. Establecerlo en 1 asegura que se coincida como máximo un vector por documento, lo que garantiza que los resultados provengan de documentos distintos. Establecerlo en 0 (ilimitado) permite que se coincidan varios vectores relevantes del mismo documento. El valor predeterminado es 0. |
| queryRewrites |
Se puede configurar para permitir que un modelo generativo vuelva a escribir la consulta antes de enviarlo para que se vectorice. |
|
| text |
string |
Texto que se va a vectorizar para realizar una consulta de búsqueda vectorial. |
| threshold | VectorThreshold: |
Umbral usado para las consultas vectoriales. Tenga en cuenta que esto solo se puede establecer si todos los campos usan la misma métrica de similitud. |
| weight |
number (float) |
Peso relativo de la consulta vectorial en comparación con otra consulta vectorial o la consulta de texto dentro de la misma solicitud de búsqueda. Este valor se usa al combinar los resultados de varias listas de clasificación generadas por las diferentes consultas vectoriales o los resultados recuperados a través de la consulta de texto. Cuanto mayor sea el peso, más alto serán los documentos que coincidan con esa consulta en la clasificación final. El valor predeterminado es 1,0 y el valor debe ser un número positivo mayor que cero. |
VectorizedQuery
Parámetros de consulta que se usarán para la búsqueda vectorial cuando se proporciona un valor de vector sin formato.
| Nombre | Tipo | Description |
|---|---|---|
| exhaustive |
boolean |
Cuando es true, desencadena una búsqueda de vecino k-más cercana exhaustiva en todos los vectores del índice de vectores. Resulta útil para escenarios en los que las coincidencias exactas son críticas, como determinar los valores de verdad del suelo. |
| fields |
string |
Campos vectoriales de tipo Collection(Edm.Single) que se van a incluir en el vector buscado. |
| filterOverride |
string |
Expresión de filtro de OData que se va a aplicar a esta consulta vectorial específica. Si no se define ninguna expresión de filtro en el nivel de vector, la expresión definida en el parámetro de filtro de nivel superior se usa en su lugar. |
| k |
integer (int32) |
Número de vecinos más cercanos para devolver como top hits. |
| kind |
string:
vector |
Tipo de consulta. |
| oversampling |
number (double) |
Factor de sobremuestreo. El valor mínimo es 1. Reemplaza el parámetro "defaultOversampling" configurado en la definición de índice. Solo se puede establecer cuando "rerankWithOriginalVectors" es true. Este parámetro solo se permite cuando se usa un método de compresión en el campo vectorial subyacente. |
| perDocumentVectorLimit |
integer (int32) |
Controla cuántos vectores se pueden hacer coincidir de cada documento en una consulta de búsqueda de vectores. Establecerlo en 1 asegura que se coincida como máximo un vector por documento, lo que garantiza que los resultados provengan de documentos distintos. Establecerlo en 0 (ilimitado) permite que se coincidan varios vectores relevantes del mismo documento. El valor predeterminado es 0. |
| threshold | VectorThreshold: |
Umbral usado para las consultas vectoriales. Tenga en cuenta que esto solo se puede establecer si todos los campos usan la misma métrica de similitud. |
| vector |
number[] (float) |
Representación vectorial de una consulta de búsqueda. |
| weight |
number (float) |
Peso relativo de la consulta vectorial en comparación con otra consulta vectorial o la consulta de texto dentro de la misma solicitud de búsqueda. Este valor se usa al combinar los resultados de varias listas de clasificación generadas por las diferentes consultas vectoriales o los resultados recuperados a través de la consulta de texto. Cuanto mayor sea el peso, más alto serán los documentos que coincidan con esa consulta en la clasificación final. El valor predeterminado es 1,0 y el valor debe ser un número positivo mayor que cero. |
VectorQueryKind
El tipo de consulta vectorial que se está realizando.
| Valor | Description |
|---|---|
| vector |
Consulta vectorial en la que se proporciona un valor de vector sin formato. |
| text |
Consulta vectorial donde se proporciona un valor de texto que debe vectorizarse. |
| imageUrl |
Consulta vectorial en la que se proporciona una dirección URL que representa un valor de imagen que debe vectorizarse. |
| imageBinary |
Consulta vectorial donde se proporciona un binario codificado en base 64 de una imagen que necesita ser vectorizada. |
VectorsDebugInfo
"Contiene información de depuración específica para búsqueda vectorial e híbrida.")
| Nombre | Tipo | Description |
|---|---|---|
| subscores |
El desglose de las subpuntuaciones del documento antes del método de fusión/combinación de conjuntos de resultados elegido, como el RRF. |
VectorSimilarityThreshold
Los resultados de la consulta vectorial se filtrarán en función de la métrica de similitud de vectores. Tenga en cuenta que esta es la definición canónica de la métrica de similitud, no la versión de "distancia". La dirección del umbral (mayor o menor) se elegirá automáticamente según la métrica utilizada por el campo.
| Nombre | Tipo | Description |
|---|---|---|
| kind |
string:
vector |
Tipo de umbral. |
| value |
number (double) |
El umbral se filtrará en función del valor de la métrica de similitud. Tenga en cuenta que esta es la definición canónica de la métrica de similitud, no la versión de "distancia". La dirección del umbral (mayor o menor) se elegirá automáticamente según la métrica utilizada por el campo. |
VectorThresholdKind
El tipo de umbral que se usa para filtrar consultas vectoriales.
| Valor | Description |
|---|---|
| vectorSimilarity |
Los resultados de la consulta vectorial se filtrarán en función de la métrica de similitud de vectores. Tenga en cuenta que esta es la definición canónica de la métrica de similitud, no la versión de "distancia". La dirección del umbral (mayor o menor) se elegirá automáticamente según la métrica utilizada por el campo. |
| searchScore |
Los resultados de la consulta vectorial filtrarán en función del valor "@search.score". Tenga en cuenta que esta es la @search.score devuelta como parte de la respuesta de búsqueda. La dirección del umbral se elegirá para una mayor @search.score. |