Interface GeneratedAnswerState

A scoped and simplified part of the headless state that is relevant to the GeneratedAnswer component.

interface GeneratedAnswerState {
    answer?: string;
    answerConfigurationId?: string;
    answerContentFormat?: "text/plain" | "text/markdown";
    cannotAnswer: boolean;
    citations: GeneratedAnswerCitation[];
    disliked: boolean;
    error?: { code?: number; isRetryable?: boolean; message?: string };
    expanded: boolean;
    feedbackModalOpen: boolean;
    feedbackSubmitted: boolean;
    fieldsToIncludeInCitations: string[];
    id: string;
    isAnswerGenerated: boolean;
    isEnabled: boolean;
    isLoading: boolean;
    isStreaming: boolean;
    isVisible: boolean;
    liked: boolean;
    responseFormat: GeneratedResponseFormat;
}

Properties

answer? answerConfigurationId? answerContentFormat? cannotAnswer citations disliked error? expanded feedbackModalOpen feedbackSubmitted fieldsToIncludeInCitations id isAnswerGenerated isEnabled isLoading isStreaming isVisible liked responseFormat

Properties

Optionalanswer

answer?: string

The generated answer.

OptionalanswerConfigurationId

answerConfigurationId?: string

The answer configuration unique identifier.

OptionalanswerContentFormat

answerContentFormat?: "text/plain" | "text/markdown"

The content format of the generated answer. Possible values are:

  • text/plain
  • text/markdown

cannotAnswer

cannotAnswer: boolean

Whether an answer cannot be generated after a query is executed.

citations

citations: GeneratedAnswerCitation[]

The document snippets retrieved to generate the answer.

disliked

disliked: boolean

Determines if the generated answer is disliked, or downvoted by the end user.

Optionalerror

error?: { code?: number; isRetryable?: boolean; message?: string }

The generated answer error.

expanded

expanded: boolean

Whether the answer is expanded.

feedbackModalOpen

feedbackModalOpen: boolean

Determines if the feedback modal is currently opened.

feedbackSubmitted

feedbackSubmitted: boolean

Determines if the generated answer feedback was submitted.

fieldsToIncludeInCitations

fieldsToIncludeInCitations: string[]

A list of indexed fields to include in the citations returned with the generated answer.

id

id: string

isAnswerGenerated

isAnswerGenerated: boolean

Determines if the answer is generated.

isEnabled

isEnabled: boolean

Determines if the generated answer is enabled.

isLoading

isLoading: boolean

Determines if the generated answer is loading.

isStreaming

isStreaming: boolean

Determines if the generated answer is streaming.

isVisible

isVisible: boolean

Determines if the generated answer is visible.

liked

liked: boolean

Determines if the generated answer is liked, or upvoted by the end user.

responseFormat

responseFormat: GeneratedResponseFormat

The desired format options for the generated answer.

Settings

Member Visibility

On This Page

Properties