Share via

SuggestDocumentsResult interface

  • Reference
Package:
@azure/search-documents

Response containing suggestion query results from an index.

Properties

coverage

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

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

Property Details

coverage

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

coverage?: number

Property Value

number

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: SuggestResult<TModel, TFields>[]

Property Value

SuggestResult<TModel, TFields>[]