VocalDocscontracts 1.65.0

PromptTemplateVersion

An immutable version of a Prompt template (1.55.0): its frozen variants, declarations and constants, the warnings its publish stored and the codes acknowledged. Agent versions pin Agent-layer versions; Calls record the Organization layer version they resolved.

An object with 20 fields.

Fields

FieldTypeRequiredDescription
acknowledged_warningsarray of PromptLintCodeyesThe warning codes the publisher acknowledges (1.55.0): each warning that needs an acknowledgement (PROMPT_ACKNOWLEDGE_CODES) must be listed, and the Audit event of the publish records the list. A code listed without a finding is kept and has no effect.
activebooleanyesTrue for the active version: the one an Agent publish pins when its prompt names none, or, for an Organization layer, the one dispatch resolves.
allow_termsarray of PromptAllowTermyesStaff and place names that phi_literal does not report (1.55.0), at most 100 of at most 100 characters.
constantsPromptConstantsyes
content_sha256stringyesThe SHA-256 of the canonical variants, declarations and constants, in lowercase hex.
declarationsPromptDeclarationsyes
include_organization_layerbooleanyes
layerPromptLayeryes
lintarray of PromptLintFindingyesThe warnings the publish lint returned (1.55.0); a version holds no error finding, because an error refuses the publish.
max_rendered_tokensintegeryesThe longest render of any variant the declared bounds allow, estimated at 4 characters a token (a target until each model family's tokenizer is measured); checked at publish against the smallest context window of the chain (length_exceeded).
notesstring or nullyes
object"prompt_template_version"yes
prompt_template_idPromptTemplateIdyes
published_atTimestampyes
published_byActorRefyes
purposePromptPurposeyes
source_revisionintegeryesThe draft revision this version was published from.
statusPromptTemplateVersionStatusyes
variantsPromptVariantsyes
versionintegeryesThe snapshot number, from 1.

Used by

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