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

• 包索引: @codesoul-co/hypha-memory
• 源码: packages/memory/src/context-contracts.ts
• 导出数: 29

模块用法

用于声明并运行时校验契约。Context contracts 模块公开 28 接口、1 类型。

从包入口导入

import type {
  ContextBudgetPlan,
  ContextBuildExplanation,
  ContextBuildInput,
  ContextBuildRequest,
  ContextBundle,
  ContextCompactionPolicySpec,
  ContextConflict,
  ContextEnvelope,
} from '@codesoul-co/hypha-memory';

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

使用要点

• 29 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。

公共导出

Symbol	种类	签名	说明
ContextBudgetPlan	接口	interface ContextBudgetPlan	Context Budget Plan 接口，共包含 6 个公开字段或方法。
ContextBuildExplanation	接口	interface ContextBuildExplanation	Context Build Explanation 接口，共包含 6 个公开字段或方法。
ContextBuildInput	接口	interface ContextBuildInput extends ContextBuildRequest	Context Build Input 接口，共包含 20 个公开字段或方法。
ContextBuildRequest	接口	interface ContextBuildRequest	Context Build Request 接口，共包含 17 个公开字段或方法。
ContextBundle	接口	interface ContextBundle	Context Bundle 接口，共包含 16 个公开字段或方法。
ContextCompactionPolicySpec	接口	interface ContextCompactionPolicySpec	Context Compaction Policy Spec 接口，共包含 6 个公开字段或方法。
ContextConflict	接口	interface ContextConflict	Context Conflict 接口，共包含 3 个公开字段或方法。
ContextEnvelope	接口	interface ContextEnvelope	Context Envelope 接口，共包含 17 个公开字段或方法。
ContextInjectionGateway	接口	interface ContextInjectionGateway	Context Injection Gateway 接口，共包含 1 个公开字段或方法。
ContextItem	接口	interface ContextItem	Context Item 接口，共包含 14 个公开字段或方法。
ContextItemPolicyDecision	接口	interface ContextItemPolicyDecision	Context Item Policy Decision 接口，共包含 2 个公开字段或方法。
ContextItemPolicyEvaluator	接口	interface ContextItemPolicyEvaluator	Context Item Policy Evaluator 接口，共包含 1 个公开字段或方法。
ContextItemPolicyInput	接口	interface ContextItemPolicyInput	Context Item Policy Input 接口，共包含 5 个公开字段或方法。
ContextProfileSpec	接口	interface ContextProfileSpec	Context Profile Spec 接口，共包含 23 个公开字段或方法。
ContextProvenanceLabel	接口	interface ContextProvenanceLabel	Context Provenance Label 接口，共包含 7 个公开字段或方法。
ContextRankingPolicySpec	接口	interface ContextRankingPolicySpec	Context Ranking Policy Spec 接口，共包含 8 个公开字段或方法。
ContextRejectedItem	接口	interface ContextRejectedItem	Context Rejected Item 接口，共包含 2 个公开字段或方法。
ContextSourceBudget	接口	interface ContextSourceBudget	Context Source Budget 接口，共包含 6 个公开字段或方法。
ContextSourceResolutionInput	接口	interface ContextSourceResolutionInput extends ResolvedContextBuildInput	Context Source Resolution Input 接口，共包含 20 个公开字段或方法。
ContextSourceResolver	接口	interface ContextSourceResolver	Context Source Resolver 接口，共包含 3 个公开字段或方法。
ContextSourceResolverRegistry	接口	interface ContextSourceResolverRegistry	Context Source Resolver Registry 接口，共包含 1 个公开字段或方法。
ContextSourceSpec	接口	interface ContextSourceSpec	Context Source Spec 接口，共包含 9 个公开字段或方法。
ContextTruncationPolicySpec	接口	interface ContextTruncationPolicySpec	Context Truncation Policy Spec 接口，共包含 5 个公开字段或方法。
ContextTruncationRecord	接口	interface ContextTruncationRecord	Context Truncation Record 接口，共包含 5 个公开字段或方法。
MemoryContextBuilder	接口	interface MemoryContextBuilder	Memory Context Builder 接口，共包含 2 个公开字段或方法。
PromptSegment	接口	interface PromptSegment	Prompt Segment 接口，共包含 8 个公开字段或方法。
ResolvedContextBuildInput	接口	interface ResolvedContextBuildInput extends ContextBuildRequest	Resolved Context Build Input 接口，共包含 19 个公开字段或方法。
TokenEstimator	接口	interface TokenEstimator	Token Estimator 接口，共包含 2 个公开字段或方法。
ContextSourceType	类型	type ContextSourceType = 'system' | 'workflow_state' | 'messages' | 'working_memory' | 'long_term_memory' | 'tool_observation' | 'artifact' | 'human_review' | 'custom'	Context Source Type 公共类型别名；完整类型表达式见声明。

ContextBudgetPlan

Context Budget Plan 接口，共包含 6 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextBudgetPlan } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextBudgetPlan {
    totalAvailableTokens: number;
    fixedTokens: number;
    dynamicTokens: number;
    sourceBudgets: ContextSourceBudget[];
    tokenizerRef: MemoryContractSpecRef;
    safetyMarginTokens: number;
}

契约成员

成员	种类	签名	说明
dynamicTokens	属性	dynamicTokens: number	公开属性；类型、只读和可选状态以签名列为准。
fixedTokens	属性	fixedTokens: number	公开属性；类型、只读和可选状态以签名列为准。
safetyMarginTokens	属性	safetyMarginTokens: number	公开属性；类型、只读和可选状态以签名列为准。
sourceBudgets	属性	sourceBudgets: ContextSourceBudget[]	公开属性；类型、只读和可选状态以签名列为准。
tokenizerRef	属性	tokenizerRef: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
totalAvailableTokens	属性	totalAvailableTokens: number	公开属性；类型、只读和可选状态以签名列为准。

ContextBuildExplanation

Context Build Explanation 接口，共包含 6 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextBuildExplanation } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextBuildExplanation {
    contextHash: string;
    selectedItemIds: string[];
    omittedItemIds: string[];
    rejectedItems: ContextRejectedItem[];
    ranking: Array<{
        itemId: string;
        score: number;
        reasons: string[];
    }>;
    budgetPlan: ContextBudgetPlan;
}

契约成员

成员	种类	签名	说明
budgetPlan	属性	budgetPlan: ContextBudgetPlan	公开属性；类型、只读和可选状态以签名列为准。
contextHash	属性	contextHash: string	公开属性；类型、只读和可选状态以签名列为准。
omittedItemIds	属性	omittedItemIds: string[]	公开属性；类型、只读和可选状态以签名列为准。
ranking	属性	ranking: { itemId: string; score: number; reasons: string[]; }[]	公开属性；类型、只读和可选状态以签名列为准。
rejectedItems	属性	rejectedItems: ContextRejectedItem[]	公开属性；类型、只读和可选状态以签名列为准。
selectedItemIds	属性	selectedItemIds: string[]	公开属性；类型、只读和可选状态以签名列为准。

ContextBuildInput

Context Build Input 接口，共包含 20 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextBuildInput } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextBuildInput extends ContextBuildRequest {
    profile: ContextProfileSpec;
    sourceItems: ContextItem[];
    tokenizerRef?: MemoryContractSpecRef;
}

契约成员

成员	种类	签名	说明
explicitSourceRefs	属性	explicitSourceRefs?: string[]	公开属性；类型、只读和可选状态以签名列为准。
messageCursor	属性	messageCursor?: string	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
modelContextWindowTokens	属性	modelContextWindowTokens: number	公开属性；类型、只读和可选状态以签名列为准。
operationId	属性	operationId: string	公开属性；类型、只读和可选状态以签名列为准。
previousContextHash	属性	previousContextHash?: string	公开属性；类型、只读和可选状态以签名列为准。
principal	属性	principal: MemoryPrincipal	公开属性；类型、只读和可选状态以签名列为准。
profile	属性	profile: ContextProfileSpec	公开属性；类型、只读和可选状态以签名列为准。
profileRef	属性	profileRef: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
query	属性	query?: string	公开属性；类型、只读和可选状态以签名列为准。
reservedInstructionTokens	属性	reservedInstructionTokens: number	公开属性；类型、只读和可选状态以签名列为准。
reservedOutputTokens	属性	reservedOutputTokens: number	公开属性；类型、只读和可选状态以签名列为准。
reservedSystemTokens	属性	reservedSystemTokens: number	公开属性；类型、只读和可选状态以签名列为准。
runId	属性	runId: string	公开属性；类型、只读和可选状态以签名列为准。
runtimeStateRef	属性	runtimeStateRef?: string	公开属性；类型、只读和可选状态以签名列为准。
scope	属性	scope: ManagedMemoryScope	公开属性；类型、只读和可选状态以签名列为准。
sourceItems	属性	sourceItems: ContextItem[]	公开属性；类型、只读和可选状态以签名列为准。
stateId	属性	stateId?: string	公开属性；类型、只读和可选状态以签名列为准。
stepId	属性	stepId?: string	公开属性；类型、只读和可选状态以签名列为准。
tokenizerRef	属性	tokenizerRef?: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。

ContextBuildRequest

Context Build Request 接口，共包含 17 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextBuildRequest } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextBuildRequest {
    operationId: string;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    runId: string;
    stepId?: string;
    stateId?: string;
    profileRef: MemoryContractSpecRef;
    modelContextWindowTokens: number;
    reservedSystemTokens: number;
    reservedInstructionTokens: number;
    reservedOutputTokens: number;
    runtimeStateRef?: string;
    messageCursor?: string;
    explicitSourceRefs?: string[];
    query?: string;
    previousContextHash?: string;
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
explicitSourceRefs	属性	explicitSourceRefs?: string[]	公开属性；类型、只读和可选状态以签名列为准。
messageCursor	属性	messageCursor?: string	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
modelContextWindowTokens	属性	modelContextWindowTokens: number	公开属性；类型、只读和可选状态以签名列为准。
operationId	属性	operationId: string	公开属性；类型、只读和可选状态以签名列为准。
previousContextHash	属性	previousContextHash?: string	公开属性；类型、只读和可选状态以签名列为准。
principal	属性	principal: MemoryPrincipal	公开属性；类型、只读和可选状态以签名列为准。
profileRef	属性	profileRef: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
query	属性	query?: string	公开属性；类型、只读和可选状态以签名列为准。
reservedInstructionTokens	属性	reservedInstructionTokens: number	公开属性；类型、只读和可选状态以签名列为准。
reservedOutputTokens	属性	reservedOutputTokens: number	公开属性；类型、只读和可选状态以签名列为准。
reservedSystemTokens	属性	reservedSystemTokens: number	公开属性；类型、只读和可选状态以签名列为准。
runId	属性	runId: string	公开属性；类型、只读和可选状态以签名列为准。
runtimeStateRef	属性	runtimeStateRef?: string	公开属性；类型、只读和可选状态以签名列为准。
scope	属性	scope: ManagedMemoryScope	公开属性；类型、只读和可选状态以签名列为准。
stateId	属性	stateId?: string	公开属性；类型、只读和可选状态以签名列为准。
stepId	属性	stepId?: string	公开属性；类型、只读和可选状态以签名列为准。

ContextBundle

Context Bundle 接口，共包含 16 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextBundle } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextBundle {
    id: string;
    runId: string;
    stepId?: string;
    profileRef: MemoryContractSpecRef;
    profileRevision: string;
    items: ContextItem[];
    totalTokens: number;
    totalCharacters: number;
    omittedItemIds: string[];
    rejectedItems: ContextRejectedItem[];
    conflicts: ContextConflict[];
    sourceHashes: Record<string, string>;
    contextHash: string;
    createdAt: string;
    metadata?: Record<string, unknown>;
    artifactRefs?: ContextArtifactRef[];
}

契约成员

成员	种类	签名	说明
artifactRefs	属性	artifactRefs?: ContextArtifactRef[]	公开属性；类型、只读和可选状态以签名列为准。
conflicts	属性	conflicts: ContextConflict[]	公开属性；类型、只读和可选状态以签名列为准。
contextHash	属性	contextHash: string	公开属性；类型、只读和可选状态以签名列为准。
createdAt	属性	createdAt: string	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
items	属性	items: ContextItem[]	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
omittedItemIds	属性	omittedItemIds: string[]	公开属性；类型、只读和可选状态以签名列为准。
profileRef	属性	profileRef: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
profileRevision	属性	profileRevision: string	公开属性；类型、只读和可选状态以签名列为准。
rejectedItems	属性	rejectedItems: ContextRejectedItem[]	公开属性；类型、只读和可选状态以签名列为准。
runId	属性	runId: string	公开属性；类型、只读和可选状态以签名列为准。
sourceHashes	属性	sourceHashes: Record<string, string>	公开属性；类型、只读和可选状态以签名列为准。
stepId	属性	stepId?: string	公开属性；类型、只读和可选状态以签名列为准。
totalCharacters	属性	totalCharacters: number	公开属性；类型、只读和可选状态以签名列为准。
totalTokens	属性	totalTokens: number	公开属性；类型、只读和可选状态以签名列为准。

ContextCompactionPolicySpec

Context Compaction Policy Spec 接口，共包含 6 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextCompactionPolicySpec } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextCompactionPolicySpec {
    enabled: boolean;
    triggerRatio: number;
    summaryProviderRef?: MemoryContractSpecRef;
    preserveLastMessages?: number;
    persistSummaryAsMemory?: boolean;
    summaryMemoryType?: import('./contracts').ManagedMemoryType;
}

契约成员

成员	种类	签名	说明
enabled	属性	enabled: boolean	公开属性；类型、只读和可选状态以签名列为准。
persistSummaryAsMemory	属性	persistSummaryAsMemory?: boolean	公开属性；类型、只读和可选状态以签名列为准。
preserveLastMessages	属性	preserveLastMessages?: number	公开属性；类型、只读和可选状态以签名列为准。
summaryMemoryType	属性	summaryMemoryType?: import("/Users/erwin/Downloads/codespace/Hypha/packages/memory/dist/contracts").ManagedMemoryType	公开属性；类型、只读和可选状态以签名列为准。
summaryProviderRef	属性	summaryProviderRef?: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
triggerRatio	属性	triggerRatio: number	公开属性；类型、只读和可选状态以签名列为准。

ContextConflict

Context Conflict 接口，共包含 3 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextConflict } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextConflict {
    conflictGroupId: string;
    itemIds: string[];
    resolution?: string;
}

契约成员

成员	种类	签名	说明
conflictGroupId	属性	conflictGroupId: string	公开属性；类型、只读和可选状态以签名列为准。
itemIds	属性	itemIds: string[]	公开属性；类型、只读和可选状态以签名列为准。
resolution	属性	resolution?: string	公开属性；类型、只读和可选状态以签名列为准。

ContextEnvelope

Context Envelope 接口，共包含 17 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextEnvelope } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextEnvelope {
    id: string;
    runId: string;
    stepId?: string;
    contextHash: string;
    profileRevision: string;
    budgetPlan: ContextBudgetPlan;
    systemSegments: PromptSegment[];
    instructionSegments: PromptSegment[];
    dataSegments: PromptSegment[];
    includedSourceRefs: string[];
    omittedSourceRefs: string[];
    truncationRecords: ContextTruncationRecord[];
    provenanceIndex: Record<string, ContextProvenanceLabel>;
    conflicts: ContextConflict[];
    totalTokens: number;
    createdAt: string;
    artifactRefs?: ContextArtifactRef[];
}

契约成员

成员	种类	签名	说明
artifactRefs	属性	artifactRefs?: ContextArtifactRef[]	公开属性；类型、只读和可选状态以签名列为准。
budgetPlan	属性	budgetPlan: ContextBudgetPlan	公开属性；类型、只读和可选状态以签名列为准。
conflicts	属性	conflicts: ContextConflict[]	公开属性；类型、只读和可选状态以签名列为准。
contextHash	属性	contextHash: string	公开属性；类型、只读和可选状态以签名列为准。
createdAt	属性	createdAt: string	公开属性；类型、只读和可选状态以签名列为准。
dataSegments	属性	dataSegments: PromptSegment[]	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
includedSourceRefs	属性	includedSourceRefs: string[]	公开属性；类型、只读和可选状态以签名列为准。
instructionSegments	属性	instructionSegments: PromptSegment[]	公开属性；类型、只读和可选状态以签名列为准。
omittedSourceRefs	属性	omittedSourceRefs: string[]	公开属性；类型、只读和可选状态以签名列为准。
profileRevision	属性	profileRevision: string	公开属性；类型、只读和可选状态以签名列为准。
provenanceIndex	属性	provenanceIndex: Record<string, ContextProvenanceLabel>	公开属性；类型、只读和可选状态以签名列为准。
runId	属性	runId: string	公开属性；类型、只读和可选状态以签名列为准。
stepId	属性	stepId?: string	公开属性；类型、只读和可选状态以签名列为准。
systemSegments	属性	systemSegments: PromptSegment[]	公开属性；类型、只读和可选状态以签名列为准。
totalTokens	属性	totalTokens: number	公开属性；类型、只读和可选状态以签名列为准。
truncationRecords	属性	truncationRecords: ContextTruncationRecord[]	公开属性；类型、只读和可选状态以签名列为准。

ContextInjectionGateway

Context Injection Gateway 接口，共包含 1 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextInjectionGateway } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextInjectionGateway {
    buildEnvelope(bundle: ContextBundle, profile: ContextProfileSpec): Promise<ContextEnvelope>;
}

契约成员

成员	种类	签名	说明
buildEnvelope	方法	buildEnvelope(bundle: ContextBundle, profile: ContextProfileSpec): Promise<ContextEnvelope>	公开方法；参数与返回类型以签名列为准。

ContextItem

Context Item 接口，共包含 14 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextItem } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextItem {
    id: string;
    sourceType: ContextSourceType;
    sourceId?: string;
    content: unknown;
    text: string;
    tokenEstimate: number;
    priority: number;
    score?: number;
    required?: boolean;
    untrusted?: boolean;
    provenance?: MemoryProvenance | Record<string, unknown>;
    conflictGroupId?: string;
    metadata?: Record<string, unknown>;
    artifactRef?: ContextArtifactRef;
}

契约成员

成员	种类	签名	说明
artifactRef	属性	artifactRef?: ContextArtifactRef	公开属性；类型、只读和可选状态以签名列为准。
conflictGroupId	属性	conflictGroupId?: string	公开属性；类型、只读和可选状态以签名列为准。
content	属性	content: unknown	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
priority	属性	priority: number	公开属性；类型、只读和可选状态以签名列为准。
provenance	属性	provenance?: Record<string, unknown> | MemoryProvenance	公开属性；类型、只读和可选状态以签名列为准。
required	属性	required?: boolean	公开属性；类型、只读和可选状态以签名列为准。
score	属性	score?: number	公开属性；类型、只读和可选状态以签名列为准。
sourceId	属性	sourceId?: string	公开属性；类型、只读和可选状态以签名列为准。
sourceType	属性	sourceType: ContextSourceType	公开属性；类型、只读和可选状态以签名列为准。
text	属性	text: string	公开属性；类型、只读和可选状态以签名列为准。
tokenEstimate	属性	tokenEstimate: number	公开属性；类型、只读和可选状态以签名列为准。
untrusted	属性	untrusted?: boolean	公开属性；类型、只读和可选状态以签名列为准。

ContextItemPolicyDecision

Context Item Policy Decision 接口，共包含 2 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextItemPolicyDecision } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextItemPolicyDecision {
    allowed: boolean;
    reason?: string;
}

契约成员

成员	种类	签名	说明
allowed	属性	allowed: boolean	公开属性；类型、只读和可选状态以签名列为准。
reason	属性	reason?: string	公开属性；类型、只读和可选状态以签名列为准。

ContextItemPolicyEvaluator

Context Item Policy Evaluator 接口，共包含 1 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextItemPolicyEvaluator } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextItemPolicyEvaluator {
    evaluate(input: ContextItemPolicyInput): Promise<ContextItemPolicyDecision>;
}

契约成员

成员	种类	签名	说明
evaluate	方法	evaluate(input: ContextItemPolicyInput): Promise<ContextItemPolicyDecision>	公开方法；参数与返回类型以签名列为准。

ContextItemPolicyInput

Context Item Policy Input 接口，共包含 5 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextItemPolicyInput } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextItemPolicyInput {
    operationId: string;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    profileRef: MemoryContractSpecRef;
    item: ContextItem;
}

契约成员

成员	种类	签名	说明
item	属性	item: ContextItem	公开属性；类型、只读和可选状态以签名列为准。
operationId	属性	operationId: string	公开属性；类型、只读和可选状态以签名列为准。
principal	属性	principal: MemoryPrincipal	公开属性；类型、只读和可选状态以签名列为准。
profileRef	属性	profileRef: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
scope	属性	scope: ManagedMemoryScope	公开属性；类型、只读和可选状态以签名列为准。

ContextProfileSpec

Context Profile Spec 接口，共包含 23 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextProfileSpec } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextProfileSpec {
    id: string;
    version: string;
    revision?: string;
    name?: string;
    description?: string;
    sources: ContextSourceSpec[];
    maxItems?: number;
    maxCharacters?: number;
    maxSerializedBytes?: number;
    maxTokens: number;
    reservedOutputTokens?: number;
    reservedSystemTokens?: number;
    deduplication: 'none' | 'id' | 'hash' | 'semantic';
    semanticDedupThreshold?: number;
    ranking: ContextRankingPolicySpec;
    truncation: ContextTruncationPolicySpec;
    conflictPolicy?: 'include_marked' | 'prefer_latest' | 'prefer_verified';
    includeProvenance: boolean;
    includeScores?: boolean;
    instructionBoundary: 'strict' | 'tagged' | 'quoted';
    untrustedContentPolicy: 'escape' | 'tag' | 'reject';
    compactionPolicy?: ContextCompactionPolicySpec;
    metadata?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
compactionPolicy	属性	compactionPolicy?: ContextCompactionPolicySpec	公开属性；类型、只读和可选状态以签名列为准。
conflictPolicy	属性	conflictPolicy?: "include_marked" | "prefer_latest" | "prefer_verified"	公开属性；类型、只读和可选状态以签名列为准。
deduplication	属性	deduplication: "none" | "id" | "semantic" | "hash"	公开属性；类型、只读和可选状态以签名列为准。
description	属性	description?: string	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
includeProvenance	属性	includeProvenance: boolean	公开属性；类型、只读和可选状态以签名列为准。
includeScores	属性	includeScores?: boolean	公开属性；类型、只读和可选状态以签名列为准。
instructionBoundary	属性	instructionBoundary: "strict" | "tagged" | "quoted"	公开属性；类型、只读和可选状态以签名列为准。
maxCharacters	属性	maxCharacters?: number	公开属性；类型、只读和可选状态以签名列为准。
maxItems	属性	maxItems?: number	公开属性；类型、只读和可选状态以签名列为准。
maxSerializedBytes	属性	maxSerializedBytes?: number	公开属性；类型、只读和可选状态以签名列为准。
maxTokens	属性	maxTokens: number	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
name	属性	name?: string	公开属性；类型、只读和可选状态以签名列为准。
ranking	属性	ranking: ContextRankingPolicySpec	公开属性；类型、只读和可选状态以签名列为准。
reservedOutputTokens	属性	reservedOutputTokens?: number	公开属性；类型、只读和可选状态以签名列为准。
reservedSystemTokens	属性	reservedSystemTokens?: number	公开属性；类型、只读和可选状态以签名列为准。
revision	属性	revision?: string	公开属性；类型、只读和可选状态以签名列为准。
semanticDedupThreshold	属性	semanticDedupThreshold?: number	公开属性；类型、只读和可选状态以签名列为准。
sources	属性	sources: ContextSourceSpec[]	公开属性；类型、只读和可选状态以签名列为准。
truncation	属性	truncation: ContextTruncationPolicySpec	公开属性；类型、只读和可选状态以签名列为准。
untrustedContentPolicy	属性	untrustedContentPolicy: "reject" | "escape" | "tag"	公开属性；类型、只读和可选状态以签名列为准。
version	属性	version: string	公开属性；类型、只读和可选状态以签名列为准。

ContextProvenanceLabel

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

• 种类: 接口
• 导入: import type { ContextProvenanceLabel } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextProvenanceLabel {
    sourceType: ContextSourceType;
    sourceId: string;
    memoryId?: string;
    memoryVersionId?: string;
    authority?: 'unverified' | 'user_asserted' | 'system_observed' | 'verified' | 'authoritative';
    observedAt?: string;
    citationLabel: string;
}

契约成员

成员	种类	签名	说明
authority	属性	authority?: "verified" | "unverified" | "user_asserted" | "system_observed" | "authoritative"	公开属性；类型、只读和可选状态以签名列为准。
citationLabel	属性	citationLabel: string	公开属性；类型、只读和可选状态以签名列为准。
memoryId	属性	memoryId?: string	公开属性；类型、只读和可选状态以签名列为准。
memoryVersionId	属性	memoryVersionId?: string	公开属性；类型、只读和可选状态以签名列为准。
observedAt	属性	observedAt?: string	公开属性；类型、只读和可选状态以签名列为准。
sourceId	属性	sourceId: string	公开属性；类型、只读和可选状态以签名列为准。
sourceType	属性	sourceType: ContextSourceType	公开属性；类型、只读和可选状态以签名列为准。

ContextRankingPolicySpec

Context Ranking Policy Spec 接口，共包含 8 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextRankingPolicySpec } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextRankingPolicySpec {
    method: 'priority' | 'score_fusion' | 'reranker' | 'custom';
    recencyWeight?: number;
    relevanceWeight?: number;
    importanceWeight?: number;
    confidenceWeight?: number;
    provenanceWeight?: number;
    sourceWeights?: Record<string, number>;
    rerankerProviderRef?: MemoryContractSpecRef;
}

契约成员

成员	种类	签名	说明
confidenceWeight	属性	confidenceWeight?: number	公开属性；类型、只读和可选状态以签名列为准。
importanceWeight	属性	importanceWeight?: number	公开属性；类型、只读和可选状态以签名列为准。
method	属性	method: "custom" | "priority" | "score_fusion" | "reranker"	公开属性；类型、只读和可选状态以签名列为准。
provenanceWeight	属性	provenanceWeight?: number	公开属性；类型、只读和可选状态以签名列为准。
recencyWeight	属性	recencyWeight?: number	公开属性；类型、只读和可选状态以签名列为准。
relevanceWeight	属性	relevanceWeight?: number	公开属性；类型、只读和可选状态以签名列为准。
rerankerProviderRef	属性	rerankerProviderRef?: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
sourceWeights	属性	sourceWeights?: Record<string, number>	公开属性；类型、只读和可选状态以签名列为准。

ContextRejectedItem

Context Rejected Item 接口，共包含 2 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextRejectedItem } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextRejectedItem {
    itemId: string;
    reason: 'scope_denied' | 'policy_denied' | 'invalid_status' | 'duplicate' | 'budget_exceeded' | 'untrusted_rejected' | 'invalid_input';
}

契约成员

成员	种类	签名	说明
itemId	属性	itemId: string	公开属性；类型、只读和可选状态以签名列为准。
reason	属性	reason: "policy_denied" | "duplicate" | "scope_denied" | "invalid_status" | "budget_exceeded" | "untrusted_rejected" | "invalid_input"	公开属性；类型、只读和可选状态以签名列为准。

ContextSourceBudget

Context Source Budget 接口，共包含 6 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextSourceBudget } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextSourceBudget {
    sourceId: string;
    minTokens?: number;
    targetTokens?: number;
    maxTokens: number;
    required: boolean;
    overflowPolicy: 'drop' | 'truncate' | 'summarize' | 'spill_to_artifact' | 'fail';
}

契约成员

成员	种类	签名	说明
maxTokens	属性	maxTokens: number	公开属性；类型、只读和可选状态以签名列为准。
minTokens	属性	minTokens?: number	公开属性；类型、只读和可选状态以签名列为准。
overflowPolicy	属性	overflowPolicy: "fail" | "summarize" | "drop" | "truncate" | "spill_to_artifact"	公开属性；类型、只读和可选状态以签名列为准。
required	属性	required: boolean	公开属性；类型、只读和可选状态以签名列为准。
sourceId	属性	sourceId: string	公开属性；类型、只读和可选状态以签名列为准。
targetTokens	属性	targetTokens?: number	公开属性；类型、只读和可选状态以签名列为准。

ContextSourceResolutionInput

Context Source Resolution Input 接口，共包含 20 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextSourceResolutionInput } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextSourceResolutionInput extends ResolvedContextBuildInput {
    source: ContextSourceSpec;
}

契约成员

成员	种类	签名	说明
explicitSourceRefs	属性	explicitSourceRefs?: string[]	公开属性；类型、只读和可选状态以签名列为准。
messageCursor	属性	messageCursor?: string	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
modelContextWindowTokens	属性	modelContextWindowTokens: number	公开属性；类型、只读和可选状态以签名列为准。
operationId	属性	operationId: string	公开属性；类型、只读和可选状态以签名列为准。
previousContextHash	属性	previousContextHash?: string	公开属性；类型、只读和可选状态以签名列为准。
principal	属性	principal: MemoryPrincipal	公开属性；类型、只读和可选状态以签名列为准。
profile	属性	profile: ContextProfileSpec	公开属性；类型、只读和可选状态以签名列为准。
profileRef	属性	profileRef: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
query	属性	query?: string	公开属性；类型、只读和可选状态以签名列为准。
reservedInstructionTokens	属性	reservedInstructionTokens: number	公开属性；类型、只读和可选状态以签名列为准。
reservedOutputTokens	属性	reservedOutputTokens: number	公开属性；类型、只读和可选状态以签名列为准。
reservedSystemTokens	属性	reservedSystemTokens: number	公开属性；类型、只读和可选状态以签名列为准。
runId	属性	runId: string	公开属性；类型、只读和可选状态以签名列为准。
runtimeStateRef	属性	runtimeStateRef?: string	公开属性；类型、只读和可选状态以签名列为准。
scope	属性	scope: ManagedMemoryScope	公开属性；类型、只读和可选状态以签名列为准。
source	属性	source: ContextSourceSpec	公开属性；类型、只读和可选状态以签名列为准。
stateId	属性	stateId?: string	公开属性；类型、只读和可选状态以签名列为准。
stepId	属性	stepId?: string	公开属性；类型、只读和可选状态以签名列为准。
tokenizerRef	属性	tokenizerRef?: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。

ContextSourceResolver

Context Source Resolver 接口，共包含 3 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextSourceResolver } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextSourceResolver {
    readonly id: string;
    supports(source: ContextSourceSpec): boolean;
    resolve(request: ContextSourceResolutionInput): Promise<ContextItem[]>;
}

契约成员

成员	种类	签名	说明
id	属性	readonly id: string	公开属性；类型、只读和可选状态以签名列为准。
resolve	方法	resolve(request: ContextSourceResolutionInput): Promise<ContextItem[]>	公开方法；参数与返回类型以签名列为准。
supports	方法	supports(source: ContextSourceSpec): boolean	公开方法；参数与返回类型以签名列为准。

ContextSourceResolverRegistry

Context Source Resolver Registry 接口，共包含 1 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextSourceResolverRegistry } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextSourceResolverRegistry {
    resolve(request: ResolvedContextBuildInput): Promise<ContextItem[]>;
}

契约成员

成员	种类	签名	说明
resolve	方法	resolve(request: ResolvedContextBuildInput): Promise<ContextItem[]>	公开方法；参数与返回类型以签名列为准。

ContextSourceSpec

Context Source Spec 接口，共包含 9 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextSourceSpec } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextSourceSpec {
    id: string;
    type: ContextSourceType;
    ref?: MemoryContractSpecRef;
    required?: boolean;
    priority: number;
    maxItems?: number;
    maxTokens?: number;
    overflowPolicy?: ContextSourceBudget['overflowPolicy'];
    filters?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
filters	属性	filters?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
maxItems	属性	maxItems?: number	公开属性；类型、只读和可选状态以签名列为准。
maxTokens	属性	maxTokens?: number	公开属性；类型、只读和可选状态以签名列为准。
overflowPolicy	属性	overflowPolicy?: "fail" | "summarize" | "drop" | "truncate" | "spill_to_artifact"	公开属性；类型、只读和可选状态以签名列为准。
priority	属性	priority: number	公开属性；类型、只读和可选状态以签名列为准。
ref	属性	ref?: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
required	属性	required?: boolean	公开属性；类型、只读和可选状态以签名列为准。
type	属性	type: ContextSourceType	公开属性；类型、只读和可选状态以签名列为准。

ContextTruncationPolicySpec

Context Truncation Policy Spec 接口，共包含 5 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextTruncationPolicySpec } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextTruncationPolicySpec {
    method: 'drop_lowest' | 'truncate_items' | 'summarize' | 'hybrid';
    preserveRequiredSources: boolean;
    preserveLatestMessages?: number;
    minItemTokens?: number;
    truncationMarker?: string;
}

契约成员

成员	种类	签名	说明
method	属性	method: "hybrid" | "summarize" | "drop_lowest" | "truncate_items"	公开属性；类型、只读和可选状态以签名列为准。
minItemTokens	属性	minItemTokens?: number	公开属性；类型、只读和可选状态以签名列为准。
preserveLatestMessages	属性	preserveLatestMessages?: number	公开属性；类型、只读和可选状态以签名列为准。
preserveRequiredSources	属性	preserveRequiredSources: boolean	公开属性；类型、只读和可选状态以签名列为准。
truncationMarker	属性	truncationMarker?: string	公开属性；类型、只读和可选状态以签名列为准。

ContextTruncationRecord

Context Truncation Record 接口，共包含 5 个公开字段或方法。

• 种类: 接口
• 导入: import type { ContextTruncationRecord } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ContextTruncationRecord {
    itemId: string;
    originalTokens: number;
    retainedTokens: number;
    method: 'drop' | 'truncate' | 'summarize' | 'spill_to_artifact';
    reason: string;
}

契约成员

成员	种类	签名	说明
itemId	属性	itemId: string	公开属性；类型、只读和可选状态以签名列为准。
method	属性	method: "summarize" | "drop" | "truncate" | "spill_to_artifact"	公开属性；类型、只读和可选状态以签名列为准。
originalTokens	属性	originalTokens: number	公开属性；类型、只读和可选状态以签名列为准。
reason	属性	reason: string	公开属性；类型、只读和可选状态以签名列为准。
retainedTokens	属性	retainedTokens: number	公开属性；类型、只读和可选状态以签名列为准。

MemoryContextBuilder

Memory Context Builder 接口，共包含 2 个公开字段或方法。

• 种类: 接口
• 导入: import type { MemoryContextBuilder } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface MemoryContextBuilder {
    build(request: ContextBuildInput): Promise<ContextBundle>;
    explain(contextHash: string): Promise<ContextBuildExplanation | null>;
}

契约成员

成员	种类	签名	说明
build	方法	build(request: ContextBuildInput): Promise<ContextBundle>	公开方法；参数与返回类型以签名列为准。
explain	方法	explain(contextHash: string): Promise<ContextBuildExplanation | null>	公开方法；参数与返回类型以签名列为准。

PromptSegment

Prompt Segment 接口，共包含 8 个公开字段或方法。

• 种类: 接口
• 导入: import type { PromptSegment } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface PromptSegment {
    id: string;
    role: 'system' | 'developer' | 'user' | 'assistant' | 'tool' | 'data';
    text: string;
    tokenCount: number;
    trustLevel: 'trusted_instruction' | 'trusted_data' | 'untrusted_data';
    sourceRefs: string[];
    required?: boolean;
    artifactRefs?: ContextArtifactRef[];
}

契约成员

成员	种类	签名	说明
artifactRefs	属性	artifactRefs?: ContextArtifactRef[]	公开属性；类型、只读和可选状态以签名列为准。
id	属性	id: string	公开属性；类型、只读和可选状态以签名列为准。
required	属性	required?: boolean	公开属性；类型、只读和可选状态以签名列为准。
role	属性	role: "system" | "tool" | "user" | "assistant" | "developer" | "data"	公开属性；类型、只读和可选状态以签名列为准。
sourceRefs	属性	sourceRefs: string[]	公开属性；类型、只读和可选状态以签名列为准。
text	属性	text: string	公开属性；类型、只读和可选状态以签名列为准。
tokenCount	属性	tokenCount: number	公开属性；类型、只读和可选状态以签名列为准。
trustLevel	属性	trustLevel: "trusted_instruction" | "trusted_data" | "untrusted_data"	公开属性；类型、只读和可选状态以签名列为准。

ResolvedContextBuildInput

Resolved Context Build Input 接口，共包含 19 个公开字段或方法。

• 种类: 接口
• 导入: import type { ResolvedContextBuildInput } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface ResolvedContextBuildInput extends ContextBuildRequest {
    profile: ContextProfileSpec;
    tokenizerRef?: MemoryContractSpecRef;
}

契约成员

成员	种类	签名	说明
explicitSourceRefs	属性	explicitSourceRefs?: string[]	公开属性；类型、只读和可选状态以签名列为准。
messageCursor	属性	messageCursor?: string	公开属性；类型、只读和可选状态以签名列为准。
metadata	属性	metadata?: Record<string, unknown>	公开属性；类型、只读和可选状态以签名列为准。
modelContextWindowTokens	属性	modelContextWindowTokens: number	公开属性；类型、只读和可选状态以签名列为准。
operationId	属性	operationId: string	公开属性；类型、只读和可选状态以签名列为准。
previousContextHash	属性	previousContextHash?: string	公开属性；类型、只读和可选状态以签名列为准。
principal	属性	principal: MemoryPrincipal	公开属性；类型、只读和可选状态以签名列为准。
profile	属性	profile: ContextProfileSpec	公开属性；类型、只读和可选状态以签名列为准。
profileRef	属性	profileRef: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。
query	属性	query?: string	公开属性；类型、只读和可选状态以签名列为准。
reservedInstructionTokens	属性	reservedInstructionTokens: number	公开属性；类型、只读和可选状态以签名列为准。
reservedOutputTokens	属性	reservedOutputTokens: number	公开属性；类型、只读和可选状态以签名列为准。
reservedSystemTokens	属性	reservedSystemTokens: number	公开属性；类型、只读和可选状态以签名列为准。
runId	属性	runId: string	公开属性；类型、只读和可选状态以签名列为准。
runtimeStateRef	属性	runtimeStateRef?: string	公开属性；类型、只读和可选状态以签名列为准。
scope	属性	scope: ManagedMemoryScope	公开属性；类型、只读和可选状态以签名列为准。
stateId	属性	stateId?: string	公开属性；类型、只读和可选状态以签名列为准。
stepId	属性	stepId?: string	公开属性；类型、只读和可选状态以签名列为准。
tokenizerRef	属性	tokenizerRef?: MemoryContractSpecRef	公开属性；类型、只读和可选状态以签名列为准。

TokenEstimator

Token Estimator 接口，共包含 2 个公开字段或方法。

• 种类: 接口
• 导入: import type { TokenEstimator } from '@codesoul-co/hypha-memory';
• 源码模块: context-contracts

声明

export interface TokenEstimator {
    readonly id: string;
    estimate(text: string): number;
}

契约成员

成员	种类	签名	说明
estimate	方法	estimate(text: string): number	公开方法；参数与返回类型以签名列为准。
id	属性	readonly id: string	公开属性；类型、只读和可选状态以签名列为准。

ContextSourceType

Context Source Type 公共类型别名；完整类型表达式见声明。

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

声明

export type ContextSourceType = 'system' | 'workflow_state' | 'messages' | 'working_memory' | 'long_term_memory' | 'tool_observation' | 'artifact' | 'human_review' | 'custom';