SearchDocumentsResultBase interface

Paquete:

@azure/search-documents

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

Propiedades

answers	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". NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
count	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 Azure Cognitive Search no puede devolver todos los documentos solicitados en una única respuesta de búsqueda. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
coverage	Valor que indica el porcentaje del índice que se incluyó en la consulta, o null si minimumCoverage no se especificó en la solicitud. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
facets	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 incluía ninguna expresión de faceta. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
semanticErrorReason	Motivo por el que se devolvió una respuesta parcial para una solicitud de búsqueda semántica. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
semanticSearchResultsType	Tipo de respuesta parcial que se devolvió para una solicitud de búsqueda semántica. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

Detalles de las propiedades

answers

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". NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

answers?: QueryAnswerResult[]

Valor de propiedad

QueryAnswerResult[]

count

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 Azure Cognitive Search no puede devolver todos los documentos solicitados en una única respuesta de búsqueda. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

count?: number

Valor de propiedad

number

coverage

Valor que indica el porcentaje del índice que se incluyó en la consulta, o null si minimumCoverage no se especificó en la solicitud. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

coverage?: number

Valor de propiedad

number

facets

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 incluía ninguna expresión de faceta. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

facets?: {[propertyName: string]: FacetResult[]}

Valor de propiedad

{[propertyName: string]: FacetResult[]}

semanticErrorReason

Motivo por el que se devolvió una respuesta parcial para una solicitud de búsqueda semántica. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

semanticErrorReason?: "maxWaitExceeded" | "capacityOverloaded" | "transient"

Valor de propiedad

"maxWaitExceeded" | "capacityOverloaded" | "transient"

semanticSearchResultsType

Tipo de respuesta parcial que se devolvió para una solicitud de búsqueda semántica. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

semanticSearchResultsType?: "baseResults" | "rerankedResults"

Valor de propiedad

"baseResults" | "rerankedResults"