@codesoul-co/hypha-memory / memory-application-service
模块用法
用于使用该功能边界的公共契约与操作。Memory application service 模块公开 1 类、2 接口。
从包入口导入
ts
import {
DefaultMemoryApplicationService,
} from '@codesoul-co/hypha-memory';
import type {
DefaultMemoryApplicationServiceOptions,
MemoryApplicationService,
} from '@codesoul-co/hypha-memory';使用要点
- 2 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用
import type，运行时不应依赖它们。 - 1 个类提供可实例化的运行时实现；构造参数与公开方法在各自条目中完整列出。
公共导出
| Symbol | 种类 | 签名 | 说明 |
|---|---|---|---|
DefaultMemoryApplicationService | 类 | new DefaultMemoryApplicationService(options: DefaultMemoryApplicationServiceOptions): DefaultMemoryApplicationService | Canonical application-facing Memory surface. HTTP, Chat, Workflow and Harness integrations consume this service instead of selecting a Provider or Store. |
DefaultMemoryApplicationServiceOptions | 接口 | interface DefaultMemoryApplicationServiceOptions | Default Memory Application Service Options 接口，共包含 6 个公开字段或方法。 |
MemoryApplicationService | 接口 | interface MemoryApplicationService | Memory Application Service 接口，共包含 12 个公开字段或方法。 |
DefaultMemoryApplicationService
Canonical application-facing Memory surface. HTTP, Chat, Workflow and Harness integrations consume this service instead of selecting a Provider or Store.
- 种类: 类
- 导入:
import { DefaultMemoryApplicationService } from '@codesoul-co/hypha-memory'; - 源码模块:
memory-application-service
声明
text
export declare class DefaultMemoryApplicationService implements MemoryApplicationService {
constructor(options: DefaultMemoryApplicationServiceOptions);
add(request: MemoryAddRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>;
search(request: ManagedMemorySearchRequest, signal?: AbortSignal): Promise<ManagedMemorySearchResult[]>;
get(request: MemoryGetRequest, signal?: AbortSignal): Promise<ManagedMemoryRecord | null>;
list(request: MemoryListRequest, signal?: AbortSignal): Promise<MemoryListResult>;
update(request: ManagedMemoryUpdateRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>;
delete(request: ManagedMemoryDeleteRequest, signal?: AbortSignal): Promise<ManagedMemoryDeleteResult>;
history(request: MemoryHistoryRequest, signal?: AbortSignal): Promise<MemoryVersion[]>;
buildContext(request: ContextBuildInput, signal?: AbortSignal): Promise<ContextEnvelope>;
explainContext(contextHash: string): Promise<ContextBuildExplanation | null>;
providerCapabilities(): Promise<MemoryManagementCapabilities>;
providerHealth(): Promise<ProviderHealth>;
close(): Promise<void>;
}公开成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
add | 方法 | add(request: MemoryAddRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult> | 公开方法；参数与返回类型以签名列为准。 |
buildContext | 方法 | buildContext(request: ContextBuildInput, signal?: AbortSignal): Promise<ContextEnvelope> | 公开方法；参数与返回类型以签名列为准。 |
close | 方法 | close(): Promise<void> | 公开方法；参数与返回类型以签名列为准。 |
constructor | 构造函数 | (options: DefaultMemoryApplicationServiceOptions): DefaultMemoryApplicationService | 创建该类的实例。 |
delete | 方法 | delete(request: ManagedMemoryDeleteRequest, signal?: AbortSignal): Promise<ManagedMemoryDeleteResult> | 公开方法；参数与返回类型以签名列为准。 |
explainContext | 方法 | explainContext(contextHash: string): Promise<ContextBuildExplanation | null> | 公开方法；参数与返回类型以签名列为准。 |
get | 方法 | get(request: MemoryGetRequest, signal?: AbortSignal): Promise<ManagedMemoryRecord | null> | 公开方法；参数与返回类型以签名列为准。 |
history | 方法 | history(request: MemoryHistoryRequest, signal?: AbortSignal): Promise<MemoryVersion[]> | 公开方法；参数与返回类型以签名列为准。 |
list | 方法 | list(request: MemoryListRequest, signal?: AbortSignal): Promise<MemoryListResult> | 公开方法；参数与返回类型以签名列为准。 |
providerCapabilities | 方法 | providerCapabilities(): Promise<MemoryManagementCapabilities> | 公开方法；参数与返回类型以签名列为准。 |
providerHealth | 方法 | providerHealth(): Promise<ProviderHealth> | 公开方法；参数与返回类型以签名列为准。 |
search | 方法 | search(request: ManagedMemorySearchRequest, signal?: AbortSignal): Promise<ManagedMemorySearchResult[]> | 公开方法；参数与返回类型以签名列为准。 |
update | 方法 | update(request: ManagedMemoryUpdateRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult> | 公开方法；参数与返回类型以签名列为准。 |
DefaultMemoryApplicationServiceOptions
Default Memory Application Service Options 接口，共包含 6 个公开字段或方法。
- 种类: 接口
- 导入:
import type { DefaultMemoryApplicationServiceOptions } from '@codesoul-co/hypha-memory'; - 源码模块:
memory-application-service
声明
text
export interface DefaultMemoryApplicationServiceOptions {
manager: GovernedMemoryManager;
activities: MemoryActivityPort;
provider: MemoryManagementProvider;
contextBuilder?: MemoryContextBuilder;
eventContext: MemoryEventContext | ((request: ContextBuildInput) => MemoryEventContext);
contextTimeoutMs?: number;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
activities | 属性 | activities: MemoryActivityPort | 公开属性；类型、只读和可选状态以签名列为准。 |
contextBuilder | 属性 | contextBuilder?: MemoryContextBuilder | 公开属性；类型、只读和可选状态以签名列为准。 |
contextTimeoutMs | 属性 | contextTimeoutMs?: number | 公开属性；类型、只读和可选状态以签名列为准。 |
eventContext | 属性 | eventContext: MemoryEventContext | ((request: ContextBuildInput) => MemoryEventContext) | 公开属性；类型、只读和可选状态以签名列为准。 |
manager | 属性 | manager: GovernedMemoryManager | 公开属性；类型、只读和可选状态以签名列为准。 |
provider | 属性 | provider: MemoryManagementProvider | 公开属性；类型、只读和可选状态以签名列为准。 |
MemoryApplicationService
Memory Application Service 接口，共包含 12 个公开字段或方法。
- 种类: 接口
- 导入:
import type { MemoryApplicationService } from '@codesoul-co/hypha-memory'; - 源码模块:
memory-application-service
声明
text
export interface MemoryApplicationService {
add(request: MemoryAddRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>;
search(request: ManagedMemorySearchRequest, signal?: AbortSignal): Promise<ManagedMemorySearchResult[]>;
get(request: MemoryGetRequest, signal?: AbortSignal): Promise<ManagedMemoryRecord | null>;
list(request: MemoryListRequest, signal?: AbortSignal): Promise<MemoryListResult>;
update(request: ManagedMemoryUpdateRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>;
delete(request: ManagedMemoryDeleteRequest, signal?: AbortSignal): Promise<ManagedMemoryDeleteResult>;
history(request: MemoryHistoryRequest, signal?: AbortSignal): Promise<MemoryVersion[]>;
buildContext(request: ContextBuildInput, signal?: AbortSignal): Promise<ContextEnvelope>;
explainContext(contextHash: string): Promise<ContextBuildExplanation | null>;
providerCapabilities(): Promise<MemoryManagementCapabilities>;
providerHealth(): Promise<ProviderHealth>;
close(): Promise<void>;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
add | 方法 | add(request: MemoryAddRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult> | 公开方法；参数与返回类型以签名列为准。 |
buildContext | 方法 | buildContext(request: ContextBuildInput, signal?: AbortSignal): Promise<ContextEnvelope> | 公开方法；参数与返回类型以签名列为准。 |
close | 方法 | close(): Promise<void> | 公开方法；参数与返回类型以签名列为准。 |
delete | 方法 | delete(request: ManagedMemoryDeleteRequest, signal?: AbortSignal): Promise<ManagedMemoryDeleteResult> | 公开方法；参数与返回类型以签名列为准。 |
explainContext | 方法 | explainContext(contextHash: string): Promise<ContextBuildExplanation | null> | 公开方法；参数与返回类型以签名列为准。 |
get | 方法 | get(request: MemoryGetRequest, signal?: AbortSignal): Promise<ManagedMemoryRecord | null> | 公开方法；参数与返回类型以签名列为准。 |
history | 方法 | history(request: MemoryHistoryRequest, signal?: AbortSignal): Promise<MemoryVersion[]> | 公开方法；参数与返回类型以签名列为准。 |
list | 方法 | list(request: MemoryListRequest, signal?: AbortSignal): Promise<MemoryListResult> | 公开方法；参数与返回类型以签名列为准。 |
providerCapabilities | 方法 | providerCapabilities(): Promise<MemoryManagementCapabilities> | 公开方法；参数与返回类型以签名列为准。 |
providerHealth | 方法 | providerHealth(): Promise<ProviderHealth> | 公开方法；参数与返回类型以签名列为准。 |
search | 方法 | search(request: ManagedMemorySearchRequest, signal?: AbortSignal): Promise<ManagedMemorySearchResult[]> | 公开方法；参数与返回类型以签名列为准。 |
update | 方法 | update(request: ManagedMemoryUpdateRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult> | 公开方法；参数与返回类型以签名列为准。 |