Documents - Search Get

Referencia

Servicio:: Search Service

Versión de la API:: 2024-07-01

Busca documentos en el índice.

GET {endpoint}/indexes('{indexName}')/docs?api-version=2024-07-01

Con parámetros opcionales:

GET {endpoint}/indexes('{indexName}')/docs?search={search}&$count={$count}&facet={facet}&$filter={$filter}&highlight={highlight}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&queryType={queryType}&scoringParameter={scoringParameter}&scoringProfile={scoringProfile}&searchFields={searchFields}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&api-version=2024-07-01&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}

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.
$count	query		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.
$filter	query		string	Expresión de $filter de OData que se va a aplicar a la consulta de búsqueda.
$orderby	query		string[]	Lista 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 y 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 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.
$select	query		string[]	Lista de campos que se van a recuperar. Si no se especifica, se incluyen todos los campos marcados como recuperables en el esquema.
$skip	query		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 $skip debido a esta limitación, considere la posibilidad de usar $orderby en una clave totalmente ordenada y $filter con una consulta de intervalo en su lugar.
$top	query		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.
answers	query		QueryAnswerType	Este parámetro solo es válido si el tipo de consulta es `semantic`. Si se establece, la consulta devuelve respuestas extraídas de los pasajes clave de los documentos clasificados más altos. El número de respuestas devueltas se puede configurar anexando el carácter de canalización `\|` seguido de la opción `count-<number of answers>` después del valor del parámetro de respuestas, como `extractive\|count-3`. El recuento predeterminado es 1. El umbral de confianza se puede configurar anexando el carácter de canalización `\|` seguido de la opción `threshold-<confidence threshold>` después del valor del parámetro de respuestas, como `extractive\|threshold-0.9`. El umbral predeterminado es 0,7.
captions	query		QueryCaptionType	Este parámetro solo es válido si el tipo de consulta es `semantic`. Si se establece, la consulta devuelve títulos extraídos de los pasajes clave de los documentos clasificados más altos. Cuando captions se establece en `extractive`, el resaltado está habilitado de forma predeterminada y se puede configurar anexando el carácter de canalización `\|` seguido de la opción `highlight-<true/false>`, como `extractive\|highlight-true`. El valor predeterminado es `None`.
facet	query		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.
highlight	query		string[]	Lista 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	query		string	Etiqueta de cadena que se anexa a los resaltados de aciertos. Debe establecerse con highlightPreTag. El valor predeterminado es </em>.
highlightPreTag	query		string	Etiqueta de cadena que se antepone para alcanzar los resaltados. Debe establecerse con highlightPostTag. El valor predeterminado es <em>.
minimumCoverage	query		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.
queryType	query		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.
scoringParameter	query		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	query		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	query		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.
search	query		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	query		string[]	Lista 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	query		SearchMode	Valor que especifica si alguno o todos los términos de búsqueda deben coincidir para contar el documento como una coincidencia.
semanticConfiguration	query		string	Nombre de la configuración semántica que enumera los campos que se deben usar para la clasificación semántica, los títulos, los resaltados y las respuestas.
semanticErrorHandling	query		SemanticErrorMode	Permite al usuario elegir si una llamada semántica debe producir un error por completo o devolver resultados parciales (valor predeterminado).
semanticMaxWaitInMilliseconds	query		integer int32	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	query		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	query		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 '_'.

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.

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

SearchIndexSearchDocumentsGet

SearchIndexSearchDocumentsSemanticGet

SearchIndexSearchDocumentsGet

Solicitud de ejemplo

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=nice hotels&$count=True&facet=category,count:10,sort:count&$filter=rating gt 10&highlight=title&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&queryType=simple&scoringProfile=sp&searchFields=title,description&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2024-07-01

Respuesta de muestra

status code:: 200

{
  "@odata.count": 25,
  "@search.coverage": 80,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "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"
    }
  ]
}

SearchIndexSearchDocumentsSemanticGet

Solicitud de ejemplo

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=how do clouds form&$count=True&highlightPostTag=</em>&highlightPreTag=<em>&queryType=semantic&api-version=2024-07-01&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true&semanticQuery={semanticQuery}

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
    }
  ],
  "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"
      ]
    }
  ]
}

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`.
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.
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 de Lucene.
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.
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.
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

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.

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.

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.

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

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

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

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.

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.

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.

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.
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.
text	string	Texto 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.

VectorQueryKind

Tipo de consulta vectorial que se está realizando.

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

Compartir a través de

Documents - Search Get

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Ejemplos

SearchIndexSearchDocumentsGet

Solicitud de ejemplo

Respuesta de muestra

SearchIndexSearchDocumentsSemanticGet

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AnswerResult

CaptionResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

QueryAnswerType

QueryCaptionType

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchMode

SearchRequest

SearchResult

SemanticErrorMode

SemanticErrorReason

SemanticSearchResultsType

VectorFilterMode

VectorizableTextQuery

VectorQueryKind

Recursos adicionales