chat¶
Operation¶
async
¶
chat(input: ChatInput, plugins: list[Plugin] | None = None) -> DuplexEventStream[ChatInputStream, ChatOutputStream, ChatOutput]
Starts or continues a streaming Amazon Q Business conversation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ChatInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DuplexEventStream[ChatInputStream, ChatOutputStream, ChatOutput]
|
A |
Input¶
dataclass
¶
Dataclass for ChatInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.
class-attribute
instance-attribute
¶
client_token: str | None = None
A token that you provide to identify the chat input.
class-attribute
instance-attribute
¶
conversation_id: str | None = None
The identifier of the Amazon Q Business conversation.
class-attribute
instance-attribute
¶
parent_message_id: str | None = None
The identifier used to associate a user message with a AI generated response.
class-attribute
instance-attribute
¶
user_groups: list[str] | None = None
The group names that a user associated with the chat input belongs to.
class-attribute
instance-attribute
¶
user_id: str | None = None
The identifier of the user attached to the chat input.
Output¶
This operation returns a DuplexEventStream for bidirectional streaming.
Event Stream Structure¶
Input Event Type¶
Output Event Type¶
Initial Response Structure¶
dataclass
¶
Dataclass for ChatOutput structure.