`@codesoul-co/hypha-tools` / `execution-adapter`

包索引: @codesoul-co/hypha-tools
源码: packages/tools/src/execution-adapter.ts
导出数: 18

模块用法

用于把外部或本地 Provider 绑定到 Hypha Port。Execution adapter 模块公开 2 类、1 常量、3 函数、10 接口、2 类型。

从包入口导入

import {
  ExecutionToolAdapter,
  ExecutionToolTerminalError,
  EXECUTION_TOOL_TERMINAL_STATES,
  hashExecutionToolInput,
  normalizeExecutionToolInput,
  validateExecutionToolRuntimeRequest,
} from '@codesoul-co/hypha-tools';

import type {
  ExecutionToolAdapterOptions,
  ExecutionToolDispatchFactoryRequest,
  ExecutionToolDispatchPlan,
  ExecutionToolEvidence,
  ExecutionToolObservation,
  ExecutionToolProvenance,
  ExecutionToolRuntimePort,
  ExecutionToolRuntimeRequest,
} from '@codesoul-co/hypha-tools';

// 完整导出列表见下方。

使用要点

12 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。
2 个类提供可实例化的运行时实现；构造参数与公开方法在各自条目中完整列出。
3 个函数是该模块的直接操作入口；每个 overload 的必需/可选参数与返回类型均在下方列出。
1 个常量/枚举提供稳定值、Schema、Definition 或默认配置；应复用这些导出，避免在应用中复制内部值。

公共导出

Symbol	种类	签名	说明
`ExecutionToolAdapter`	类	`new ExecutionToolAdapter<TInput = unknown>(id: string, port: ExecutionToolRuntimePort, createDispatch: ExecutionToolDispatchFactory<TInput>, options: ExecutionToolAdapterOptions): ExecutionToolAdapter<TInput>`	Execution Tool Adapter 类，共公开 8 个构造函数或成员；精确签名见本条目的声明与成员表。
`ExecutionToolTerminalError`	类	`new ExecutionToolTerminalError(observation: ExecutionToolObservation): ExecutionToolTerminalError`	Execution Tool Terminal Error 类，共公开 13 个构造函数或成员；精确签名见本条目的声明与成员表。
`EXECUTION_TOOL_TERMINAL_STATES`	常量	`const EXECUTION_TOOL_TERMINAL_STATES: readonly ["completed", "failed", "timed_out", "cancelled", "unknown", "quarantined"]`	由 `execution-adapter` 模块导出的 EXECUTION TOOL TERMINAL STATES 常量。
`hashExecutionToolInput`	函数	`hashExecutionToolInput(input: unknown): string`	Hash Execution Tool Input 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`normalizeExecutionToolInput`	函数	`normalizeExecutionToolInput<TInput>(input: TInput): TInput`	Normalize Execution Tool Input 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`validateExecutionToolRuntimeRequest`	函数	`validateExecutionToolRuntimeRequest<TInput>(input: ExecutionToolRuntimeRequest<TInput>): ExecutionToolRuntimeRequest<TInput>`	Recomputes the normalized input digest at the Execution boundary. Runtime-port implementations must call this validator before delegating to a provider.
`ExecutionToolAdapterOptions`	接口	`interface ExecutionToolAdapterOptions`	Execution Tool Adapter Options 接口，共包含 6 个公开字段或方法。
`ExecutionToolDispatchFactoryRequest`	接口	`interface ExecutionToolDispatchFactoryRequest extends AdapterExecutionRequest<TInput>`	Execution Tool Dispatch Factory Request 接口，共包含 6 个公开字段或方法。
`ExecutionToolDispatchPlan`	接口	`interface ExecutionToolDispatchPlan`	Execution Tool Dispatch Plan 接口，共包含 3 个公开字段或方法。
`ExecutionToolEvidence`	接口	`interface ExecutionToolEvidence`	Execution Tool Evidence 接口，共包含 4 个公开字段或方法。
`ExecutionToolObservation`	接口	`interface ExecutionToolObservation extends ExecutionToolRuntimeResult`	Execution Tool Observation 接口，共包含 14 个公开字段或方法。
`ExecutionToolProvenance`	接口	`interface ExecutionToolProvenance`	Execution Tool Provenance 接口，共包含 7 个公开字段或方法。
`ExecutionToolRuntimePort`	接口	`interface ExecutionToolRuntimePort`	Execution Tool Runtime Port 接口，共包含 3 个公开字段或方法。
`ExecutionToolRuntimeRequest`	接口	`interface ExecutionToolRuntimeRequest`	Execution Tool Runtime Request 接口，共包含 4 个公开字段或方法。
`ExecutionToolRuntimeResult`	接口	`interface ExecutionToolRuntimeResult`	Execution Tool Runtime Result 接口，共包含 13 个公开字段或方法。
`ExecutionToolRuntimeScope`	接口	`interface ExecutionToolRuntimeScope`	Execution Tool Runtime Scope 接口，共包含 6 个公开字段或方法。
`ExecutionToolDispatchFactory`	类型	`type ExecutionToolDispatchFactory = (request: ExecutionToolDispatchFactoryRequest<TInput>) => Promise<ExecutionToolDispatchPlan> \| ExecutionToolDispatchPlan`	Execution Tool Dispatch Factory 公共类型别名；完整类型表达式见声明。
`ExecutionToolTerminalState`	类型	`type ExecutionToolTerminalState = (typeof EXECUTION_TOOL_TERMINAL_STATES)[number]`	Execution Tool Terminal State 公共类型别名；完整类型表达式见声明。

`ExecutionToolAdapter`

Execution Tool Adapter 类，共公开 8 个构造函数或成员；精确签名见本条目的声明与成员表。

种类: 类
导入: import { ExecutionToolAdapter } from '@codesoul-co/hypha-tools';
源码模块: execution-adapter

声明

text

export declare class ExecutionToolAdapter<TInput = unknown> implements ToolAdapter<TInput, ExecutionToolObservation> {
    readonly id: string;
    readonly source: ToolSource;
    constructor(id: string, port: ExecutionToolRuntimePort, createDispatch: ExecutionToolDispatchFactory<TInput>, options: ExecutionToolAdapterOptions);
    capabilities(): Promise<ToolAdapterCapabilities>;
    execute(request: AdapterExecutionRequest<TInput>): Promise<ToolExecutionEnvelope<ExecutionToolObservation>>;
    cancel(request: AdapterCancellationRequest): Promise<void>;
    health(): Promise<ProviderHealth>;
    close(): Promise<void>;
}

公开成员

成员	种类	签名	说明
`cancel`	方法	`cancel(request: AdapterCancellationRequest): Promise<void>`	公开方法；参数与返回类型以签名列为准。
`capabilities`	方法	`capabilities(): Promise<ToolAdapterCapabilities>`	公开方法；参数与返回类型以签名列为准。
`close`	方法	`close(): Promise<void>`	公开方法；参数与返回类型以签名列为准。
`constructor`	构造函数	`<TInput = unknown>(id: string, port: ExecutionToolRuntimePort, createDispatch: ExecutionToolDispatchFactory<TInput>, options: ExecutionToolAdapterOptions): ExecutionToolAdapter<TInput>`	创建该类的实例。
`execute`	方法	`execute(request: AdapterExecutionRequest<TInput>): Promise<ToolExecutionEnvelope<ExecutionToolObservation>>`	公开方法；参数与返回类型以签名列为准。
`health`	方法	`health(): Promise<ProviderHealth>`	公开方法；参数与返回类型以签名列为准。
`id`	属性	`readonly id: string`	公开属性；类型、只读和可选状态以签名列为准。
`source`	属性	`readonly source: ToolSource`	公开属性；类型、只读和可选状态以签名列为准。

`ExecutionToolTerminalError`

Execution Tool Terminal Error 类，共公开 13 个构造函数或成员；精确签名见本条目的声明与成员表。

种类: 类
导入: import { ExecutionToolTerminalError } from '@codesoul-co/hypha-tools';
源码模块: execution-adapter

声明

text

export declare class ExecutionToolTerminalError extends FrameworkError {
    readonly terminalState: Exclude<ExecutionToolTerminalState, 'completed'>;
    readonly executionError: NormalizedExecutionError;
    readonly observation: ExecutionToolObservation;
    constructor(observation: ExecutionToolObservation);
}

公开成员

成员	种类	签名	说明
`cause`	属性	`readonly cause?: unknown`	公开属性；类型、只读和可选状态以签名列为准。
`code`	属性	`readonly code: string`	公开属性；类型、只读和可选状态以签名列为准。
`constructor`	构造函数	`(observation: ExecutionToolObservation): ExecutionToolTerminalError`	创建该类的实例。
`context`	属性	`readonly context?: Record<string, unknown>`	公开属性；类型、只读和可选状态以签名列为准。
`executionError`	属性	`readonly executionError: NormalizedExecutionError`	公开属性；类型、只读和可选状态以签名列为准。
`message`	属性	`message: string`	公开属性；类型、只读和可选状态以签名列为准。
`name`	属性	`name: string`	公开属性；类型、只读和可选状态以签名列为准。
`observation`	属性	`readonly observation: ExecutionToolObservation`	公开属性；类型、只读和可选状态以签名列为准。
`stack`	属性	`stack?: string`	公开属性；类型、只读和可选状态以签名列为准。
`static captureStackTrace`	方法	`static captureStackTrace(targetObject: object, constructorOpt?: Function): void`	Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. js const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`. The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace. The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance: `js function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a();`
`static prepareStackTrace`	方法	`static prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any`	公开方法；参数与返回类型以签名列为准。
`static stackTraceLimit`	属性	`static stackTraceLimit: number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
`terminalState`	属性	`readonly terminalState: "unknown" \| "cancelled" \| "failed" \| "timed_out" \| "quarantined"`	公开属性；类型、只读和可选状态以签名列为准。

`EXECUTION_TOOL_TERMINAL_STATES`

由 execution-adapter 模块导出的 EXECUTION TOOL TERMINAL STATES 常量。

种类: 常量
导入: import { EXECUTION_TOOL_TERMINAL_STATES } from '@codesoul-co/hypha-tools';
源码模块: execution-adapter

声明

text

export declare const EXECUTION_TOOL_TERMINAL_STATES: readonly ["completed", "failed", "timed_out", "cancelled", "unknown", "quarantined"];

`hashExecutionToolInput`

Hash Execution Tool Input 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { hashExecutionToolInput } from '@codesoul-co/hypha-tools';
源码模块: execution-adapter

声明

text

export declare function hashExecutionToolInput(input: unknown): string;

调用签名

text

hashExecutionToolInput(input: unknown): string

参数

参数	类型	必需	说明
`input`	`unknown`	是	必需参数；接受的值由类型列定义。

返回值

类型: string
说明: 返回值契约由上述类型定义。

`normalizeExecutionToolInput`

Normalize Execution Tool Input 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { normalizeExecutionToolInput } from '@codesoul-co/hypha-tools';
源码模块: execution-adapter

声明

text

export declare function normalizeExecutionToolInput<TInput>(input: TInput): TInput;

调用签名

text

normalizeExecutionToolInput<TInput>(input: TInput): TInput

参数

参数	类型	必需	说明
`input`	`TInput`	是	必需参数；接受的值由类型列定义。

返回值

类型: TInput
说明: 返回值契约由上述类型定义。

`validateExecutionToolRuntimeRequest`

Recomputes the normalized input digest at the Execution boundary. Runtime-port implementations must call this validator before delegating to a provider.

种类: 函数
导入: import { validateExecutionToolRuntimeRequest } from '@codesoul-co/hypha-tools';
源码模块: execution-adapter

声明

text

export declare function validateExecutionToolRuntimeRequest<TInput>(input: ExecutionToolRuntimeRequest<TInput>): ExecutionToolRuntimeRequest<TInput>;

调用签名

text

validateExecutionToolRuntimeRequest<TInput>(input: ExecutionToolRuntimeRequest<TInput>): ExecutionToolRuntimeRequest<TInput>

Recomputes the normalized input digest at the Execution boundary. Runtime-port implementations must call this validator before delegating to a provider.

参数

参数	类型	必需	说明
`input`	`ExecutionToolRuntimeRequest<TInput>`	是	必需参数；接受的值由类型列定义。

返回值

类型: ExecutionToolRuntimeRequest<TInput>
说明: 返回值契约由上述类型定义。

`ExecutionToolAdapterOptions`

Execution Tool Adapter Options 接口，共包含 6 个公开字段或方法。

种类: 接口
导入: import type { ExecutionToolAdapterOptions } from '@codesoul-co/hypha-tools';
源码模块: execution-adapter

声明

text

export interface ExecutionToolAdapterOptions {
    toolRevision: string;
    binding: ExecutionToolBinding;
    providerId: string;
    healthTimeoutMs?: number;
    maxEvidenceBytes?: number;
    now?: () => string;
}

契约成员

成员	种类	签名	说明
`binding`	属性	`binding: ExecutionToolBinding`	公开属性；类型、只读和可选状态以签名列为准。
`healthTimeoutMs`	属性	`healthTimeoutMs?: number`	公开属性；类型、只读和可选状态以签名列为准。
`maxEvidenceBytes`	属性	`maxEvidenceBytes?: number`	公开属性；类型、只读和可选状态以签名列为准。
`now`	方法	`now?(): string`	公开方法；参数与返回类型以签名列为准。
`providerId`	属性	`providerId: string`	公开属性；类型、只读和可选状态以签名列为准。
`toolRevision`	属性	`toolRevision: string`	公开属性；类型、只读和可选状态以签名列为准。

`ExecutionToolDispatchFactoryRequest`

Execution Tool Dispatch Factory Request 接口，共包含 6 个公开字段或方法。

种类: 接口
导入: import type { ExecutionToolDispatchFactoryRequest } from '@codesoul-co/hypha-tools';
源码模块: execution-adapter

声明

text

export interface ExecutionToolDispatchFactoryRequest<TInput> extends AdapterExecutionRequest<TInput> {
    normalizedInput: TInput;
    inputHash: string;
    signal: AbortSignal;
}

契约成员

成员	种类	签名	说明
`context`	属性	`context: ToolCallContext`	公开属性；类型、只读和可选状态以签名列为准。
`input`	属性	`input: TInput`	公开属性；类型、只读和可选状态以签名列为准。
`inputHash`	属性	`inputHash: string`	公开属性；类型、只读和可选状态以签名列为准。
`normalizedInput`	属性	`normalizedInput: TInput`	公开属性；类型、只读和可选状态以签名列为准。
`signal`	属性	`signal: AbortSignal`	公开属性；类型、只读和可选状态以签名列为准。
`toolId`	属性	`toolId: string`	公开属性；类型、只读和可选状态以签名列为准。

`ExecutionToolDispatchPlan`

Execution Tool Dispatch Plan 接口，共包含 3 个公开字段或方法。

种类: 接口
导入: import type { ExecutionToolDispatchPlan } from '@codesoul-co/hypha-tools';
源码模块: execution-adapter

声明

text

export interface ExecutionToolDispatchPlan {
    dispatch: ExecutionDispatchRequest;
    expectedRevision: number;
    approvalExpiresAt?: string;
}

契约成员

成员	种类	签名	说明
`approvalExpiresAt`	属性	`approvalExpiresAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`dispatch`	属性	`dispatch: ExecutionDispatchRequest`	公开属性；类型、只读和可选状态以签名列为准。
`expectedRevision`	属性	`expectedRevision: number`	公开属性；类型、只读和可选状态以签名列为准。

`ExecutionToolEvidence`

Execution Tool Evidence 接口，共包含 4 个公开字段或方法。

种类: 接口
导入: import type { ExecutionToolEvidence } from '@codesoul-co/hypha-tools';
源码模块: execution-adapter

声明

text

export interface ExecutionToolEvidence {
    kind: 'authorization' | 'event' | 'receipt' | 'artifact' | 'snapshot' | 'trace';
    ref: string;
    hash?: string;
    recordedAt?: string;
}

契约成员

成员	种类	签名	说明
`hash`	属性	`hash?: string`	公开属性；类型、只读和可选状态以签名列为准。
`kind`	属性	`kind: "artifact" \| "event" \| "snapshot" \| "authorization" \| "trace" \| "receipt"`	公开属性；类型、只读和可选状态以签名列为准。
`recordedAt`	属性	`recordedAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`ref`	属性	`ref: string`	公开属性；类型、只读和可选状态以签名列为准。

`ExecutionToolObservation`

Execution Tool Observation 接口，共包含 14 个公开字段或方法。

种类: 接口
导入: import type { ExecutionToolObservation } from '@codesoul-co/hypha-tools';
源码模块: execution-adapter

声明

text

export interface ExecutionToolObservation extends ExecutionToolRuntimeResult {
    evidenceHash: string;
}

契约成员

成员	种类	签名	说明
`activityResult`	属性	`activityResult: ExecutionActivityResult`	公开属性；类型、只读和可选状态以签名列为准。
`contractSnapshotRef`	属性	`contractSnapshotRef: string`	公开属性；类型、只读和可选状态以签名列为准。
`evidence`	属性	`evidence: ExecutionToolEvidence[]`	公开属性；类型、只读和可选状态以签名列为准。
`evidenceHash`	属性	`evidenceHash: string`	公开属性；类型、只读和可选状态以签名列为准。
`fencingToken`	属性	`fencingToken: number`	公开属性；类型、只读和可选状态以签名列为准。
`inputHash`	属性	`inputHash: string`	公开属性；类型、只读和可选状态以签名列为准。
`operationId`	属性	`operationId: string`	公开属性；类型、只读和可选状态以签名列为准。
`provenance`	属性	`provenance: ExecutionToolProvenance`	公开属性；类型、只读和可选状态以签名列为准。
`revision`	属性	`revision: number`	公开属性；类型、只读和可选状态以签名列为准。
`scope`	属性	`scope: ExecutionToolRuntimeScope`	公开属性；类型、只读和可选状态以签名列为准。
`terminalState`	属性	`terminalState: "unknown" \| "completed" \| "cancelled" \| "failed" \| "timed_out" \| "quarantined"`	公开属性；类型、只读和可选状态以签名列为准。
`toolId`	属性	`toolId: string`	公开属性；类型、只读和可选状态以签名列为准。
`toolOperation`	属性	`toolOperation: "artifact" \| "command" \| "file_read" \| "file_write" \| "sandbox"`	公开属性；类型、只读和可选状态以签名列为准。
`toolRevision`	属性	`toolRevision: string`	公开属性；类型、只读和可选状态以签名列为准。

`ExecutionToolProvenance`

Execution Tool Provenance 接口，共包含 7 个公开字段或方法。

种类: 接口
导入: import type { ExecutionToolProvenance } from '@codesoul-co/hypha-tools';
源码模块: execution-adapter

声明

text

export interface ExecutionToolProvenance {
    providerId: string;
    authorizationEvidenceId: string;
    authorizationVerificationRef: string;
    terminalEventId: string;
    receivedAt: string;
    resultHash: string;
    receiptRef?: string;
}

契约成员

成员	种类	签名	说明
`authorizationEvidenceId`	属性	`authorizationEvidenceId: string`	公开属性；类型、只读和可选状态以签名列为准。
`authorizationVerificationRef`	属性	`authorizationVerificationRef: string`	公开属性；类型、只读和可选状态以签名列为准。
`providerId`	属性	`providerId: string`	公开属性；类型、只读和可选状态以签名列为准。
`receiptRef`	属性	`receiptRef?: string`	公开属性；类型、只读和可选状态以签名列为准。
`receivedAt`	属性	`receivedAt: string`	公开属性；类型、只读和可选状态以签名列为准。
`resultHash`	属性	`resultHash: string`	公开属性；类型、只读和可选状态以签名列为准。
`terminalEventId`	属性	`terminalEventId: string`	公开属性；类型、只读和可选状态以签名列为准。

`ExecutionToolRuntimePort`

Execution Tool Runtime Port 接口，共包含 3 个公开字段或方法。

种类: 接口
导入: import type { ExecutionToolRuntimePort } from '@codesoul-co/hypha-tools';
源码模块: execution-adapter

声明

text

export interface ExecutionToolRuntimePort {
    execute(request: ExecutionToolRuntimeRequest, signal: AbortSignal): Promise<unknown>;
    health(signal: AbortSignal): Promise<unknown>;
    close?(): Promise<void>;
}

契约成员

成员	种类	签名	说明
`close`	方法	`close?(): Promise<void>`	公开方法；参数与返回类型以签名列为准。
`execute`	方法	`execute(request: ExecutionToolRuntimeRequest, signal: AbortSignal): Promise<unknown>`	公开方法；参数与返回类型以签名列为准。
`health`	方法	`health(signal: AbortSignal): Promise<unknown>`	公开方法；参数与返回类型以签名列为准。

`ExecutionToolRuntimeRequest`

Execution Tool Runtime Request 接口，共包含 4 个公开字段或方法。

种类: 接口
导入: import type { ExecutionToolRuntimeRequest } from '@codesoul-co/hypha-tools';
源码模块: execution-adapter

声明

text

export interface ExecutionToolRuntimeRequest<TInput = unknown> {
    dispatch: ExecutionDispatchRequest;
    normalizedInput: TInput;
    inputHash: string;
    expectedRevision: number;
}

契约成员

成员	种类	签名	说明
`dispatch`	属性	`dispatch: ExecutionDispatchRequest`	公开属性；类型、只读和可选状态以签名列为准。
`expectedRevision`	属性	`expectedRevision: number`	公开属性；类型、只读和可选状态以签名列为准。
`inputHash`	属性	`inputHash: string`	公开属性；类型、只读和可选状态以签名列为准。
`normalizedInput`	属性	`normalizedInput: TInput`	公开属性；类型、只读和可选状态以签名列为准。

`ExecutionToolRuntimeResult`

Execution Tool Runtime Result 接口，共包含 13 个公开字段或方法。

种类: 接口
导入: import type { ExecutionToolRuntimeResult } from '@codesoul-co/hypha-tools';
源码模块: execution-adapter

声明

text

export interface ExecutionToolRuntimeResult {
    activityResult: ExecutionActivityResult;
    scope: ExecutionToolRuntimeScope;
    toolId: string;
    toolRevision: string;
    contractSnapshotRef: string;
    toolOperation: ExecutionDispatchRequest['binding']['operation'];
    operationId: string;
    inputHash: string;
    revision: number;
    fencingToken: number;
    terminalState: ExecutionToolTerminalState;
    provenance: ExecutionToolProvenance;
    evidence: ExecutionToolEvidence[];
}

契约成员

成员	种类	签名	说明
`activityResult`	属性	`activityResult: ExecutionActivityResult`	公开属性；类型、只读和可选状态以签名列为准。
`contractSnapshotRef`	属性	`contractSnapshotRef: string`	公开属性；类型、只读和可选状态以签名列为准。
`evidence`	属性	`evidence: ExecutionToolEvidence[]`	公开属性；类型、只读和可选状态以签名列为准。
`fencingToken`	属性	`fencingToken: number`	公开属性；类型、只读和可选状态以签名列为准。
`inputHash`	属性	`inputHash: string`	公开属性；类型、只读和可选状态以签名列为准。
`operationId`	属性	`operationId: string`	公开属性；类型、只读和可选状态以签名列为准。
`provenance`	属性	`provenance: ExecutionToolProvenance`	公开属性；类型、只读和可选状态以签名列为准。
`revision`	属性	`revision: number`	公开属性；类型、只读和可选状态以签名列为准。
`scope`	属性	`scope: ExecutionToolRuntimeScope`	公开属性；类型、只读和可选状态以签名列为准。
`terminalState`	属性	`terminalState: "unknown" \| "completed" \| "cancelled" \| "failed" \| "timed_out" \| "quarantined"`	公开属性；类型、只读和可选状态以签名列为准。
`toolId`	属性	`toolId: string`	公开属性；类型、只读和可选状态以签名列为准。
`toolOperation`	属性	`toolOperation: "artifact" \| "command" \| "file_read" \| "file_write" \| "sandbox"`	公开属性；类型、只读和可选状态以签名列为准。
`toolRevision`	属性	`toolRevision: string`	公开属性；类型、只读和可选状态以签名列为准。

`ExecutionToolRuntimeScope`

Execution Tool Runtime Scope 接口，共包含 6 个公开字段或方法。

种类: 接口
导入: import type { ExecutionToolRuntimeScope } from '@codesoul-co/hypha-tools';
源码模块: execution-adapter

声明

text

export interface ExecutionToolRuntimeScope {
    principalId: string;
    userId?: string;
    tenantId?: string;
    sessionId?: string;
    runId: string;
    workspaceId: string;
}

契约成员

成员	种类	签名	说明
`principalId`	属性	`principalId: string`	公开属性；类型、只读和可选状态以签名列为准。
`runId`	属性	`runId: string`	公开属性；类型、只读和可选状态以签名列为准。
`sessionId`	属性	`sessionId?: string`	公开属性；类型、只读和可选状态以签名列为准。
`tenantId`	属性	`tenantId?: string`	公开属性；类型、只读和可选状态以签名列为准。
`userId`	属性	`userId?: string`	公开属性；类型、只读和可选状态以签名列为准。
`workspaceId`	属性	`workspaceId: string`	公开属性；类型、只读和可选状态以签名列为准。

`ExecutionToolDispatchFactory`

Execution Tool Dispatch Factory 公共类型别名；完整类型表达式见声明。

种类: 类型
导入: import type { ExecutionToolDispatchFactory } from '@codesoul-co/hypha-tools';
源码模块: execution-adapter

声明

text

export type ExecutionToolDispatchFactory<TInput = unknown> = (request: ExecutionToolDispatchFactoryRequest<TInput>) => Promise<ExecutionToolDispatchPlan> | ExecutionToolDispatchPlan;

`ExecutionToolTerminalState`

Execution Tool Terminal State 公共类型别名；完整类型表达式见声明。

种类: 类型
导入: import type { ExecutionToolTerminalState } from '@codesoul-co/hypha-tools';
源码模块: execution-adapter

声明

text

export type ExecutionToolTerminalState = (typeof EXECUTION_TOOL_TERMINAL_STATES)[number];

@codesoul-co/hypha-tools / execution-adapter ​

模块用法 ​

从包入口导入 ​

使用要点 ​

公共导出 ​

ExecutionToolAdapter ​

声明 ​

公开成员 ​

ExecutionToolTerminalError ​

声明 ​

公开成员 ​

EXECUTION_TOOL_TERMINAL_STATES ​

声明 ​

hashExecutionToolInput ​

声明 ​

调用签名 ​

参数 ​

返回值 ​

normalizeExecutionToolInput ​

声明 ​

调用签名 ​

参数 ​

返回值 ​

validateExecutionToolRuntimeRequest ​

声明 ​

调用签名 ​

参数 ​

返回值 ​

ExecutionToolAdapterOptions ​

声明 ​

契约成员 ​

ExecutionToolDispatchFactoryRequest ​

声明 ​

契约成员 ​

ExecutionToolDispatchPlan ​

声明 ​

契约成员 ​

ExecutionToolEvidence ​

声明 ​

契约成员 ​

ExecutionToolObservation ​

声明 ​

契约成员 ​

ExecutionToolProvenance ​

声明 ​

契约成员 ​

ExecutionToolRuntimePort ​

声明 ​

契约成员 ​

ExecutionToolRuntimeRequest ​

声明 ​

契约成员 ​

ExecutionToolRuntimeResult ​

声明 ​

契约成员 ​

ExecutionToolRuntimeScope ​

声明 ​

契约成员 ​

ExecutionToolDispatchFactory ​

声明 ​

ExecutionToolTerminalState ​

声明 ​

`@codesoul-co/hypha-tools` / `execution-adapter`

模块用法

从包入口导入

使用要点

公共导出

`ExecutionToolAdapter`

声明

公开成员

`ExecutionToolTerminalError`

声明

公开成员

`EXECUTION_TOOL_TERMINAL_STATES`

声明

`hashExecutionToolInput`

声明

调用签名

参数

返回值

`normalizeExecutionToolInput`

声明

调用签名

参数

返回值

`validateExecutionToolRuntimeRequest`

声明

调用签名

参数

返回值

`ExecutionToolAdapterOptions`

声明

契约成员

`ExecutionToolDispatchFactoryRequest`

声明

契约成员

`ExecutionToolDispatchPlan`

声明

契约成员

`ExecutionToolEvidence`

声明

契约成员

`ExecutionToolObservation`

声明

契约成员

`ExecutionToolProvenance`

声明

契约成员

`ExecutionToolRuntimePort`

声明

契约成员

`ExecutionToolRuntimeRequest`

声明

契约成员

`ExecutionToolRuntimeResult`

声明

契约成员

`ExecutionToolRuntimeScope`

声明

契约成员

`ExecutionToolDispatchFactory`

声明

`ExecutionToolTerminalState`

声明