feat: Support parameters for chat (#233)

Author: chyroc

cozepy/chat/__init__.py

@@ -2,7 +2,7 @@
 import json
 import time
 from enum import Enum
-from typing import TYPE_CHECKING, AsyncIterator, Dict, List, Optional, Union, overload
+from typing import TYPE_CHECKING, Any, AsyncIterator, Dict, List, Optional, Union, overload
 
 import httpx
 from typing_extensions import Literal
@@ -442,6 +442,7 @@ def create(
         custom_variables: Optional[Dict[str, str]] = None,
         auto_save_history: bool = True,
         meta_data: Optional[Dict[str, str]] = None,
+        parameters: Optional[Dict[str, Any]] = None,
     ) -> Chat:
         """
         Call the Chat API with non-streaming to send messages to a published Coze bot.
@@ -458,6 +459,7 @@ def create(
         :param custom_variables: The customized variable in a key-value pair.
         :param auto_save_history: Whether to automatically save the history of conversation records.
         :param meta_data: Additional information, typically used to encapsulate some business-related fields.
+        :param parameters: Additional parameters for the chat API. pass through to the workflow.
         :return: chat object
         """
         return self._create(
@@ -469,6 +471,7 @@ def create(
             auto_save_history=auto_save_history,
             meta_data=meta_data,
             conversation_id=conversation_id,
+            parameters=parameters,
         )
 
     def stream(
@@ -481,6 +484,7 @@ def stream(
         auto_save_history: bool = True,
         meta_data: Optional[Dict[str, str]] = None,
         conversation_id: Optional[str] = None,
+        parameters: Optional[Dict[str, Any]] = None,
         **kwargs,
     ) -> Stream[ChatEvent]:
         """
@@ -498,6 +502,7 @@ def stream(
         :param custom_variables: The customized variable in a key-value pair.
         :param auto_save_history: Whether to automatically save the history of conversation records.
         :param meta_data: Additional information, typically used to encapsulate some business-related fields.
+        :param parameters: Additional parameters for the chat API. pass through to the workflow.
         :return: iterator of ChatEvent
         """
         return self._create(
@@ -509,6 +514,7 @@ def stream(
             auto_save_history=auto_save_history,
             meta_data=meta_data,
             conversation_id=conversation_id,
+            parameters=parameters,
             **kwargs,
         )
 
@@ -523,6 +529,7 @@ def create_and_poll(
         auto_save_history: bool = True,
         meta_data: Optional[Dict[str, str]] = None,
         poll_timeout: Optional[int] = None,
+        parameters: Optional[Dict[str, Any]] = None,
     ) -> ChatPoll:
         """
         Call the Chat API with non-streaming to send messages to a published Coze bot and
@@ -541,6 +548,7 @@ def create_and_poll(
         :param auto_save_history: Whether to automatically save the history of conversation records.
         :param meta_data: Additional information, typically used to encapsulate some business-related fields.
         :param poll_timeout: poll timeout in seconds
+        :param parameters: Additional parameters for the chat API. pass through to the workflow.
         :return: chat object
         """
         chat = self.create(
@@ -551,6 +559,7 @@ def create_and_poll(
             custom_variables=custom_variables,
             auto_save_history=auto_save_history,
             meta_data=meta_data,
+            parameters=parameters,
         )
 
         start = int(time.time())
@@ -579,6 +588,7 @@ def _create(
         auto_save_history: bool = ...,
         meta_data: Optional[Dict[str, str]] = ...,
         conversation_id: Optional[str] = ...,
+        parameters: Optional[Dict[str, Any]] = ...,
     ) -> Stream[ChatEvent]: ...
 
     @overload
@@ -593,6 +603,7 @@ def _create(
         auto_save_history: bool = ...,
         meta_data: Optional[Dict[str, str]] = ...,
         conversation_id: Optional[str] = ...,
+        parameters: Optional[Dict[str, Any]] = ...,
     ) -> Chat: ...
 
     def _create(
@@ -606,11 +617,11 @@ def _create(
         auto_save_history: bool = True,
         meta_data: Optional[Dict[str, str]] = None,
         conversation_id: Optional[str] = None,
+        parameters: Optional[Dict[str, Any]] = None,
         **kwargs,
     ) -> Union[Chat, Stream[ChatEvent]]:
         """
-        Create a conversation.
-        Conversation is an interaction between a bot and a user, including one or more messages.
+        Create a chat.
         """
         url = f"{self._base_url}/v3/chat"
         params = {
@@ -624,6 +635,7 @@ def _create(
             "custom_variables": custom_variables,
             "auto_save_history": auto_save_history,
             "meta_data": meta_data,
+            "parameters": parameters,
         }
         headers: Optional[dict] = kwargs.get("headers")
         if not stream:
@@ -777,6 +789,7 @@ async def create(
         custom_variables: Optional[Dict[str, str]] = None,
         auto_save_history: bool = True,
         meta_data: Optional[Dict[str, str]] = None,
+        parameters: Optional[Dict[str, Any]] = None,
     ) -> Chat:
         """
         Call the Chat API with non-streaming to send messages to a published Coze bot.
@@ -793,6 +806,7 @@ async def create(
         :param custom_variables: The customized variable in a key-value pair.
         :param auto_save_history: Whether to automatically save the history of conversation records.
         :param meta_data: Additional information, typically used to encapsulate some business-related fields.
+        :param parameters: Additional parameters for the chat API. pass through to the workflow.
         :return: chat object
         """
         return await self._create(
@@ -804,6 +818,7 @@ async def create(
             auto_save_history=auto_save_history,
             meta_data=meta_data,
             conversation_id=conversation_id,
+            parameters=parameters,
         )
 
     async def stream(
@@ -816,6 +831,7 @@ async def stream(
         auto_save_history: bool = True,
         meta_data: Optional[Dict[str, str]] = None,
         conversation_id: Optional[str] = None,
+        parameters: Optional[Dict[str, Any]] = None,
     ) -> AsyncIterator[ChatEvent]:
         """
         Call the Chat API with streaming to send messages to a published Coze bot.
@@ -832,6 +848,7 @@ async def stream(
         :param custom_variables: The customized variable in a key-value pair.
         :param auto_save_history: Whether to automatically save the history of conversation records.
         :param meta_data: Additional information, typically used to encapsulate some business-related fields.
+        :param parameters: Additional parameters for the chat API. pass through to the workflow.
         :return: iterator of ChatEvent
         """
         async for item in await self._create(
@@ -843,6 +860,7 @@ async def stream(
             auto_save_history=auto_save_history,
             meta_data=meta_data,
             conversation_id=conversation_id,
+            parameters=parameters,
         ):
             yield item
 
@@ -858,6 +876,7 @@ async def _create(
         auto_save_history: bool = ...,
         meta_data: Optional[Dict[str, str]] = ...,
         conversation_id: Optional[str] = ...,
+        parameters: Optional[Dict[str, Any]] = ...,
     ) -> AsyncStream[ChatEvent]: ...
 
     @overload
@@ -872,6 +891,7 @@ async def _create(
         auto_save_history: bool = ...,
         meta_data: Optional[Dict[str, str]] = ...,
         conversation_id: Optional[str] = ...,
+        parameters: Optional[Dict[str, Any]] = ...,
     ) -> Chat: ...
 
     async def _create(
@@ -885,6 +905,7 @@ async def _create(
         auto_save_history: bool = True,
         meta_data: Optional[Dict[str, str]] = None,
         conversation_id: Optional[str] = None,
+        parameters: Optional[Dict[str, Any]] = None,
     ) -> Union[Chat, AsyncStream[ChatEvent]]:
         """
         Create a conversation.
@@ -902,6 +923,7 @@ async def _create(
             "custom_variables": custom_variables,
             "auto_save_history": auto_save_history,
             "meta_data": meta_data,
+            "parameters": parameters,
         }
         if not stream:
             return await self._requester.arequest(

examples/chat_stream.py

@@ -3,6 +3,7 @@
 and handle chat events
 """
 
+import json
 import logging
 import os
 from typing import Optional
@@ -45,6 +46,8 @@ def get_coze_api_token(workspace_id: Optional[str] = None) -> str:
 # Whether to print detailed logs
 is_debug = os.getenv("DEBUG")
 
+parameters = json.loads(os.getenv("COZE_PARAMETERS") or "{}")
+
 if is_debug:
     setup_logging(logging.DEBUG)
 
@@ -53,13 +56,16 @@ def get_coze_api_token(workspace_id: Optional[str] = None) -> str:
 # chat event and handle them.
 is_first_reasoning_content = True
 is_first_content = True
-for event in coze.chat.stream(
+stream = coze.chat.stream(
     bot_id=bot_id,
     user_id=user_id,
     additional_messages=[
         Message.build_user_question_text("Tell a 500-word story."),
     ],
-):
+    parameters=parameters,
+)
+print("logid:", stream.response.logid)
+for event in stream:
     if event.event == ChatEventType.CONVERSATION_MESSAGE_DELTA:
         if event.message.reasoning_content:
             if is_first_reasoning_content:
@@ -75,3 +81,8 @@ def get_coze_api_token(workspace_id: Optional[str] = None) -> str:
     if event.event == ChatEventType.CONVERSATION_CHAT_COMPLETED:
         print()
         print("token usage:", event.chat.usage.token_count)
+
+    if event.event == ChatEventType.CONVERSATION_CHAT_FAILED:
+        print()
+        print("chat failed", event.chat.last_error)
+        break