SearchDocumentsResult interface

Package:

@azure/search-documents

Response containing search results from an index.

Extends

SearchDocumentsResultBase

Properties

results

The sequence of results returned by the query. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

answers	The answers query results for the search operation; null if the answers query parameter was not specified or set to 'none'. NOTE: This property will not be serialized. It can only be populated by the server.
count	The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if Azure Cognitive Search can't return all the requested documents in a single Search response. NOTE: This property will not be serialized. It can only be populated by the server.
coverage	A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not specified in the request. NOTE: This property will not be serialized. It can only be populated by the server.
facets	The facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not include any facet expressions. NOTE: This property will not be serialized. It can only be populated by the server.
semanticErrorReason	Reason that a partial response was returned for a semantic search request. NOTE: This property will not be serialized. It can only be populated by the server.
semanticSearchResultsType	Type of partial response that was returned for a semantic search request. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

results

The sequence of results returned by the query. NOTE: This property will not be serialized. It can only be populated by the server.

results: SearchIterator<TModel, TFields>

Property Value

SearchIterator<TModel, TFields>

Inherited Property Details

answers

The answers query results for the search operation; null if the answers query parameter was not specified or set to 'none'. NOTE: This property will not be serialized. It can only be populated by the server.

answers?: QueryAnswerResult[]

Property Value

QueryAnswerResult[]

Inherited From SearchDocumentsResultBase.answers

count

The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if Azure Cognitive Search can't return all the requested documents in a single Search response. NOTE: This property will not be serialized. It can only be populated by the server.

count?: number

Property Value

number

Inherited From SearchDocumentsResultBase.count

coverage

A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not specified in the request. NOTE: This property will not be serialized. It can only be populated by the server.

coverage?: number

Property Value

number

Inherited From SearchDocumentsResultBase.coverage

facets

The facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not include any facet expressions. NOTE: This property will not be serialized. It can only be populated by the server.

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

Property Value

{[propertyName: string]: FacetResult[]}

Inherited From SearchDocumentsResultBase.facets

semanticErrorReason

Reason that a partial response was returned for a semantic search request. NOTE: This property will not be serialized. It can only be populated by the server.

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

Property Value

"maxWaitExceeded" | "capacityOverloaded" | "transient"

Inherited From SearchDocumentsResultBase.semanticErrorReason

semanticSearchResultsType

Type of partial response that was returned for a semantic search request. NOTE: This property will not be serialized. It can only be populated by the server.

semanticSearchResultsType?: "baseResults" | "rerankedResults"

Property Value

"baseResults" | "rerankedResults"

Inherited From SearchDocumentsResultBase.semanticSearchResultsType