Partager via

SearchDocumentsPageResult interface

Paquet:
@azure/search-documents

Réponse contenant les résultats de la page de recherche à partir d’un index.

Extends
SearchDocumentsResultBase

Propriétés

continuationToken

Jeton utilisé pour récupérer la page suivante des résultats lorsque le serveur applique la pagination.
results

Séquence de résultats retournés par la requête. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

Propriétés héritées

answers

Résultats de la requête réponses pour l’opération de recherche ; Null si le paramètre de requête réponses n’a pas été spécifié ou défini sur « none ». REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
count

Nombre total de résultats trouvés par l’opération de recherche ou null si le nombre n’a pas été demandé. S’il est présent, le nombre peut être supérieur au nombre de résultats dans cette réponse. Cela peut se produire si vous utilisez les paramètres $top ou $skip, ou si Recherche cognitive Azure ne peut pas retourner tous les documents demandés dans une seule réponse de recherche. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
coverage

Valeur indiquant le pourcentage de l’index inclus dans la requête ou null si minimumCoverage n’a pas été spécifié dans la requête. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
facets

Résultats de la requête de facette pour l’opération de recherche, organisés sous la forme d’une collection de compartiments pour chaque champ à facettes ; Null si la requête n’incluait aucune expression de facette. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
semanticErrorReason

Raison pour laquelle une réponse partielle a été retournée pour une demande de recherche sémantique. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
semanticSearchResultsType

Type de réponse partielle retournée pour une demande de recherche sémantique. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

Détails de la propriété

continuationToken

Jeton utilisé pour récupérer la page suivante des résultats lorsque le serveur applique la pagination.

continuationToken?: string

Valeur de propriété

string

results

Séquence de résultats retournés par la requête. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

results: SearchResult<TModel, TFields>[]

Valeur de propriété

SearchResult<TModel, TFields>[]

Détails de la propriété héritée

answers

Résultats de la requête réponses pour l’opération de recherche ; Null si le paramètre de requête réponses n’a pas été spécifié ou défini sur « none ». REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

answers?: QueryAnswerResult[]

Valeur de propriété

QueryAnswerResult[]

héritée deSearchDocumentsResultBase.answers

count

Nombre total de résultats trouvés par l’opération de recherche ou null si le nombre n’a pas été demandé. S’il est présent, le nombre peut être supérieur au nombre de résultats dans cette réponse. Cela peut se produire si vous utilisez les paramètres $top ou $skip, ou si Recherche cognitive Azure ne peut pas retourner tous les documents demandés dans une seule réponse de recherche. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

count?: number

Valeur de propriété

number

héritée deSearchDocumentsResultBase.count

coverage

Valeur indiquant le pourcentage de l’index inclus dans la requête ou null si minimumCoverage n’a pas été spécifié dans la requête. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

coverage?: number

Valeur de propriété

number

héritée deSearchDocumentsResultBase.coverage

facets

Résultats de la requête de facette pour l’opération de recherche, organisés sous la forme d’une collection de compartiments pour chaque champ à facettes ; Null si la requête n’incluait aucune expression de facette. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

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

Valeur de propriété

{[propertyName: string]: FacetResult[]}

héritée deSearchDocumentsResultBase.facets

semanticErrorReason

Raison pour laquelle une réponse partielle a été retournée pour une demande de recherche sémantique. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

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

Valeur de propriété

"maxWaitExceeded" | "capacityOverloaded" | "transient"

héritée deSearchDocumentsResultBase.semanticErrorReason

semanticSearchResultsType

Type de réponse partielle retournée pour une demande de recherche sémantique. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

semanticSearchResultsType?: "baseResults" | "rerankedResults"

Valeur de propriété

"baseResults" | "rerankedResults"

héritée deSearchDocumentsResultBase.semanticSearchResultsType