SearchDocumentsPageResult interface

Paket:

@azure/search-documents

Antwort mit Suchergebnissen aus einem Index.

Extends

SearchDocumentsResultBase

Eigenschaften

continuationToken	Ein Token, das zum Abrufen der nächsten Ergebnisseite verwendet wird, wenn der Server die Paginierung erzwingt.
results	Die Sequenz der von der Abfrage zurückgegebenen Ergebnisse. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

Geerbte Eigenschaften

answers	Die Ergebnisse der Antwortabfrage für den Suchvorgang; NULL, wenn der Antwortabfrageparameter nicht angegeben oder auf "none" festgelegt wurde. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
count	Die Gesamtanzahl der Ergebnisse, die vom Suchvorgang gefunden wurden, oder NULL, wenn die Anzahl nicht angefordert wurde. Falls vorhanden, kann die Anzahl größer sein als die Anzahl der Ergebnisse in dieser Antwort. Dies kann passieren, wenn Sie die Parameter $top oder $skip verwenden oder wenn Azure Cognitive Search nicht alle angeforderten Dokumente in einer einzelnen Suchantwort zurückgeben können. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
coverage	Ein Wert, der den Prozentsatz des Indexes angibt, der in der Abfrage enthalten war, oder NULL, wenn minimumCoverage nicht in der Anforderung angegeben wurde. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
facets	Die Ergebnisse der Facetabfrage für den Suchvorgang, organisiert als Sammlung von Buckets für jedes Facettenfeld; NULL, wenn die Abfrage keine Facetausdrücke enthält. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
semanticErrorReason	Grund dafür, dass eine Teilantwort für eine semantische Suchanforderung zurückgegeben wurde. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
semanticSearchResultsType	Typ der Teilantwort, die für eine semantische Suchanforderung zurückgegeben wurde. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

Details zur Eigenschaft

continuationToken

Ein Token, das zum Abrufen der nächsten Ergebnisseite verwendet wird, wenn der Server die Paginierung erzwingt.

continuationToken?: string

Eigenschaftswert

string

results

Die Sequenz der von der Abfrage zurückgegebenen Ergebnisse. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

results: SearchResult<TModel, TFields>[]

Eigenschaftswert

SearchResult<TModel, TFields>[]

Geerbte Eigenschaftsdetails

answers

Die Ergebnisse der Antwortabfrage für den Suchvorgang; NULL, wenn der Antwortabfrageparameter nicht angegeben oder auf "none" festgelegt wurde. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

answers?: QueryAnswerResult[]

Eigenschaftswert

QueryAnswerResult[]

Geerbt vonSearchDocumentsResultBase.answers

count

Die Gesamtanzahl der Ergebnisse, die vom Suchvorgang gefunden wurden, oder NULL, wenn die Anzahl nicht angefordert wurde. Falls vorhanden, kann die Anzahl größer sein als die Anzahl der Ergebnisse in dieser Antwort. Dies kann passieren, wenn Sie die Parameter $top oder $skip verwenden oder wenn Azure Cognitive Search nicht alle angeforderten Dokumente in einer einzelnen Suchantwort zurückgeben können. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

count?: number

Eigenschaftswert

number

Geerbt vonSearchDocumentsResultBase.count

coverage

Ein Wert, der den Prozentsatz des Indexes angibt, der in der Abfrage enthalten war, oder NULL, wenn minimumCoverage nicht in der Anforderung angegeben wurde. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

coverage?: number

Eigenschaftswert

number

Geerbt vonSearchDocumentsResultBase.coverage

facets

Die Ergebnisse der Facetabfrage für den Suchvorgang, organisiert als Sammlung von Buckets für jedes Facettenfeld; NULL, wenn die Abfrage keine Facetausdrücke enthält. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

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

Eigenschaftswert

{[propertyName: string]: FacetResult[]}

Geerbt vonSearchDocumentsResultBase.facets

semanticErrorReason

Grund dafür, dass eine Teilantwort für eine semantische Suchanforderung zurückgegeben wurde. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

semanticErrorReason?: SemanticErrorReason

Eigenschaftswert

SemanticErrorReason

Geerbt vonSearchDocumentsResultBase.semanticErrorReason

semanticSearchResultsType

Typ der Teilantwort, die für eine semantische Suchanforderung zurückgegeben wurde. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

semanticSearchResultsType?: SemanticSearchResultsType

Eigenschaftswert

SemanticSearchResultsType

Geerbt vonSearchDocumentsResultBase.semanticSearchResultsType