Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SearchDocumentsResult<T>

Package version

Response containing search results from an index.

Type parameters

  • T

Hierarchy

Index

Properties

Optional count

count: undefined | 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 coverage

coverage: undefined | 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 facets

facets: undefined | {}

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.

Optional nextLink

nextLink: undefined | string

Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nextPageParameters

nextPageParameters: SearchRequest

Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response. NOTE: This property will not be serialized. It can only be populated by the server.

results

results: SearchIterator<T>

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

Generated using TypeDoc