SearchDocumentsResult interface

Pacchetto:

@azure/search-documents

Risposta contenente i risultati della ricerca da un indice.

Extends

SearchDocumentsResultBase

Proprietà

results

Sequenza di risultati restituiti dalla query. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

Proprietà ereditate

answers	Risposte ai risultati della query per l'operazione di ricerca; Null se il parametro di query answers non è stato specificato o impostato su 'none'. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
count	Conteggio totale dei risultati rilevati dall'operazione di ricerca oppure Null se il conteggio non è stato richiesto. Se presente, il conteggio può essere maggiore del numero di risultati in questa risposta. Ciò può verificarsi se si usano i parametri $top o $skip oppure se Ricerca cognitiva di Azure non può restituire tutti i documenti richiesti in una singola risposta di ricerca. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
coverage	Valore che indica la percentuale dell'indice incluso nella query oppure null se minimumCoverage non è stato specificato nella richiesta. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
facets	Risultati della query facet per l'operazione di ricerca, organizzati come raccolta di bucket per ogni campo in base a facet; Null se la query non include espressioni facet. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
semanticErrorReason	Motivo per cui è stata restituita una risposta parziale per una richiesta di ricerca semantica. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
semanticSearchResultsType	Tipo di risposta parziale restituita per una richiesta di ricerca semantica. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

Dettagli proprietà

results

Sequenza di risultati restituiti dalla query. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

results: SearchIterator<TModel, TFields>

Valore della proprietà

SearchIterator<TModel, TFields>

Dettagli proprietà ereditate

answers

Risposte ai risultati della query per l'operazione di ricerca; Null se il parametro di query answers non è stato specificato o impostato su 'none'. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

answers?: QueryAnswerResult[]

Valore della proprietà

QueryAnswerResult[]

Ereditato daSearchDocumentsResultBase.answers

count

Conteggio totale dei risultati rilevati dall'operazione di ricerca oppure Null se il conteggio non è stato richiesto. Se presente, il conteggio può essere maggiore del numero di risultati in questa risposta. Ciò può verificarsi se si usano i parametri $top o $skip oppure se Ricerca cognitiva di Azure non può restituire tutti i documenti richiesti in una singola risposta di ricerca. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

count?: number

Valore della proprietà

number

ereditato daSearchDocumentsResultBase.count

coverage

Valore che indica la percentuale dell'indice incluso nella query oppure null se minimumCoverage non è stato specificato nella richiesta. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

coverage?: number

Valore della proprietà

number

ereditato daSearchDocumentsResultBase.coverage

facets

Risultati della query facet per l'operazione di ricerca, organizzati come raccolta di bucket per ogni campo in base a facet; Null se la query non include espressioni facet. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

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

Valore della proprietà

{[propertyName: string]: FacetResult[]}

ereditato daSearchDocumentsResultBase.facets

semanticErrorReason

Motivo per cui è stata restituita una risposta parziale per una richiesta di ricerca semantica. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

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

Valore della proprietà

"maxWaitExceeded" | "capacityOverloaded" | "transient"

Ereditato daSearchDocumentsResultBase.semanticErrorReason

semanticSearchResultsType

Tipo di risposta parziale restituita per una richiesta di ricerca semantica. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

semanticSearchResultsType?: "baseResults" | "rerankedResults"

Valore della proprietà

"baseResults" | "rerankedResults"

Ereditato daSearchDocumentsResultBase.semanticSearchResultsType