Decision Models

Decision-model registration and typed evaluation.

Namespace: Goodmem.Client.Api · Class: DecisionModelsApi

Reach this surface as client.DecisionModels 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

Saves the connection settings for a decision model. Requires CREATE_DECISION_MODEL for the new model and its owner. You can register the same provider connection more than once, but each registration must have a unique UUID. Credentials are omitted from the response.

Declaration

public Task<DecisionModelResponse> CreateAsync(CreateDecisionModelRequest request, CancellationToken ct = default)

HTTP — POST /v1/decision-models

Parameters

Returns

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

Exceptions

Example

var model = await client.DecisionModels.CreateAsync(new CreateDecisionModelRequest {
    DisplayName = "Doc decision model", ProviderType = DecisionModelProviderType.Laya,
    EndpointUrl = "http://localhost:8000", ModelIdentifier = "laya",
    MonitoringEndpoint = "http://localhost:8000/health",
});

GetAsync

Returns the connection settings and supported features of a decision model. Requires READ_DECISION_MODEL. Set includeCredentials=true to include stored credentials; this also requires READ_DECISION_MODEL_CREDENTIALS. Returns 404 if the model does not exist, or 403 if it exists but you lack permission.

Declaration

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

HTTP — GET /v1/decision-models/{id}

Parameters

Returns

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

Exceptions

Example

var fetched = await client.DecisionModels.GetAsync("your-decision-model-id");

ListAsync

Lists decision models that you have permission to read. Requires LIST_DECISION_MODEL for the instance and READ_DECISION_MODEL for each returned model. Results are ordered by creation time, newest first, with UUID descending to break ties. Credentials are omitted.

LABEL FILTERS: Label filters accept either label.<key>=<value> or label[key]=value (for example, label.environment=production or label[environment]=production).

Declaration

public Task<ListDecisionModelsResponse> ListAsync(DecisionModelsListOptions? options = null, CancellationToken ct = default)

HTTP — GET /v1/decision-models

Parameters

Returns

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

Exceptions

Example

var page = await client.DecisionModels.ListAsync(new() { ProviderType = DecisionModelProviderType.Laya, PageSize = 20 });
Console.WriteLine($"{page.TotalCount} {page.NextPageToken}");

UpdateAsync

Changes only the fields supplied in the request. Requires UPDATE_DECISION_MODEL. Send an empty string to clear description, version, or monitoringEndpoint. A supplied configuration replaces all existing settings; use {} to reset them to defaults. The provider and owner cannot be changed. Credentials are omitted from the response.

Declaration

public Task<DecisionModelResponse> UpdateAsync(string id, UpdateDecisionModelRequest request, CancellationToken ct = default)

HTTP — PUT /v1/decision-models/{id}

Parameters

Returns

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

Exceptions

Example

await client.DecisionModels.UpdateAsync("your-decision-model-id", new() { DisplayName = "Updated decision model" });

DeleteAsync

Removes the decision model from GoodMem. Requires DELETE_DECISION_MODEL. This does not contact or delete the model at the provider. Returns 404 if the registration has already been deleted.

Declaration

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

HTTP — DELETE /v1/decision-models/{id}

Parameters

Returns

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

Exceptions

Example

await client.DecisionModels.DeleteAsync("your-decision-model-id");

DecideAsync

Sends the supplied questions and content to the registered provider. Requires READ_DECISION_MODEL and EXECUTE_DECISION_MODEL. Each request calls the provider once and may incur charges, so do not retry automatically. GoodMem does not store the input or answers. Unsupported questions or media return 400. Problems with the stored provider credentials or settings return 412.

Declaration

public Task<DecisionResponse> DecideAsync(string id, DecisionRequest request, CancellationToken ct = default)

HTTP — POST /v1/decision-models/{id}/decide

Parameters

Returns

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

Exceptions

Example

var result = await client.DecisionModels.DecideAsync("your-evaluation-model-id", new() {
    State = DecisionContent.OfText("The account has been verified."),
    Questions = new Dictionary<string, DecisionQuestion> {
        ["verified"] = new() {
            Instructions = DecisionContent.OfText("Is the account verified?"),
            Noul = new(),
        },
    },
});
Console.WriteLine(result.Answers["verified"].Noul!.ProbabilityTrue);

Data Models

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

CreateDecisionModelRequest

Connection settings for a new decision model.

DecisionModelProviderType

Decision-model provider protocol.

String enum: "JEV" · "LAYA" · "CLEF"

DecisionModelResponse

Connection settings and supported features of a registered decision model.

DecisionModelCapabilities

Supported features and known limits for this provider and model. An omitted limit is unknown; it does not mean unlimited.

DecisionMediaSupport

Media formats, placements and provider constraints.

DecisionLimit

A known numeric limit.

DecisionQuestionSemantics

Meaning of the answer and confidence value for one question type.

DecisionMediaLimit

A known media limit.

DecisionRequest

Sends named questions and content to a registered decision model. The provider may charge for this request.

DecisionContent

Set exactly one of text, jsonValue, objectValue, arrayValue, or media. Use text for ordinary text. Use jsonValue to preserve a complete JSON value, including the exact precision of its numbers.

DecisionMedia

Media file included in the request. The provider and model determine which formats and sizes are supported.

DecisionQuestion

Set exactly one of choice, score, noul, or box. Clef requires instructions for every question.

DecisionObject

Named decision content fields.

DecisionArray

Ordered decision content elements.

DecisionChoiceQuestion

Choice options.

DecisionScoreQuestion

Ordered rubric levels.

DecisionNoulQuestion

Optional true and false descriptions.

DecisionBoxQuestion

Locate an object in an image. Use instructions to describe the object.

(no fields)

DecisionResponse

Structured provider answers with reported usage.

DecisionAnswer

Answer to one question. Exactly one of choice, score, noul, or box is present.

DecisionUsage

Token usage reported by the provider. Counts are omitted when unknown.

DecisionChoiceAnswer

Selected option and probability distribution.

DecisionScoreAnswer

Expected zero-based rubric level; not a percentage.

DecisionNoulAnswer

Probability that the proposition is true.

DecisionBoxAnswer

Rectangle with coordinates expressed as fractions of the image width or height. A returned box does not guarantee that the object is present.

ListDecisionModelsResponse

One page of decision models that you have permission to read.

UpdateDecisionModelRequest

Changes only the supplied fields. Omitted fields keep their current values. A supplied configuration replaces all existing provider settings.