SearchDocumentsResult interface

Pakket:

@azure/search-documents

Antwoord met zoekresultaten van een index.

Uitbreiding

SearchDocumentsResultBase

Eigenschappen

results

De reeks resultaten die door de query worden geretourneerd. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

Overgenomen eigenschappen

answers	De antwoordenqueryresultaten voor de zoekbewerking; null als de queryparameter answers niet is opgegeven of is ingesteld op 'none'. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
count	Het totale aantal resultaten dat is gevonden door de zoekbewerking of null als het aantal niet is aangevraagd. Indien aanwezig, kan het aantal groter zijn dan het aantal resultaten in dit antwoord. Dit kan gebeuren als u de parameters $top of $skip gebruikt, of als Azure Cognitive Search niet alle aangevraagde documenten in één zoekantwoord kan retourneren. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
coverage	Een waarde die het percentage aangeeft van de index die is opgenomen in de query of null als minimumCoverage niet is opgegeven in de aanvraag. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
facets	De facetqueryresultaten voor de zoekbewerking, geordend als een verzameling buckets voor elk facetveld; null als de query geen facetexpressies bevat. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
semanticErrorReason	Reden dat een gedeeltelijk antwoord is geretourneerd voor een semantische zoekaanvraag. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
semanticSearchResultsType	Type gedeeltelijke reactie dat is geretourneerd voor een semantische zoekaanvraag. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

Eigenschapdetails

results

De reeks resultaten die door de query worden geretourneerd. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

results: SearchIterator<TModel, TFields>

Waarde van eigenschap

SearchIterator<TModel, TFields>

Details van overgenomen eigenschap

answers

De antwoordenqueryresultaten voor de zoekbewerking; null als de queryparameter answers niet is opgegeven of is ingesteld op 'none'. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

answers?: QueryAnswerResult[]

Waarde van eigenschap

QueryAnswerResult[]

overgenomen vanSearchDocumentsResultBase.answers

count

Het totale aantal resultaten dat is gevonden door de zoekbewerking of null als het aantal niet is aangevraagd. Indien aanwezig, kan het aantal groter zijn dan het aantal resultaten in dit antwoord. Dit kan gebeuren als u de parameters $top of $skip gebruikt, of als Azure Cognitive Search niet alle aangevraagde documenten in één zoekantwoord kan retourneren. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

count?: number

Waarde van eigenschap

number

overgenomen vanSearchDocumentsResultBase.count

coverage

Een waarde die het percentage aangeeft van de index die is opgenomen in de query of null als minimumCoverage niet is opgegeven in de aanvraag. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

coverage?: number

Waarde van eigenschap

number

overgenomen vanSearchDocumentsResultBase.coverage

facets

De facetqueryresultaten voor de zoekbewerking, geordend als een verzameling buckets voor elk facetveld; null als de query geen facetexpressies bevat. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

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

Waarde van eigenschap

{[propertyName: string]: FacetResult[]}

overgenomen vanSearchDocumentsResultBase.facets

semanticErrorReason

Reden dat een gedeeltelijk antwoord is geretourneerd voor een semantische zoekaanvraag. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

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

Waarde van eigenschap

"maxWaitExceeded" | "capacityOverloaded" | "transient"

overgenomen vanSearchDocumentsResultBase.semanticErrorReason

semanticSearchResultsType

Type gedeeltelijke reactie dat is geretourneerd voor een semantische zoekaanvraag. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

semanticSearchResultsType?: "baseResults" | "rerankedResults"

Waarde van eigenschap

"baseResults" | "rerankedResults"

overgenomen vanSearchDocumentsResultBase.semanticSearchResultsType