Skip to content

@codesoul-co/hypha-memory / context-builder

模块用法

用于使用该功能边界的公共契约与操作。Context builder 模块公开 4 类。

从包入口导入

ts
import {
  CalibratedCharacterTokenEstimator,
  DefaultContextInjectionGateway,
  DefaultMemoryContextBuilder,
  MetadataContextItemPolicyEvaluator,
} from '@codesoul-co/hypha-memory';

使用要点

  • 4 个类提供可实例化的运行时实现;构造参数与公开方法在各自条目中完整列出。

公共导出

Symbol种类签名说明
CalibratedCharacterTokenEstimatornew CalibratedCharacterTokenEstimator(charactersPerToken?: number): CalibratedCharacterTokenEstimatorCalibrated Character Token Estimator 类,共公开 3 个构造函数或成员;精确签名见本条目的声明与成员表。
DefaultContextInjectionGatewaynew DefaultContextInjectionGateway(now?: () => string, artifactStore?: ContextArtifactStore | undefined): DefaultContextInjectionGatewayDefault Context Injection Gateway 类,共公开 2 个构造函数或成员;精确签名见本条目的声明与成员表。
DefaultMemoryContextBuildernew DefaultMemoryContextBuilder(tokenizer?: TokenEstimator, now?: () => string, compactor?: ContextCompactor, policy?: ContextItemPolicyEvaluator, artifactStore?: ContextArtifactStore | undefined): DefaultMemoryContextBuilderDefault Memory Context Builder 类,共公开 3 个构造函数或成员;精确签名见本条目的声明与成员表。
MetadataContextItemPolicyEvaluatornew MetadataContextItemPolicyEvaluator(): MetadataContextItemPolicyEvaluatorMetadata Context Item Policy Evaluator 类,共公开 2 个构造函数或成员;精确签名见本条目的声明与成员表。

CalibratedCharacterTokenEstimator

Calibrated Character Token Estimator 类,共公开 3 个构造函数或成员;精确签名见本条目的声明与成员表。

  • 种类: 类
  • 导入: import { CalibratedCharacterTokenEstimator } from '@codesoul-co/hypha-memory';
  • 源码模块: context-builder

声明

text
export declare class CalibratedCharacterTokenEstimator implements TokenEstimator {
    readonly id = "tokenizer.calibrated-character-v1";
    constructor(charactersPerToken?: number);
    estimate(text: string): number;
}

公开成员

成员种类签名说明
constructor构造函数(charactersPerToken?: number): CalibratedCharacterTokenEstimator创建该类的实例。
estimate方法estimate(text: string): number公开方法;参数与返回类型以签名列为准。
id属性readonly id: "tokenizer.calibrated-character-v1"公开属性;类型、只读和可选状态以签名列为准。

DefaultContextInjectionGateway

Default Context Injection Gateway 类,共公开 2 个构造函数或成员;精确签名见本条目的声明与成员表。

  • 种类: 类
  • 导入: import { DefaultContextInjectionGateway } from '@codesoul-co/hypha-memory';
  • 源码模块: context-builder

声明

text
export declare class DefaultContextInjectionGateway implements ContextInjectionGateway {
    constructor(now?: () => string, artifactStore?: ContextArtifactStore | undefined);
    buildEnvelope(bundle: ContextBundle, profile: ContextProfileSpec): Promise<ContextEnvelope>;
}

公开成员

成员种类签名说明
buildEnvelope方法buildEnvelope(bundle: ContextBundle, profile: ContextProfileSpec): Promise<ContextEnvelope>公开方法;参数与返回类型以签名列为准。
constructor构造函数(now?: () => string, artifactStore?: ContextArtifactStore | undefined): DefaultContextInjectionGateway创建该类的实例。

DefaultMemoryContextBuilder

Default Memory Context Builder 类,共公开 3 个构造函数或成员;精确签名见本条目的声明与成员表。

  • 种类: 类
  • 导入: import { DefaultMemoryContextBuilder } from '@codesoul-co/hypha-memory';
  • 源码模块: context-builder

声明

text
export declare class DefaultMemoryContextBuilder implements MemoryContextBuilder {
    constructor(tokenizer?: TokenEstimator, now?: () => string, compactor?: ContextCompactor, policy?: ContextItemPolicyEvaluator, artifactStore?: ContextArtifactStore | undefined);
    build(request: ContextBuildInput): Promise<ContextBundle>;
    explain(contextHash: string): Promise<ContextBuildExplanation | null>;
}

公开成员

成员种类签名说明
build方法build(request: ContextBuildInput): Promise<ContextBundle>公开方法;参数与返回类型以签名列为准。
constructor构造函数(tokenizer?: TokenEstimator, now?: () => string, compactor?: ContextCompactor, policy?: ContextItemPolicyEvaluator, artifactStore?: ContextArtifactStore | undefined): DefaultMemoryContextBuilder创建该类的实例。
explain方法explain(contextHash: string): Promise<ContextBuildExplanation | null>公开方法;参数与返回类型以签名列为准。

MetadataContextItemPolicyEvaluator

Metadata Context Item Policy Evaluator 类,共公开 2 个构造函数或成员;精确签名见本条目的声明与成员表。

  • 种类: 类
  • 导入: import { MetadataContextItemPolicyEvaluator } from '@codesoul-co/hypha-memory';
  • 源码模块: context-builder

声明

text
export declare class MetadataContextItemPolicyEvaluator implements ContextItemPolicyEvaluator {
    evaluate(input: ContextItemPolicyInput): Promise<{
            allowed: boolean;
            reason?: string;
        }>;
}

公开成员

成员种类签名说明
constructor构造函数(): MetadataContextItemPolicyEvaluator创建该类的实例。
evaluate方法evaluate(input: ContextItemPolicyInput): Promise<{ allowed: boolean; reason?: string; }>公开方法;参数与返回类型以签名列为准。