Partager via

SearchDocumentsPageResult interface

  • Référence
Paquet:
@azure/search-documents

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

Extends
SearchDocumentsResultBase

Propriétés

continuationToken

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

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

Propriétés héritées

answers

Résultats de la requête de réponses pour l’opération de recherche ; Null si le paramètre de requête answers n’a pas été spécifié ou défini sur « none ». REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli 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é. Le cas échéant, 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 pouvez pas retourner tous les documents demandés dans une seule réponse de recherche. REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli 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. Il ne peut être rempli que par le serveur.
facets

Les résultats de la requête 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. Il ne peut être rempli 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. Il ne peut être rempli 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. Il ne peut être rempli que par le serveur.

Détails de la propriété

continuationToken

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

continuationToken?: string

Valeur de propriété

string

results

Séquence de résultats retournée par la requête. REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli 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 de réponses pour l’opération de recherche ; Null si le paramètre de requête answers n’a pas été spécifié ou défini sur « none ». REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

answers?: QueryAnswerResult[]

Valeur de propriété

QueryAnswerResult[]

Hérité 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é. Le cas échéant, 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 pouvez pas retourner tous les documents demandés dans une seule réponse de recherche. REMARQUE : Cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

count?: number

Valeur de propriété

number

Hérité 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. Il ne peut être rempli que par le serveur.

coverage?: number

Valeur de propriété

number

Héritée deSearchDocumentsResultBase.coverage

facets

Les résultats de la requête 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. Il ne peut être rempli que par le serveur.

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

Valeur de propriété

{[propertyName: string]: FacetResult[]}

Hérité 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. Il ne peut être rempli que par le serveur.

semanticErrorReason?: SemanticErrorReason

Valeur de propriété

SemanticErrorReason

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. Il ne peut être rempli que par le serveur.

semanticSearchResultsType?: SemanticSearchResultsType

Valeur de propriété

SemanticSearchResultsType

Héritée deSearchDocumentsResultBase.semanticSearchResultsType