@codesoul-co/hypha-memory / hybrid

• Package index: @codesoul-co/hypha-memory
• Source: packages/memory/src/hybrid.ts
• Exports: 2

Using this module

Use the Hybrid module for using the public contracts and operations for this capability boundary. It exports 1 class, 1 interface.

Import from the package entrypoint

import {
  HybridMemoryProvider,
} from '@codesoul-co/hypha-memory';

import type {
  HybridMemoryProviderOptions,
} from '@codesoul-co/hypha-memory';

Usage patterns

• Use the 1 type/interface export as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
• The module exposes 1 class as constructable runtime implementations. Each symbol entry lists its constructor and public methods.

Public exports

Symbol	Kind	Signature	Description
HybridMemoryProvider	class	new HybridMemoryProvider(options: HybridMemoryProviderOptions): HybridMemoryProvider	Hybrid Memory Provider class with 8 public constructor or member entries; its exact declarations are listed below.
HybridMemoryProviderOptions	interface	interface HybridMemoryProviderOptions	Hybrid Memory Provider Options interface with 5 public fields or methods.

HybridMemoryProvider

Hybrid Memory Provider class with 8 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { HybridMemoryProvider } from '@codesoul-co/hypha-memory';
• Source module: hybrid

Declaration

export declare class HybridMemoryProvider implements MemoryProvider {
    constructor(options: HybridMemoryProviderOptions);
    read(scope: MemoryScope, query: MemoryReadQuery): Promise<MemoryRecord[]>;
    search(scope: MemoryScope, query: MemorySearchQuery): Promise<MemorySearchResult[]>;
    write(scope: MemoryScope, record: MemoryRecord, policy: MemoryWritePolicy): Promise<MemoryWriteResult>;
    update(scope: MemoryScope, recordId: string, patch: Partial<MemoryRecord>): Promise<void>;
    invalidate(scope: MemoryScope, recordId: string, reason: string): Promise<void>;
    summarize(scope: MemoryScope, options?: MemorySummaryOptions): Promise<MemorySummary>;
    audit(scope: MemoryScope, _options?: MemoryAuditOptions): Promise<MemoryAuditReport>;
}

Public members

Member	Kind	Signature	Description
audit	method	audit(scope: MemoryScope, _options?: MemoryAuditOptions): Promise<MemoryAuditReport>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: HybridMemoryProviderOptions): HybridMemoryProvider	Creates an instance of this class.
invalidate	method	invalidate(scope: MemoryScope, recordId: string, reason: string): Promise<void>	Public method; parameters and return type are shown in the signature.
read	method	read(scope: MemoryScope, query: MemoryReadQuery): Promise<MemoryRecord[]>	Public method; parameters and return type are shown in the signature.
search	method	search(scope: MemoryScope, query: MemorySearchQuery): Promise<MemorySearchResult[]>	Public method; parameters and return type are shown in the signature.
summarize	method	summarize(scope: MemoryScope, options?: MemorySummaryOptions): Promise<MemorySummary>	Public method; parameters and return type are shown in the signature.
update	method	update(scope: MemoryScope, recordId: string, patch: Partial<MemoryRecord>): Promise<void>	Public method; parameters and return type are shown in the signature.
write	method	write(scope: MemoryScope, record: MemoryRecord, policy: MemoryWritePolicy): Promise<MemoryWriteResult>	Public method; parameters and return type are shown in the signature.

HybridMemoryProviderOptions

Hybrid Memory Provider Options interface with 5 public fields or methods.

• Kind: interface
• Import: import type { HybridMemoryProviderOptions } from '@codesoul-co/hypha-memory';
• Source module: hybrid

Declaration

export interface HybridMemoryProviderOptions {
    structured: StructuredStoreProvider;
    vector?: VectorIndexProvider;
    artifacts?: ArtifactStoreProvider;
    embeddings?: EmbeddingProvider;
    tableName?: string;
}

Contract members

Member	Kind	Signature	Description
artifacts	property	artifacts?: ArtifactStoreProvider	Public property; its type, readonly modifier and optionality are shown in the signature.
embeddings	property	embeddings?: EmbeddingProvider	Public property; its type, readonly modifier and optionality are shown in the signature.
structured	property	structured: StructuredStoreProvider	Public property; its type, readonly modifier and optionality are shown in the signature.
tableName	property	tableName?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
vector	property	vector?: VectorIndexProvider	Public property; its type, readonly modifier and optionality are shown in the signature.