VocalDocscontracts 1.65.0

PromptEvalScenario

A scenario of an evaluation suite (1.55.0): a simulated caller with a rubric, or a scripted conversation test with expectations, with synthetic variables and Tool mocks.

An object with 16 fields.

Fields

FieldTypeRequiredDescription
callerPromptEvalCaller or nullyesThe caller, the content class text: null unless the read names include=text, and null in the answer of a write.
created_atTimestampyes
expectationsarray of ConversationTestExpectationyesThe expectations of a scripted scenario; empty otherwise.
idPromptEvalScenarioIdyes
initial_slotsPromptEvalInitialSlotsnoThe starting slot values (1.63.0); absent from an api before 1.63.0, which a reader treats as none.
kindPromptEvalScenarioKindyes
max_turnsintegeryesThe most Turns a Call of the scenario takes before it is ended.
namestringyesA display name.
object"prompt_eval_scenario"yes
revisionintegeryesCounts writes; returned as the ETag and required in If-Match.
rubricarray of PromptEvalRubricItemyesThe rubric of a simulated scenario; empty otherwise.
suite_idPromptEvalSuiteIdyes
tagsarray of PromptEvalTagyes
tool_mocksarray of PromptEvalToolMockyes
updated_atTimestampyes
variablesPromptEvalVariablesyes

Used by

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