Skip to main content

TypeSafe Jev

This Integration is part of the TypeSafe Jev Pack.#

Supported versions

Available on Cortex XSOAR (versions 6.10.0 and later) and Cortex XSIAM.

Use TypeSafe Jev typed judgments and calibrated probabilities in Cortex XSIAM and XSOAR playbooks.

Configure TypeSafe Jev in Cortex#

ParameterDescriptionRequired
Server URLTrue
API KeyThe TypeSafe API key used to authenticate Jev requests. Generate or manage keys in the TypeSafe console.True
ModelThe default Jev model. Use a pinned version when playbook thresholds have been validated against that version.False
Model (optional free text override)The optional model name that overrides the selected model.False
Request timeoutThe HTTP request timeout in seconds.True
Trust any certificate (not secure)False
Use system proxy settingsFalse

Commands#

You can execute these commands from the CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

jev-evaluate#


Evaluate a state against one or more typed TypeSafe questions in a single request.

Base Command#

jev-evaluate

Input#

Argument NameDescriptionRequired
stateThe text or JSON state to evaluate. Valid JSON is sent as structured state; other values are sent as text.Required
questionsThe JSON object whose keys are question IDs and whose values are TypeSafe Noul, Choice, or Score question definitions.Required
modelThe optional model override for this request.Optional

Context Output#

PathTypeDescription
TypeSafeJev.Evaluation.modelStringThe versioned model that handled the request.
TypeSafeJev.Evaluation.answersUnknownThe typed answers keyed by the submitted question IDs.
TypeSafeJev.Evaluation.usage.input_tokensNumberThe number of input tokens used by the request.
TypeSafeJev.Evaluation.usage.output_tokensNumberThe number of output tokens reported for the request.

jev-noul#


Evaluate one yes/no judgment and return the probability that the answer is yes.

Base Command#

jev-noul

Input#

Argument NameDescriptionRequired
stateThe text or JSON state to evaluate.Required
instructionsThe narrow yes/no judgment to make about the state.Required
true_criteriaThe optional description of what a yes result means.Optional
false_criteriaThe optional description of what a no result means.Optional
modelThe optional model override for this request.Optional

Context Output#

PathTypeDescription
TypeSafeJev.Noul.modelStringThe versioned model that handled the request.
TypeSafeJev.Noul.probabilityNumberThe probability of yes, from 0 to 1.
TypeSafeJev.Noul.usageUnknownThe token usage for the request.

jev-choice#


Select one option from a defined set and return the complete probability distribution.

Base Command#

jev-choice

Input#

Argument NameDescriptionRequired
stateThe text or JSON state to evaluate.Required
instructionsThe decision Jev should make about the state.Required
criteriaThe JSON object mapping each option name to its description or null. Include a no-match option when appropriate.Required
modelThe optional model override for this request.Optional

Context Output#

PathTypeDescription
TypeSafeJev.Choice.modelStringThe versioned model that handled the request.
TypeSafeJev.Choice.choiceStringThe selected option.
TypeSafeJev.Choice.probabilitiesUnknownThe probability distribution over all supplied options.
TypeSafeJev.Choice.confidenceNumberThe confidence derived from the probability distribution.
TypeSafeJev.Choice.usageUnknownThe token usage for the request.

jev-score#


Score state against ordered levels and return the weighted score and probability distribution.

Base Command#

jev-score

Input#

Argument NameDescriptionRequired
stateThe text or JSON state to evaluate.Required
instructionsThe dimension Jev should score about the state.Required
criteriaThe JSON array of two to ten ordered, standalone level descriptions.Required
modelThe optional model override for this request.Optional

Context Output#

PathTypeDescription
TypeSafeJev.Score.modelStringThe versioned model that handled the request.
TypeSafeJev.Score.scoreNumberThe probability-weighted score across the ordered levels.
TypeSafeJev.Score.legendUnknownThe mapping from numeric level to its description.
TypeSafeJev.Score.probabilitiesUnknownThe probability distribution over the levels.
TypeSafeJev.Score.confidenceNumberThe confidence derived from the probability distribution.
TypeSafeJev.Score.usageUnknownThe token usage for the request.

jev-list-models#


List model aliases available to the configured TypeSafe account.

Base Command#

jev-list-models

Input#

Argument NameDescriptionRequired

Context Output#

PathTypeDescription
TypeSafeJev.Model.nameStringThe model name or alias.
TypeSafeJev.Model.descriptionStringThe model description.
TypeSafeJev.Model.release_dateDateThe model release date.