mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-07-28 00:48:07 +00:00
f1632cc351
* docs: document run event stream contract * fix(run): address event stream review feedback --------- Co-authored-by: MiaoRuidx <12540796+MiaoRuidx@users.noreply.github.com> Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
114 lines
3.8 KiB
Python
114 lines
3.8 KiB
Python
"""Canonical names and categories for persisted run events.
|
|
|
|
Producers import these definitions instead of repeating event-name/category
|
|
pairs. The public JSON contract is checked against this catalog in backend
|
|
tests, so either side changing without the other fails CI.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from dataclasses import dataclass
|
|
|
|
from deerflow.constants import (
|
|
RUN_EVENT_CATEGORY_MAX_LENGTH,
|
|
RUN_EVENT_TYPE_MAX_LENGTH,
|
|
WORKSPACE_CHANGES_EVENT_CATEGORY,
|
|
WORKSPACE_CHANGES_EVENT_TYPE,
|
|
)
|
|
|
|
|
|
def _validate_category(category: str) -> None:
|
|
if not category:
|
|
raise ValueError("Run event category must not be empty")
|
|
if len(category) > RUN_EVENT_CATEGORY_MAX_LENGTH:
|
|
raise ValueError(f"Run event category must not exceed {RUN_EVENT_CATEGORY_MAX_LENGTH} characters: {category!r}")
|
|
|
|
|
|
@dataclass(frozen=True, slots=True)
|
|
class RunEventDefinition:
|
|
event_type: str
|
|
category: str
|
|
|
|
def __post_init__(self) -> None:
|
|
if not self.event_type:
|
|
raise ValueError("Run event type must not be empty")
|
|
if len(self.event_type) > RUN_EVENT_TYPE_MAX_LENGTH:
|
|
raise ValueError(f"Run event type must not exceed {RUN_EVENT_TYPE_MAX_LENGTH} characters: {self.event_type!r}")
|
|
_validate_category(self.category)
|
|
|
|
|
|
@dataclass(frozen=True, slots=True)
|
|
class RunEventPattern:
|
|
pattern: str
|
|
prefix: str
|
|
category: str
|
|
|
|
def __post_init__(self) -> None:
|
|
_validate_category(self.category)
|
|
|
|
def event_type(self, suffix: str) -> str:
|
|
if not suffix:
|
|
raise ValueError("Run event suffix must not be empty")
|
|
max_suffix_length = RUN_EVENT_TYPE_MAX_LENGTH - len(self.prefix)
|
|
if len(suffix) > max_suffix_length:
|
|
raise ValueError(f"Run event suffix for {self.pattern!r} must not exceed {max_suffix_length} characters: {suffix!r}")
|
|
return f"{self.prefix}{suffix}"
|
|
|
|
|
|
RUN_START_EVENT = RunEventDefinition("run.start", "trace")
|
|
RUN_END_EVENT = RunEventDefinition("run.end", "outputs")
|
|
RUN_ERROR_EVENT = RunEventDefinition("run.error", "error")
|
|
LLM_HUMAN_INPUT_EVENT = RunEventDefinition("llm.human.input", "message")
|
|
LLM_AI_RESPONSE_EVENT = RunEventDefinition("llm.ai.response", "message")
|
|
LLM_TOOL_RESULT_EVENT = RunEventDefinition("llm.tool.result", "message")
|
|
LLM_ERROR_EVENT = RunEventDefinition("llm.error", "trace")
|
|
MEMORY_CONTEXT_EVENT = RunEventDefinition("context:memory", "context")
|
|
|
|
SUBAGENT_START_EVENT = RunEventDefinition("subagent.start", "subagent")
|
|
SUBAGENT_STEP_EVENT = RunEventDefinition("subagent.step", "subagent")
|
|
SUBAGENT_END_EVENT = RunEventDefinition("subagent.end", "subagent")
|
|
|
|
WORKSPACE_CHANGES_EVENT = RunEventDefinition(WORKSPACE_CHANGES_EVENT_TYPE, WORKSPACE_CHANGES_EVENT_CATEGORY)
|
|
|
|
MIDDLEWARE_EVENT_PATTERN = RunEventPattern(
|
|
pattern="middleware:{tag}",
|
|
prefix="middleware:",
|
|
category="middleware",
|
|
)
|
|
MIDDLEWARE_EVENT_TAG_MAX_LENGTH = RUN_EVENT_TYPE_MAX_LENGTH - len(MIDDLEWARE_EVENT_PATTERN.prefix)
|
|
MIDDLEWARE_GUARDRAIL_TAG = "guardrail"
|
|
MIDDLEWARE_SAFETY_TERMINATION_TAG = "safety_termination"
|
|
MIDDLEWARE_SKILL_ACTIVATION_TAG = "skill_activation"
|
|
MIDDLEWARE_SKILL_SECRETS_TAG = "skill_secrets"
|
|
MIDDLEWARE_EVENT_TAGS = (
|
|
MIDDLEWARE_GUARDRAIL_TAG,
|
|
MIDDLEWARE_SAFETY_TERMINATION_TAG,
|
|
MIDDLEWARE_SKILL_ACTIVATION_TAG,
|
|
MIDDLEWARE_SKILL_SECRETS_TAG,
|
|
)
|
|
|
|
JOURNAL_RUN_EVENT_DEFINITIONS = (
|
|
RUN_START_EVENT,
|
|
RUN_END_EVENT,
|
|
RUN_ERROR_EVENT,
|
|
LLM_HUMAN_INPUT_EVENT,
|
|
LLM_AI_RESPONSE_EVENT,
|
|
LLM_TOOL_RESULT_EVENT,
|
|
LLM_ERROR_EVENT,
|
|
MEMORY_CONTEXT_EVENT,
|
|
)
|
|
|
|
SUBAGENT_RUN_EVENT_DEFINITIONS = (
|
|
SUBAGENT_START_EVENT,
|
|
SUBAGENT_STEP_EVENT,
|
|
SUBAGENT_END_EVENT,
|
|
)
|
|
|
|
WORKSPACE_RUN_EVENT_DEFINITIONS = (WORKSPACE_CHANGES_EVENT,)
|
|
|
|
FIXED_RUN_EVENT_DEFINITIONS = (
|
|
*JOURNAL_RUN_EVENT_DEFINITIONS,
|
|
*SUBAGENT_RUN_EVENT_DEFINITIONS,
|
|
*WORKSPACE_RUN_EVENT_DEFINITIONS,
|
|
)
|