Documents - Search Post

Servicio:: Search Service

Versión de la API:: 2024-03-01-Preview

Busca documentos en el índice.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2024-03-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	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)	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>.
minimumCoverage	number (double)	Número comprendido entre 0 y 100 que indica el porcentaje del índice que debe estar cubierto por una consulta de búsqueda para que la consulta se notifique como correcta. Este parámetro puede ser útil para garantizar la disponibilidad de búsqueda incluso para los servicios con una sola réplica. El valor predeterminado es 100.
orderby	string	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.
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 o devolver resultados parciales (valor predeterminado).
semanticFields	string	Lista separada por comas de nombres de campo usados para la clasificación semántica.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Permite al usuario establecer un límite superior en la cantidad de tiempo que tarda el enriquecimiento semántico en finalizar el procesamiento antes de que se produzca un error en la solicitud.
semanticQuery	string	Permite establecer una consulta de búsqueda independiente que se usará únicamente para el reranking semántico, los subtítulos semánticos y las respuestas semánticas. Resulta útil para escenarios en los que es necesario usar consultas diferentes entre la fase de recuperación y clasificación base y la fase semántica L2.
sessionId	string	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 (int32)	Número de resultados de búsqueda que se van a omitir. Este valor no puede ser mayor que 100 000. Si necesita examinar documentos en secuencia, pero no puede usar omitir debido a esta limitación, considere la posibilidad de usar orderby en una clave totalmente ordenada y filtrar con una consulta de intervalo en su lugar.
speller	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 (int32)	Número de resultados de búsqueda que se van a recuperar. Esto se puede usar junto con $skip para implementar la paginación del lado cliente de los resultados de búsqueda. Si los resultados se truncan debido a la paginación del lado servidor, la respuesta incluirá un token de continuación que se puede usar para emitir otra solicitud de búsqueda para la página siguiente de resultados.
vectorFilterMode	VectorFilterMode	Determina si los filtros se aplican antes o después de realizar la búsqueda vectorial. El valor predeterminado es "preFilter".
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	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

Solicitud de ejemplo

HTTP

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

{
  "count": true,
  "facets": [
    "category,count:10,sort:count"
  ],
  "filter": "rating gt 4.0",
  "highlight": "description",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": null,
  "orderby": "rating desc",
  "queryType": "simple",
  "scoringParameters": [
    "currentLocation--122.123,44.77233"
  ],
  "scoringProfile": "sp",
  "search": "nice hotels",
  "searchFields": "category,description",
  "searchMode": "any",
  "sessionId": "mysessionid",
  "scoringStatistics": "global",
  "select": "hotelId,description",
  "skip": 0,
  "top": 10,
  "vectorQueries": [
    {
      "kind": "vector",
      "vector": [
        0.103,
        0.0712,
        0.0852,
        0.1547,
        0.1183
      ],
      "fields": "descriptionEmbedding",
      "k": 5,
      "exhaustive": true,
      "oversampling": 20
    }
  ],
  "vectorFilterMode": "preFilter"
}

Respuesta de muestra

status code:: 200

{
  "@odata.count": 25,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "@search.nextPageParameters": {
    "count": true,
    "facets": [
      "category,count:10,sort:count"
    ],
    "filter": "rating gt 4.0",
    "highlight": "title",
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "minimumCoverage": null,
    "orderby": "search.score() desc,rating desc",
    "queryType": "simple",
    "sessionId": "mysessionid",
    "scoringStatistics": "global",
    "scoringParameters": [
      "currentLocation--122.123,44.77233"
    ],
    "scoringProfile": "sp",
    "search": "nice hotels",
    "searchFields": "title,description",
    "searchMode": "any",
    "select": "docId,title,description",
    "skip": 2,
    "top": 8
  },
  "value": [
    {
      "@search.score": 1.5,
      "@search.highlights": {
        "title": [
          "<em>Nice</em> <em>Hotel</em>"
        ]
      },
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.score": 0.7,
      "@search.highlights": {
        "title": [
          "Fancy <em>Hotel</em>"
        ]
      },
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-03-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 "semántica".
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
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.
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
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.
SemanticDebugInfo
SemanticErrorMode	Permite al usuario elegir si una llamada semántica debe producir un error por completo o devolver resultados parciales (valor predeterminado).
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)
SemanticSearchResultsType	Tipo de respuesta parcial que se devolvió para una solicitud de clasificación semántica.
VectorFilterMode	Determina si los filtros se aplican antes o después de realizar la búsqueda vectorial.
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.

AnswerResult

Objeto

Una respuesta es un pasaje de texto extraído del contenido de los documentos más relevantes que coinciden con la consulta. Las respuestas se extraen de los resultados principales de la búsqueda. Los candidatos de respuesta se puntuan y se seleccionan las principales respuestas.

Nombre	Tipo	Description
highlights	string	Mismo pasaje de texto que en la propiedad Text con frases de texto resaltadas más relevantes para la consulta.
key	string	Clave del documento del que se extrajo la respuesta.
score	number (double)	El valor de puntuación representa la importancia de la respuesta a la consulta en relación con otras respuestas devueltas para la consulta.
text	string	El pasaje de texto extraído del contenido del documento como respuesta.

CaptionResult

Objeto

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

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.

DocumentDebugInfo

Objeto

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.

ErrorAdditionalInfo

Objeto

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

Objeto

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

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

QueryAnswerType

Enumeración

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

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

QueryCaptionType

Enumeración

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

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

QueryDebugMode

Enumeración

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

Valor	Description
disabled	No se devolverá información de depuración de consultas.
semantic	Permite al usuario explorar aún más sus resultados reranked.

QueryLanguage

Enumeración

Idioma de la consulta.

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

QueryResultDocumentRerankerInput

Objeto

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

Objeto

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)

QuerySpellerType

Enumeración

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.

Valor	Description
none	Corrector ortográfico no habilitado.
lexicon	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.

QueryType

Enumeración

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.

Valor	Description
simple	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.
full	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	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.

RawVectorQuery

Objeto

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	Lista separada por comas de nombres de campo que se van a incluir en la búsqueda vectorial. Cada uno de los campos debe ser un tipo de vector válido, como Collection(Edm.Single). Si se proporcionan varios campos, el vector se usará para buscar las coincidencias más cercanas en todos los campos.
k	integer (int32)	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 (double)	Factor de sobremuestreo. El valor mínimo es 1. Reemplaza el parámetro "defaultOversampling" configurado en la definición de índice. Solo se puede establecer cuando "rerankWithOriginalVectors" es true. Este parámetro solo se permite cuando se usa un método de compresión en el campo vectorial subyacente.
vector	number[] (float)	Representación vectorial de una consulta de búsqueda.

ScoringStatistics

Enumeración

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.

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

SearchDocumentsResult

Objeto

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

Nombre	Tipo	Description
@odata.count	integer (int64)	Recuento total de resultados encontrados por la operación de búsqueda o null si no se solicitó el recuento. Si está presente, el recuento puede ser mayor que el número de resultados en esta respuesta. Esto puede 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 (double)	Valor que indica el porcentaje del índice que se incluyó en la consulta, o null si no se especificó minimumCoverage en la solicitud.
@search.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.
value	SearchResult[]	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

Objeto

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>.
minimumCoverage	number (double)	Número comprendido entre 0 y 100 que indica el porcentaje del índice que debe estar cubierto por una consulta de búsqueda para que la consulta se notifique como correcta. Este parámetro puede ser útil para garantizar la disponibilidad de búsqueda incluso para los servicios con una sola réplica. El valor predeterminado es 100.
orderby	string	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.
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 o devolver resultados parciales (valor predeterminado).
semanticFields	string	Lista separada por comas de nombres de campo usados para la clasificación semántica.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Permite al usuario establecer un límite superior en la cantidad de tiempo que tarda el enriquecimiento semántico en finalizar el procesamiento antes de que se produzca un error en la solicitud.
semanticQuery	string	Permite establecer una consulta de búsqueda independiente que se usará únicamente para el reranking semántico, los subtítulos semánticos y las respuestas semánticas. Resulta útil para escenarios en los que es necesario usar consultas diferentes entre la fase de recuperación y clasificación base y la fase semántica L2.
sessionId	string	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 (int32)	Número de resultados de búsqueda que se van a omitir. Este valor no puede ser mayor que 100 000. Si necesita examinar documentos en secuencia, pero no puede usar omitir debido a esta limitación, considere la posibilidad de usar orderby en una clave totalmente ordenada y filtrar con una consulta de intervalo en su lugar.
speller	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 (int32)	Número de resultados de búsqueda que se van a recuperar. Esto se puede usar junto con $skip para implementar la paginación del lado cliente de los resultados de búsqueda. Si los resultados se truncan debido a la paginación del lado servidor, la respuesta incluirá un token de continuación que se puede usar para emitir otra solicitud de búsqueda para la página siguiente de resultados.
vectorFilterMode	VectorFilterMode	Determina si los filtros se aplican antes o después de realizar la búsqueda vectorial. El valor predeterminado es "preFilter".
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Los parámetros de consulta para las consultas de búsqueda híbrida y vectorial.

SearchResult

Objeto

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 (double)	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 (double)	Puntuación de relevancia del documento en comparación con otros documentos devueltos por la consulta.

SemanticDebugInfo

Objeto

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

Enumeración

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

Valor	Description
partial	Si se produce un error en el procesamiento semántico, los resultados parciales siguen devolviendo. La definición de resultados parciales depende del error del paso semántico y del motivo del error.
fail	Si hay una excepción durante el paso de procesamiento semántico, se producirá un error en la consulta y se devolverá el código HTTP adecuado en función del error.

SemanticErrorReason

Enumeración

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

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

SemanticFieldState

Enumeración

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

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

SemanticSearchResultsType

Enumeración

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

Valor	Description
baseResults	Resultados sin enriquecimiento semántico ni reeranking.
rerankedResults	Los resultados se han vuelto a cambiar con el modelo de reranker y incluirán subtítulos semánticos. No incluirán respuestas, resaltados de respuestas ni resaltados de subtítulos.

VectorFilterMode

Enumeración

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

Valor	Description
postFilter	El filtro se aplicará después de que se devuelva el conjunto candidato de resultados vectoriales. Dependiendo de la selectividad del filtro, esto puede dar lugar a menos resultados de los solicitados por el parámetro 'k'.
preFilter	El filtro se aplicará antes de la consulta de búsqueda.

VectorizableTextQuery

Objeto

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	Lista separada por comas de nombres de campo que se van a incluir en la búsqueda vectorial. Cada uno de los campos debe ser un tipo de vector válido, como Collection(Edm.Single). Si se proporcionan varios campos, el vector se usará para buscar las coincidencias más cercanas en todos los campos.
k	integer (int32)	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 (double)	Factor de sobremuestreo. El valor mínimo es 1. Reemplaza el parámetro "defaultOversampling" configurado en la definición de índice. Solo se puede establecer cuando "rerankWithOriginalVectors" es true. Este parámetro solo se permite cuando se usa un método de compresión en el campo vectorial subyacente.
text	string	Texto que se va a vectorizar para realizar una consulta de búsqueda vectorial.

VectorQueryKind

Enumeración

Tipo de consulta vectorial que se está realizando.

Valor	Description
vector	Consulta vectorial en la que se proporciona un valor de vector sin formato.
text	Consulta vectorial donde se proporciona un valor de texto que debe vectorizarse.