SearchDocumentsPageResult interface

Paquete:

@azure/search-documents

Respuesta que contiene los resultados de la página de búsqueda de un índice.

Extends

SearchDocumentsResultBase

Propiedades

continuationToken	Token usado para recuperar la página siguiente de resultados cuando el servidor aplica la paginación.
results	Secuencia de resultados devueltos por la consulta. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

Propiedades heredadas

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 suceder si usa los parámetros $top o $skip, o si Azure AI Search no puede devolver todos los documentos solicitados en una sola 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 no se especificó minimumCoverage en la solicitud. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
debugInfo	Depurar información que se aplica a los resultados de búsqueda en su conjunto. 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 incluye 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.
semanticQueryRewritesResultType	Tipo de reescritura de consulta que se usó para recuperar documentos. 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

continuationToken

Token usado para recuperar la página siguiente de resultados cuando el servidor aplica la paginación.

continuationToken?: string

Valor de propiedad

string

results

Secuencia de resultados devueltos por la consulta. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

results: SearchResult<TModel, TFields>[]

Valor de propiedad

SearchResult<TModel, TFields>[]

Detalles de las propiedades heredadas

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

Heredado deSearchDocumentsResultBase.answers

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 suceder si usa los parámetros $top o $skip, o si Azure AI Search no puede devolver todos los documentos solicitados en una sola respuesta de búsqueda. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

count?: number

Valor de propiedad

number

heredado deSearchDocumentsResultBase.count

coverage

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

coverage?: number

Valor de propiedad

number

Heredado deSearchDocumentsResultBase.coverage

debugInfo

Depurar información que se aplica a los resultados de búsqueda en su conjunto. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

debugInfo?: DebugInfo

Valor de propiedad

DebugInfo

heredado deSearchDocumentsResultBase.debugInfo

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 incluye 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[]}

Heredado deSearchDocumentsResultBase.facets

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"

Heredado deSearchDocumentsResultBase.semanticErrorReason

semanticQueryRewritesResultType

Tipo de reescritura de consulta que se usó para recuperar documentos. NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.

semanticQueryRewritesResultType?: string

Valor de propiedad

string

heredado deSearchDocumentsResultBase.semanticQueryRewritesResultType

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"

Heredado deSearchDocumentsResultBase.semanticSearchResultsType