Skip to content

Graphorin API reference v0.12.1


Graphorin API reference / @graphorin/memory / / EmbeddingMetaRegistryLike

Interface: EmbeddingMetaRegistryLike

Defined in: packages/memory/src/internal/storage-adapter.ts:292

Optional extension surface for storage adapters' embedder registry. The interface is structural so any adapter that matches the shape works.

Stable

Methods

assertKnown()

ts
assertKnown(id): void;

Defined in: packages/memory/src/internal/storage-adapter.ts:310

Parameters

ParameterType
idstring

Returns

void


get()

ts
get(id): unknown;

Defined in: packages/memory/src/internal/storage-adapter.ts:309

Parameters

ParameterType
idstring

Returns

unknown


listActive()

ts
listActive(): readonly {
  id: string;
  retiredAt: number | null;
}[];

Defined in: packages/memory/src/internal/storage-adapter.ts:313

Returns

readonly { id: string; retiredAt: number | null; }[]


listAll()

ts
listAll(): readonly {
  id: string;
  retiredAt: number | null;
}[];

Defined in: packages/memory/src/internal/storage-adapter.ts:312

Returns

readonly { id: string; retiredAt: number | null; }[]


registerOrReturn()

ts
registerOrReturn(input): {
  id: string;
};

Defined in: packages/memory/src/internal/storage-adapter.ts:293

Parameters

ParameterTypeDescription
input{ configHash: string; dim: number; distanceMetric?: "cosine" | "dot" | "euclidean"; embedderKind: string; id: string; indexMode?: string | null; model: string; notes?: string | null; }-
input.configHashstring-
input.dimnumber-
input.distanceMetric?"cosine" | "dot" | "euclidean"-
input.embedderKindstring-
input.idstring-
input.indexMode?string | nullWrite-path contextualization recipe (item 10 step 1) - joins the index version key so a contextualRetrieval switch invalidates the index like a model change. Optional-additive: registries predating the field ignore it.
input.modelstring-
input.notes?string | null-

Returns

ts
{
  id: string;
}
NameTypeDefined in
idstringpackages/memory/src/internal/storage-adapter.ts:308

retire()

ts
retire(id, retiredAt?): void;

Defined in: packages/memory/src/internal/storage-adapter.ts:311

Parameters

ParameterType
idstring
retiredAt?number

Returns

void