Compartir a través de

Documents - Search Post

Servicio:
Search Service
Versión de la API:
2025-09-01

Busca documentos en el índice.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2025-09-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
 path True

string

La dirección URL del punto de conexión del servicio de búsqueda.
indexName
 path True

string

El nombre del índice.
api-version
 query True

string

Versión de api de cliente.

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-client-request-id

string (uuid)

El identificador de seguimiento enviado con la solicitud para ayudar con la depuración.

Cuerpo de la solicitud

Nombre Tipo Description
answers

QueryAnswerType

Valor que especifica si las respuestas deben devolverse como parte de la respuesta de búsqueda.
captions

QueryCaptionType

Valor que especifica si se deben devolver subtítulos como parte de la respuesta de búsqueda.
count

boolean

Valor que especifica si se debe capturar el recuento total de resultados. El valor predeterminado es False. Establecer este valor en true puede tener un impacto en el rendimiento. Tenga en cuenta que el recuento devuelto es una aproximación.
debug

QueryDebugMode

Habilita una herramienta de depuración que se puede usar para explorar más a fondo los resultados reclasificados.
facets

string[]

La 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, opcionalmente seguido de una lista separada por comas de pares nombre:valor.
filter

string

OData $filter expresión que se va a aplicar a la consulta de búsqueda.
highlight

string

La lista separada por comas de nombres de campo que se usarán para los resaltados de visitas. Solo se pueden usar campos de búsqueda para resaltar visitas.
highlightPostTag

string

Una etiqueta de cadena que se anexa a los resaltados de golpes. Debe establecerse con highlightPreTag. El valor predeterminado es </em>.
highlightPreTag

string

Una etiqueta de cadena que se antepone a los aspectos más destacados. Debe establecerse con highlightPostTag. El valor predeterminado es <em>.
minimumCoverage

number (double)

Un número entre 0 y 100 que indica el porcentaje del índice que debe cubrir 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 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 por los puntajes de los documentos de los partidos. Si no se especifica ninguna $orderby, el criterio de ordenación predeterminado es descendente por puntuación de coincidencia de documento. Puede haber como máximo 32 cláusulas $orderby.
queryType

QueryType

Valor que 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.
scoringParameters

string[]

Lista de valores de parámetro que se usarán en las funciones de puntuación (por ejemplo, referencePointParameter) con 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

El nombre de un perfil de puntuación para evaluar las puntuaciones de coincidencia de los documentos coincidentes con el fin de ordenar los resultados.
scoringStatistics

ScoringStatistics

Un valor que especifica si queremos calcular las estadísticas de puntuación (como la frecuencia del documento) globalmente para una puntuación más consistente, o localmente, para una latencia más baja. 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 utiliza la búsqueda por campos (fieldName:searchExpression) en una consulta completa de Lucene, los nombres de campo de cada expresión de búsqueda por campos tienen prioridad sobre los nombres de campo enumerados en este parámetro.
searchMode

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ántica.
semanticErrorHandling

SemanticErrorMode

Permite al usuario elegir si una llamada semántica debe fallar por completo (comportamiento predeterminado / actual) o devolver resultados parciales.
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 utilizará únicamente para la reclasificación semántica, los subtítulos semánticos y las respuestas semánticas. Es útil para escenarios en los que es necesario usar diferentes consultas entre la fase de recuperación y clasificación base y la fase semántica de Capa 2.
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 intentará hacer todo lo posible para tener como destino el mismo conjunto de réplicas. Tenga en cuenta que la reutilización repetida de los mismos valores de sessionID 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 utilizado como sessionId no puede comenzar con un carácter '_'.
skip

integer (int32)

El número de resultados de búsqueda que se van a omitir. Este valor no puede ser mayor que 100.000. Si necesita escanear 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 filtre con una consulta de rango en su lugar.
top

integer (int32)

El 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 siguiente página de resultados.
vectorFilterMode

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 consultas de búsqueda vectorial e híbrida.

Respuestas

Nombre Tipo Description
200 OK

SearchDocumentsResult

Respuesta que contiene documentos que coinciden con los criterios de búsqueda.
Other Status Codes

SearchDocumentsResult

Respuesta que contiene documentos parciales que coinciden con los criterios de búsqueda.
Other Status Codes

ErrorResponse

Respuesta de error.

Ejemplos

SearchIndexSearchDocumentsPost
SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Solicitud de ejemplo

POST https://stableexampleservice.search.windows.net/indexes('stable-test')/docs/search.post.search?api-version=2025-09-01


{
  "count": true,
  "facets": [
    "ownerId"
  ],
  "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",
  "select": "id,name,description,category,ownerId",
  "skip": 0,
  "top": 10,
  "semanticConfiguration": "testconfig",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 5000,
  "semanticQuery": "find all purple",
  "answers": "extractive",
  "captions": "extractive",
  "vectorQueries": [
    {
      "vector": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9
      ],
      "kind": "vector",
      "k": 50,
      "fields": "vector22, vector1b",
      "exhaustive": true,
      "weight": 1
    }
  ],
  "vectorFilterMode": "preFilter"
}

Respuesta de muestra

status code:
200 
{
  "@odata.count": 42,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 26,
        "value": "sam"
      },
      {
        "count": 12,
        "value": "ryan"
      },
      {
        "count": 4,
        "value": "benny"
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.04419642686843872,
      "@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": 1.3862943649291992
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00011109876504633576,
                  "vectorSimilarity": 94.86833055544514
                },
                "vector1b": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                }
              }
            ]
          }
        }
      },
      "id": "10",
      "name": "test",
      "description": "test10 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.012820512987673283,
      "@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": 1.0779930353164673
            },
            "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.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0431547611951828,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00017358097829855978,
                  "vectorSimilarity": 75.89466323761327
                },
                "vector1b": {
                  "searchScore": 0.0005099439295008779,
                  "vectorSimilarity": 44.27188622909418
                }
              }
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04460374265909195,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00020656888955272734,
                  "vectorSimilarity": 69.5701087211589
                },
                "vector1b": {
                  "searchScore": 0.0006939625018276274,
                  "vectorSimilarity": 37.947332584023194
                }
              }
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.042533937841653824,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00015997439913917333,
                  "vectorSimilarity": 79.0569427290381
                },
                "vector1b": {
                  "searchScore": 0.0004442470089998096,
                  "vectorSimilarity": 47.43416449302081
                }
              }
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04651741310954094,
      "@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": 1.9616584777832031
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00013715539535041898,
                  "vectorSimilarity": 85.38149735825786
                },
                "vector1b": {
                  "searchScore": 0.00034590106224641204,
                  "vectorSimilarity": 53.758721003860366
                }
              }
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04703196510672569,
      "@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": 1.0779930353164673
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                },
                "vector1b": {
                  "searchScore": 0.0009990009712055326,
                  "vectorSimilarity": 31.622777042048124
                }
              }
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.043300654739141464,
      "@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": 1.1507283449172974
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00012753476039506495,
                  "vectorSimilarity": 88.5437719937623
                },
                "vector1b": {
                  "searchScore": 0.0003085467324126512,
                  "vectorSimilarity": 56.92099902893652
                }
              }
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04082724079489708,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00010404744534753263,
                  "vectorSimilarity": 98.03060760075451
                },
                "vector1b": {
                  "searchScore": 0.00022670596081297845,
                  "vectorSimilarity": 66.40783109116562
                }
              }
            ]
          }
        }
      },
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}
status code:
206 
{
  "@odata.count": 42,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 26,
        "value": "sam"
      },
      {
        "count": 12,
        "value": "ryan"
      },
      {
        "count": 4,
        "value": "benny"
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.04419642686843872,
      "@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": 1.3862943649291992
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00011109876504633576,
                  "vectorSimilarity": 94.86833055544514
                },
                "vector1b": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                }
              }
            ]
          }
        }
      },
      "id": "10",
      "name": "test",
      "description": "test10 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.012820512987673283,
      "@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": 1.0779930353164673
            },
            "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.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0431547611951828,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00017358097829855978,
                  "vectorSimilarity": 75.89466323761327
                },
                "vector1b": {
                  "searchScore": 0.0005099439295008779,
                  "vectorSimilarity": 44.27188622909418
                }
              }
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04460374265909195,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00020656888955272734,
                  "vectorSimilarity": 69.5701087211589
                },
                "vector1b": {
                  "searchScore": 0.0006939625018276274,
                  "vectorSimilarity": 37.947332584023194
                }
              }
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.042533937841653824,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00015997439913917333,
                  "vectorSimilarity": 79.0569427290381
                },
                "vector1b": {
                  "searchScore": 0.0004442470089998096,
                  "vectorSimilarity": 47.43416449302081
                }
              }
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04651741310954094,
      "@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": 1.9616584777832031
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00013715539535041898,
                  "vectorSimilarity": 85.38149735825786
                },
                "vector1b": {
                  "searchScore": 0.00034590106224641204,
                  "vectorSimilarity": 53.758721003860366
                }
              }
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04703196510672569,
      "@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": 1.0779930353164673
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                },
                "vector1b": {
                  "searchScore": 0.0009990009712055326,
                  "vectorSimilarity": 31.622777042048124
                }
              }
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.043300654739141464,
      "@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": 1.1507283449172974
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00012753476039506495,
                  "vectorSimilarity": 88.5437719937623
                },
                "vector1b": {
                  "searchScore": 0.0003085467324126512,
                  "vectorSimilarity": 56.92099902893652
                }
              }
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04082724079489708,
      "@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": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00010404744534753263,
                  "vectorSimilarity": 98.03060760075451
                },
                "vector1b": {
                  "searchScore": 0.00022670596081297845,
                  "vectorSimilarity": 66.40783109116562
                }
              }
            ]
          }
        }
      },
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

SearchIndexSearchDocumentsSemanticPost

Solicitud de ejemplo

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2025-09-01

{
  "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

status code:
200 
{
  "@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=2024-07-01"
}
status code:
206 
{
  "@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=2024-07-01"
}

Definiciones

Nombre Description
AnswerResult

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 principales resultados de búsqueda. Se califican los candidatos de respuesta y se seleccionan las mejores respuestas.
CaptionResult

Los subtítulos son los pasajes más representativos del documento en relación con la consulta de búsqueda. A menudo se utilizan como resumen de documentos. Los subtítulos solo se devuelven para consultas de tipo semantic.
DocumentDebugInfo

Contiene información de depuración que se puede usar para explorar más a fondo los resultados de la búsqueda.
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.
ErrorDetail

Detalle del error.
ErrorResponse

Respuesta de error
QueryAnswerType

Valor que especifica si las respuestas deben devolverse como parte de la respuesta de búsqueda.
QueryCaptionType

Valor que especifica si se deben devolver subtítulos como parte de la respuesta 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.
QueryResultDocumentSubscores

El desglose de las subpuntuaciones 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 recibió.
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.
RawVectorQuery

Los parámetros de consulta que se usarán para la búsqueda vectorial cuando se proporciona un valor vectorial sin procesar.
ScoringStatistics

Un valor que especifica si queremos calcular las estadísticas de puntuación (como la frecuencia del documento) globalmente para una puntuación más consistente, o localmente, para una latencia más baja. 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.
SearchDocumentsResult

Respuesta que contiene los resultados de búsqueda de un índice.
SearchMode

Especifica si alguno o 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.
SearchResult

Contiene un documento encontrado por una consulta de búsqueda, además de metadatos asociados.
SemanticErrorMode

Permite al usuario elegir si una llamada semántica debe fallar por completo (comportamiento predeterminado / actual) o devolver resultados parciales.
SemanticErrorReason

Razón por la que se devolvió una respuesta parcial para una solicitud de clasificación semántica.
SemanticSearchResultsType

Tipo de respuesta parcial que se devolvió para una solicitud de clasificación semántica.
SingleVectorFieldResult

Un solo resultado de campo vectorial. Se devuelven los @search.score valores de similitud de ambos y vectores. La similitud vectorial está relacionada con @search.score una ecuación.
TextResult

La puntuación BM25 o Classic 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.
VectorizableTextQuery

Los parámetros de consulta que se usarán para la búsqueda vectorial cuando se proporciona un valor de texto que debe vectorizarse.
VectorQueryKind

El tipo de consulta vectorial que se está realizando.
VectorsDebugInfo

AnswerResult

Object

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 principales resultados de búsqueda. Se califican los candidatos de respuesta y se seleccionan las mejores respuestas.

Nombre Tipo Description
highlights

string

El mismo pasaje de texto que en la propiedad Text con las frases de texto resaltadas más relevantes para la consulta.
key

string

La clave del documento del que se extrajo la respuesta.
score

number (double)

El valor de puntuación representa la relevancia de la respuesta para 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.

CaptionResult

Object

Los subtítulos son los pasajes más representativos del documento en relación con la consulta de búsqueda. A menudo se utilizan como resumen de documentos. Los subtítulos solo se devuelven para consultas de tipo semantic.

Nombre Tipo Description
highlights

string

El mismo pasaje de texto que en la propiedad Text con las 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.

DocumentDebugInfo

Object

Contiene información de depuración que se puede usar para explorar más a fondo los resultados de la búsqueda.

Nombre Tipo Description
vectors

VectorsDebugInfo

Contiene información de depuración específica para la búsqueda vectorial e híbrida.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.
type

string

Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

ErrorDetail[]

Detalles del error.
message

string

El mensaje de error.
target

string

Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

QueryAnswerType

Enumeración

Valor que especifica si las respuestas deben devolverse como parte de la respuesta de búsqueda.

Valor Description
none

No devuelva respuestas para la consulta.
extractive

Los extractos responden a los candidatos del contenido de los documentos devueltos en respuesta a una consulta expresada como una pregunta en lenguaje natural.

QueryCaptionType

Enumeración

Valor que especifica si se deben devolver subtítulos como parte de la respuesta de búsqueda.

Valor Description
none

No devuelva subtítulos para la consulta.
extractive

Extrae leyendas de los documentos coincidentes que contienen pasajes relevantes para la consulta de búsqueda.

QueryDebugMode

Enumeración

Habilita una herramienta de depuración que se puede usar para explorar más a fondo los resultados de la búsqueda.

Valor Description
disabled

No se devolverá ninguna información de depuración de consultas.
vector

Permite al usuario explorar más a fondo los resultados de sus consultas híbridas y vectoriales.

QueryResultDocumentSubscores

Object

El desglose de las subpuntuaciones 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 recibió.

Nombre Tipo Description
documentBoost

number (double)

La puntuación BM25 o Classic para la parte de texto de la consulta.
text

TextResult

La puntuación BM25 o Classic para la parte de texto de la consulta.
vectors

<string,  SingleVectorFieldResult>

La similitud y los valores vectoriales de @search.score cada consulta vectorial.

QueryType

Enumeración

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.

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.

RawVectorQuery

Object

Los parámetros de consulta que se usarán para la búsqueda vectorial cuando se proporciona un valor vectorial sin procesar.

Nombre Tipo Description
exhaustive

boolean

Cuando es true, desencadena una búsqueda exhaustiva de k vecinos más cercanos en todos los vectores dentro del índice vectorial. Útil para escenarios en los que las coincidencias exactas son críticas, como la determinación de los valores de verdad del terreno.
fields

string

Campos vectoriales de tipo Collection(Edm.Single) que se incluirán en el vector buscado.
k

integer (int32)

Número de vecinos más cercanos que se devolverán como resultados principales.
kind string:

vector

El tipo de consulta vectorial que se está realizando.
oversampling

number (double)

Factor de sobremuestreo. El valor mínimo es 1. Anula el parámetro 'defaultOversampling' configurado en la definición del índice. Solo se puede establecer cuando 'rerankWithOriginalVectors' es true. Este parámetro solo se permite cuando se utiliza un método de compresión en el campo vectorial subyacente.
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 y/o la consulta de texto dentro de la misma solicitud de búsqueda. Este valor se utiliza al combinar los resultados de varias listas de clasificación producidas por las diferentes consultas vectoriales y/o los resultados recuperados a través de la consulta de texto. Cuanto mayor sea el peso, mayores 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.

ScoringStatistics

Enumeración

Un valor que especifica si queremos calcular las estadísticas de puntuación (como la frecuencia del documento) globalmente para una puntuación más consistente, o localmente, para una latencia más baja. 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

Object

Respuesta que contiene los resultados de búsqueda de un índice.

Nombre Tipo Description
@odata.count

integer (int64)

El 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

AnswerResult[]

Los resultados de la consulta de respuestas para la operación de búsqueda; null si el parámetro de consulta answers no se especificó 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 minimumCoverage no se especificó en la solicitud.
@search.facets

object

Los resultados de la consulta de facetas para la operación de búsqueda, organizados como una colección de cubos para cada campo facetado; null si la consulta no incluía ninguna expresión de faceta.
@search.nextPageParameters

SearchRequest

Continuación de la carga JSON que se devuelve cuando la consulta no puede devolver todos los resultados solicitados en una sola respuesta. Puede usar este JSON junto con @odata.nextLink para formular otra solicitud de búsqueda POST para obtener la siguiente parte de la respuesta de búsqueda.
@search.semanticPartialResponseReason

SemanticErrorReason

Razón por la que se devolvió una respuesta parcial para una solicitud de clasificación semántica.
@search.semanticPartialResponseType

SemanticSearchResultsType

Tipo de respuesta parcial que se devolvió para una solicitud de clasificación semántica.
value

SearchResult[]

La secuencia de resultados devueltos por la consulta.

SearchMode

Enumeración

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

Object

Parámetros para filtrar, ordenar, facetar, paginar y otros comportamientos de consulta de búsqueda.

Nombre Tipo Description
answers

QueryAnswerType

Valor que especifica si las respuestas deben devolverse como parte de la respuesta de búsqueda.
captions

QueryCaptionType

Valor que especifica si se deben devolver subtítulos como parte de la respuesta de búsqueda.
count

boolean

Valor que especifica si se debe capturar el recuento total de resultados. El valor predeterminado es False. Establecer este valor en true puede tener un impacto en el rendimiento. Tenga en cuenta que el recuento devuelto es una aproximación.
debug

QueryDebugMode

Habilita una herramienta de depuración que se puede usar para explorar más a fondo los resultados reclasificados.
facets

string[]

La 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, opcionalmente seguido de una lista separada por comas de pares nombre:valor.
filter

string

OData $filter expresión que se va a aplicar a la consulta de búsqueda.
highlight

string

La lista separada por comas de nombres de campo que se usarán para los resaltados de visitas. Solo se pueden usar campos de búsqueda para resaltar visitas.
highlightPostTag

string

Una etiqueta de cadena que se anexa a los resaltados de golpes. Debe establecerse con highlightPreTag. El valor predeterminado es </em>.
highlightPreTag

string

Una etiqueta de cadena que se antepone a los aspectos más destacados. Debe establecerse con highlightPostTag. El valor predeterminado es <em>.
minimumCoverage

number (double)

Un número entre 0 y 100 que indica el porcentaje del índice que debe cubrir 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 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 por los puntajes de los documentos de los partidos. Si no se especifica ninguna $orderby, el criterio de ordenación predeterminado es descendente por puntuación de coincidencia de documento. Puede haber como máximo 32 cláusulas $orderby.
queryType

QueryType

Valor que 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.
scoringParameters

string[]

Lista de valores de parámetro que se usarán en las funciones de puntuación (por ejemplo, referencePointParameter) con 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

El nombre de un perfil de puntuación para evaluar las puntuaciones de coincidencia de los documentos coincidentes con el fin de ordenar los resultados.
scoringStatistics

ScoringStatistics

Un valor que especifica si queremos calcular las estadísticas de puntuación (como la frecuencia del documento) globalmente para una puntuación más consistente, o localmente, para una latencia más baja. 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 utiliza la búsqueda por campos (fieldName:searchExpression) en una consulta completa de Lucene, los nombres de campo de cada expresión de búsqueda por campos tienen prioridad sobre los nombres de campo enumerados en este parámetro.
searchMode

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ántica.
semanticErrorHandling

SemanticErrorMode

Permite al usuario elegir si una llamada semántica debe fallar por completo (comportamiento predeterminado / actual) o devolver resultados parciales.
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 utilizará únicamente para la reclasificación semántica, los subtítulos semánticos y las respuestas semánticas. Es útil para escenarios en los que es necesario usar diferentes consultas entre la fase de recuperación y clasificación base y la fase semántica de Capa 2.
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 intentará hacer todo lo posible para tener como destino el mismo conjunto de réplicas. Tenga en cuenta que la reutilización repetida de los mismos valores de sessionID 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 utilizado como sessionId no puede comenzar con un carácter '_'.
skip

integer (int32)

El número de resultados de búsqueda que se van a omitir. Este valor no puede ser mayor que 100.000. Si necesita escanear 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 filtre con una consulta de rango en su lugar.
top

integer (int32)

El 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 siguiente página de resultados.
vectorFilterMode

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 consultas de búsqueda vectorial e híbrida.

SearchResult

Object

Contiene un documento encontrado por una consulta de búsqueda, además de metadatos asociados.

Nombre Tipo Description
@search.captions

CaptionResult[]

Los subtítulos son los pasajes más representativos del documento en relación con la consulta de búsqueda. A menudo se utilizan como resumen de documentos. Los subtítulos solo se devuelven para consultas de tipo 'semántica'.
@search.documentDebugInfo

DocumentDebugInfo

Contiene información de depuración que se puede usar para explorar más a fondo 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 la búsqueda se ordenan por RerankerScore/RerankerBoostedScore en función de 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.

SemanticErrorMode

Enumeración

Permite al usuario elegir si una llamada semántica debe fallar por completo (comportamiento predeterminado / actual) o devolver resultados parciales.

Valor Description
partial

Si se produce un error en el procesamiento semántico, se siguen devolviendo resultados parciales. La definición de resultados parciales depende de qué paso semántico falló y cuál fue la razón del fracaso.
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

Enumeración

Razón por la que se devolvió una respuesta parcial para una solicitud de clasificación semántica.

Valor Description
maxWaitExceeded

Si semanticMaxWaitInMilliseconds se estableció y la duración del procesamiento semántico superó ese valor. Solo se devolvieron los resultados base.
capacityOverloaded

La solicitud fue estrangulada. Solo se devolvieron los resultados base.
transient

Al menos un paso del proceso semántico falló.

SemanticSearchResultsType

Enumeración

Tipo de respuesta parcial que se devolvió para una solicitud de clasificación semántica.

Valor Description
baseResults

Resultados sin ningún enriquecimiento semántico o reclasificación.
rerankedResults

Los resultados se han reclasificado con el modelo de reranker e incluirán subtítulos semánticos. No incluirán respuestas, respuestas destacadas o subtítulos destacados.

SingleVectorFieldResult

Object

Un solo resultado de campo vectorial. Se devuelven los @search.score valores de similitud de ambos y vectores. La similitud vectorial está relacionada con @search.score una ecuación.

Nombre Tipo Description
searchScore

number (double)

El @search.score valor que se calcula a partir de la puntuación de similitud vectorial. Esta es la puntuación visible en una consulta de un solo campo y un solo vector puro.
vectorSimilarity

number (double)

La puntuación de similitud vectorial para este documento. Tenga en cuenta que esta es la definición canónica de métrica de similitud, no la versión de 'distancia'. Por ejemplo, similitud de coseno en lugar de distancia de coseno.

TextResult

Object

La puntuación BM25 o Classic para la parte de texto de la consulta.

Nombre Tipo Description
searchScore

number (double)

La puntuación BM25 o Classic para la parte de texto de la consulta.

VectorFilterMode

Enumeración

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 que los solicitados por el parámetro 'k'.
preFilter

El filtro se aplicará antes de la consulta de búsqueda.

VectorizableTextQuery

Object

Los parámetros de consulta que se usarán 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 exhaustiva de k vecinos más cercanos en todos los vectores dentro del índice vectorial. Útil para escenarios en los que las coincidencias exactas son críticas, como la determinación de los valores de verdad del terreno.
fields

string

Campos vectoriales de tipo Collection(Edm.Single) que se incluirán en el vector buscado.
k

integer (int32)

Número de vecinos más cercanos que se devolverán como resultados principales.
kind string:

text

El tipo de consulta vectorial que se está realizando.
oversampling

number (double)

Factor de sobremuestreo. El valor mínimo es 1. Anula el parámetro 'defaultOversampling' configurado en la definición del índice. Solo se puede establecer cuando 'rerankWithOriginalVectors' es true. Este parámetro solo se permite cuando se utiliza un método de compresión en el campo vectorial subyacente.
text

string

El texto 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 y/o la consulta de texto dentro de la misma solicitud de búsqueda. Este valor se utiliza al combinar los resultados de varias listas de clasificación producidas por las diferentes consultas vectoriales y/o los resultados recuperados a través de la consulta de texto. Cuanto mayor sea el peso, mayores 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

Enumeración

El tipo de consulta vectorial que se está realizando.

Valor Description
vector

Consulta vectorial en la que se proporciona un valor vectorial sin procesar.
text

Consulta vectorial en la que se proporciona un valor de texto que debe vectorizarse.

VectorsDebugInfo

Object
Nombre Tipo Description
subscores

QueryResultDocumentSubscores

El desglose de las subpuntuaciones del documento antes del método de fusión/combinación de conjuntos de resultados elegido, como el RRF.