@codesoul-co/hypha-memory / operations

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

Using this module

Use the Operations module for using the public contracts and operations for this capability boundary. It exports 20 interfaces.

Import from the package entrypoint

import type {
  ManagedMemoryDeleteRequest,
  ManagedMemoryDeleteResult,
  ManagedMemorySearchRequest,
  ManagedMemorySearchResult,
  ManagedMemoryUpdateRequest,
  ManagedMemoryWriteResult,
  MemoryAddRequest,
  MemoryGetRequest,
} from '@codesoul-co/hypha-memory';

// The complete export list is documented below.

Usage patterns

• Use the 20 type/interface exports as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.

Public exports

Symbol	Kind	Signature	Description
ManagedMemoryDeleteRequest	interface	interface ManagedMemoryDeleteRequest	Managed Memory Delete Request interface with 8 public fields or methods.
ManagedMemoryDeleteResult	interface	interface ManagedMemoryDeleteResult	Managed Memory Delete Result interface with 6 public fields or methods.
ManagedMemorySearchRequest	interface	interface ManagedMemorySearchRequest	Managed Memory Search Request interface with 20 public fields or methods.
ManagedMemorySearchResult	interface	interface ManagedMemorySearchResult	Managed Memory Search Result interface with 7 public fields or methods.
ManagedMemoryUpdateRequest	interface	interface ManagedMemoryUpdateRequest	Managed Memory Update Request interface with 8 public fields or methods.
ManagedMemoryWriteResult	interface	interface ManagedMemoryWriteResult	Managed Memory Write Result interface with 7 public fields or methods.
MemoryAddRequest	interface	interface MemoryAddRequest	Memory Add Request interface with 13 public fields or methods.
MemoryGetRequest	interface	interface MemoryGetRequest	Memory Get Request interface with 5 public fields or methods.
MemoryHistoryRequest	interface	interface MemoryHistoryRequest	Memory History Request interface with 5 public fields or methods.
MemoryIndexJobRef	interface	interface MemoryIndexJobRef	Memory Index Job Ref interface with 2 public fields or methods.
MemoryListRequest	interface	interface MemoryListRequest	Memory List Request interface with 5 public fields or methods.
MemoryListResult	interface	interface MemoryListResult extends PaginationResult	Memory List Result interface with 3 public fields or methods.
MemoryManagementProvider	interface	interface MemoryManagementProvider	Memory Management Provider interface with 11 public fields or methods.
MemoryPatch	interface	interface MemoryPatch	Memory Patch interface with 8 public fields or methods.
MemoryRejectedItem	interface	interface MemoryRejectedItem	Memory Rejected Item interface with 3 public fields or methods.
MemorySearchFilter	interface	interface MemorySearchFilter	Memory Search Filter interface with 18 public fields or methods.
MemoryVersion	interface	interface MemoryVersion	Memory Version interface with 4 public fields or methods.
PaginationRequest	interface	interface PaginationRequest	Pagination Request interface with 7 public fields or methods.
PaginationResult	interface	interface PaginationResult	Pagination Result interface with 2 public fields or methods.
ProviderHealth	interface	interface ProviderHealth	Provider Health interface with 5 public fields or methods.

ManagedMemoryDeleteRequest

Managed Memory Delete Request interface with 8 public fields or methods.

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

Declaration

export interface ManagedMemoryDeleteRequest {
    operationId: string;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    memoryIds?: string[];
    filter?: MemorySearchFilter;
    mode: 'soft' | 'hard' | 'compliance';
    reason: string;
    idempotencyKey?: string;
}

Contract members

Member	Kind	Signature	Description
filter	property	filter?: MemorySearchFilter	Public property; its type, readonly modifier and optionality are shown in the signature.
idempotencyKey	property	idempotencyKey?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryIds	property	memoryIds?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
mode	property	mode: "soft" | "hard" | "compliance"	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
principal	property	principal: MemoryPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.
reason	property	reason: string	Public property; its type, readonly modifier and optionality are shown in the signature.
scope	property	scope: ManagedMemoryScope	Public property; its type, readonly modifier and optionality are shown in the signature.

ManagedMemoryDeleteResult

Managed Memory Delete Result interface with 6 public fields or methods.

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

Declaration

export interface ManagedMemoryDeleteResult {
    operationId: string;
    status: 'completed' | 'partial' | 'rejected' | 'failed';
    deletedMemoryIds: string[];
    pendingProviderIds?: string[];
    events?: string[];
    warnings?: string[];
}

Contract members

Member	Kind	Signature	Description
deletedMemoryIds	property	deletedMemoryIds: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
events	property	events?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
pendingProviderIds	property	pendingProviderIds?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
status	property	status: "completed" | "rejected" | "failed" | "partial"	Public property; its type, readonly modifier and optionality are shown in the signature.
warnings	property	warnings?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.

ManagedMemorySearchRequest

Managed Memory Search Request interface with 20 public fields or methods.

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

Declaration

export interface ManagedMemorySearchRequest {
    operationId: string;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    profileRef: MemoryContractSpecRef;
    query?: string;
    queryEmbedding?: number[];
    filters?: MemorySearchFilter;
    memoryTypes?: ManagedMemoryType[];
    mode?: 'structured' | 'semantic' | 'keyword' | 'hybrid' | 'graph';
    topK?: number;
    scoreThreshold?: number;
    includeDormant?: boolean;
    includeSuperseded?: boolean;
    includeContent?: boolean;
    includeProvenance?: boolean;
    includeRelations?: boolean;
    rerank?: boolean;
    updateAccessStats?: boolean;
    pagination?: PaginationRequest;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
filters	property	filters?: MemorySearchFilter	Public property; its type, readonly modifier and optionality are shown in the signature.
includeContent	property	includeContent?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
includeDormant	property	includeDormant?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
includeProvenance	property	includeProvenance?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
includeRelations	property	includeRelations?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
includeSuperseded	property	includeSuperseded?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryTypes	property	memoryTypes?: ManagedMemoryType[]	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
mode	property	mode?: "structured" | "hybrid" | "semantic" | "keyword" | "graph"	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
pagination	property	pagination?: PaginationRequest	Public property; its type, readonly modifier and optionality are shown in the signature.
principal	property	principal: MemoryPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.
profileRef	property	profileRef: MemoryContractSpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
query	property	query?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
queryEmbedding	property	queryEmbedding?: number[]	Public property; its type, readonly modifier and optionality are shown in the signature.
rerank	property	rerank?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
scope	property	scope: ManagedMemoryScope	Public property; its type, readonly modifier and optionality are shown in the signature.
scoreThreshold	property	scoreThreshold?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
topK	property	topK?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
updateAccessStats	property	updateAccessStats?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.

ManagedMemorySearchResult

Managed Memory Search Result interface with 7 public fields or methods.

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

Declaration

export interface ManagedMemorySearchResult {
    record: ManagedMemoryRecord;
    score?: number;
    semanticScore?: number;
    keywordScore?: number;
    graphScore?: number;
    rerankScore?: number;
    reasons?: string[];
}

Contract members

Member	Kind	Signature	Description
graphScore	property	graphScore?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
keywordScore	property	keywordScore?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
reasons	property	reasons?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
record	property	record: ManagedMemoryRecord<unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
rerankScore	property	rerankScore?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
score	property	score?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
semanticScore	property	semanticScore?: number	Public property; its type, readonly modifier and optionality are shown in the signature.

ManagedMemoryUpdateRequest

Managed Memory Update Request interface with 8 public fields or methods.

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

Declaration

export interface ManagedMemoryUpdateRequest {
    operationId: string;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    memoryId: string;
    expectedRevision?: number;
    patch: MemoryPatch;
    reason: string;
    idempotencyKey?: string;
}

Contract members

Member	Kind	Signature	Description
expectedRevision	property	expectedRevision?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
idempotencyKey	property	idempotencyKey?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryId	property	memoryId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
patch	property	patch: MemoryPatch	Public property; its type, readonly modifier and optionality are shown in the signature.
principal	property	principal: MemoryPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.
reason	property	reason: string	Public property; its type, readonly modifier and optionality are shown in the signature.
scope	property	scope: ManagedMemoryScope	Public property; its type, readonly modifier and optionality are shown in the signature.

ManagedMemoryWriteResult

Managed Memory Write Result interface with 7 public fields or methods.

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

Declaration

export interface ManagedMemoryWriteResult {
    operationId: string;
    status: 'committed' | 'queued' | 'reused' | 'rejected' | 'partial' | 'failed';
    records: ManagedMemoryRecord[];
    rejectedItems?: MemoryRejectedItem[];
    indexJobs?: MemoryIndexJobRef[];
    events?: string[];
    warnings?: string[];
}

Contract members

Member	Kind	Signature	Description
events	property	events?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
indexJobs	property	indexJobs?: MemoryIndexJobRef[]	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
records	property	records: ManagedMemoryRecord<unknown>[]	Public property; its type, readonly modifier and optionality are shown in the signature.
rejectedItems	property	rejectedItems?: MemoryRejectedItem[]	Public property; its type, readonly modifier and optionality are shown in the signature.
status	property	status: "rejected" | "queued" | "failed" | "committed" | "reused" | "partial"	Public property; its type, readonly modifier and optionality are shown in the signature.
warnings	property	warnings?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryAddRequest

Memory Add Request interface with 13 public fields or methods.

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

Declaration

export interface MemoryAddRequest {
    operationId: string;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    input: unknown;
    inputType?: 'message' | 'text' | 'structured' | 'artifact_ref' | 'event_ref';
    memoryType?: ManagedMemoryType;
    source: MemorySource;
    extractionMode?: 'none' | 'native' | 'provider' | 'custom';
    writeMode?: 'sync' | 'async';
    idempotencyKey?: string;
    profileRef: MemoryContractSpecRef;
    tags?: string[];
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
extractionMode	property	extractionMode?: "none" | "provider" | "custom" | "native"	Public property; its type, readonly modifier and optionality are shown in the signature.
idempotencyKey	property	idempotencyKey?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
input	property	input: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
inputType	property	inputType?: "structured" | "text" | "message" | "artifact_ref" | "event_ref"	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryType	property	memoryType?: ManagedMemoryType	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
principal	property	principal: MemoryPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.
profileRef	property	profileRef: MemoryContractSpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
scope	property	scope: ManagedMemoryScope	Public property; its type, readonly modifier and optionality are shown in the signature.
source	property	source: MemorySource	Public property; its type, readonly modifier and optionality are shown in the signature.
tags	property	tags?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
writeMode	property	writeMode?: "sync" | "async"	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryGetRequest

Memory Get Request interface with 5 public fields or methods.

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

Declaration

export interface MemoryGetRequest {
    operationId: string;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    memoryId: string;
    includeHistory?: boolean;
}

Contract members

Member	Kind	Signature	Description
includeHistory	property	includeHistory?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
memoryId	property	memoryId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
principal	property	principal: MemoryPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.
scope	property	scope: ManagedMemoryScope	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryHistoryRequest

Memory History Request interface with 5 public fields or methods.

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

Declaration

export interface MemoryHistoryRequest {
    operationId: string;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    memoryId: string;
    pagination?: PaginationRequest;
}

Contract members

Member	Kind	Signature	Description
memoryId	property	memoryId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
pagination	property	pagination?: PaginationRequest	Public property; its type, readonly modifier and optionality are shown in the signature.
principal	property	principal: MemoryPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.
scope	property	scope: ManagedMemoryScope	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryIndexJobRef

Memory Index Job Ref interface with 2 public fields or methods.

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

Declaration

export interface MemoryIndexJobRef {
    id: string;
    state: 'pending' | 'processing' | 'completed' | 'partial' | 'failed';
}

Contract members

Member	Kind	Signature	Description
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
state	property	state: "completed" | "failed" | "processing" | "pending" | "partial"	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryListRequest

Memory List Request interface with 5 public fields or methods.

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

Declaration

export interface MemoryListRequest {
    operationId: string;
    principal: MemoryPrincipal;
    scope: ManagedMemoryScope;
    filter?: MemorySearchFilter;
    pagination?: PaginationRequest;
}

Contract members

Member	Kind	Signature	Description
filter	property	filter?: MemorySearchFilter	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
pagination	property	pagination?: PaginationRequest	Public property; its type, readonly modifier and optionality are shown in the signature.
principal	property	principal: MemoryPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.
scope	property	scope: ManagedMemoryScope	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryListResult

Memory List Result interface with 3 public fields or methods.

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

Declaration

export interface MemoryListResult extends PaginationResult {
    records: ManagedMemoryRecord[];
}

Contract members

Member	Kind	Signature	Description
hasMore	property	hasMore: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
nextCursor	property	nextCursor?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
records	property	records: ManagedMemoryRecord<unknown>[]	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryManagementProvider

Memory Management Provider interface with 11 public fields or methods.

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

Declaration

export interface MemoryManagementProvider {
    readonly id: string;
    capabilities(): Promise<import('./contracts').MemoryManagementCapabilities>;
    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[]>;
    health(): Promise<ProviderHealth>;
    close?(): Promise<void>;
}

Contract members

Member	Kind	Signature	Description
add	method	add(request: MemoryAddRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>	Public method; parameters and return type are shown in the signature.
capabilities	method	capabilities(): Promise<import("./contracts").MemoryManagementCapabilities>	Public method; parameters and return type are shown in the signature.
close	method	close?(): Promise<void>	Public method; parameters and return type are shown in the signature.
delete	method	delete(request: ManagedMemoryDeleteRequest, signal?: AbortSignal): Promise<ManagedMemoryDeleteResult>	Public method; parameters and return type are shown in the signature.
get	method	get(request: MemoryGetRequest, signal?: AbortSignal): Promise<ManagedMemoryRecord | null>	Public method; parameters and return type are shown in the signature.
health	method	health(): Promise<ProviderHealth>	Public method; parameters and return type are shown in the signature.
history	method	history?(request: MemoryHistoryRequest, signal?: AbortSignal): Promise<MemoryVersion[]>	Public method; parameters and return type are shown in the signature.
id	property	readonly id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
list	method	list(request: MemoryListRequest, signal?: AbortSignal): Promise<MemoryListResult>	Public method; parameters and return type are shown in the signature.
search	method	search(request: ManagedMemorySearchRequest, signal?: AbortSignal): Promise<ManagedMemorySearchResult[]>	Public method; parameters and return type are shown in the signature.
update	method	update(request: ManagedMemoryUpdateRequest, signal?: AbortSignal): Promise<ManagedMemoryWriteResult>	Public method; parameters and return type are shown in the signature.

MemoryPatch

Memory Patch interface with 8 public fields or methods.

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

Declaration

export interface MemoryPatch {
    content?: unknown;
    canonicalText?: string;
    summary?: string;
    confidence?: number;
    importance?: number;
    tags?: string[];
    status?: Exclude<MemoryStatus, 'deleted'>;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
canonicalText	property	canonicalText?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
confidence	property	confidence?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
content	property	content?: unknown	Public property; its type, readonly modifier and optionality are shown in the signature.
importance	property	importance?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
status	property	status?: "failed" | "invalidated" | "deletion_pending" | "active" | "pending" | "superseded" | "dormant"	Public property; its type, readonly modifier and optionality are shown in the signature.
summary	property	summary?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
tags	property	tags?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryRejectedItem

Memory Rejected Item interface with 3 public fields or methods.

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

Declaration

export interface MemoryRejectedItem {
    itemId?: string;
    reason: string;
    error?: NormalizedMemoryError;
}

Contract members

Member	Kind	Signature	Description
error	property	error?: NormalizedMemoryError	Public property; its type, readonly modifier and optionality are shown in the signature.
itemId	property	itemId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
reason	property	reason: string	Public property; its type, readonly modifier and optionality are shown in the signature.

MemorySearchFilter

Memory Search Filter interface with 18 public fields or methods.

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

Declaration

export interface MemorySearchFilter {
    ids?: string[];
    excludeIds?: string[];
    statuses?: MemoryStatus[];
    tagsAny?: string[];
    tagsAll?: string[];
    createdAfter?: string;
    createdBefore?: string;
    updatedAfter?: string;
    expiresAfter?: string;
    confidenceGte?: number;
    importanceGte?: number;
    sourceTypes?: MemorySource['type'][];
    entityIds?: string[];
    visibility?: ManagedMemoryRecord['visibility'][];
    verifiedOnly?: boolean;
    conflictFreeOnly?: boolean;
    canonicalKeys?: string[];
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
canonicalKeys	property	canonicalKeys?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
confidenceGte	property	confidenceGte?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
conflictFreeOnly	property	conflictFreeOnly?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
createdAfter	property	createdAfter?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
createdBefore	property	createdBefore?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
entityIds	property	entityIds?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
excludeIds	property	excludeIds?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
expiresAfter	property	expiresAfter?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
ids	property	ids?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
importanceGte	property	importanceGte?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
sourceTypes	property	sourceTypes?: ("human_review" | "artifact" | "system" | "derived" | "user_message" | "assistant_message" | "tool_result" | "workflow_state" | "import")[]	Public property; its type, readonly modifier and optionality are shown in the signature.
statuses	property	statuses?: MemoryStatus[]	Public property; its type, readonly modifier and optionality are shown in the signature.
tagsAll	property	tagsAll?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
tagsAny	property	tagsAny?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
updatedAfter	property	updatedAfter?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
verifiedOnly	property	verifiedOnly?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
visibility	property	visibility?: ("workspace" | "session" | "private" | "shared" | "tenant")[]	Public property; its type, readonly modifier and optionality are shown in the signature.

MemoryVersion

Memory Version interface with 4 public fields or methods.

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

Declaration

export interface MemoryVersion {
    memoryId: string;
    versionId: string;
    revision: number;
    record: ManagedMemoryRecord;
}

Contract members

Member	Kind	Signature	Description
memoryId	property	memoryId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
record	property	record: ManagedMemoryRecord<unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
revision	property	revision: number	Public property; its type, readonly modifier and optionality are shown in the signature.
versionId	property	versionId: string	Public property; its type, readonly modifier and optionality are shown in the signature.

PaginationRequest

Pagination Request interface with 7 public fields or methods.

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

Declaration

export interface PaginationRequest {
    cursor?: string;
    limit?: number;
    maxPages?: number;
    maxItems?: number;
    maxBytes?: number;
    maxDurationMs?: number;
    maxCalls?: number;
}

Contract members

Member	Kind	Signature	Description
cursor	property	cursor?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
limit	property	limit?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxBytes	property	maxBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxCalls	property	maxCalls?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxDurationMs	property	maxDurationMs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxItems	property	maxItems?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxPages	property	maxPages?: number	Public property; its type, readonly modifier and optionality are shown in the signature.

PaginationResult

Pagination Result interface with 2 public fields or methods.

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

Declaration

export interface PaginationResult {
    nextCursor?: string;
    hasMore: boolean;
}

Contract members

Member	Kind	Signature	Description
hasMore	property	hasMore: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
nextCursor	property	nextCursor?: string	Public property; its type, readonly modifier and optionality are shown in the signature.

ProviderHealth

Provider Health interface with 5 public fields or methods.

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

Declaration

export interface ProviderHealth {
    status: 'healthy' | 'degraded' | 'unhealthy' | 'unknown';
    checkedAt: string;
    latencyMs?: number;
    message?: string;
    details?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
checkedAt	property	checkedAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
details	property	details?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
latencyMs	property	latencyMs?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
message	property	message?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
status	property	status: "healthy" | "degraded" | "unhealthy" | "unknown"	Public property; its type, readonly modifier and optionality are shown in the signature.