VocalDocscontracts 1.65.0

AgentPromptRenderRequest

A dry run of the request an Agent version composes for one model request (1.55.0): the platform base it tracks or pins, the Organization layer it receives (the named one's active version, or the default layer's), its Agent layer, then the synthetic directive and context entries.

An object with 10 fields.

Fields

FieldTypeRequiredDescription
callPromptRenderCallInputno
constantsmap of PromptConstantValuenoOrganization constants for this render; those of the Organization layer the render resolves when omitted. display_name is the Organization name.
contextarray of PromptContextEntryInputno
directivestringnoA synthetic directive slot, as rewrite_instruction would set it.
retrievalmap of booleannoWhether each Knowledge binding returned passages for this request, by handle: true renders the first branch of its retrieval slot, false or absent the second.
slotsmap of PromptSlotValuenoSynthetic slot values; an unset slot renders empty or its default().
statestringnoThe active state, the state root.
time_nowRequestTimestampnoThe time.now root; the request instant when omitted.
variablesmap of VariableValuenoSynthetic values of the declared variables. A value of an undeclared name is variable_unknown, of the wrong type variable_type; an optional variable without a value renders empty and is named in missing_values.
variantPromptVariantKeynoThe variant to compose; the model family of the version's primary model when omitted, which is default until the llm descriptors name their model family.

Used by

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