Decision Models

Decision-model registration and typed evaluation.

Methods on this page are called through client.decision_models.

client.decision_models.create

client.decision_models.create(request: CreateDecisionModelRequest, requestOptions?: RequestOptions): Promise<DecisionModelResponseShape>

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.

HTTP: POST /v1/decision-models

Parameters

Returns: Promise<DecisionModelResponseShape>

Example

const model = await client.decisionModels.create({
  displayName: "Doc decision model", providerType: "LAYA",
  endpointUrl: "http://localhost:8000", modelIdentifier: "laya",
  monitoringEndpoint: "http://localhost:8000/health",
});

client.decision_models.decide

client.decision_models.decide(id: string, request: DecisionRequest, requestOptions?: RequestOptions): Promise<DecisionResponseShape>

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.

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

Parameters

Returns: Promise<DecisionResponseShape>

Example

const result = await client.decisionModels.decide(model.decisionModelId, {
  state: { text: "The account has been verified." },
  questions: { verified: {
    instructions: { text: "Is the account verified?" },
    noul: {},
  } },
});
console.log(result.answers.verified.noul?.probabilityTrue);

client.decision_models.delete

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

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.

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

Parameters

Returns: Promise<void>

Example

await client.decisionModels.delete(model.decisionModelId);

client.decision_models.get

client.decision_models.get(id: string, options?: DecisionModelsGetOptions, requestOptions?: RequestOptions): Promise<DecisionModelResponseShape>

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.

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

Parameters

Returns: Promise<DecisionModelResponseShape>

Example

const fetched = await client.decisionModels.get(model.decisionModelId);

client.decision_models.list

client.decision_models.list(options?: DecisionModelsListOptions, requestOptions?: RequestOptions): Promise<ListDecisionModelsResponseShape>

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).

HTTP: GET /v1/decision-models

Parameters

Returns: Promise<ListDecisionModelsResponseShape>

Example

const page = await client.decisionModels.list({ providerType: "LAYA", pageSize: 20 });
console.log(page.totalCount, page.nextPageToken);

client.decision_models.update

client.decision_models.update(id: string, request: UpdateDecisionModelRequest, requestOptions?: RequestOptions): Promise<DecisionModelResponseShape>

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.

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

Parameters

Returns: Promise<DecisionModelResponseShape>

Example

await client.decisionModels.update(model.decisionModelId, { displayName: "Updated decision model" });

Data Models

Enum Values

DecisionModelProviderType

JEV, LAYA, CLEF

Interfaces

CreateDecisionModelRequest

Connection settings for a new decision model.

DecisionAnswer

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

DecisionArray

Ordered decision content elements.

DecisionBoxAnswer

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

DecisionBoxQuestion

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

No fields.

DecisionChoiceAnswer

Selected option and probability distribution.

DecisionChoiceQuestion

Choice options.

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.

DecisionLimit

A known numeric limit.

DecisionMedia

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

DecisionMediaLimit

A known media limit.

DecisionMediaSupport

Media formats, placements and provider constraints.

DecisionModelCapabilities

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

DecisionModelResponse

Connection settings and supported features of a registered decision model.

DecisionNoulAnswer

Probability that the proposition is true.

DecisionNoulQuestion

Optional true and false descriptions.

DecisionObject

Named decision content fields.

DecisionQuestion

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

DecisionQuestionSemantics

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

DecisionRequest

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

DecisionResponse

Structured provider answers with reported usage.

DecisionScoreAnswer

Expected zero-based rubric level; not a percentage.

DecisionScoreQuestion

Ordered rubric levels.

DecisionUsage

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

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.

Response Shapes

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

DecisionLimitResponseShape

DecisionMediaLimitResponseShape

DecisionMediaSupportResponseShape

DecisionModelCapabilitiesResponseShape

DecisionModelResponseShape

DecisionQuestionSemanticsResponseShape

DecisionResponseShape

DecisionUsageResponseShape

ListDecisionModelsResponseShape