Skip to content

@codesoul-co/hypha-adapters-local / artifact-manager-tool-port

模块用法

用于定义或实现 Provider-neutral Port。Artifact manager tool port 模块公开 1 类、2 接口。

从包入口导入

ts
import {
  ArtifactManagerToolPort,
} from '@codesoul-co/hypha-adapters-local';

import type {
  ArtifactManagerToolPortOptions,
  ToolArtifactManagerContext,
} from '@codesoul-co/hypha-adapters-local';

使用要点

  • 2 个类型/接口用于应用代码、Adapter 或测试中的静态契约;请使用 import type,运行时不应依赖它们。
  • 1 个类提供可实例化的运行时实现;构造参数与公开方法在各自条目中完整列出。

公共导出

Symbol种类签名说明
ArtifactManagerToolPortnew ArtifactManagerToolPort(options: ArtifactManagerToolPortOptions): ArtifactManagerToolPortRoutes governed Tool result bytes through the Core ArtifactManager.
ArtifactManagerToolPortOptions接口interface ArtifactManagerToolPortOptionsArtifact Manager Tool Port Options 接口,共包含 2 个公开字段或方法。
ToolArtifactManagerContext接口interface ToolArtifactManagerContextTool Artifact Manager Context 接口,共包含 8 个公开字段或方法。

ArtifactManagerToolPort

Routes governed Tool result bytes through the Core ArtifactManager.

  • 种类: 类
  • 导入: import { ArtifactManagerToolPort } from '@codesoul-co/hypha-adapters-local';
  • 源码模块: artifact-manager-tool-port

声明

text
export declare class ArtifactManagerToolPort implements ToolArtifactPort {
    constructor(options: ArtifactManagerToolPortOptions);
    store(request: {
            invocationId: string;
            toolId: string;
            value: unknown;
            mimeType?: string;
            metadata?: Record<string, unknown>;
        }): Promise<string>;
}

公开成员

成员种类签名说明
constructor构造函数(options: ArtifactManagerToolPortOptions): ArtifactManagerToolPort创建该类的实例。
store方法store(request: { invocationId: string; toolId: string; value: unknown; mimeType?: string; metadata?: Record<string, unknown>; }): Promise<string>公开方法;参数与返回类型以签名列为准。

ArtifactManagerToolPortOptions

Artifact Manager Tool Port Options 接口,共包含 2 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { ArtifactManagerToolPortOptions } from '@codesoul-co/hypha-adapters-local';
  • 源码模块: artifact-manager-tool-port

声明

text
export interface ArtifactManagerToolPortOptions {
    manager: Pick<ArtifactManager, 'create'>;
    resolveContext(request: {
        invocationId: string;
        toolId: string;
    }): ToolArtifactManagerContext | Promise<ToolArtifactManagerContext>;
}

契约成员

成员种类签名说明
manager属性manager: Pick<ArtifactManager, "create">公开属性;类型、只读和可选状态以签名列为准。
resolveContext方法resolveContext(request: { invocationId: string; toolId: string; }): ToolArtifactManagerContext | Promise<ToolArtifactManagerContext>公开方法;参数与返回类型以签名列为准。

ToolArtifactManagerContext

Tool Artifact Manager Context 接口,共包含 8 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { ToolArtifactManagerContext } from '@codesoul-co/hypha-adapters-local';
  • 源码模块: artifact-manager-tool-port

声明

text
export interface ToolArtifactManagerContext {
    principal: ExecutionPrincipal;
    profileRef: SpecRef;
    userId: string;
    workspaceId: string;
    tenantId?: string;
    sessionId?: string;
    runId?: string;
    agentId?: string;
}

契约成员

成员种类签名说明
agentId属性agentId?: string公开属性;类型、只读和可选状态以签名列为准。
principal属性principal: ExecutionPrincipal公开属性;类型、只读和可选状态以签名列为准。
profileRef属性profileRef: SpecRef公开属性;类型、只读和可选状态以签名列为准。
runId属性runId?: string公开属性;类型、只读和可选状态以签名列为准。
sessionId属性sessionId?: string公开属性;类型、只读和可选状态以签名列为准。
tenantId属性tenantId?: string公开属性;类型、只读和可选状态以签名列为准。
userId属性userId: string公开属性;类型、只读和可选状态以签名列为准。
workspaceId属性workspaceId: string公开属性;类型、只读和可选状态以签名列为准。