Interface UseConversationMessagesParams

Parameters required for the useConversationMessages hook.

interface UseConversationMessagesParams {
    agentId: string | null;
    agentIds: string[];
    assistantIntroRef: MutableRefObject<PseudonymousMessage[]>;
    chatIntroRef: MutableRefObject<PseudonymousMessage[]>;
    chatPasscode: string;
    conversationId: string | undefined;
    initialJoinComplete: boolean;
    pseudonym: string | null;
    userId: string | null;
}

Properties

agentId: string | null

The ID of the agent associated with the conversation, used to fetch assistant messages.

agentIds: string[]

An array of agent IDs associated with the conversation, used to fetch all assistant messages.

assistantIntroRef: MutableRefObject<PseudonymousMessage[]>

A mutable reference to an array of introductory assistant messages, used to prepend to fetched assistant messages.

chatIntroRef: MutableRefObject<PseudonymousMessage[]>

A mutable reference to an array of introductory chat messages, used to prepend to fetched chat messages.

chatPasscode: string

The passcode for accessing chat messages in the conversation.

conversationId: string | undefined

The unique identifier for the current conversation, used to fetch messages.

initialJoinComplete: boolean

Whether the user has completed the initial join process for the conversation.

pseudonym: string | null

The pseudonym of the current user, used to filter messages and replies.

userId: string | null

The ID of the current user participating in the conversation.