mirror of
https://github.com/bytedance/deer-flow.git
synced 2026-11-07 19:20:34 +00:00
1dd6d05627
* feat(extension-api): add task identity fields to CompactionEvent (0.2.10) CompactionEvent carried the transform, its hashes and its counts, but nothing that names the task, run or thread the compaction happened in. An observer that wants to relate a compaction to the run that produced it had to match hashes across sessions, which is unreliable. Append three optional fields, task_id, run_id and thread_id (str | None, default None). Existing keyword and positional construction is unchanged, so already-released extensions keep working. The host fills them in the next commit. Bump deerflow-extension-api to 0.2.10 and the harness's exact pin with it. * fix(extensions): hand compaction observers the live task store and its identity The summarization middleware already recovers the live task store from the runtime to observe its summary system call, and the registry allocates that store precisely because a compaction observer is registered. notify_context_compacted() then discarded it and handed every observer a detached store, with a docstring claiming there was no live task. - The lead run worker and the subagent executor now seed every task store they allocate with the task's TaskInfo, not only when a lifecycle contributor is registered; the lifecycle notification reuses the seeded object. A subagent without a parent run_id still gets no TaskInfo. - compact_state() and acompact_state() pass the store from task_store_from_runtime() to _record_compaction(). - notify_context_compacted() takes an optional task_store. A live store goes to the observers and fills the event's task_id/run_id/thread_id from its TaskInfo; without one (manual /compact runs outside any run) observers still receive a detached store and the ids stay None. For a background subagent the store keeps its public scope id (the provider tool_call_id) while TaskInfo.task_id stays the execution id, as lifecycle contributors already see it; the event follows TaskInfo. * docs(extensions): document compaction event identity and seeded TaskInfo The extensions guide and the developer manual still said compaction observers always receive a detached store because no task is live at the call site. Describe what the host does now: lead runs and subagents with a parent run seed every task store with TaskInfo, compaction observers get the live store, and CompactionEvent's task_id/run_id/thread_id come from it; only manual /compact falls back to a detached store with None ids. Adds the 0.2.10 row to the contract version table (PR number pending). * docs(changelog): note compaction observers receive the live task identity * docs(extensions): list compaction observers among task-store triggers * docs: reference #7831 for the compaction event identity change * docs(extensions): backfill contract history rows 0.2.5 to 0.2.9 The version table jumped from 0.2.4 to 0.2.10 although 0.2.5-0.2.9 shipped. Add those rows, attributing names merged without a bump to the first release that carried them (#5796 in 0.2.5, #6920 and #5645 in 0.2.8, #7729 in 0.2.10). The page intro now says it documents 0.2.4 plus the 0.2.10 CompactionEvent fields, and points to the history for the rest.
209 lines
6.0 KiB
Python
209 lines
6.0 KiB
Python
"""Public contracts for DeerFlow extensions.
|
|
|
|
This package MUST NOT import `deerflow`. Every host contract an extension
|
|
needs lives here, while framework imports remain direct extension dependencies;
|
|
extensions can therefore be released independently of the host.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from deerflow_extension_api.agent_runs import AGENT_RUNS_CONTEXT_KEY, AGENT_RUNS_RESOLVER_KEY, AgentRun, AgentRunError, AgentRuns, ExecutionFence, require_agent_runs, resolve_agent_runs
|
|
from deerflow_extension_api.assembly import (
|
|
AgentAssemblyDescriptor,
|
|
AgentAssemblyObserver,
|
|
MiddlewareDescriptor,
|
|
ToolDescriptor,
|
|
)
|
|
from deerflow_extension_api.auth import (
|
|
EXTENSION_PLUGIN_AUTHZ_RESOLVER_ASYNC_KEY,
|
|
EXTENSION_PLUGIN_AUTHZ_RESOLVER_KEY,
|
|
EXTENSION_PRINCIPAL_RESOLVER_KEY,
|
|
ExtensionPrincipal,
|
|
arequire_plugin_management,
|
|
require_admin,
|
|
require_plugin_management,
|
|
resolve_principal,
|
|
)
|
|
from deerflow_extension_api.compaction import (
|
|
CompactionEvent,
|
|
ContextCompactionObserver,
|
|
)
|
|
from deerflow_extension_api.completed_run_evidence import CompletedRunEvent, CompletedRunEventPage, CompletedRunEvidenceReader, CompletedRunSnapshot, EvidenceLimits
|
|
from deerflow_extension_api.contracts import (
|
|
ExtensionInstall,
|
|
ExtensionRegistry,
|
|
ExtensionRuntimeDeps,
|
|
ExtensionService,
|
|
HostPolicySnapshot,
|
|
MiddlewareContributor,
|
|
SystemModelCallObserver,
|
|
SystemModelRequest,
|
|
SystemModelResult,
|
|
SystemOperationKind,
|
|
TaskInfo,
|
|
TaskLifecycleContributor,
|
|
TaskOutcome,
|
|
extension,
|
|
)
|
|
from deerflow_extension_api.host_capabilities import HostCapabilityError
|
|
from deerflow_extension_api.model_invocation import (
|
|
ModelInvocationError,
|
|
ModelInvocationFailed,
|
|
ModelInvocationRequest,
|
|
ModelInvocationResult,
|
|
ModelInvocationUnauthorized,
|
|
ModelInvocationUnavailable,
|
|
ModelInvoker,
|
|
ModelMessage,
|
|
ModelOutputValidationError,
|
|
ModelUsage,
|
|
)
|
|
from deerflow_extension_api.placement import (
|
|
AgentBuildContext,
|
|
AgentScope,
|
|
MiddlewarePlacement,
|
|
Placement,
|
|
)
|
|
from deerflow_extension_api.plugins import ActionContext, BackendAction, BrowserAssets, BrowserModule, ModelTool, PluginContribution, PluginToolResult, ToolContext
|
|
from deerflow_extension_api.provenance import (
|
|
MESSAGE_CONTENT_KIND_KEY,
|
|
MESSAGE_PRODUCER_ENTITY_ID_KEY,
|
|
MESSAGE_PRODUCER_KIND_KEY,
|
|
PROVENANCE_KEYS,
|
|
ContentKind,
|
|
MessageProvenance,
|
|
provenance_kwargs,
|
|
read_provenance,
|
|
)
|
|
from deerflow_extension_api.release import (
|
|
ReleasePolicyProvider,
|
|
canonical_hash,
|
|
canonical_json,
|
|
collect_release_policies,
|
|
)
|
|
from deerflow_extension_api.run_evidence import (
|
|
RUN_EVIDENCE_READER_RESOLVER_KEY,
|
|
InvalidRunEvidenceCursor,
|
|
RunEventPage,
|
|
RunEventView,
|
|
RunEvidenceReader,
|
|
RunPage,
|
|
RunStatusView,
|
|
require_run_evidence_reader,
|
|
resolve_run_evidence_reader,
|
|
)
|
|
from deerflow_extension_api.runtime_bridge import (
|
|
EXTENSION_TASK_STORE_KEY,
|
|
task_store_from_runtime,
|
|
)
|
|
from deerflow_extension_api.settings import SettingsField
|
|
from deerflow_extension_api.skill_mutations import AssessmentRef, AssetRevision, BundleFile, HostCheckResult, MutationCapabilities, Operation, Proposal, ProposalBundle, SkillMutationService, SkillRevisionView
|
|
from deerflow_extension_api.state import ExtensionData
|
|
|
|
#: Contract version. Before 1.0, minors may break and patches are additive.
|
|
#: From 1.0 on, bump the major for breaking changes.
|
|
API_VERSION = "0.2.10"
|
|
|
|
__all__ = [
|
|
"AGENT_RUNS_CONTEXT_KEY",
|
|
"AGENT_RUNS_RESOLVER_KEY",
|
|
"AgentRun",
|
|
"AgentRunError",
|
|
"AgentRuns",
|
|
"ExecutionFence",
|
|
"require_agent_runs",
|
|
"resolve_agent_runs",
|
|
"ModelInvocationError",
|
|
"ModelInvocationFailed",
|
|
"ModelInvocationRequest",
|
|
"ModelInvocationResult",
|
|
"ModelInvocationUnauthorized",
|
|
"ModelInvocationUnavailable",
|
|
"ModelInvoker",
|
|
"ModelMessage",
|
|
"ModelOutputValidationError",
|
|
"ModelUsage",
|
|
"ActionContext",
|
|
"BackendAction",
|
|
"BrowserAssets",
|
|
"BrowserModule",
|
|
"ModelTool",
|
|
"PluginToolResult",
|
|
"PluginContribution",
|
|
"SettingsField",
|
|
"ToolContext",
|
|
"CompletedRunEvent",
|
|
"CompletedRunEventPage",
|
|
"CompletedRunEvidenceReader",
|
|
"CompletedRunSnapshot",
|
|
"EvidenceLimits",
|
|
"HostCapabilityError",
|
|
"AssessmentRef",
|
|
"AssetRevision",
|
|
"BundleFile",
|
|
"HostCheckResult",
|
|
"MutationCapabilities",
|
|
"Operation",
|
|
"Proposal",
|
|
"ProposalBundle",
|
|
"SkillMutationService",
|
|
"SkillRevisionView",
|
|
"API_VERSION",
|
|
"EXTENSION_PLUGIN_AUTHZ_RESOLVER_ASYNC_KEY",
|
|
"EXTENSION_PLUGIN_AUTHZ_RESOLVER_KEY",
|
|
"EXTENSION_PRINCIPAL_RESOLVER_KEY",
|
|
"EXTENSION_TASK_STORE_KEY",
|
|
"MESSAGE_CONTENT_KIND_KEY",
|
|
"MESSAGE_PRODUCER_ENTITY_ID_KEY",
|
|
"MESSAGE_PRODUCER_KIND_KEY",
|
|
"PROVENANCE_KEYS",
|
|
"AgentAssemblyDescriptor",
|
|
"AgentAssemblyObserver",
|
|
"AgentBuildContext",
|
|
"AgentScope",
|
|
"CompactionEvent",
|
|
"ContentKind",
|
|
"ContextCompactionObserver",
|
|
"ExtensionData",
|
|
"ExtensionInstall",
|
|
"ExtensionPrincipal",
|
|
"ExtensionRegistry",
|
|
"ExtensionRuntimeDeps",
|
|
"ExtensionService",
|
|
"HostPolicySnapshot",
|
|
"InvalidRunEvidenceCursor",
|
|
"MessageProvenance",
|
|
"MiddlewareContributor",
|
|
"MiddlewareDescriptor",
|
|
"MiddlewarePlacement",
|
|
"Placement",
|
|
"ReleasePolicyProvider",
|
|
"RunEvidenceReader",
|
|
"RUN_EVIDENCE_READER_RESOLVER_KEY",
|
|
"RunEventPage",
|
|
"RunEventView",
|
|
"RunPage",
|
|
"RunStatusView",
|
|
"require_run_evidence_reader",
|
|
"resolve_run_evidence_reader",
|
|
"SystemModelCallObserver",
|
|
"SystemModelRequest",
|
|
"SystemModelResult",
|
|
"SystemOperationKind",
|
|
"TaskInfo",
|
|
"TaskLifecycleContributor",
|
|
"TaskOutcome",
|
|
"ToolDescriptor",
|
|
"canonical_hash",
|
|
"canonical_json",
|
|
"collect_release_policies",
|
|
"arequire_plugin_management",
|
|
"extension",
|
|
"provenance_kwargs",
|
|
"read_provenance",
|
|
"require_admin",
|
|
"require_plugin_management",
|
|
"resolve_principal",
|
|
"task_store_from_runtime",
|
|
]
|