Embedders

Embedder management.

Methods on this page are called through client.embedders.

client.embedders.create

client.embedders.create(request: EmbeddersCreateRequest, requestOptions?: ProviderApiKeyOptions): Promise<EmbedderResponseShape>

Creates an embedder configuration for use with memory spaces. If ownerId is omitted, the authenticated principal becomes the owner; CREATE_EMBEDDER is evaluated against that proposed embedder and owner. Returns 409 when an equivalent embedder configuration already exists for the owner. See the embedder provider guide for provider-specific configuration.

HTTP: POST /v1/embedders

Parameters

Returns: Promise<EmbedderResponseShape>

Example

const embedder = await client.embedders.create(
  {
    displayName: "Doc Embedder",
    modelIdentifier: "text-embedding-3-small",
    labels: { env: "docs" },
  },
  { apiKey: "sk-..." },
);

client.embedders.delete

client.embedders.delete(id: string, requestOptions?: RequestOptions): Promise<void>

Permanently deletes an embedder configuration. This operation cannot be undone and removes the embedder record and securely deletes stored credentials. IMPORTANT: This does NOT invalidate or delete embeddings previously created with this embedder - existing embeddings remain accessible. CONFLICT: Returns HTTP 409 Conflict if the embedder is still referenced by a space. Requires DELETE_EMBEDDER on the requested embedder.

HTTP: DELETE /v1/embedders/{id}

Parameters

Returns: Promise<void>

Example

await client.embedders.delete("your-embedder-id");

client.embedders.get

client.embedders.get(id: string, options?: EmbeddersGetOptions, requestOptions?: RequestOptions): Promise<EmbedderResponseShape>

Retrieves the details of a specific embedder configuration by its unique identifier. Requires READ_EMBEDDER on the requested embedder. The service distinguishes a missing embedder from an existing embedder the caller cannot read. This is a read-only operation with no side effects.

HTTP: GET /v1/embedders/{id}

Parameters

Returns: Promise<EmbedderResponseShape>

Example

const fetchedEmbedder = await client.embedders.get("your-embedder-id");
console.log(fetchedEmbedder.displayName);

client.embedders.list

client.embedders.list(options?: EmbeddersListOptions, requestOptions?: RequestOptions): Promise<Array<EmbedderResponseShape>>

Retrieves a list of embedder configurations accessible to the caller, with optional filtering. LABEL FILTERS: Label filters accept either label.<key>=<value> or label[key]=value (for example, label.environment=production or label[environment]=production). AUTHORIZATION: Requires LIST_EMBEDDER on the GoodMem instance. Each returned embedder must also be visible through READ_EMBEDDER; unauthorized embedders are filtered in PostgreSQL. The ownerId parameter filters that already-authorized result set and does not grant additional visibility. This is a read-only operation with no side effects.

HTTP: GET /v1/embedders

Parameters

Returns: Promise<Array<EmbedderResponseShape>>

Example

for (const emb of await client.embedders.list()) {
  console.log(emb.embedderId, emb.displayName);
}

client.embedders.update

client.embedders.update(id: string, request: UpdateEmbedderRequest, requestOptions?: RequestOptions): Promise<EmbedderResponseShape>

Updates explicitly supplied embedder fields; at least one mutable field is required. Field omission and reset semantics are defined by the request schema, and providerType cannot be changed. Returns 409 if the resulting configuration duplicates another embedder for the owner, and 412 when model-defining fields are changed while the embedder is in use. Requires UPDATE_EMBEDDER on the requested embedder. See the embedder provider guide for provider-specific configuration.

HTTP: PUT /v1/embedders/{id}

Parameters

Returns: Promise<EmbedderResponseShape>

Example

const updatedEmbedder = await client.embedders.update("your-embedder-id", {
  displayName: "Doc Embedder (updated)",
  mergeLabels: { version: "2" },
});
console.log(updatedEmbedder.embedderId);

Data Models

Enum Values

DistributionType

DENSE, SPARSE

GeminiApiBackend

UNSPECIFIED, DEVELOPER, GOOGLE_CLOUD

Interfaces

EmbedderCreationRequest

Request body for creating a new Embedder. An Embedder represents a configuration for vectorizing content.

EmbedderResponse

Embedder configuration information

GeminiEndpointConfig

Gemini backend routing. DEVELOPER does not use projectId or location; GOOGLE_CLOUD requires projectId and defaults an omitted location to global.

ListEmbeddersResponse

Response containing a list of embedders

UpdateEmbedderRequest

Request body for updating an existing Embedder. Only fields that should be updated need to be included. supportedModalities is creation-time only and cannot be changed here.

Response Shapes

Response shape types model values returned by the SDK after forward-compatible unknown enum strings are coerced to null.

EmbedderResponseShape

GeminiEndpointConfigResponseShape

ListEmbeddersResponseShape