SearchDocumentsResult interface

Paket:

@azure/search-documents

Antwort, die Suchergebnisse aus einem Index enthält.

Extends

SearchDocumentsResultBase

Eigenschaften

results

Die Abfolge der ergebnisse, die von der Abfrage zurückgegeben werden. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er 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. Er 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. Wenn vorhanden, kann die Anzahl größer als die Anzahl der Ergebnisse in dieser Antwort sein. Dies kann der Fall sein, wenn Sie die Parameter $top oder $skip verwenden oder wenn Azure AI Search nicht alle angeforderten Dokumente in einer einzigen Suchantwort zurückgeben kann. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er 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. Er kann nur vom Server aufgefüllt werden.
debugInfo	Debuggen Sie Informationen, die für die Suchergebnisse als Ganzes gelten. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
facets	Die Facetabfrageergebnisse für den Suchvorgang, organisiert als Sammlung von Buckets für jedes faceted-Feld; null, wenn die Abfrage keine Facetausdrücke enthält. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
semanticErrorReason	Grund für die Rückgabe einer Teilantwort für eine semantische Suchanforderung. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
semanticQueryRewritesResultType	Typ der Abfrageumschreibung, die zum Abrufen von Dokumenten verwendet wurde. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
semanticSearchResultsType	Typ der teilweisen Antwort, die für eine semantische Suchanforderung zurückgegeben wurde. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

Details zur Eigenschaft

results

Die Abfolge der ergebnisse, die von der Abfrage zurückgegeben werden. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

results: SearchIterator<TModel, TFields>

Eigenschaftswert

SearchIterator<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. Er kann nur vom Server aufgefüllt werden.

answers?: QueryAnswerResult[]

Eigenschaftswert

QueryAnswerResult[]

vonSearchDocumentsResultBase.answers geerbt

count

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

count?: number

Eigenschaftswert

number

vonSearchDocumentsResultBase.count geerbt

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. Er kann nur vom Server aufgefüllt werden.

coverage?: number

Eigenschaftswert

number

geerbt vonSearchDocumentsResultBase.coverage

debugInfo

Debuggen Sie Informationen, die für die Suchergebnisse als Ganzes gelten. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

debugInfo?: DebugInfo

Eigenschaftswert

DebugInfo

Geerbt vonSearchDocumentsResultBase.debugInfo

facets

Die Facetabfrageergebnisse für den Suchvorgang, organisiert als Sammlung von Buckets für jedes faceted-Feld; null, wenn die Abfrage keine Facetausdrücke enthält. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

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

Eigenschaftswert

{[propertyName: string]: FacetResult[]}

vonSearchDocumentsResultBase.facets

semanticErrorReason

Grund für die Rückgabe einer Teilantwort für eine semantische Suchanforderung. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

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

Eigenschaftswert

"maxWaitExceeded" | "capacityOverloaded" | "transient"

vonSearchDocumentsResultBase.semanticErrorReason

semanticQueryRewritesResultType

Typ der Abfrageumschreibung, die zum Abrufen von Dokumenten verwendet wurde. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.

semanticQueryRewritesResultType?: string

Eigenschaftswert

string

Geerbt vonSearchDocumentsResultBase.semanticQueryRewritesResultType

semanticSearchResultsType

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

semanticSearchResultsType?: "baseResults" | "rerankedResults"

Eigenschaftswert

"baseResults" | "rerankedResults"

vonSearchDocumentsResultBase.semanticSearchResultsType