Skip to content

Graphorin API reference v0.1.0


Graphorin API reference / @graphorin/memory / / EmbeddingMetaRegistryLike

Interface: EmbeddingMetaRegistryLike

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

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:147

Parameters

ParameterType
idstring

Returns

void


get()

ts
get(id): unknown;

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

Parameters

ParameterType
idstring

Returns

unknown


listActive()

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

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

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:149

Returns

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


registerOrReturn()

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

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

Parameters

ParameterType
input{ configHash: string; dim: number; distanceMetric?: "cosine" | "dot" | "euclidean"; embedderKind: string; id: string; model: string; notes?: string | null; }
input.configHashstring
input.dimnumber
input.distanceMetric?"cosine" | "dot" | "euclidean"
input.embedderKindstring
input.idstring
input.modelstring
input.notes?string | null

Returns

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

retire()

ts
retire(id, retiredAt?): void;

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

Parameters

ParameterType
idstring
retiredAt?number

Returns

void