Package version:

Interface SearchDocumentsResult<TModel, TFields>

Response containing search results from an index.

interface SearchDocumentsResult<TModel, TFields> {
    answers?: QueryAnswerResult[];
    count?: number;
    coverage?: number;
    debugInfo?: DebugInfo;
    facets?: {
        [propertyName: string]: FacetResult[];
    };
    results: PagedAsyncIterableIterator<SearchResult<TModel, TFields>, SearchDocumentsPageResult<TModel, TFields>, ListSearchResultsPageSettings>;
    semanticErrorReason?: "maxWaitExceeded" | "capacityOverloaded" | "transient";
    semanticQueryRewritesResultType?: string;
    semanticSearchResultsType?: "baseResults" | "rerankedResults";
}

Type Parameters

Hierarchy (view full)

Properties

answers? count? coverage? debugInfo? facets? results semanticErrorReason? semanticQueryRewritesResultType? semanticSearchResultsType?

Properties

Optional Readonlyanswers

answers?: QueryAnswerResult[]

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.

Optional Readonlycount

count?: number

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.

Optional Readonlycoverage

coverage?: number

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.

Optional ReadonlydebugInfo

debugInfo?: DebugInfo

Debug information that applies to the search results as a whole. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonlyfacets

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

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.

Readonlyresults

results: PagedAsyncIterableIterator<SearchResult<TModel, TFields>, SearchDocumentsPageResult<TModel, TFields>, ListSearchResultsPageSettings>

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

Optional ReadonlysemanticErrorReason

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

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.

Optional ReadonlysemanticQueryRewritesResultType

semanticQueryRewritesResultType?: string

Type of query rewrite that was used to retrieve documents. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlysemanticSearchResultsType

semanticSearchResultsType?: "baseResults" | "rerankedResults"

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.

Settings

Member Visibility