Skip to content

ConversationSessionOptions

Options for starting a session on a conversation object. Unlike SessionStartEventOptions, conversationId is not needed since it's implicit from the conversation.

Properties

Property Type Description
capabilities? SessionCapabilities Optional capabilities of this client to advertise to the service when starting the session. Generally not needed unless the client is accessing more advanced features.
echo? boolean When set, causes events emitted to also be dispatched to event handlers. This option is useful when the event helper objects are bound to UI components as it allows a single code path for rendering both user and assistant messages.
logLevel? LogLevel Sets the log level for WebSocket session debugging. When set, enables logging at the specified level for the underlying WebSocket connection. Example import { LogLevel } from '@uipath/uipath-typescript/conversational-agent'; const session = conversation.startSession({ logLevel: LogLevel.Debug });