Documents - Search Post

Service:

Search Service

API Version:

2023-10-01-Preview

Busca documentos en el índice.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2023-10-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 número devuelto será 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	OData $filter expresión que se va a aplicar a la consulta de búsqueda.
highlight	string	Lista separada por comas de nombres de campo que se van a usar 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	Una etiqueta de cadena que se antepone para alcanzar los resaltados. Debe establecerse con highlightPostTag. El valor predeterminado es <em>.
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	La lista separada por comas de OData $orderby expresiones 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 ascendente. Los empates se resolverán por la puntuación de coincidencia de los 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[]	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	El nombre de un perfil de puntuación para evaluar puntuaciones de coincidencia para documentos coincidentes a 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 reducir la 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 "*" 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 nada, se incluirán 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	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 reempleo 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 base y clasificación, y la fase semántica L2.
sessionId	string	Valor que se va a usar para crear una sesión permanente, 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 de 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 utilizado como sessionId no puede empezar con el carácter "_".
skip	integer	El 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 skip debido a esta limitación, considere la posibilidad de usar orderby en una clave totalmente ordenada y filtrar con una consulta de rango en su lugar.
speller	QuerySpellerType	Valor que especificó el tipo del corrector ortográfico que se va a usar para corregir los términos de consulta de búsqueda individuales.
top	integer	El número de resultados de búsqueda que se van a recuperar. Esto se puede usar junto con $skip para implementar la paginación del lado cliente de los resultados de búsqueda. Si los resultados se truncan debido a la paginación del lado servidor, la respuesta incluirá un token de continuación que se puede usar para emitir otra solicitud de búsqueda para la página siguiente de resultados.
vectorFilterMode	VectorFilterMode	Determina si se aplican o no filtros 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	SearchError	Respuesta de error.

Ejemplos

SearchIndexSearchDocumentsPost

Sample Request

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-10-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
    }
  ],
  "vectorFilterMode": "preFilter"
}

Sample Response

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=2023-10-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. Se puntúan los candidatos de respuesta y se seleccionan las respuestas principales.
CaptionResult	Los subtí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.
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 formato 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 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 de vectores cuando se proporciona un valor de vector sin formato.
ScoringStatistics	Valor que especifica si queremos calcular estadísticas de puntuación (como la frecuencia del documento) globalmente para 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 puntuar. El uso de estadísticas de puntuación global puede aumentar la latencia de las consultas de búsqueda.
SearchDocumentsResult	Respuesta que contiene los resultados de búsqueda de un índice.
SearchError	Describe una condición de error para la API.
SearchMode	Especifica si alguno o todos los términos de búsqueda deben coincidir para considerar 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 usado, parcialmente utilizado o sin usar)
SemanticSearchResultsType	Tipo de respuesta parcial que se devolvió para una solicitud de clasificación semántica.
VectorFilterMode	Determina si se aplican o no filtros antes o después de realizar la búsqueda vectorial.
VectorizableTextQuery	Parámetros de consulta que se usarán para la búsqueda vectorial cuando se proporciona un valor de texto que se debe vectorizar.
VectorQueryKind	El tipo de consulta vectorial que se realiza.

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. Se puntúan los candidatos de respuesta y se seleccionan las respuestas principales.

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	Pasaje de texto extraído del contenido del documento como respuesta.

CaptionResult

Los subtí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	El 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

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.

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

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

QueryLanguage

Idioma de la consulta.

Nombre	Tipo	Description
ar-eg	string	Valor del idioma de consulta para árabe (Egipto).
ar-jo	string	Valor del idioma de consulta para árabe (Jordania).
ar-kw	string	Valor del idioma de consulta para árabe (Kuwait).
ar-ma	string	Valor del idioma de consulta para árabe (Marruecos).
ar-sa	string	Valor del 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 idioma 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 de idioma de consulta para inglés (Estados Unidos).
es-es	string	Valor del idioma de consulta para español (España).
es-mx	string	Valor del idioma de consulta para español (México).
et-ee	string	Valor del lenguaje de consulta para Estonia (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 del 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 lenguaje de consulta para Hindi (India).
hr-ba	string	Valor del idioma de consulta para croata (Bosnia y Herzegovina).
hr-hr	string	Valor del lenguaje de consulta para croata (Croacia).
hu-hu	string	Valor del idioma de consulta para húngaro (Hungría).
hy-am	string	Valor del 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 lenguaje 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 Malayo (Brunéi Dar traductor).
ms-my	string	Valor del lenguaje de consulta para Malayo (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 lenguaje 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 del idioma de consulta para rumano (Rumania).
ru-ru	string	Valor del idioma de consulta para ruso (Rusia).
sk-sk	string	Valor del lenguaje de consulta para Eslovaco (Eslovaquia).
sl-sl	string	Valor del lenguaje de consulta para Eslovenia (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 de 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 del idioma de consulta para vietnamita (Viet Nam).
zh-cn	string	Valor del idioma de consulta para chino (China).
zh-tw	string	Valor de idioma de consulta para chino (Taiwán).

QueryResultDocumentRerankerInput

Cadenas concatenadas sin formato 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 usado, parcialmente utilizado o sin usar)

QuerySpellerType

Valor que especificó el tipo del corrector ortográfico que se va a usar para corregir 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 de consulta completa 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 de vectores cuando se proporciona un valor de vector sin formato.

Nombre	Tipo	Description
exhaustive	boolean	Cuando es true, desencadena una búsqueda de vecinos 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.
k	integer	Número de vecinos más cercanos que se van a devolver como visitas principales.
kind	string: vector	Tipo de consulta vectorial que se realiza.
vector	number[]	Representación vectorial de una consulta de búsqueda.

ScoringStatistics

Valor que especifica si queremos calcular estadísticas de puntuación (como la frecuencia del documento) globalmente para 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 puntuar. 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.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.

SearchError

Describe una condición de error para la API.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	SearchError[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
message	string	Representación legible del error.

SearchMode

Especifica si alguno o todos los términos de búsqueda deben coincidir para considerar 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 con el fin de 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 número devuelto será 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	La expresión $filter 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 para alcanzar los resaltados. Debe establecerse con highlightPreTag. El valor predeterminado es </em>.
highlightPreTag	string	Etiqueta de cadena que se antepone a los resaltados. Debe establecerse con highlightPostTag. El valor predeterminado es <em>.
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 $orderby de OData 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 ascendente. Los empates se resolverán por la puntuación de coincidencia de los 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 cláusulas de $orderby.
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[]	Lista de valores de parámetro que se van a usar en las funciones de puntuación (por ejemplo, referencePointParameter) con el formato name-values. Por ejemplo, si el perfil de puntuación define una función con un parámetro denominado "mylocation", la cadena de parámetro sería "mylocation--122.2,44.8" (sin las comillas).
scoringProfile	string	El nombre de un perfil de puntuación para evaluar puntuaciones de coincidencia para documentos coincidentes a fin de ordenar los resultados.
scoringStatistics	ScoringStatistics	Valor que especifica si queremos calcular estadísticas de puntuación (como la frecuencia del documento) globalmente para 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 puntuar. 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 coincidencia.
select	string	Lista separada por comas de campos que se van a recuperar. Si no se especifica nada, se incluirán 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	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 la repetición semántica, los títulos semánticos y las respuestas semánticas. Resulta útil para escenarios en los que es necesario usar diferentes consultas entre la fase de clasificación y recuperación base y la fase semántica L2.
sessionId	string	Valor que se va a 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 establecer como destino el mismo conjunto de réplicas. Tenga cuidado de que reutilizar repetidamente los mismos valores sessionID puede interferir con el equilibrio de carga de las solicitudes entre réplicas y afectar negativamente al rendimiento del servicio de búsqueda. El valor utilizado como sessionId no puede empezar con el carácter "_".
skip	integer	El 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 rango 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	El número de resultados de búsqueda que se van a recuperar. Esto se puede usar junto con $skip para implementar la paginación del lado cliente de los resultados de búsqueda. Si los resultados se truncan debido a la paginación del lado servidor, la respuesta incluirá un token de continuación que se puede usar para emitir otra solicitud de búsqueda para la siguiente página de resultados.
vectorFilterMode	VectorFilterMode	Determina si se aplican o no filtros antes o después de que se realice la búsqueda vectorial. El valor predeterminado es "preFilter".
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	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 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 aciertos 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 'semantic'.
@search.score	number	Puntuación de relevancia del documento en comparación con otros documentos devueltos por la consulta.

SemanticDebugInfo

Nombre	Tipo	Description
contentFields	QueryResultDocumentSemanticField[]	Los campos de contenido que se enviaron al proceso de enriquecimiento semántico, así como cómo se usaron
keywordFields	QueryResultDocumentSemanticField[]	Los campos de palabra clave que se enviaron al proceso de enriquecimiento semántico, así como cómo se usaron.
rerankerInput	QueryResultDocumentRerankerInput	Cadenas concatenadas sin formato 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 o devolver resultados parciales (valor predeterminado).

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 se estableció 'semanticMaxWaitInMilliseconds' y la duración del procesamiento semántico superó ese valor. Solo se devolvieron los resultados base.
transient	string	Error al menos un paso del proceso semántico.

SemanticFieldState

La forma en que se usó el campo para el proceso de enriquecimiento semántico (totalmente usado, 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.

SemanticSearchResultsType

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

Nombre	Tipo	Description
baseResults	string	Resultados sin ningún enriquecimiento semántico ni reranking.
rerankedResults	string	Los resultados se han vuelto a generar con el modelo de reranker y incluirán subtítulos semánticos. No incluirá ninguna respuesta, resaltado de respuestas ni subtítulo resaltados.

VectorFilterMode

Determina si se aplican o no filtros 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 de 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.

VectorizableTextQuery

Parámetros de consulta que se usarán para la búsqueda vectorial cuando se proporciona un valor de texto que se debe vectorizar.

Nombre	Tipo	Description
exhaustive	boolean	Cuando es true, desencadena una búsqueda de vecinos 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.
k	integer	Número de vecinos más cercanos que se van a devolver como visitas principales.
kind	string: text	Tipo de consulta vectorial que se realiza.
text	string	Texto que se va a vectorizar para realizar una consulta de búsqueda vectorial.

VectorQueryKind

El tipo de consulta vectorial que se realiza.

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