Embedders

Embedder management — provider configuration + lifecycle.

Namespace: Goodmem.Client.Api · Class: EmbeddersApi

Reach this surface as client.Embedders on a GoodmemClient. Every network method is asynchronous — it returns a Task<T> (or an IAsyncEnumerable<T> for pagination and streaming) and accepts a CancellationToken; the Async suffix marks the standard .NET Task-based async pattern.

Methods

CreateAsync

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.

Declaration

public Task<EmbedderResponse> CreateAsync(EmbedderCreationRequest request, string? apiKey = null, CancellationToken ct = default)

HTTP — POST /v1/embedders

Parameters

Returns

Task<EmbedderResponse> — an awaitable that resolves to EmbedderResponse.

Exceptions

Example

var embedder = await client.Embedders.CreateAsync(
    new EmbedderCreationRequest
    {
        DisplayName = "Doc Embedder",
        ModelIdentifier = "text-embedding-3-small",
        Labels = new Dictionary<string, string> { ["env"] = "docs" },
    },
    "sk-..."
);
Console.WriteLine(embedder.EmbedderId);

GetAsync

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.

Declaration

public Task<EmbedderResponse> GetAsync(string id, EmbeddersGetOptions? options = null, CancellationToken ct = default)

HTTP — GET /v1/embedders/{id}

Parameters

Returns

Task<EmbedderResponse> — an awaitable that resolves to EmbedderResponse.

Exceptions

Example

var embedder = await client.Embedders.GetAsync("your-embedder-id");
Console.WriteLine(embedder.DisplayName);

ListAsync

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.

Declaration

public Task<ListEmbeddersResponse> ListAsync(EmbeddersListOptions? options = null, CancellationToken ct = default)

HTTP — GET /v1/embedders

Parameters

Returns

Task<ListEmbeddersResponse> — an awaitable that resolves to ListEmbeddersResponse.

Exceptions

Example

var resp = await client.Embedders.ListAsync();
foreach (var embedder in resp.Embedders)
    Console.WriteLine($"{embedder.EmbedderId} {embedder.DisplayName}");

UpdateAsync

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.

Declaration

public Task<EmbedderResponse> UpdateAsync(string id, UpdateEmbedderRequest request, CancellationToken ct = default)

HTTP — PUT /v1/embedders/{id}

Parameters

Returns

Task<EmbedderResponse> — an awaitable that resolves to EmbedderResponse.

Exceptions

Example

var updated = await client.Embedders.UpdateAsync(
    "your-embedder-id",
    new UpdateEmbedderRequest
    {
        DisplayName = "Doc Embedder (updated)",
        MergeLabels = new Dictionary<string, string> { ["version"] = "2" },
    }
);
Console.WriteLine(updated.EmbedderId);

DeleteAsync

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.

Declaration

public Task DeleteAsync(string id, CancellationToken ct = default)

HTTP — DELETE /v1/embedders/{id}

Parameters

Returns

Task — completes when the operation finishes; there is no response body.

Exceptions

Example

await client.Embedders.DeleteAsync("your-embedder-id");

Data Models

Types in the Goodmem.Client.Models namespace. Each row lists the C# property, its type, the JSON wire name, and a description.

EmbedderCreationRequest

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

DistributionType

Type of embedding distribution produced by the embedder

String enum: "DENSE" · "SPARSE"

GeminiEndpointConfig

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

GeminiApiBackend

Google API surface used by a Gemini embedder

String enum: "UNSPECIFIED" · "DEVELOPER" · "GOOGLE_CLOUD"

EmbedderResponse

Embedder configuration information

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.