VocalDocscontracts 1.65.0

Experiment

A traffic-split experiment on an Agent (1.55.0, FR-prompts-4): the arms and their shares, the unit, the stop rules and the lifecycle. Vocal reports results with intervals and never declares a winner; a Member promotes or stops it.

An object with 21 fields.

Fields

FieldTypeRequiredDescription
agent_idAgentIdyes
armsarray of ExperimentArmyesThe control first, then the candidates in the order they were named.
created_atTimestampyes
created_byActorRefyes
descriptionstring or nullyesFor reviewers.
goalExperimentGoal or nullnoThe goal the results report per arm (1.63.0): a slot value at Call end or an Outcome field value. Fixed at create. Null for none; absent from an api before 1.63.0, which a reader treats as null.
idExperimentIdyes
namestringyesA display name.
object"experiment"yes
promoted_armExperimentCandidateArmKey or nullyes
started_atTimestamp or nullyes
started_byActorRef or nullyes
statusExperimentStatusyes
stop_reasonExperimentStopReason or nullyes
stop_ruleExperimentStopRule or nullyesSet with stop_rule only.
stop_rulesExperimentStopRulesyes
stopped_atTimestamp or nullyes
stopped_byActorRef or nullyesWho stopped or promoted it; null when a stop rule or a version change did.
suite_idPromptEvalSuiteId or nullyesA suite whose rubric judges a sample of live Calls, only with live_call_judging; refused with capability_not_available and live_call_judging_not_available until the Compliance profile carries it, and from 1.63.0 while the profile has it off.
unitExperimentUnityes
updated_atTimestampyes

Used by

The operations whose parameters, request body or responses name this shape directly.