1. Interfaces

RelatedQuestionsOptions

Version:
TypeInterface
Import path@sitecore-cloudsdk/search/browser

Options to retrieve AI-generated question-and-answer pairs relevant to the site visitor's query. Used in the questions-answers object of a widget item.

Signature

export interface RelatedQuestionsOptions {
  limit?: number;
  includeSources?: boolean;
  filter?: Filter;
  offset?: number;
}

Properties

NameTypeDescriptionValue
limitintegerOptional.

The number to set as the question-and-answer pair limit.

Used for pagination by specifying the maximum number of question-and-answer pairs to return.

Minimum: 1.

Maximum: 100.		25
includeSourcesbooleanOptional.

Include configured additional attributes from index documents used to generate this answer.		true
filterFilterOptional.

Various filter criteria that can be used to filter the content to be returned.		N/A
offsetintegerOptional.

The number of items to skip in the results that are returned.

Used for pagination by indicating how many results to skip.

For example, 10 means the related question-and-answer pairs show the 11th item onwards.

Minimum: 1.		1
If you have suggestions for improving this article, let us know!