Share via


ConversationParameters Class

Parameters for creating a new conversation.

Constructor

pydantic model ConversationParameters

Parameters

Name Description
is_group
Required

IsGroup

agent
Required

The agent address for this conversation

members
Required

Members to add to the conversation

topic_name
Required
str

(Optional) Topic of the conversation (if supported by the channel)

activity
Required

(Optional) When creating a new conversation, use this activity as the initial message to the conversation

channel_data
Required

Channel specific payload for creating the conversation

tenant_id
Required
str

(Optional) The tenant ID in which the conversation should be created

Keyword-Only Parameters

Name Description
isGroup
Default value: None
bot
Default value: None
members
Default value: None
topicName
Default value: None
activity
Default value: None
channelData
Default value: None
tenantId
Default value: None

Attributes

activity

field activity: Activity = None

agent

field agent: ChannelAccount = None (alias 'bot')

channel_data

field channel_data: object = None (alias 'channelData')

is_group

field is_group: bool = None (alias 'isGroup')

members

field members: list[ChannelAccount] = None

tenant_id

field tenant_id: str = None (alias 'tenantId')

topic_name

field topic_name: str = None (alias 'topicName')