HYPHA / DOCS

简体中文

English

简体中文

English

@codesoul-co/hypha-core / contracts/runtime-activity ​

模块用法 ​

用于声明并运行时校验契约。Runtime activity 模块公开 2 常量、1 接口、1 类型。

从包入口导入 ​

ts
import {
  RUNTIME_ACTIVITY_DESCRIPTOR_VERSION,
  RUNTIME_ACTIVITY_KINDS,
} from '@codesoul-co/hypha-core';

import type {
  RuntimeActivityDescriptor,
  RuntimeActivityKind,
} from '@codesoul-co/hypha-core';

使用要点 ​

  • 2 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。
  • 2 个常量/枚举提供稳定值、Schema、Definition 或默认配置；应复用这些导出，避免在应用中复制内部值。

公共导出 ​

Symbol种类签名说明
RUNTIME_ACTIVITY_DESCRIPTOR_VERSION常量const RUNTIME_ACTIVITY_DESCRIPTOR_VERSION: "1.0.0"由 contracts/runtime-activity 模块导出的 RUNTIME ACTIVITY DESCRIPTOR VERSION 常量。
RUNTIME_ACTIVITY_KINDS常量const RUNTIME_ACTIVITY_KINDS: readonly ["react_quantum", "tool", "memory", "execution", "mcp", "policy"]由 contracts/runtime-activity 模块导出的 RUNTIME ACTIVITY KINDS 常量。
RuntimeActivityDescriptor接口interface RuntimeActivityDescriptorRuntime Activity Descriptor 接口，共包含 13 个公开字段或方法。
RuntimeActivityKind类型type RuntimeActivityKind = (typeof RUNTIME_ACTIVITY_KINDS)[number]Runtime Activity Kind 公共类型别名；完整类型表达式见声明。

RUNTIME_ACTIVITY_DESCRIPTOR_VERSION ​

由 contracts/runtime-activity 模块导出的 RUNTIME ACTIVITY DESCRIPTOR VERSION 常量。

  • 种类: 常量
  • 导入: import { RUNTIME_ACTIVITY_DESCRIPTOR_VERSION } from '@codesoul-co/hypha-core';
  • 源码模块: contracts/runtime-activity

声明 ​

text
export declare const RUNTIME_ACTIVITY_DESCRIPTOR_VERSION: "1.0.0";

RUNTIME_ACTIVITY_KINDS ​

由 contracts/runtime-activity 模块导出的 RUNTIME ACTIVITY KINDS 常量。

声明 ​

text
export declare const RUNTIME_ACTIVITY_KINDS: readonly ["react_quantum", "tool", "memory", "execution", "mcp", "policy"];

RuntimeActivityDescriptor ​

Runtime Activity Descriptor 接口，共包含 13 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { RuntimeActivityDescriptor } from '@codesoul-co/hypha-core';
  • 源码模块: contracts/runtime-activity

声明 ​

text
export interface RuntimeActivityDescriptor {
    version: typeof RUNTIME_ACTIVITY_DESCRIPTOR_VERSION;
    activityId: string;
    activityKind: RuntimeActivityKind;
    runId: string;
    stateId: string;
    stateAttempt: number;
    operationId: string;
    inputRef: string;
    inputHash: string;
    providerRef?: string;
    providerRevision?: string;
    idempotencyKey: string;
    deadlineAt?: string;
}

契约成员 ​

成员种类签名说明
activityId属性activityId: string公开属性；类型、只读和可选状态以签名列为准。
activityKind属性activityKind: "memory" | "mcp" | "policy" | "tool" | "execution" | "react_quantum"公开属性；类型、只读和可选状态以签名列为准。
deadlineAt属性deadlineAt?: string公开属性；类型、只读和可选状态以签名列为准。
idempotencyKey属性idempotencyKey: string公开属性；类型、只读和可选状态以签名列为准。
inputHash属性inputHash: string公开属性；类型、只读和可选状态以签名列为准。
inputRef属性inputRef: string公开属性；类型、只读和可选状态以签名列为准。
operationId属性operationId: string公开属性；类型、只读和可选状态以签名列为准。
providerRef属性providerRef?: string公开属性；类型、只读和可选状态以签名列为准。
providerRevision属性providerRevision?: string公开属性；类型、只读和可选状态以签名列为准。
runId属性runId: string公开属性；类型、只读和可选状态以签名列为准。
stateAttempt属性stateAttempt: number公开属性；类型、只读和可选状态以签名列为准。
stateId属性stateId: string公开属性；类型、只读和可选状态以签名列为准。
version属性version: "1.0.0"公开属性；类型、只读和可选状态以签名列为准。

RuntimeActivityKind ​

Runtime Activity Kind 公共类型别名；完整类型表达式见声明。

声明 ​

text
export type RuntimeActivityKind = (typeof RUNTIME_ACTIVITY_KINDS)[number];