feat(chat): add chat events (#35)

Author: joyme123

libs/api/hiagent_api/chat.py

@@ -21,62 +21,121 @@
 
 from hiagent_api.base import AppAPIMixin, Service
 from hiagent_api.chat_types import (
+    AgentErrorChatEvent,
     AgentIntentionChatEvent,
     AgentJumpChatEvent,
     AgentTakeOverChatEvent,
     AgentThoughtChatEvent,
     AgentThoughtEndChatEvent,
     AgentThoughtUpdateChatEvent,
+    AsyncResumeAppWorkflowRequest,
+    AsyncResumeAppWorkflowResponse,
     BlockingChatResponse,
+    CancelConversationTopRequest,
+    ChatAgainRequest,
+    ChatContinueRequest,
     ChatEvent,
     ChatRequest,
+    ClearLongMemoryRequest,
+    ClearMessageRequest,
     CreateConversationRequest,
     CreateConversationResponse,
+    DeepSearchExtractionChatEvent,
+    DeepSearchExtractionEndChatEvent,
+    DeepSearchExtractionStartChatEvent,
+    DeepSearchQueryChatEvent,
+    DeepSearchQueryEndChatEvent,
+    DeepSearchQueryStartChatEvent,
+    DeepSearchThinkChatEvent,
+    DeepSearchThinkEndChatEvent,
+    DeepSearchThinkStartChatEvent,
+    DeleteConversationRequest,
+    DeleteLongMemoryRequest,
+    DeleteMessageRequest,
+    EmptyResponse,
+    EventTriggerWebhookResponse,
+    FeedbackRequest,
+    FlowCostWorkflowEvent,
+    FlowEndChatEvent,
+    FlowEndWorkflowEvent,
+    FlowErrorWorkflowEvent,
+    FlowInterruptedWorkflowEvent,
+    FlowStartChatEvent,
+    FlowStartWorkflowEvent,
     GetAppConfigPreviewRequest,
     GetAppConfigPreviewResponse,
+    GetAppUserVariablesRequest,
+    GetAppUserVariablesResponse,
+    GetConversationInputsRequest,
+    GetConversationInputsResponse,
+    GetConversationListRequest,
+    GetConversationListResponse,
+    GetConversationMessageRequest,
+    GetConversationMessageResponse,
+    GetMessageInfoRequest,
+    GetMessageInfoResponse,
+    GetOpeningConfigOpenRequest,
+    GetOpeningConfigOpenResponse,
+    GetSuggestedQuestionsRequest,
+    GetSuggestedQuestionsResponse,
     InterruptedChatEvent,
     KnowledgeGraphRetrieveChatEvent,
     KnowledgeGraphRetrieveEndChatEvent,
     KnowledgeRetrieveChatEvent,
     KnowledgeRetrieveEndChatEvent,
+    ListLongMemoryRequest,
+    ListLongMemoryResponse,
+    ListOauth2TokenRequest,
+    ListOauth2TokenResponse,
     LongTermMemoryRetrieveChatEvent,
     LongTermMemoryRetrieveEndChatEvent,
     MessageChatEvent,
     MessageCostChatEvent,
     MessageEndChatEvent,
     MessageFailedChatEvent,
     MessageOutputEndChatEvent,
+    MessageOutputEndWorkflowEvent,
     MessageOutputStartChatEvent,
+    MessageOutputStartWorkflowEvent,
     MessageStartChatEvent,
+    MessageWorkflowEvent,
     QARetrieveChatEvent,
+    QueryAppMessageOauthStatusOpenRequest,
+    QueryAppMessageOauthStatusResponse,
+    QueryAppSkillAsyncTaskRequest,
+    QueryAppSkillAsyncTaskResponse,
+    QueryRunAppProcessRequest,
+    QueryRunAppProcessResponse,
+    QueryTriggerRunRecordsRequest,
+    QueryTriggerRunRecordsResponse,
+    RunAppWorkflowRequest,
+    RunAppWorkflowResponse,
+    SetAppUserVariablesRequest,
+    SetConversationTopRequest,
+    SetMessageAnswerUsedRequest,
+    StopMessageRequest,
     StreamingChatEventType,
+    StreamingWorkflowEventType,
     SuggestionChatEvent,
     SuggestionCostChatEvent,
+    SyncResumeAppWorkflowRequest,
+    SyncResumeAppWorkflowResponse,
+    SyncRunAppWorkflowRequest,
+    SyncRunAppWorkflowResponse,
     TerminologyRetrieveChatEvent,
     TerminologyRetrieveEndChatEvent,
     ThinkMessageChatEvent,
     ThinkMessageOutputEndChatEvent,
     ThinkMessageOutputStartChatEvent,
     ToolMessageChatEvent,
     ToolMessageOutputEndChatEvent,
+    ToolMessageOutputEndWorkflowEvent,
     ToolMessageOutputStartChatEvent,
-    ChatAgainRequest, GetConversationListRequest, GetConversationListResponse, GetConversationInputsRequest,
-    GetConversationInputsResponse, UpdateConversationRequest, EmptyResponse, DeleteConversationRequest,
-    StopMessageRequest, ClearMessageRequest, GetConversationMessageRequest, GetConversationMessageResponse,
-    GetMessageInfoRequest, GetMessageInfoResponse, DeleteMessageRequest, FeedbackRequest, SetMessageAnswerUsedRequest,
-    GetSuggestedQuestionsRequest, GetSuggestedQuestionsResponse, RunAppWorkflowRequest, RunAppWorkflowResponse,
-    SyncRunAppWorkflowRequest, SyncRunAppWorkflowResponse, QueryRunAppProcessRequest, QueryRunAppProcessResponse,
-    ListOauth2TokenRequest, ListOauth2TokenResponse, EventTriggerWebhookResponse, ChatContinueRequest,
-    ListLongMemoryRequest, ListLongMemoryResponse, UpdateLongMemoryRequest, DeleteLongMemoryRequest,
-    ClearLongMemoryRequest, AsyncResumeAppWorkflowRequest, AsyncResumeAppWorkflowResponse, SetConversationTopRequest,
-    CancelConversationTopRequest, QueryAppSkillAsyncTaskRequest, QueryAppSkillAsyncTaskResponse,
-    SyncResumeAppWorkflowRequest, SyncResumeAppWorkflowResponse, WorkflowEvent, StreamingWorkflowEventType,
-    FlowStartWorkflowEvent, FlowEndWorkflowEvent, FlowErrorWorkflowEvent, ToolMessageOutputEndWorkflowEvent,
-    ToolMessageOutputStartWorkflowEvent, ToolMessageWorkflowEvent, FlowCostWorkflowEvent, FlowInterruptedWorkflowEvent,
-    MessageOutputStartWorkflowEvent, MessageOutputEndWorkflowEvent, MessageWorkflowEvent, GetAppUserVariablesRequest,
-    GetAppUserVariablesResponse, SetAppUserVariablesRequest, QueryTriggerRunRecordsRequest,
-    QueryTriggerRunRecordsResponse, GetOpeningConfigOpenRequest, GetOpeningConfigOpenResponse,
-    QueryAppMessageOauthStatusOpenRequest, QueryAppMessageOauthStatusResponse
+    ToolMessageOutputStartWorkflowEvent,
+    ToolMessageWorkflowEvent,
+    UpdateConversationRequest,
+    UpdateLongMemoryRequest,
+    WorkflowEvent,
 )
 
 
@@ -957,6 +1016,30 @@ def parse_chat_event(event_data: dict) -> Optional[ChatEvent]:
             return ThinkMessageOutputEndChatEvent.model_validate(event_data)
         case StreamingChatEventType.think_message:
             return ThinkMessageChatEvent.model_validate(event_data)
+        case StreamingChatEventType.agent_error:
+            return AgentErrorChatEvent.model_validate(event_data)
+        case StreamingChatEventType.deep_search_think_start:
+            return DeepSearchThinkStartChatEvent.model_validate(event_data)
+        case StreamingChatEventType.deep_search_think_end:
+            return DeepSearchThinkEndChatEvent.model_validate(event_data)
+        case StreamingChatEventType.deep_search_think:
+            return DeepSearchThinkChatEvent.model_validate(event_data)
+        case StreamingChatEventType.deep_search_query_start:
+            return DeepSearchQueryStartChatEvent.model_validate(event_data)
+        case StreamingChatEventType.deep_search_query_end:
+            return DeepSearchQueryEndChatEvent.model_validate(event_data)
+        case StreamingChatEventType.deep_search_query:
+            return DeepSearchQueryChatEvent.model_validate(event_data)
+        case StreamingChatEventType.deep_search_extraction_start:
+            return DeepSearchExtractionStartChatEvent.model_validate(event_data)
+        case StreamingChatEventType.deep_search_extraction_end:
+            return DeepSearchExtractionEndChatEvent.model_validate(event_data)
+        case StreamingChatEventType.deep_search_extraction:
+            return DeepSearchExtractionChatEvent.model_validate(event_data)
+        case StreamingChatEventType.flow_start:
+            return FlowStartChatEvent.model_validate(event_data)
+        case StreamingChatEventType.flow_end:
+            return FlowEndChatEvent.model_validate(event_data)
 
     return None
 

libs/api/hiagent_api/chat_types.py

@@ -137,7 +137,7 @@ class GetAppConfigPreviewResponse(BaseSchema):
         validation_alias="OpenMessage",
         default="",
     )
-    open_query: str = Field(
+    open_query: list[str] = Field(
         description="open query",
         validation_alias="OpenQuery",
         default="",
@@ -399,19 +399,35 @@ class StreamingChatEventType(StrEnum):
     think_message_output_start = "think_message_output_start"
     think_message = "think_message"
     think_message_output_end = "think_message_output_end"
+    agent_error = "agent_error"
+    deep_search_think_start = "deep_search_think_start"
+    deep_search_think = "deep_search_think"
+    deep_search_think_end = "deep_search_think_end"
+    deep_search_query_start = "deep_search_query_start"
+    deep_search_query = "deep_search_query"
+    deep_search_query_end = "deep_search_query_end"
+    deep_search_extraction_start = "deep_search_extraction_start"
+    deep_search_extraction = "deep_search_extraction"
+    deep_search_extraction_end = "deep_search_extraction_end"
+    flow_start = "flow_start"
+    flow_end = "flow_end"
 
 
 class ChatEvent(BaseSchema):
     event: str = Field(
+        default="",
         description="event",
     )
     task_id: str = Field(
+        default="",
         description="task id",
     )
     id: str = Field(
+        default="",
         description="id",
     )
     conversation_id: str = Field(
+        default="",
         description="conversation id",
     )
     created_at: int = Field(
@@ -768,6 +784,43 @@ class ThinkMessageChatEvent(ChatEvent):
 
 class ThinkMessageOutputEndChatEvent(ChatEvent): ...
 
+class AgentErrorChatEvent(ChatEvent):
+    error_msg: str = Field(
+        description="error message",
+    )
+
+class DeepSearchThinkStartChatEvent(ChatEvent): ...
+
+class DeepSearchThinkChatEvent(ChatEvent):
+    content: str = Field(
+        description="think content",
+    )
+
+class DeepSearchThinkEndChatEvent(ChatEvent): ...
+
+class DeepSearchQueryStartChatEvent(ChatEvent): ...
+
+class DeepSearchQueryChatEvent(ChatEvent):
+    content: str = Field(
+        description="query content",
+    )
+
+class DeepSearchQueryEndChatEvent(ChatEvent): ...
+
+class DeepSearchExtractionStartChatEvent(ChatEvent): ...
+
+class DeepSearchExtractionChatEvent(ChatEvent):
+    content: str = Field(
+        description="extraction content",
+    )
+
+class DeepSearchExtractionEndChatEvent(ChatEvent): ...
+
+class FlowStartChatEvent(ChatEvent):
+    run_id: str
+
+class FlowEndChatEvent(ChatEvent):
+    run_id: str
 
 class ChatAgainRequest(BaseSchema):
     app_key: str = Field(