feat(workflow): support message format

Author: kevinlin09

dashscope/app/application_response.py

@@ -6,7 +6,7 @@
 """
 from dataclasses import dataclass
 from http import HTTPStatus
-from typing import Dict, List
+from typing import Dict, List, Optional
 
 from dashscope.api_entities.dashscope_response import (DashScopeAPIResponse,
                                                        DictMixin)
@@ -105,6 +105,50 @@ def __init__(self,
                          page_number=page_number,
                          **kwargs)
 
+@dataclass(init=False)
+class WorkflowMessage(DictMixin):
+    node_id: str
+    node_name: str
+    node_type: str
+    node_status: str
+    node_is_completed: str
+    node_msg_seq_id: int
+    message: str
+
+    class Message(DictMixin):
+        role: str
+        content: str
+
+    def __init__(self,
+                 node_id: str = None,
+                 node_name: str = None,
+                 node_type: str = None,
+                 node_status: str = None,
+                 node_is_completed: str = None,
+                 node_msg_seq_id: int = None,
+                 message: Message = None,
+                 **kwargs):
+        """ Workflow message.
+
+        Args:
+            node_id (str, optional): .
+            node_name (str, optional): .
+            node_type (str, optional): .
+            node_status (str, optional): .
+            node_is_completed (str, optional): .
+            node_msg_seq_id (int, optional): .
+            message (Message, optional): .
+        """
+
+        super().__init__(node_id=node_id,
+                         node_name=node_name,
+                         node_type=node_type,
+                         node_status=node_status,
+                         node_is_completed=node_is_completed,
+                         node_msg_seq_id=node_msg_seq_id,
+                         message=message,
+                         **kwargs)
+
 
 @dataclass(init=False)
 class ApplicationOutput(DictMixin):
@@ -113,13 +157,15 @@ class ApplicationOutput(DictMixin):
     session_id: str
     thoughts: List[ApplicationThought]
     doc_references: List[ApplicationDocReference]
+    workflow_message: WorkflowMessage
 
     def __init__(self,
                  text: str = None,
                  finish_reason: str = None,
                  session_id: str = None,
                  thoughts: List[ApplicationThought] = None,
                  doc_references: List[ApplicationDocReference] = None,
+                 workflow_message: WorkflowMessage = None,
                  **kwargs):
 
         ths = None
@@ -139,6 +185,7 @@ def __init__(self,
                          session_id=session_id,
                          thoughts=ths,
                          doc_references=refs,
+                         workflow_message=workflow_message,
                          **kwargs)
 
 

samples/test_application.py

@@ -0,0 +1,20 @@
+import os
+from http import HTTPStatus
+from dashscope import Application
+responses = Application.call(
+            api_key=os.getenv("DASHSCOPE_API_KEY"),
+            app_id=os.getenv("DASHSCOPE_APP_ID"),
+            prompt='你是谁？',
+            stream=True,  # 流式输出
+            has_thoughts=True, # 输出节点内容
+            incremental_output=True,
+            flow_stream_mode='agent_format')  # 设置为Agent模式，透出指定节点的输出
+
+for response in responses:
+    if response.status_code != HTTPStatus.OK:
+        print(f'request_id={response.request_id}')
+        print(f'code={response.status_code}')
+        print(f'message={response.message}')
+        print(f'请参考文档：https://help.aliyun.com/zh/model-studio/developer-reference/error-code')
+    else:
+        print(f'response: {response}\n')