Documents - Search Post

Servicio:

Search Service

Versión de la API:

2024-11-01-preview

Busca documentos en el índice.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Dirección URL del punto de conexión del servicio de búsqueda.
indexName	path	True	string	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	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 se deben devolver como parte de la respuesta de búsqueda.
captions	QueryCaptionType	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 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 aún más los resultados reempleados.
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	HybridSearch	Parámetros de consulta para configurar comportamientos de búsqueda híbrida.
minimumCoverage	number	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	Lista separada por comas de expresiones de OData $orderby por las que se ordenan 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	QueryLanguage	Valor que especifica el idioma de la consulta de búsqueda.
queryRewrites	QueryRewritesType	Valor que especifica si se deben generar reescrituras de consultas para aumentar la consulta de búsqueda.
queryType	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	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". Use "global" para agregar estadísticas de puntuación globalmente antes de la puntuación. El uso de estadísticas de puntuación global puede aumentar la latencia de las consultas de búsqueda.
search	string	Expresión de consulta de búsqueda de texto completo; Use "*" o 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	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	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	SemanticErrorMode	Permite al usuario elegir si una llamada semántica debe producir un error por completo (comportamiento predeterminado o actual) o para devolver resultados parciales.
semanticFields	string	Lista separada por comas de nombres de campo usados para la clasificación semántica.
semanticMaxWaitInMilliseconds	integer	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	Valor que se usará para crear una sesión pegajosa, lo que puede ayudar a obtener resultados más coherentes. 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	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	QuerySpellerType	Valor que especificó el tipo del corrector ortográfico que se va a usar para corregir la ortografía de los términos de consulta de búsqueda individuales.
top	integer	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	VectorFilterMode	Determina si los filtros se aplican antes o después de realizar la búsqueda vectorial. El valor predeterminado es "preFilter" para los nuevos índices.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[] VectorizableImageUrlQuery[] VectorizableImageBinaryQuery[]	Los parámetros de consulta para las consultas de búsqueda híbrida y vectorial.

Respuestas

Nombre	Tipo	Description
200 OK	SearchDocumentsResult	Respuesta que contiene documentos que coinciden con los criterios de búsqueda.
Other Status Codes	ErrorResponse	Respuesta de error.

Ejemplos

SearchIndexSearchDocumentsPost

SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Solicitud de ejemplo

HTTP

POST https://previewexampleservice.search.windows.net/indexes('preview-test')/docs/search.post.search?api-version=2024-11-01-preview


{
  "count": true,
  "facets": [
    "ownerId"
  ],
  "filter": "category eq 'purple' or category eq 'pink'",
  "highlight": "category",
  "highlightPostTag": "</em>",
  "highlightPreTag": "</em>",
  "orderby": "id desc",
  "queryType": "simple",
  "scoringStatistics": "global",
  "sessionId": "mysessionid",
  "scoringParameters": [
    "categoryTag:desiredCategoryValue"
  ],
  "scoringProfile": "stringFieldBoost",
  "search": "purple",
  "searchFields": "id,name,description,category,ownerId",
  "searchMode": "any",
  "select": "id,name,description,category,ownerId",
  "skip": 0,
  "top": 10,
  "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

status code:

200

{
  "@odata.count": 27,
  "@search.facets": {
    "ownerId": [
      {
        "count": 16,
        "value": "sam"
      },
      {
        "count": 8,
        "value": "ryan"
      },
      {
        "count": 3,
        "value": "benny"
      }
    ]
  },
  "value": [
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "empty-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "9",
      "name": "test",
      "description": "test9 hello",
      "category": "purple",
      "ownerId": "ryan"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "6",
      "name": "test",
      "description": "test6 hello",
      "category": "purple",
      "ownerId": "ryan"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "3",
      "name": "test",
      "description": "test3 hello",
      "category": "purple",
      "ownerId": "ryan"
    },
    {
      "@search.score": 1,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "id": "24",
      "name": "test",
      "description": "test24 hello",
      "category": "purple",
      "ownerId": "ryan"
    }
  ]
}

SearchIndexSearchDocumentsSemanticPost

Solicitud de ejemplo

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-11-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

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-11-01-preview"
}

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 resultados principales de la búsqueda. Los candidatos de respuesta se puntuan y se seleccionan las principales respuestas.
CaptionResult	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.
DebugInfo	Contiene información de depuración que se puede usar para explorar aún más los resultados de la búsqueda.
DocumentDebugInfo	Contiene información de depuración que se puede usar para explorar aún más 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
HybridCountAndFacetMode	Determina si el recuento y las facetas deben incluir todos los documentos que coinciden con la consulta de búsqueda o solo los documentos que se recuperan en la ventana "maxTextRecallSize". El valor predeterminado es "countAllResults".
HybridSearch	Los parámetros de consulta para configurar comportamientos de búsqueda híbrida.
QueryAnswerType	Valor que especifica si las respuestas se deben devolver como parte de la respuesta de búsqueda.
QueryCaptionType	Valor que especifica si se deben devolver títulos como parte de la respuesta de búsqueda.
QueryDebugMode	Habilita una herramienta de depuración que se puede usar para explorar aún más los resultados de la búsqueda. Puede habilitar varios modos de depuración simultáneamente separandolos con un | carácter, por ejemplo: semantic|queryRewrites.
QueryLanguage	Idioma de la consulta.
QueryResultDocumentRerankerInput	Cadenas concatenadas sin procesar que se enviaron al proceso de enriquecimiento semántico.
QueryResultDocumentSemanticField	Descripción de los campos que se enviaron al proceso de enriquecimiento semántico, así como cómo se usaron
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.
QueryRewritesDebugInfo	Contiene información de depuración específica de las reescrituras de consultas.
QueryRewritesType	Valor que especifica si se deben generar reescrituras de consultas para aumentar la consulta de búsqueda.
QueryRewritesValuesDebugInfo	Contiene información de depuración específica de las reescrituras de consultas.
QuerySpellerType	Valor que especificó el tipo del corrector ortográfico que se va a usar para corregir la ortografía de los términos de consulta de búsqueda individuales.
QueryType	Especifica la sintaxis de la consulta de búsqueda. El valor predeterminado es "simple". Use "full" si la consulta usa la sintaxis de consulta lucene y la "semántica" si no se necesita la sintaxis de consulta.
RawVectorQuery	Parámetros de consulta que se usarán para la búsqueda vectorial cuando se proporciona un valor de vector sin formato.
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". Use "global" para agregar estadísticas de puntuación globalmente antes de la puntuación. 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.
SearchScoreThreshold	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.
SemanticDebugInfo
SemanticErrorMode	Permite al usuario elegir si una llamada semántica debe producir un error por completo (comportamiento predeterminado o actual) o para devolver resultados parciales.
SemanticErrorReason	Motivo por el que se devolvió una respuesta parcial para una solicitud de clasificación semántica.
SemanticFieldState	La forma en que se usó el campo para el proceso de enriquecimiento semántico (totalmente utilizado, parcialmente utilizado o sin usar)
SemanticQueryRewritesResultType	Tipo de reescritura de consulta que se usó para esta solicitud.
SemanticSearchResultsType	Tipo de respuesta parcial que se devolvió para una solicitud de clasificación semántica.
SingleVectorFieldResult	Resultado de un campo de vector único. Se devuelven los valores de similitud de vector y @search.score. La similitud de vectores está relacionada con @search.score mediante una ecuación.
TextResult	Puntuación bm25 o clásica para la parte de texto de la consulta.
VectorFilterMode	Determina si los filtros se aplican antes o después de realizar la búsqueda vectorial.
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.
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.
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.
VectorQueryKind	Tipo de consulta vectorial que se está realizando.
VectorsDebugInfo
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.
VectorThresholdKind	Tipo de consulta vectorial que se está realizando.

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 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	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.

CaptionResult

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.

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	QueryRewritesDebugInfo	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
semantic	SemanticDebugInfo	Contiene información de depuración específica de las solicitudes de clasificación semántica.
vectors	VectorsDebugInfo	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	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

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	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

HybridCountAndFacetMode

Determina si el recuento y las facetas deben incluir todos los documentos que coinciden con la consulta de búsqueda o solo los documentos que se recuperan en la ventana "maxTextRecallSize". El valor predeterminado es "countAllResults".

Nombre	Tipo	Description
countAllResults	string	Incluya todos los documentos que coincidan con la consulta de búsqueda al calcular "count" y "facetas", independientemente de si esos documentos están dentro de la ventana de recuperación "maxTextRecallSize".
countRetrievableResults	string	Incluya solo documentos que coincidan en la ventana de recuperación "maxTextRecallSize" al calcular "count" y "facetas".

HybridSearch

Los parámetros de consulta para configurar comportamientos de búsqueda híbrida.

Nombre	Tipo	Description
countAndFacetMode	HybridCountAndFacetMode	Determina si el recuento y las facetas deben incluir todos los documentos que coinciden con la consulta de búsqueda o solo los documentos que se recuperan en la ventana "maxTextRecallSize".
maxTextRecallSize	integer	Determina el número máximo de documentos que va a recuperar la parte de consulta de texto de una solicitud de búsqueda híbrida. Esos documentos se combinarán con los documentos que coinciden con las consultas vectoriales para generar una única lista final de resultados. Elegir un valor maxTextRecallSize mayor permitirá recuperar y paginar más documentos (con los parámetros top y skip), a costa de un mayor uso de recursos y una mayor latencia. El valor debe estar comprendido entre 1 y 10 000. El valor predeterminado es 1000.

QueryAnswerType

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

Nombre	Tipo	Description
extractive	string	Extrae candidatos de respuesta del contenido de los documentos devueltos en respuesta a una consulta expresada como una pregunta en lenguaje natural.
none	string	No devuelva respuestas para la consulta.

QueryCaptionType

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

Nombre	Tipo	Description
extractive	string	Extrae títulos de los documentos coincidentes que contienen pasajes relevantes para la consulta de búsqueda.
none	string	No devuelva subtítulos para la consulta.

QueryDebugMode

Habilita una herramienta de depuración que se puede usar para explorar aún más los resultados de la búsqueda. Puede habilitar varios modos de depuración simultáneamente separandolos con un | carácter, por ejemplo: semantic|queryRewrites.

Nombre	Tipo	Description
all	string	Active todas las opciones de depuración.
disabled	string	No se devolverá información de depuración de consultas.
queryRewrites	string	Permite al usuario explorar la lista de reescrituras de consultas generadas para su solicitud de búsqueda.
semantic	string	Permite al usuario explorar aún más sus resultados reranked.
vector	string	Permite al usuario explorar aún más los resultados de la consulta híbrida y vectorial.

QueryLanguage

Idioma de la consulta.

Nombre	Tipo	Description
ar-eg	string	Valor de idioma de consulta para árabe (Egipto).
ar-jo	string	Valor del lenguaje de consulta para árabe (Jordania).
ar-kw	string	Valor del idioma de consulta para árabe (Kuwait).
ar-ma	string	Valor de idioma de consulta para árabe (Marruecos).
ar-sa	string	Valor de idioma de consulta para árabe (Arabia Saudí).
bg-bg	string	Valor del idioma de consulta para Búlgaro (Bulgaria).
bn-in	string	Valor del lenguaje de consulta para Bengali (India).
ca-es	string	Valor del lenguaje de consulta para catalán.
cs-cz	string	Valor de idioma de consulta para Checo (República Checa).
da-dk	string	Valor de idioma de consulta para danés (Dinamarca).
de-de	string	Valor del idioma de consulta para alemán (Alemania).
el-gr	string	Valor del lenguaje de consulta para griego (Grecia).
en-au	string	Valor del idioma de consulta para inglés (Australia).
en-ca	string	Valor del idioma de consulta para inglés (Canadá).
en-gb	string	Valor del idioma de consulta para inglés (Gran Bretaña).
en-in	string	Valor del idioma de consulta para inglés (India).
en-us	string	Valor del idioma de consulta para inglés (Estados Unidos).
es-es	string	Valor de idioma de consulta para español (España).
es-mx	string	Valor de idioma de consulta para español (México).
et-ee	string	Valor del lenguaje de consulta para Estonio (Estonia).
eu-es	string	Valor del lenguaje de consulta para Euskera.
fa-ae	string	Valor del lenguaje de consulta para persa (U.A.E.).
fi-fi	string	Valor del lenguaje de consulta para finés (Finlandia).
fr-ca	string	Valor del lenguaje de consulta para francés (Canadá).
fr-fr	string	Valor de idioma de consulta para francés (Francia).
ga-ie	string	Valor del lenguaje de consulta para irlandés (Irlanda).
gl-es	string	Valor del lenguaje de consulta para Gallega.
gu-in	string	Valor del lenguaje de consulta para Gujarati (India).
he-il	string	Valor del lenguaje de consulta para hebreo (Israel).
hi-in	string	Valor del idioma de consulta para Hindi (India).
hr-ba	string	Valor del lenguaje de consulta para croata (Bosnia y Herzegovina).
hr-hr	string	Valor del idioma de consulta para croata (Croacia).
hu-hu	string	Valor del idioma de consulta para húngaro (Hungría).
hy-am	string	Valor de idioma de consulta para Armenio (Armenia).
id-id	string	Valor del idioma de consulta para Indonesia (Indonesia).
is-is	string	Valor del lenguaje de consulta para Islandés (Islandia).
it-it	string	Valor del idioma de consulta para italiano (Italia).
ja-jp	string	Valor del idioma de consulta para japonés (Japón).
kn-in	string	Valor del lenguaje de consulta para Kannada (India).
ko-kr	string	Valor del idioma de consulta para coreano (Corea).
lt-lt	string	Valor del lenguaje de consulta para Lituano (Lituania).
lv-lv	string	Valor del lenguaje de consulta para Letón (Letonia).
ml-in	string	Valor del lenguaje de consulta para Malayalam (India).
mr-in	string	Valor del lenguaje de consulta para Marathi (India).
ms-bn	string	Valor del lenguaje de consulta para Malay (Brunéi Dar traductor).
ms-my	string	Valor del lenguaje de consulta para Malay (Malasia).
nb-no	string	Valor del lenguaje de consulta para noruego (Noruega).
nl-be	string	Valor del idioma de consulta para neerlandés (Bélgica).
nl-nl	string	Valor del idioma de consulta para neerlandés (Países Bajos).
no-no	string	Valor del lenguaje de consulta para noruego (Noruega).
none	string	Lenguaje de consulta no especificado.
pa-in	string	Valor del lenguaje de consulta para Punjabi (India).
pl-pl	string	Valor del idioma de consulta para polaco (Polonia).
pt-br	string	Valor del idioma de consulta para portugués (Brasil).
pt-pt	string	Valor del idioma de consulta para portugués (Portugal).
ro-ro	string	Valor de idioma de consulta para rumano (Rumania).
ru-ru	string	Valor del idioma de consulta para ruso (Rusia).
sk-sk	string	Valor de idioma de consulta para Eslovaco (Eslovaquia).
sl-sl	string	Valor del lenguaje de consulta para esloveno (Eslovenia).
sr-ba	string	Valor del lenguaje de consulta para Serbio (Bosnia y Herzegovina).
sr-me	string	Valor del lenguaje de consulta para Serbio (Montenegro).
sr-rs	string	Valor del lenguaje de consulta para serbio (Serbia).
sv-se	string	Valor de idioma de consulta para sueco (Suecia).
ta-in	string	Valor del lenguaje de consulta para Tamil (India).
te-in	string	Valor del lenguaje de consulta para Telugu (India).
th-th	string	Valor del idioma de consulta para Tailandés (Tailandia).
tr-tr	string	Valor del idioma de consulta para turco (Turquía).
uk-ua	string	Valor del lenguaje de consulta para Ucrania (Ucrania).
ur-pk	string	Valor del lenguaje de consulta para Urdu (Pakistán).
vi-vn	string	Valor de idioma de consulta para vietnamita (Viet Nam).
zh-cn	string	Valor de idioma de consulta para chino (China).
zh-tw	string	Valor de idioma de consulta para chino (Taiwán).

QueryResultDocumentRerankerInput

Cadenas concatenadas sin procesar que se enviaron al proceso de enriquecimiento semántico.

Nombre	Tipo	Description
content	string	Cadenas concatenadas sin formato para los campos de contenido que se usaron para el enriquecimiento semántico.
keywords	string	Cadenas concatenadas sin formato para los campos de palabra 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	SemanticFieldState	La forma en que se usó el campo para el proceso de enriquecimiento semántico (totalmente utilizado, parcialmente utilizado o sin usar)

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	Puntuación bm25 o clásica para la parte de texto de la consulta.
text	TextResult	Puntuación bm25 o clásica para la parte de texto de la consulta.
vectors	<string,  SingleVectorFieldResult>	Similitud de vectores y valores @search.score para cada consulta vectorial.

QueryRewritesDebugInfo

Contiene información de depuración específica de las reescrituras de consultas.

Nombre	Tipo	Description
text	QueryRewritesValuesDebugInfo	Lista de reescrituras de consultas generadas para la consulta de texto.
vectors	QueryRewritesValuesDebugInfo[]	Lista de reescrituras de consultas generadas para las consultas de texto vectorizables.

QueryRewritesType

Valor que especifica si se deben generar reescrituras de consultas para aumentar la consulta de búsqueda.

Nombre	Tipo	Description
generative	string	Genere términos de consulta alternativos para aumentar la recuperación de una solicitud de búsqueda.
none	string	No genere reescrituras de consultas adicionales para esta consulta.

QueryRewritesValuesDebugInfo

Contiene información de depuración específica de las reescrituras de consultas.

Nombre	Tipo	Description
inputQuery	string	Texto de entrada en el modelo de reescritura de consultas generativas. Puede haber casos en los que la consulta del usuario y la entrada en el modelo generativo no sean idénticas.
rewrites	string[]	Lista de reescrituras de consultas.

QuerySpellerType

Valor que especificó el tipo del corrector ortográfico que se va a usar para corregir la ortografía de los términos de consulta de búsqueda individuales.

Nombre	Tipo	Description
lexicon	string	El corrector ortográfico corrige los términos de consulta individuales mediante un léxico estático para el idioma especificado por el parámetro queryLanguage.
none	string	Corrector ortográfico no habilitado.

QueryType

Especifica la sintaxis de la consulta de búsqueda. El valor predeterminado es "simple". Use "full" si la consulta usa la sintaxis de consulta lucene y la "semántica" si no se necesita la sintaxis de consulta.

Nombre	Tipo	Description
full	string	Usa la sintaxis completa de consulta de Lucene para las búsquedas. El texto de búsqueda se interpreta mediante el lenguaje de consulta lucene que permite búsquedas específicas y ponderadas de campo, así como otras características avanzadas.
semantic	string	Más adecuado para las 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 resultados de búsqueda principales mediante un modelo de clasificación entrenado en el corpus web.
simple	string	Usa la sintaxis de consulta simple para las búsquedas. El texto de búsqueda se interpreta mediante 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.

RawVectorQuery

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	Número de vecinos más cercanos para devolver como top hits.
kind	string: vector	Tipo de consulta vectorial que se está realizando.
oversampling	number	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.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	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[]	Representación vectorial de una consulta de búsqueda.
weight	number	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.

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". Use "global" para agregar estadísticas de puntuación globalmente antes de la puntuación. El uso de estadísticas de puntuación global puede aumentar la latencia de las consultas de búsqueda.

Nombre	Tipo	Description
global	string	Las estadísticas de puntuación se calcularán globalmente para obtener una puntuación más coherente.
local	string	Las estadísticas de puntuación se calcularán localmente para una menor latencia.

SearchDocumentsResult

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

Nombre	Tipo	Description
@odata.count	integer	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 ocurrir 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 única respuesta. Puede usar esta dirección URL para formular otra solicitud GET o POST Search 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 generó esta respuesta.
@search.answers	AnswerResult[]	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	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	DebugInfo	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	SearchRequest	Carga JSON de continuación devuelta cuando la consulta no puede devolver todos los resultados solicitados en una única respuesta. Puede usar este JSON junto con @odata.nextLink para formular otra solicitud POST Search para obtener la siguiente parte de la respuesta de búsqueda.
@search.semanticPartialResponseReason	SemanticErrorReason	Motivo por el 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.
@search.semanticQueryRewritesResultType	SemanticQueryRewritesResultType	Tipo de reescritura de consulta que se usó para recuperar documentos.
value	SearchResult[]	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.

Nombre	Tipo	Description
all	string	Todos los términos de búsqueda deben coincidir para contar el documento como una coincidencia.
any	string	Cualquiera de los términos de búsqueda debe 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	QueryAnswerType	Valor que especifica si las respuestas se deben devolver como parte de la respuesta de búsqueda.
captions	QueryCaptionType	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 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 aún más los resultados reempleados.
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	HybridSearch	Parámetros de consulta para configurar comportamientos de búsqueda híbrida.
minimumCoverage	number	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	Lista separada por comas de expresiones de OData $orderby por las que se ordenan 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	QueryLanguage	Valor que especifica el idioma de la consulta de búsqueda.
queryRewrites	QueryRewritesType	Valor que especifica si se deben generar reescrituras de consultas para aumentar la consulta de búsqueda.
queryType	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	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". Use "global" para agregar estadísticas de puntuación globalmente antes de la puntuación. El uso de estadísticas de puntuación global puede aumentar la latencia de las consultas de búsqueda.
search	string	Expresión de consulta de búsqueda de texto completo; Use "*" o 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	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	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	SemanticErrorMode	Permite al usuario elegir si una llamada semántica debe producir un error por completo (comportamiento predeterminado o actual) o para devolver resultados parciales.
semanticFields	string	Lista separada por comas de nombres de campo usados para la clasificación semántica.
semanticMaxWaitInMilliseconds	integer	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	Valor que se usará para crear una sesión pegajosa, lo que puede ayudar a obtener resultados más coherentes. 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	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	QuerySpellerType	Valor que especificó el tipo del corrector ortográfico que se va a usar para corregir la ortografía de los términos de consulta de búsqueda individuales.
top	integer	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	VectorFilterMode	Determina si los filtros se aplican antes o después de realizar la búsqueda vectorial. El valor predeterminado es "preFilter" para los nuevos índices.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableImageBinaryQuery[] VectorizableImageUrlQuery[] VectorizableTextQuery[]	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	CaptionResult[]	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 "semántica".
@search.documentDebugInfo	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 referencias no estaba habilitado para la consulta.
@search.rerankerScore	number	Puntuación de relevancia calculada por el clasificador semántico para los resultados de búsqueda principales. Los resultados de la búsqueda se ordenan primero por RerankerScore y, a continuación, por la Puntuación. RerankerScore solo se devuelve para las consultas de tipo "semántica".
@search.score	number	Puntuación de relevancia del documento en comparación con otros documentos devueltos por la consulta.

SearchScoreThreshold

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.

Nombre	Tipo	Description
kind	string: searchScore	El tipo de umbral usado para filtrar las consultas vectoriales
value	number	El umbral se filtrará 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.

SemanticDebugInfo

Nombre	Tipo	Description
contentFields	QueryResultDocumentSemanticField[]	Campos de contenido que se enviaron al proceso de enriquecimiento semántico, así como cómo se usaron
keywordFields	QueryResultDocumentSemanticField[]	Campos de palabra clave que se enviaron al proceso de enriquecimiento semántico, así como cómo se usaron
rerankerInput	QueryResultDocumentRerankerInput	Cadenas concatenadas sin procesar que se enviaron al proceso de enriquecimiento semántico.
titleField	QueryResultDocumentSemanticField	Campo de título que se envió al proceso de enriquecimiento semántico, así como cómo se usó

SemanticErrorMode

Permite al usuario elegir si una llamada semántica debe producir un error por completo (comportamiento predeterminado o actual) o para devolver resultados parciales.

Nombre	Tipo	Description
fail	string	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.
partial	string	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.

SemanticErrorReason

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

Nombre	Tipo	Description
capacityOverloaded	string	La solicitud se limitó. Solo se devolvieron los resultados base.
maxWaitExceeded	string	Si semanticMaxWaitInMilliseconds se estableció y la duración del procesamiento semántico superó ese valor. Solo se devolvieron los resultados base.
transient	string	Error al menos en un paso del proceso semántico.

SemanticFieldState

La forma en que se usó el campo para el proceso de enriquecimiento semántico (totalmente utilizado, parcialmente utilizado o sin usar)

Nombre	Tipo	Description
partial	string	El campo se usó parcialmente para el enriquecimiento semántico.
unused	string	El campo no se usó para el enriquecimiento semántico.
used	string	El campo se usó completamente para el enriquecimiento semántico.

SemanticQueryRewritesResultType

Tipo de reescritura de consulta que se usó para esta solicitud.

Nombre	Tipo	Description
originalQueryOnly	string	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.

Nombre	Tipo	Description
baseResults	string	Resultados sin enriquecimiento semántico ni reeranking.
rerankedResults	string	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. Se devuelven los valores de similitud de vector y @search.score. La similitud de vectores está relacionada con @search.score mediante una ecuación.

Nombre	Tipo	Description
searchScore	number	Valor de @search.score que se calcula a partir de la puntuación de similitud de vectores. Esta es la puntuación visible en una consulta de un solo campo de un solo vector.
vectorSimilarity	number	Puntuación de similitud de vectores 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	Puntuación bm25 o clásica para la parte de texto de la consulta.

VectorFilterMode

Determina si los filtros se aplican antes o después de realizar la búsqueda vectorial.

Nombre	Tipo	Description
postFilter	string	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	string	El filtro se aplicará antes de la consulta de búsqueda.

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	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	Número de vecinos más cercanos para devolver como top hits.
kind	string: imageBinary	Tipo de consulta vectorial que se está realizando.
oversampling	number	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.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	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	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	Número de vecinos más cercanos para devolver como top hits.
kind	string: imageUrl	Tipo de consulta vectorial que se está realizando.
oversampling	number	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.
threshold	VectorThreshold: SearchScoreThreshold VectorSimilarityThreshold	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	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	Número de vecinos más cercanos para devolver como top hits.
kind	string: text	Tipo de consulta vectorial que se está realizando.
oversampling	number	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.
queryRewrites	QueryRewritesType	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: SearchScoreThreshold VectorSimilarityThreshold	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	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

Tipo de consulta vectorial que se está realizando.

Nombre	Tipo	Description
imageBinary	string	Consulta vectorial en la que se proporciona un binario codificado en base 64 de una imagen que debe vectorizarse.
imageUrl	string	Consulta vectorial donde se proporciona una dirección URL que representa un valor de imagen que debe vectorizarse.
text	string	Consulta vectorial donde se proporciona un valor de texto que debe vectorizarse.
vector	string	Consulta vectorial en la que se proporciona un valor de vector sin formato.

VectorsDebugInfo

Nombre	Tipo	Description
subscores	QueryResultDocumentSubscores	Desglose de las subscores del documento antes del método de fusión y combinación del conjunto de resultados elegido, como 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: vectorSimilarity	El tipo de umbral usado para filtrar las consultas vectoriales
value	number	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

Tipo de consulta vectorial que se está realizando.

Nombre	Tipo	Description
searchScore	string	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.
vectorSimilarity	string	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.