Interface ConversationalSearchItem<TUserDefinedType>

A text response generated by AI with an optional list of citations for where the information came from.

interface ConversationalSearchItem<TUserDefinedType = Record<string, unknown>> {
    agent_message_type?: AgentMessageType;
    citations?: ConversationalSearchItemCitation[];
    citations_title: string;
    disclaimer: string;
    message_options?: GenericItemMessageOptions;
    response_type: MessageResponseTypes;
    streaming_metadata?: ItemStreamingMetadata;
    text: string;
    user_defined?: TUserDefinedType;
}

Type Parameters

  • TUserDefinedType = Record<string, unknown>

Hierarchy (View Summary, Expand)

Properties

agent_message_type? citations? citations_title disclaimer message_options? response_type streaming_metadata? text user_defined?

Properties

Optionalagent_message_type

agent_message_type?: AgentMessageType

For messages that are sent between the user and a human agent, we assign an agent type to the message to distinguish what type it is.

Optionalcitations

citations?: ConversationalSearchItemCitation[]

Citations are used to connect specific text within a conversational search response with the relevant documents returned by the backend.

citations_title

citations_title: string

A title to display above the citation list, default set to "How do we know?".

disclaimer

disclaimer: string

A string to explain that these results are generated, default set to "Accuracy of generated answers may vary.".

Optionalmessage_options

message_options?: GenericItemMessageOptions

Options that control additional features available for a message item.

response_type

response_type: MessageResponseTypes

The response type of this message item.

Optionalstreaming_metadata

streaming_metadata?: ItemStreamingMetadata

Metadata used identify a generic item within the context of a stream in order to correlate any updates meant for a specific item.

text

text: string

The returned conversational text. Any HTML/Markdown will be ignored.

Optionaluser_defined

user_defined?: TUserDefinedType

An optional buckets of additional user defined properties for this item.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR