PromptPack Specification
- 1. Property
PromptPack Specification > $schema - 2. Property
PromptPack Specification > id - 3. Property
PromptPack Specification > name - 4. Property
PromptPack Specification > version - 5. Property
PromptPack Specification > description - 6. Property
PromptPack Specification > template_engine - 7. Property
PromptPack Specification > prompts- 7.1. Property
PromptPack Specification > prompts > Prompt- 7.1.1. Property
PromptPack Specification > prompts > additionalProperties > id - 7.1.2. Property
PromptPack Specification > prompts > additionalProperties > name - 7.1.3. Property
PromptPack Specification > prompts > additionalProperties > description - 7.1.4. Property
PromptPack Specification > prompts > additionalProperties > version - 7.1.5. Property
PromptPack Specification > prompts > additionalProperties > system_template - 7.1.6. Property
PromptPack Specification > prompts > additionalProperties > variables- 7.1.6.1. PromptPack Specification > prompts > additionalProperties > variables > Variable
- 7.1.6.1.1. Property
PromptPack Specification > prompts > additionalProperties > variables > variables items > name - 7.1.6.1.2. Property
PromptPack Specification > prompts > additionalProperties > variables > variables items > type - 7.1.6.1.3. Property
PromptPack Specification > prompts > additionalProperties > variables > variables items > required - 7.1.6.1.4. Property
PromptPack Specification > prompts > additionalProperties > variables > variables items > default - 7.1.6.1.5. Property
PromptPack Specification > prompts > additionalProperties > variables > variables items > description - 7.1.6.1.6. Property
PromptPack Specification > prompts > additionalProperties > variables > variables items > example - 7.1.6.1.7. Property
PromptPack Specification > prompts > additionalProperties > variables > variables items > validation- 7.1.6.1.7.1. Property
PromptPack Specification > prompts > additionalProperties > variables > variables items > validation > pattern - 7.1.6.1.7.2. Property
PromptPack Specification > prompts > additionalProperties > variables > variables items > validation > min_length - 7.1.6.1.7.3. Property
PromptPack Specification > prompts > additionalProperties > variables > variables items > validation > max_length - 7.1.6.1.7.4. Property
PromptPack Specification > prompts > additionalProperties > variables > variables items > validation > minimum - 7.1.6.1.7.5. Property
PromptPack Specification > prompts > additionalProperties > variables > variables items > validation > maximum - 7.1.6.1.7.6. Property
PromptPack Specification > prompts > additionalProperties > variables > variables items > validation > enum
- 7.1.6.1.7.1. Property
- 7.1.6.1.1. Property
- 7.1.6.1. PromptPack Specification > prompts > additionalProperties > variables > Variable
- 7.1.7. Property
PromptPack Specification > prompts > additionalProperties > tools - 7.1.8. Property
PromptPack Specification > prompts > additionalProperties > tool_policy- 7.1.8.1. Property
PromptPack Specification > prompts > additionalProperties > tool_policy > tool_choice - 7.1.8.2. Property
PromptPack Specification > prompts > additionalProperties > tool_policy > max_rounds - 7.1.8.3. Property
PromptPack Specification > prompts > additionalProperties > tool_policy > max_tool_calls_per_turn - 7.1.8.4. Property
PromptPack Specification > prompts > additionalProperties > tool_policy > blocklist
- 7.1.8.1. Property
- 7.1.9. Property
PromptPack Specification > prompts > additionalProperties > pipeline- 7.1.9.1. Property
PromptPack Specification > prompts > additionalProperties > pipeline > stages - 7.1.9.2. Property
PromptPack Specification > prompts > additionalProperties > pipeline > middleware
- 7.1.9.1. Property
- 7.1.10. Property
PromptPack Specification > prompts > additionalProperties > parameters- 7.1.10.1. Property
PromptPack Specification > prompts > additionalProperties > parameters > temperature - 7.1.10.2. Property
PromptPack Specification > prompts > additionalProperties > parameters > max_tokens - 7.1.10.3. Property
PromptPack Specification > prompts > additionalProperties > parameters > top_p - 7.1.10.4. Property
PromptPack Specification > prompts > additionalProperties > parameters > top_k - 7.1.10.5. Property
PromptPack Specification > prompts > additionalProperties > parameters > frequency_penalty - 7.1.10.6. Property
PromptPack Specification > prompts > additionalProperties > parameters > presence_penalty
- 7.1.10.1. Property
- 7.1.11. Property
PromptPack Specification > prompts > additionalProperties > validators- 7.1.11.1. PromptPack Specification > prompts > additionalProperties > validators > Validator
- 7.1.11.1.1. Property
PromptPack Specification > prompts > additionalProperties > validators > validators items > type - 7.1.11.1.2. Property
PromptPack Specification > prompts > additionalProperties > validators > validators items > enabled - 7.1.11.1.3. Property
PromptPack Specification > prompts > additionalProperties > validators > validators items > fail_on_violation - 7.1.11.1.4. Property
PromptPack Specification > prompts > additionalProperties > validators > validators items > params
- 7.1.11.1.1. Property
- 7.1.11.1. PromptPack Specification > prompts > additionalProperties > validators > Validator
- 7.1.12. Property
PromptPack Specification > prompts > additionalProperties > tested_models- 7.1.12.1. PromptPack Specification > prompts > additionalProperties > tested_models > TestedModel
- 7.1.12.1.1. Property
PromptPack Specification > prompts > additionalProperties > tested_models > tested_models items > provider - 7.1.12.1.2. Property
PromptPack Specification > prompts > additionalProperties > tested_models > tested_models items > model - 7.1.12.1.3. Property
PromptPack Specification > prompts > additionalProperties > tested_models > tested_models items > date - 7.1.12.1.4. Property
PromptPack Specification > prompts > additionalProperties > tested_models > tested_models items > success_rate - 7.1.12.1.5. Property
PromptPack Specification > prompts > additionalProperties > tested_models > tested_models items > avg_tokens - 7.1.12.1.6. Property
PromptPack Specification > prompts > additionalProperties > tested_models > tested_models items > avg_cost - 7.1.12.1.7. Property
PromptPack Specification > prompts > additionalProperties > tested_models > tested_models items > avg_latency_ms - 7.1.12.1.8. Property
PromptPack Specification > prompts > additionalProperties > tested_models > tested_models items > notes
- 7.1.12.1.1. Property
- 7.1.12.1. PromptPack Specification > prompts > additionalProperties > tested_models > TestedModel
- 7.1.13. Property
PromptPack Specification > prompts > additionalProperties > model_overrides- 7.1.13.1. Property
PromptPack Specification > prompts > additionalProperties > model_overrides > ModelOverride- 7.1.13.1.1. Property
PromptPack Specification > prompts > additionalProperties > model_overrides > additionalProperties > system_template_prefix - 7.1.13.1.2. Property
PromptPack Specification > prompts > additionalProperties > model_overrides > additionalProperties > system_template_suffix - 7.1.13.1.3. Property
PromptPack Specification > prompts > additionalProperties > model_overrides > additionalProperties > system_template - 7.1.13.1.4. Property
PromptPack Specification > prompts > additionalProperties > model_overrides > additionalProperties > parameters
- 7.1.13.1.1. Property
- 7.1.13.1. Property
- 7.1.14. Property
PromptPack Specification > prompts > additionalProperties > media- 7.1.14.1. Property
PromptPack Specification > prompts > additionalProperties > media > enabled - 7.1.14.2. Property
PromptPack Specification > prompts > additionalProperties > media > supported_types - 7.1.14.3. Property
PromptPack Specification > prompts > additionalProperties > media > image- 7.1.14.3.1. Property
PromptPack Specification > prompts > additionalProperties > media > image > max_size_mb - 7.1.14.3.2. Property
PromptPack Specification > prompts > additionalProperties > media > image > allowed_formats - 7.1.14.3.3. Property
PromptPack Specification > prompts > additionalProperties > media > image > default_detail - 7.1.14.3.4. Property
PromptPack Specification > prompts > additionalProperties > media > image > require_caption - 7.1.14.3.5. Property
PromptPack Specification > prompts > additionalProperties > media > image > max_images_per_msg
- 7.1.14.3.1. Property
- 7.1.14.4. Property
PromptPack Specification > prompts > additionalProperties > media > audio- 7.1.14.4.1. Property
PromptPack Specification > prompts > additionalProperties > media > audio > max_size_mb - 7.1.14.4.2. Property
PromptPack Specification > prompts > additionalProperties > media > audio > allowed_formats - 7.1.14.4.3. Property
PromptPack Specification > prompts > additionalProperties > media > audio > max_duration_sec - 7.1.14.4.4. Property
PromptPack Specification > prompts > additionalProperties > media > audio > require_metadata
- 7.1.14.4.1. Property
- 7.1.14.5. Property
PromptPack Specification > prompts > additionalProperties > media > video- 7.1.14.5.1. Property
PromptPack Specification > prompts > additionalProperties > media > video > max_size_mb - 7.1.14.5.2. Property
PromptPack Specification > prompts > additionalProperties > media > video > allowed_formats - 7.1.14.5.3. Property
PromptPack Specification > prompts > additionalProperties > media > video > max_duration_sec - 7.1.14.5.4. Property
PromptPack Specification > prompts > additionalProperties > media > video > require_metadata
- 7.1.14.5.1. Property
- 7.1.14.6. Property
PromptPack Specification > prompts > additionalProperties > media > document- 7.1.14.6.1. Property
PromptPack Specification > prompts > additionalProperties > media > document > max_size_mb - 7.1.14.6.2. Property
PromptPack Specification > prompts > additionalProperties > media > document > allowed_formats - 7.1.14.6.3. Property
PromptPack Specification > prompts > additionalProperties > media > document > max_pages - 7.1.14.6.4. Property
PromptPack Specification > prompts > additionalProperties > media > document > require_metadata - 7.1.14.6.5. Property
PromptPack Specification > prompts > additionalProperties > media > document > extraction_mode
- 7.1.14.6.1. Property
- 7.1.14.7. Property
PromptPack Specification > prompts > additionalProperties > media > examples- 7.1.14.7.1. PromptPack Specification > prompts > additionalProperties > media > examples > MultimodalExample
- 7.1.14.7.1.1. Property
PromptPack Specification > prompts > additionalProperties > media > examples > examples items > name - 7.1.14.7.1.2. Property
PromptPack Specification > prompts > additionalProperties > media > examples > examples items > description - 7.1.14.7.1.3. Property
PromptPack Specification > prompts > additionalProperties > media > examples > examples items > role - 7.1.14.7.1.4. Property
PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts- 7.1.14.7.1.4.1. PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > ContentPart
- 7.1.14.7.1.4.1.1. Property
PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > parts items > type - 7.1.14.7.1.4.1.2. Property
PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > parts items > text - 7.1.14.7.1.4.1.3. Property
PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > parts items > media- 7.1.14.7.1.4.1.3.1. Property
PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > parts items > media > file_path - 7.1.14.7.1.4.1.3.2. Property
PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > parts items > media > url - 7.1.14.7.1.4.1.3.3. Property
PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > parts items > media > base64 - 7.1.14.7.1.4.1.3.4. Property
PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > parts items > media > mime_type - 7.1.14.7.1.4.1.3.5. Property
PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > parts items > media > detail - 7.1.14.7.1.4.1.3.6. Property
PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > parts items > media > caption
- 7.1.14.7.1.4.1.3.1. Property
- 7.1.14.7.1.4.1.1. Property
- 7.1.14.7.1.4.1. PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > ContentPart
- 7.1.14.7.1.1. Property
- 7.1.14.7.1. PromptPack Specification > prompts > additionalProperties > media > examples > MultimodalExample
- 7.1.14.8. Pattern Property
PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$- 7.1.14.8.1. Property
PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ > oneOf > ImageConfig - 7.1.14.8.2. Property
PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ > oneOf > AudioConfig - 7.1.14.8.3. Property
PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ > oneOf > VideoConfig - 7.1.14.8.4. Property
PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ > oneOf > DocumentConfig - 7.1.14.8.5. Property
PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ > oneOf > GenericMediaTypeConfig- 7.1.14.8.5.1. Property
PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ > oneOf > item 4 > max_size_mb - 7.1.14.8.5.2. Property
PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ > oneOf > item 4 > allowed_formats - 7.1.14.8.5.3. Property
PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ > oneOf > item 4 > require_metadata - 7.1.14.8.5.4. Property
PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ > oneOf > item 4 > validation_params
- 7.1.14.8.5.1. Property
- 7.1.14.8.1. Property
- 7.1.14.1. Property
- 7.1.1. Property
- 7.1. Property
- 8. Property
PromptPack Specification > fragments - 9. Property
PromptPack Specification > tools- 9.1. Property
PromptPack Specification > tools > Tool- 9.1.1. Property
PromptPack Specification > tools > additionalProperties > name - 9.1.2. Property
PromptPack Specification > tools > additionalProperties > description - 9.1.3. Property
PromptPack Specification > tools > additionalProperties > parameters
- 9.1.1. Property
- 9.1. Property
- 10. Property
PromptPack Specification > metadata - 11. Property
PromptPack Specification > compilation
Title: PromptPack Specification
| Type | object |
| Required | No |
| Additional properties | Not allowed |
Description: Schema for packaging, testing, and running multi-prompt conversational systems with multimodal support
Examples:
{ "$schema": "https://promptpack.org/schema/v1/promptpack.schema.json", "id": "customer-support", "name": "Customer Support Pack", "version": "1.0.0", "description": "Complete customer support prompt pack with multiple task types", "template_engine": { "version": "v1", "syntax": "{{variable}}", "features": [ "basic_substitution", "fragments" ] }, "prompts": { "support": { "id": "support", "name": "Support Bot", "description": "General customer support assistant", "version": "1.0.0", "system_template": "You are a {{role}} assistant for {{company}}.", "variables": [ { "name": "role", "type": "string", "required": true, "description": "The role of the assistant", "example": "support agent" } ], "tools": [ "lookup_order" ], "parameters": { "temperature": 0.7, "max_tokens": 1500 } } }, "tools": { "lookup_order": { "name": "lookup_order", "description": "Look up order details by order ID", "parameters": { "type": "object", "properties": { "order_id": { "type": "string", "description": "The order ID to look up" } }, "required": [ "order_id" ] } } }}{ "$schema": "https://promptpack.org/schema/v1/promptpack.schema.json", "id": "image-analyzer", "name": "Image Analysis Pack", "version": "1.0.0", "description": "Multimodal pack for analyzing images with vision models", "template_engine": { "version": "v1", "syntax": "{{variable}}", "features": [ "basic_substitution" ] }, "prompts": { "analyze": { "id": "analyze", "name": "Image Analyzer", "description": "Analyzes images and provides detailed descriptions", "version": "1.0.0", "system_template": "You are an expert image analyst. Provide detailed, accurate descriptions of images.", "parameters": { "temperature": 0.7, "max_tokens": 1000 }, "media": { "enabled": true, "supported_types": [ "image" ], "image": { "max_size_mb": 20, "allowed_formats": [ "jpeg", "png", "webp" ], "default_detail": "high", "max_images_per_msg": 5 }, "examples": [ { "name": "simple-image-analysis", "description": "Basic image analysis with a single photo", "role": "user", "parts": [ { "type": "text", "text": "What's in this image?" }, { "type": "image", "media": { "file_path": "examples/photo.jpg", "mime_type": "image/jpeg", "detail": "high", "caption": "Sample photo for analysis" } } ] } ] } } }}| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - $schema | No | string | No | - | JSON Schema reference for validation and IDE support |
| + id | No | string | No | - | Unique identifier for the pack. Used for referencing and caching. Should be lowercase with hyphens. |
| + name | No | string | No | - | Human-readable name for the pack. Displayed in UIs and documentation. |
| + version | No | string | No | - | Pack version following Semantic Versioning 2.0.0 (MAJOR.MINOR.PATCH). Can optionally include ‘v’ prefix. Use MAJOR for breaking changes, MINOR for new features, PATCH for bug fixes. This version tracks the pack as a whole, while individual prompts can have independent versions. |
| - description | No | string | No | - | Detailed description of the pack’s purpose, use cases, and contents. Supports markdown formatting. |
| + template_engine | No | object | No | - | Template engine configuration shared across all prompts in the pack. Defines how variables are substituted and fragments are resolved. |
| + prompts | No | object | No | - | Map of task_type to prompt configuration. Each key is a task type (e.g., ‘support’, ‘sales’) and each value is a complete prompt definition. A pack must contain at least one prompt. |
| - fragments | No | object | No | - | Shared template fragments that can be referenced by any prompt in the pack. Fragments are reusable text blocks resolved at compile time. Keys are fragment names, values are fragment content. |
| - tools | No | object | No | - | Tool definitions that can be referenced by prompts. Tools enable the LLM to call external functions. Keys are tool names, values are tool specifications following the JSON Schema for function calling. |
| - metadata | No | object | No | - | Optional pack-level metadata for categorization, discovery, and operational planning. |
| - compilation | No | object | No | - | Information about when and how this pack was compiled. Generated automatically by the packc compiler. |
1. Property PromptPack Specification > $schema {#schema}
| Type | string |
| Required | No |
| Default | "https://promptpack.org/schema/v1/promptpack.schema.json" |
Description: JSON Schema reference for validation and IDE support
Example:
"https://promptpack.org/schema/v1/promptpack.schema.json"2. Property PromptPack Specification > id {#id}
| Type | string |
| Required | Yes |
Description: Unique identifier for the pack. Used for referencing and caching. Should be lowercase with hyphens.
Examples:
"customer-support""sales-assistant""technical-help"| Restrictions | |
|---|---|
| Min length | 1 |
| Max length | 100 |
| Must match regular expression | ^[a-z][a-z0-9-]*$ Test |
3. Property PromptPack Specification > name {#name}
| Type | string |
| Required | Yes |
Description: Human-readable name for the pack. Displayed in UIs and documentation.
Examples:
"Customer Support Pack""Sales Assistant""Technical Support"| Restrictions | |
|---|---|
| Min length | 1 |
| Max length | 200 |
4. Property PromptPack Specification > version {#version}
| Type | string |
| Required | Yes |
Description: Pack version following Semantic Versioning 2.0.0 (MAJOR.MINOR.PATCH). Can optionally include ‘v’ prefix. Use MAJOR for breaking changes, MINOR for new features, PATCH for bug fixes. This version tracks the pack as a whole, while individual prompts can have independent versions.
Examples:
"1.0.0""v2.1.3""1.0.0-alpha""2.0.0-beta.1+build.123"| Restrictions | |
|---|---|
| Must match regular expression | ^v?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$ Test |
5. Property PromptPack Specification > description {#description}
| Type | string |
| Required | No |
Description: Detailed description of the pack’s purpose, use cases, and contents. Supports markdown formatting.
Example:
"Complete customer support prompt pack with multiple task types for handling support, sales, and technical inquiries"| Restrictions | |
|---|---|
| Max length | 5000 |
6. Property PromptPack Specification > template_engine {#template_engine}
| Type | object |
| Required | Yes |
| Additional properties | Not allowed |
Description: Template engine configuration shared across all prompts in the pack. Defines how variables are substituted and fragments are resolved.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + version | No | string | No | - | Template engine version. Use ‘v1’ for the current stable version. |
| + syntax | No | string | No | - | Variable substitution syntax pattern. Defines how variables appear in templates. |
| - features | No | array of enum (of string) | No | - | Optional list of supported template features beyond basic substitution. |
6.1. Property PromptPack Specification > template_engine > version {#template_engine_version}
| Type | string |
| Required | Yes |
Description: Template engine version. Use ‘v1’ for the current stable version.
Examples:
"v1""v2"6.2. Property PromptPack Specification > template_engine > syntax {#template_engine_syntax}
| Type | string |
| Required | Yes |
Description: Variable substitution syntax pattern. Defines how variables appear in templates.
Examples:
"{{variable}}""${variable}""{variable}"6.3. Property PromptPack Specification > template_engine > features {#template_engine_features}
| Type | array of enum (of string) |
| Required | No |
Description: Optional list of supported template features beyond basic substitution.
Example:
[ "basic_substitution", "fragments"]| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| features items | - |
6.3.1. PromptPack Specification > template_engine > features > features items {#template_engine_features_items}
| Type | enum (of string) |
| Required | No |
Must be one of:
- “basic_substitution”
- “fragments”
- “conditionals”
- “loops”
- “filters”
7. Property PromptPack Specification > prompts {#prompts}
| Type | object |
| Required | Yes |
| Additional properties | Each additional property must conform to the schema |
Description: Map of task_type to prompt configuration. Each key is a task type (e.g., ‘support’, ‘sales’) and each value is a complete prompt definition. A pack must contain at least one prompt.
Example:
{ "support": { "id": "support", "name": "Support Bot", "version": "1.0.0", "system_template": "You are a helpful assistant." }}7.1. Property PromptPack Specification > prompts > Prompt {#prompts_additionalProperties}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/$defs/Prompt |
Description: A single prompt configuration within a pack. Each prompt represents a specific task type (e.g., ‘support’, ‘sales’) with its own template, variables, tools, and validation rules. Prompts within a pack can evolve independently with their own version numbers.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + id | No | string | No | - | Unique identifier for this prompt, typically matching the task_type key |
| + name | No | string | No | - | Human-readable name for this prompt |
| - description | No | string | No | - | Detailed description of this prompt’s purpose and behavior |
| + version | No | string | No | - | Prompt version following Semantic Versioning 2.0.0. Independent from pack version, allowing individual prompts to evolve separately. |
| + system_template | No | string | No | - | The system prompt template. Use template syntax (e.g., {{variable}}) for variable substitution. This is the core instruction that guides the LLM’s behavior. |
| - variables | No | array | No | - | Variable definitions for this prompt. Variables are placeholders in the template that are replaced with actual values at runtime. |
| - tools | No | array of string | No | - | List of tool names that this prompt is allowed to use. Tools must be defined in the pack-level ‘tools’ object. |
| - tool_policy | No | object | No | In #/$defs/ToolPolicy | Policy governing how tools can be used by this prompt |
| - pipeline | No | object | No | In #/$defs/PipelineConfig | Pipeline configuration defining processing stages and middleware |
| - parameters | No | object | No | In #/$defs/Parameters | LLM generation parameters like temperature and max_tokens |
| - validators | No | array | No | - | Validation rules (guardrails) applied to LLM responses |
| - tested_models | No | array | No | - | Model testing results documenting which models have been tested with this prompt and their performance |
| - model_overrides | No | object | No | - | Model-specific template modifications. Keys are model names (e.g., ‘claude-3-opus’, ‘gpt-4’), values are override configurations. |
| - media | No | object | No | In #/$defs/MediaConfig | Multimodal content configuration for this prompt. Defines supported media types and validation rules. |
7.1.1. Property PromptPack Specification > prompts > additionalProperties > id {#prompts_additionalProperties_id}
| Type | string |
| Required | Yes |
Description: Unique identifier for this prompt, typically matching the task_type key
Examples:
"support""sales""technical_support"| Restrictions | |
|---|---|
| Must match regular expression | ^[a-z][a-z0-9_-]*$ Test |
7.1.2. Property PromptPack Specification > prompts > additionalProperties > name {#prompts_additionalProperties_name}
| Type | string |
| Required | Yes |
Description: Human-readable name for this prompt
Examples:
"Support Bot""Sales Assistant"| Restrictions | |
|---|---|
| Min length | 1 |
7.1.3. Property PromptPack Specification > prompts > additionalProperties > description {#prompts_additionalProperties_description}
| Type | string |
| Required | No |
Description: Detailed description of this prompt’s purpose and behavior
Example:
"General customer support assistant for handling inquiries"7.1.4. Property PromptPack Specification > prompts > additionalProperties > version {#prompts_additionalProperties_version}
| Type | string |
| Required | Yes |
Description: Prompt version following Semantic Versioning 2.0.0. Independent from pack version, allowing individual prompts to evolve separately.
Examples:
"1.0.0""v2.1.0""1.5.2-beta"| Restrictions | |
|---|---|
| Must match regular expression | ^v?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$ Test |
7.1.5. Property PromptPack Specification > prompts > additionalProperties > system_template {#prompts_additionalProperties_system_template}
| Type | string |
| Required | Yes |
Description: The system prompt template. Use template syntax (e.g., {{variable}}) for variable substitution. This is the core instruction that guides the LLM’s behavior.
Examples:
"You are a {{role}} assistant for {{company}}.\\n\\nProvide helpful, professional support.""You are an expert in {{domain}}. Help users with {{task_description}}."| Restrictions | |
|---|---|
| Min length | 1 |
7.1.6. Property PromptPack Specification > prompts > additionalProperties > variables {#prompts_additionalProperties_variables}
| Type | array |
| Required | No |
Description: Variable definitions for this prompt. Variables are placeholders in the template that are replaced with actual values at runtime.
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| Variable | A template variable definition with type information and validation rules. Variables are replaced with actual values when the prompt is rendered. |
7.1.6.1. PromptPack Specification > prompts > additionalProperties > variables > Variable {#prompts_additionalProperties_variables_items}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/$defs/Variable |
Description: A template variable definition with type information and validation rules. Variables are replaced with actual values when the prompt is rendered.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + name | No | string | No | - | Variable name used in templates (e.g., {{name}}) |
| + type | No | enum (of string) | No | - | Data type of the variable |
| + required | No | boolean | No | - | Whether this variable must be provided. Required variables without values will cause an error. |
| - default | No | object | No | - | Default value used when variable is not provided. Cannot be set if required is true. |
| - description | No | string | No | - | Human-readable description of the variable’s purpose |
| - example | No | object | No | - | Example value showing expected format and content |
| - validation | No | object | No | - | Validation rules applied to the variable value at runtime |
7.1.6.1.1. Property PromptPack Specification > prompts > additionalProperties > variables > variables items > name {#prompts_additionalProperties_variables_items_name}
| Type | string |
| Required | Yes |
Description: Variable name used in templates (e.g., {{name}})
Examples:
"role""company""customer_name"| Restrictions | |
|---|---|
| Must match regular expression | ^[a-zA-Z_][a-zA-Z0-9_]*$ Test |
7.1.6.1.2. Property PromptPack Specification > prompts > additionalProperties > variables > variables items > type {#prompts_additionalProperties_variables_items_type}
| Type | enum (of string) |
| Required | Yes |
Description: Data type of the variable
Examples:
"string""number"Must be one of:
- “string”
- “number”
- “boolean”
- “object”
- “array”
7.1.6.1.3. Property PromptPack Specification > prompts > additionalProperties > variables > variables items > required {#prompts_additionalProperties_variables_items_required}
| Type | boolean |
| Required | Yes |
Description: Whether this variable must be provided. Required variables without values will cause an error.
7.1.6.1.4. Property PromptPack Specification > prompts > additionalProperties > variables > variables items > default {#prompts_additionalProperties_variables_items_default}
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
Description: Default value used when variable is not provided. Cannot be set if required is true.
Examples:
"TechCo"42true{ "key": "value"}7.1.6.1.5. Property PromptPack Specification > prompts > additionalProperties > variables > variables items > description {#prompts_additionalProperties_variables_items_description}
| Type | string |
| Required | No |
Description: Human-readable description of the variable’s purpose
Examples:
"The role of the assistant""Customer's account ID"7.1.6.1.6. Property PromptPack Specification > prompts > additionalProperties > variables > variables items > example {#prompts_additionalProperties_variables_items_example}
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
Description: Example value showing expected format and content
Examples:
"support agent""12345""john@example.com"7.1.6.1.7. Property PromptPack Specification > prompts > additionalProperties > variables > variables items > validation {#prompts_additionalProperties_variables_items_validation}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
Description: Validation rules applied to the variable value at runtime
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - pattern | No | string | No | - | Regular expression pattern (for string types) |
| - min_length | No | integer | No | - | Minimum string length (for string types) |
| - max_length | No | integer | No | - | Maximum string length (for string types) |
| - minimum | No | number | No | - | Minimum numeric value (for number types) |
| - maximum | No | number | No | - | Maximum numeric value (for number types) |
| - enum | No | array | No | - | List of allowed values |
7.1.6.1.7.1. Property PromptPack Specification > prompts > additionalProperties > variables > variables items > validation > pattern {#prompts_additionalProperties_variables_items_validation_pattern}
| Type | string |
| Required | No |
Description: Regular expression pattern (for string types)
Examples:
"^[a-zA-Z\\\\s]+$""^\\\\d{5}$""^[a-z0-9._%+-]+@[a-z0-9.-]+\\\\.[a-z]{2,}$"7.1.6.1.7.2. Property PromptPack Specification > prompts > additionalProperties > variables > variables items > validation > min_length {#prompts_additionalProperties_variables_items_validation_min_length}
| Type | integer |
| Required | No |
Description: Minimum string length (for string types)
Examples:
310| Restrictions | |
|---|---|
| Minimum | ≥ 0 |
7.1.6.1.7.3. Property PromptPack Specification > prompts > additionalProperties > variables > variables items > validation > max_length {#prompts_additionalProperties_variables_items_validation_max_length}
| Type | integer |
| Required | No |
Description: Maximum string length (for string types)
Examples:
501000| Restrictions | |
|---|---|
| Minimum | ≥ 1 |
7.1.6.1.7.4. Property PromptPack Specification > prompts > additionalProperties > variables > variables items > validation > minimum {#prompts_additionalProperties_variables_items_validation_minimum}
| Type | number |
| Required | No |
Description: Minimum numeric value (for number types)
Examples:
011007.1.6.1.7.5. Property PromptPack Specification > prompts > additionalProperties > variables > variables items > validation > maximum {#prompts_additionalProperties_variables_items_validation_maximum}
| Type | number |
| Required | No |
Description: Maximum numeric value (for number types)
Examples:
10010007.1.6.1.7.6. Property PromptPack Specification > prompts > additionalProperties > variables > variables items > validation > enum {#prompts_additionalProperties_variables_items_validation_enum}
| Type | array |
| Required | No |
Description: List of allowed values
Examples:
[ "low", "medium", "high"][ 1, 2, 3]| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| enum items | - |
7.1.6.1.7.6.1. PromptPack Specification > prompts > additionalProperties > variables > variables items > validation > enum > enum items {#prompts_additionalProperties_variables_items_validation_enum_items}
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
7.1.7. Property PromptPack Specification > prompts > additionalProperties > tools {#prompts_additionalProperties_tools}
| Type | array of string |
| Required | No |
Description: List of tool names that this prompt is allowed to use. Tools must be defined in the pack-level ‘tools’ object.
Examples:
[ "lookup_order", "create_ticket"][ "search_products", "get_pricing"]| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| tools items | - |
7.1.7.1. PromptPack Specification > prompts > additionalProperties > tools > tools items {#prompts_additionalProperties_tools_items}
| Type | string |
| Required | No |
7.1.8. Property PromptPack Specification > prompts > additionalProperties > tool_policy {#prompts_additionalProperties_tool_policy}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/$defs/ToolPolicy |
Description: Policy governing how tools can be used by this prompt
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - tool_choice | No | enum (of string) | No | - | ‘auto’ lets the LLM decide when to use tools, ‘required’ forces tool use, ‘none’ disables tools |
| - max_rounds | No | integer | No | - | Maximum number of LLM → tool → LLM cycles allowed per turn |
| - max_tool_calls_per_turn | No | integer | No | - | Maximum number of tool calls allowed in a single turn |
| - blocklist | No | array of string | No | - | List of tool names that are not allowed for this prompt (overrides tools list) |
7.1.8.1. Property PromptPack Specification > prompts > additionalProperties > tool_policy > tool_choice {#prompts_additionalProperties_tool_policy_tool_choice}
| Type | enum (of string) |
| Required | No |
| Default | "auto" |
Description: ‘auto’ lets the LLM decide when to use tools, ‘required’ forces tool use, ‘none’ disables tools
Examples:
"auto""required"Must be one of:
- “auto”
- “required”
- “none”
7.1.8.2. Property PromptPack Specification > prompts > additionalProperties > tool_policy > max_rounds {#prompts_additionalProperties_tool_policy_max_rounds}
| Type | integer |
| Required | No |
| Default | 5 |
Description: Maximum number of LLM → tool → LLM cycles allowed per turn
Examples:
3510| Restrictions | |
|---|---|
| Minimum | ≥ 1 |
7.1.8.3. Property PromptPack Specification > prompts > additionalProperties > tool_policy > max_tool_calls_per_turn {#prompts_additionalProperties_tool_policy_max_tool_calls_per_turn}
| Type | integer |
| Required | No |
| Default | 10 |
Description: Maximum number of tool calls allowed in a single turn
Examples:
1510| Restrictions | |
|---|---|
| Minimum | ≥ 1 |
7.1.8.4. Property PromptPack Specification > prompts > additionalProperties > tool_policy > blocklist {#prompts_additionalProperties_tool_policy_blocklist}
| Type | array of string |
| Required | No |
Description: List of tool names that are not allowed for this prompt (overrides tools list)
Example:
[ "dangerous_tool", "delete_data"]| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| blocklist items | - |
7.1.8.4.1. PromptPack Specification > prompts > additionalProperties > tool_policy > blocklist > blocklist items {#prompts_additionalProperties_tool_policy_blocklist_items}
| Type | string |
| Required | No |
7.1.9. Property PromptPack Specification > prompts > additionalProperties > pipeline {#prompts_additionalProperties_pipeline}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/$defs/PipelineConfig |
Description: Pipeline configuration defining processing stages and middleware
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + stages | No | array of string | No | - | Ordered list of pipeline stages. Common stages: ‘template’, ‘provider’, ‘validator’ |
| - middleware | No | array | No | - | Middleware components with their configurations. Applied in order during pipeline execution. |
7.1.9.1. Property PromptPack Specification > prompts > additionalProperties > pipeline > stages {#prompts_additionalProperties_pipeline_stages}
| Type | array of string |
| Required | Yes |
Description: Ordered list of pipeline stages. Common stages: ‘template’, ‘provider’, ‘validator’
Example:
[ "template", "provider", "validator"]| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| stages items | - |
7.1.9.1.1. PromptPack Specification > prompts > additionalProperties > pipeline > stages > stages items {#prompts_additionalProperties_pipeline_stages_items}
| Type | string |
| Required | No |
7.1.9.2. Property PromptPack Specification > prompts > additionalProperties > pipeline > middleware {#prompts_additionalProperties_pipeline_middleware}
| Type | array |
| Required | No |
Description: Middleware components with their configurations. Applied in order during pipeline execution.
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| MiddlewareConfig | Configuration for a single middleware component in the pipeline |
7.1.9.2.1. PromptPack Specification > prompts > additionalProperties > pipeline > middleware > MiddlewareConfig {#prompts_additionalProperties_pipeline_middleware_items}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/$defs/MiddlewareConfig |
Description: Configuration for a single middleware component in the pipeline
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + type | No | string | No | - | Middleware type identifier |
| - config | No | object | No | - | Type-specific configuration for the middleware |
7.1.9.2.1.1. Property PromptPack Specification > prompts > additionalProperties > pipeline > middleware > middleware items > type {#prompts_additionalProperties_pipeline_middleware_items_type}
| Type | string |
| Required | Yes |
Description: Middleware type identifier
Examples:
"template""provider""validator""custom"7.1.9.2.1.2. Property PromptPack Specification > prompts > additionalProperties > pipeline > middleware > middleware items > config {#prompts_additionalProperties_pipeline_middleware_items_config}
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
Description: Type-specific configuration for the middleware
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - additionalProperties | No | object | No | - | - |
7.1.10. Property PromptPack Specification > prompts > additionalProperties > parameters {#prompts_additionalProperties_parameters}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/$defs/Parameters |
Description: LLM generation parameters like temperature and max_tokens
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - temperature | No | number | No | - | Sampling temperature (0-2). Higher values make output more random, lower values more deterministic. |
| - max_tokens | No | integer | No | - | Maximum number of tokens to generate in the response |
| - top_p | No | number | No | - | Nucleus sampling parameter (0-1). Alternative to temperature for controlling randomness. |
| - top_k | No | integer or null | No | - | Top-k sampling parameter. Limits to top K tokens. Null means no limit. |
| - frequency_penalty | No | number | No | - | Penalty for token frequency (-2 to 2). Positive values reduce repetition. |
| - presence_penalty | No | number | No | - | Penalty for token presence (-2 to 2). Positive values encourage new topics. |
7.1.10.1. Property PromptPack Specification > prompts > additionalProperties > parameters > temperature {#prompts_additionalProperties_parameters_temperature}
| Type | number |
| Required | No |
Description: Sampling temperature (0-2). Higher values make output more random, lower values more deterministic.
Examples:
0.71.0| Restrictions | |
|---|---|
| Minimum | ≥ 0 |
| Maximum | ≤ 2 |
7.1.10.2. Property PromptPack Specification > prompts > additionalProperties > parameters > max_tokens {#prompts_additionalProperties_parameters_max_tokens}
| Type | integer |
| Required | No |
Description: Maximum number of tokens to generate in the response
Examples:
10010004000| Restrictions | |
|---|---|
| Minimum | ≥ 1 |
7.1.10.3. Property PromptPack Specification > prompts > additionalProperties > parameters > top_p {#prompts_additionalProperties_parameters_top_p}
| Type | number |
| Required | No |
Description: Nucleus sampling parameter (0-1). Alternative to temperature for controlling randomness.
Examples:
0.91.0| Restrictions | |
|---|---|
| Minimum | ≥ 0 |
| Maximum | ≤ 1 |
7.1.10.4. Property PromptPack Specification > prompts > additionalProperties > parameters > top_k {#prompts_additionalProperties_parameters_top_k}
| Type | integer or null |
| Required | No |
Description: Top-k sampling parameter. Limits to top K tokens. Null means no limit.
Examples:
40100null| Restrictions | |
|---|---|
| Minimum | ≥ 1 |
7.1.10.5. Property PromptPack Specification > prompts > additionalProperties > parameters > frequency_penalty {#prompts_additionalProperties_parameters_frequency_penalty}
| Type | number |
| Required | No |
Description: Penalty for token frequency (-2 to 2). Positive values reduce repetition.
Examples:
00.5| Restrictions | |
|---|---|
| Minimum | ≥ -2 |
| Maximum | ≤ 2 |
7.1.10.6. Property PromptPack Specification > prompts > additionalProperties > parameters > presence_penalty {#prompts_additionalProperties_parameters_presence_penalty}
| Type | number |
| Required | No |
Description: Penalty for token presence (-2 to 2). Positive values encourage new topics.
Examples:
00.5| Restrictions | |
|---|---|
| Minimum | ≥ -2 |
| Maximum | ≤ 2 |
7.1.11. Property PromptPack Specification > prompts > additionalProperties > validators {#prompts_additionalProperties_validators}
| Type | array |
| Required | No |
Description: Validation rules (guardrails) applied to LLM responses
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| Validator | A validation rule (guardrail) applied to LLM responses. Validators can check content, length, format, and other constraints to ensure response quality and safety. |
7.1.11.1. PromptPack Specification > prompts > additionalProperties > validators > Validator {#prompts_additionalProperties_validators_items}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/$defs/Validator |
Description: A validation rule (guardrail) applied to LLM responses. Validators can check content, length, format, and other constraints to ensure response quality and safety.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + type | No | enum (of string) | No | - | Type of validation to perform |
| + enabled | No | boolean | No | - | Whether this validator is active. Allows temporarily disabling validators without removing them. |
| - fail_on_violation | No | boolean | No | - | If true, validation failures cause an error. If false, violations are logged but allowed. |
| - params | No | object | No | - | Validator-specific parameters |
7.1.11.1.1. Property PromptPack Specification > prompts > additionalProperties > validators > validators items > type {#prompts_additionalProperties_validators_items_type}
| Type | enum (of string) |
| Required | Yes |
Description: Type of validation to perform
Examples:
"banned_words""max_length"Must be one of:
- “banned_words”
- “max_length”
- “min_length”
- “regex_match”
- “json_schema”
- “sentiment”
- “toxicity”
- “pii_detection”
- “custom”
7.1.11.1.2. Property PromptPack Specification > prompts > additionalProperties > validators > validators items > enabled {#prompts_additionalProperties_validators_items_enabled}
| Type | boolean |
| Required | Yes |
Description: Whether this validator is active. Allows temporarily disabling validators without removing them.
7.1.11.1.3. Property PromptPack Specification > prompts > additionalProperties > validators > validators items > fail_on_violation {#prompts_additionalProperties_validators_items_fail_on_violation}
| Type | boolean |
| Required | No |
| Default | false |
Description: If true, validation failures cause an error. If false, violations are logged but allowed.
7.1.11.1.4. Property PromptPack Specification > prompts > additionalProperties > validators > validators items > params {#prompts_additionalProperties_validators_items_params}
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
Description: Validator-specific parameters
Examples:
{ "words": [ "inappropriate", "banned" ]}{ "max_characters": 1000, "max_tokens": 250}| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - additionalProperties | No | object | No | - | - |
7.1.12. Property PromptPack Specification > prompts > additionalProperties > tested_models {#prompts_additionalProperties_tested_models}
| Type | array |
| Required | No |
Description: Model testing results documenting which models have been tested with this prompt and their performance
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| TestedModel | Testing results for a specific model. Documents which models have been tested with this prompt and their performance metrics. |
7.1.12.1. PromptPack Specification > prompts > additionalProperties > tested_models > TestedModel {#prompts_additionalProperties_tested_models_items}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/$defs/TestedModel |
Description: Testing results for a specific model. Documents which models have been tested with this prompt and their performance metrics.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + provider | No | string | No | - | LLM provider name |
| + model | No | string | No | - | Specific model identifier |
| + date | No | string | No | - | Date when the model was tested (YYYY-MM-DD) |
| - success_rate | No | number | No | - | Success rate (0-1) from test runs |
| - avg_tokens | No | number | No | - | Average number of tokens used per response |
| - avg_cost | No | number | No | - | Average cost per execution in USD |
| - avg_latency_ms | No | number | No | - | Average response latency in milliseconds |
| - notes | No | string | No | - | Additional notes about model performance or observations |
7.1.12.1.1. Property PromptPack Specification > prompts > additionalProperties > tested_models > tested_models items > provider {#prompts_additionalProperties_tested_models_items_provider}
| Type | string |
| Required | Yes |
Description: LLM provider name
Examples:
"openai""anthropic""azure""bedrock"7.1.12.1.2. Property PromptPack Specification > prompts > additionalProperties > tested_models > tested_models items > model {#prompts_additionalProperties_tested_models_items_model}
| Type | string |
| Required | Yes |
Description: Specific model identifier
Examples:
"gpt-4""gpt-3.5-turbo""claude-3-opus""claude-3-sonnet"7.1.12.1.3. Property PromptPack Specification > prompts > additionalProperties > tested_models > tested_models items > date {#prompts_additionalProperties_tested_models_items_date}
| Type | string |
| Required | Yes |
| Format | date |
Description: Date when the model was tested (YYYY-MM-DD)
Examples:
"2025-10-31""2025-12-01"7.1.12.1.4. Property PromptPack Specification > prompts > additionalProperties > tested_models > tested_models items > success_rate {#prompts_additionalProperties_tested_models_items_success_rate}
| Type | number |
| Required | No |
Description: Success rate (0-1) from test runs
Examples:
0.950.87| Restrictions | |
|---|---|
| Minimum | ≥ 0 |
| Maximum | ≤ 1 |
7.1.12.1.5. Property PromptPack Specification > prompts > additionalProperties > tested_models > tested_models items > avg_tokens {#prompts_additionalProperties_tested_models_items_avg_tokens}
| Type | number |
| Required | No |
Description: Average number of tokens used per response
Examples:
150500| Restrictions | |
|---|---|
| Minimum | ≥ 0 |
7.1.12.1.6. Property PromptPack Specification > prompts > additionalProperties > tested_models > tested_models items > avg_cost {#prompts_additionalProperties_tested_models_items_avg_cost}
| Type | number |
| Required | No |
Description: Average cost per execution in USD
Examples:
0.00450.012| Restrictions | |
|---|---|
| Minimum | ≥ 0 |
7.1.12.1.7. Property PromptPack Specification > prompts > additionalProperties > tested_models > tested_models items > avg_latency_ms {#prompts_additionalProperties_tested_models_items_avg_latency_ms}
| Type | number |
| Required | No |
Description: Average response latency in milliseconds
Examples:
12003500| Restrictions | |
|---|---|
| Minimum | ≥ 0 |
7.1.12.1.8. Property PromptPack Specification > prompts > additionalProperties > tested_models > tested_models items > notes {#prompts_additionalProperties_tested_models_items_notes}
| Type | string |
| Required | No |
Description: Additional notes about model performance or observations
7.1.13. Property PromptPack Specification > prompts > additionalProperties > model_overrides {#prompts_additionalProperties_model_overrides}
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
Description: Model-specific template modifications. Keys are model names (e.g., ‘claude-3-opus’, ‘gpt-4’), values are override configurations.
7.1.13.1. Property PromptPack Specification > prompts > additionalProperties > model_overrides > ModelOverride {#prompts_additionalProperties_model_overrides_additionalProperties}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/$defs/ModelOverride |
Description: Model-specific template modifications. Allows customizing prompts for specific models without changing the base template.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - system_template_prefix | No | string | No | - | Text prepended to the system template for this model |
| - system_template_suffix | No | string | No | - | Text appended to the system template for this model |
| - system_template | No | string | No | - | Complete replacement system template for this model (overrides the base template entirely) |
| - parameters | No | object | No | Same as parameters | Model-specific parameter overrides |
7.1.13.1.1. Property PromptPack Specification > prompts > additionalProperties > model_overrides > additionalProperties > system_template_prefix {#prompts_additionalProperties_model_overrides_additionalProperties_system_template_prefix}
| Type | string |
| Required | No |
Description: Text prepended to the system template for this model
Examples:
"<thinking>\\n""[Task]\\n"7.1.13.1.2. Property PromptPack Specification > prompts > additionalProperties > model_overrides > additionalProperties > system_template_suffix {#prompts_additionalProperties_model_overrides_additionalProperties_system_template_suffix}
| Type | string |
| Required | No |
Description: Text appended to the system template for this model
Examples:
"\\n\\nBe concise and direct.""\\n</thinking>"7.1.13.1.3. Property PromptPack Specification > prompts > additionalProperties > model_overrides > additionalProperties > system_template {#prompts_additionalProperties_model_overrides_additionalProperties_system_template}
| Type | string |
| Required | No |
Description: Complete replacement system template for this model (overrides the base template entirely)
7.1.13.1.4. Property PromptPack Specification > prompts > additionalProperties > model_overrides > additionalProperties > parameters {#prompts_additionalProperties_model_overrides_additionalProperties_parameters}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | parameters |
Description: Model-specific parameter overrides
7.1.14. Property PromptPack Specification > prompts > additionalProperties > media {#prompts_additionalProperties_media}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/$defs/MediaConfig |
Description: Multimodal content configuration for this prompt. Defines supported media types and validation rules.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + enabled | No | boolean | No | - | Whether multimodal content is enabled for this prompt |
| - supported_types | No | array of string | No | - | List of supported media types for this prompt. Common types include: image, audio, video, document, model3d, archive. Custom types are allowed - each type should have a corresponding configuration object (e.g., ‘foo’ type requires a ‘foo’ field with GenericMediaTypeConfig or a specific schema). |
| - image | No | object | No | In #/$defs/ImageConfig | Image-specific configuration and constraints |
| - audio | No | object | No | In #/$defs/AudioConfig | Audio-specific configuration and constraints |
| - video | No | object | No | In #/$defs/VideoConfig | Video-specific configuration and constraints |
| - document | No | object | No | In #/$defs/DocumentConfig | Document-specific configuration and constraints (PDFs, CAD files, spreadsheets, etc.) |
| - examples | No | array | No | - | Example multimodal messages showing how to use media with this prompt |
| - ^[a-z0-9_]+$ | Yes | Combination | No | - | - |
7.1.14.1. Property PromptPack Specification > prompts > additionalProperties > media > enabled {#prompts_additionalProperties_media_enabled}
| Type | boolean |
| Required | Yes |
Description: Whether multimodal content is enabled for this prompt
7.1.14.2. Property PromptPack Specification > prompts > additionalProperties > media > supported_types {#prompts_additionalProperties_media_supported_types}
| Type | array of string |
| Required | No |
Description: List of supported media types for this prompt. Common types include: image, audio, video, document, model3d, archive. Custom types are allowed - each type should have a corresponding configuration object (e.g., ‘foo’ type requires a ‘foo’ field with GenericMediaTypeConfig or a specific schema).
Examples:
[ "image"][ "image", "audio"][ "image", "audio", "video"][ "document", "image"][ "model3d", "document"]| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| supported_types items | - |
7.1.14.2.1. PromptPack Specification > prompts > additionalProperties > media > supported_types > supported_types items {#prompts_additionalProperties_media_supported_types_items}
| Type | string |
| Required | No |
| Restrictions | |
|---|---|
| Must match regular expression | ^[a-z0-9_]+$ Test |
7.1.14.3. Property PromptPack Specification > prompts > additionalProperties > media > image {#prompts_additionalProperties_media_image}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/$defs/ImageConfig |
Description: Image-specific configuration and constraints
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - max_size_mb | No | integer | No | - | Maximum file size in megabytes |
| - allowed_formats | No | array of enum (of string) | No | - | List of allowed image formats |
| - default_detail | No | enum (of string) | No | - | Default detail level for image processing. ‘low’ uses fewer tokens, ‘high’ provides more detail, ‘auto’ lets the model decide. |
| - require_caption | No | boolean | No | - | Whether image captions are required |
| - max_images_per_msg | No | integer | No | - | Maximum number of images allowed per message |
7.1.14.3.1. Property PromptPack Specification > prompts > additionalProperties > media > image > max_size_mb {#prompts_additionalProperties_media_image_max_size_mb}
| Type | integer |
| Required | No |
Description: Maximum file size in megabytes
Examples:
1020| Restrictions | |
|---|---|
| Minimum | ≥ 1 |
7.1.14.3.2. Property PromptPack Specification > prompts > additionalProperties > media > image > allowed_formats {#prompts_additionalProperties_media_image_allowed_formats}
| Type | array of enum (of string) |
| Required | No |
Description: List of allowed image formats
Example:
[ "jpeg", "png", "webp"]| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| allowed_formats items | - |
7.1.14.3.2.1. PromptPack Specification > prompts > additionalProperties > media > image > allowed_formats > allowed_formats items {#prompts_additionalProperties_media_image_allowed_formats_items}
| Type | enum (of string) |
| Required | No |
Must be one of:
- “jpeg”
- “jpg”
- “png”
- “webp”
- “gif”
- “bmp”
7.1.14.3.3. Property PromptPack Specification > prompts > additionalProperties > media > image > default_detail {#prompts_additionalProperties_media_image_default_detail}
| Type | enum (of string) |
| Required | No |
| Default | "auto" |
Description: Default detail level for image processing. ‘low’ uses fewer tokens, ‘high’ provides more detail, ‘auto’ lets the model decide.
Examples:
"high""auto"Must be one of:
- “low”
- “high”
- “auto”
7.1.14.3.4. Property PromptPack Specification > prompts > additionalProperties > media > image > require_caption {#prompts_additionalProperties_media_image_require_caption}
| Type | boolean |
| Required | No |
| Default | false |
Description: Whether image captions are required
7.1.14.3.5. Property PromptPack Specification > prompts > additionalProperties > media > image > max_images_per_msg {#prompts_additionalProperties_media_image_max_images_per_msg}
| Type | integer |
| Required | No |
Description: Maximum number of images allowed per message
Examples:
1510| Restrictions | |
|---|---|
| Minimum | ≥ 1 |
7.1.14.4. Property PromptPack Specification > prompts > additionalProperties > media > audio {#prompts_additionalProperties_media_audio}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/$defs/AudioConfig |
Description: Audio-specific configuration and constraints
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - max_size_mb | No | integer | No | - | Maximum file size in megabytes |
| - allowed_formats | No | array of enum (of string) | No | - | List of allowed audio formats |
| - max_duration_sec | No | integer | No | - | Maximum audio duration in seconds |
| - require_metadata | No | boolean | No | - | Whether audio metadata (title, description) is required |
7.1.14.4.1. Property PromptPack Specification > prompts > additionalProperties > media > audio > max_size_mb {#prompts_additionalProperties_media_audio_max_size_mb}
| Type | integer |
| Required | No |
Description: Maximum file size in megabytes
Examples:
2550| Restrictions | |
|---|---|
| Minimum | ≥ 1 |
7.1.14.4.2. Property PromptPack Specification > prompts > additionalProperties > media > audio > allowed_formats {#prompts_additionalProperties_media_audio_allowed_formats}
| Type | array of enum (of string) |
| Required | No |
Description: List of allowed audio formats
Example:
[ "mp3", "wav", "opus"]| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| allowed_formats items | - |
7.1.14.4.2.1. PromptPack Specification > prompts > additionalProperties > media > audio > allowed_formats > allowed_formats items {#prompts_additionalProperties_media_audio_allowed_formats_items}
| Type | enum (of string) |
| Required | No |
Must be one of:
- “mp3”
- “wav”
- “opus”
- “flac”
- “m4a”
- “aac”
7.1.14.4.3. Property PromptPack Specification > prompts > additionalProperties > media > audio > max_duration_sec {#prompts_additionalProperties_media_audio_max_duration_sec}
| Type | integer |
| Required | No |
Description: Maximum audio duration in seconds
Examples:
300600| Restrictions | |
|---|---|
| Minimum | ≥ 1 |
7.1.14.4.4. Property PromptPack Specification > prompts > additionalProperties > media > audio > require_metadata {#prompts_additionalProperties_media_audio_require_metadata}
| Type | boolean |
| Required | No |
| Default | false |
Description: Whether audio metadata (title, description) is required
7.1.14.5. Property PromptPack Specification > prompts > additionalProperties > media > video {#prompts_additionalProperties_media_video}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/$defs/VideoConfig |
Description: Video-specific configuration and constraints
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - max_size_mb | No | integer | No | - | Maximum file size in megabytes |
| - allowed_formats | No | array of enum (of string) | No | - | List of allowed video formats |
| - max_duration_sec | No | integer | No | - | Maximum video duration in seconds |
| - require_metadata | No | boolean | No | - | Whether video metadata (title, description) is required |
7.1.14.5.1. Property PromptPack Specification > prompts > additionalProperties > media > video > max_size_mb {#prompts_additionalProperties_media_video_max_size_mb}
| Type | integer |
| Required | No |
Description: Maximum file size in megabytes
Examples:
100200| Restrictions | |
|---|---|
| Minimum | ≥ 1 |
7.1.14.5.2. Property PromptPack Specification > prompts > additionalProperties > media > video > allowed_formats {#prompts_additionalProperties_media_video_allowed_formats}
| Type | array of enum (of string) |
| Required | No |
Description: List of allowed video formats
Example:
[ "mp4", "webm"]| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| allowed_formats items | - |
7.1.14.5.2.1. PromptPack Specification > prompts > additionalProperties > media > video > allowed_formats > allowed_formats items {#prompts_additionalProperties_media_video_allowed_formats_items}
| Type | enum (of string) |
| Required | No |
Must be one of:
- “mp4”
- “webm”
- “mov”
- “avi”
- “mkv”
7.1.14.5.3. Property PromptPack Specification > prompts > additionalProperties > media > video > max_duration_sec {#prompts_additionalProperties_media_video_max_duration_sec}
| Type | integer |
| Required | No |
Description: Maximum video duration in seconds
Examples:
6001200| Restrictions | |
|---|---|
| Minimum | ≥ 1 |
7.1.14.5.4. Property PromptPack Specification > prompts > additionalProperties > media > video > require_metadata {#prompts_additionalProperties_media_video_require_metadata}
| Type | boolean |
| Required | No |
| Default | false |
Description: Whether video metadata (title, description) is required
7.1.14.6. Property PromptPack Specification > prompts > additionalProperties > media > document {#prompts_additionalProperties_media_document}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/$defs/DocumentConfig |
Description: Document-specific configuration and constraints (PDFs, CAD files, spreadsheets, etc.)
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - max_size_mb | No | integer | No | - | Maximum file size in megabytes |
| - allowed_formats | No | array of string | No | - | List of allowed document formats |
| - max_pages | No | integer | No | - | Maximum number of pages/sheets for paginated documents |
| - require_metadata | No | boolean | No | - | Whether document metadata (title, author, description) is required |
| - extraction_mode | No | enum (of string) | No | - | How to extract content from documents. ‘text’ extracts text only, ‘structured’ preserves formatting, ‘raw’ keeps original binary format. |
7.1.14.6.1. Property PromptPack Specification > prompts > additionalProperties > media > document > max_size_mb {#prompts_additionalProperties_media_document_max_size_mb}
| Type | integer |
| Required | No |
Description: Maximum file size in megabytes
Examples:
50100| Restrictions | |
|---|---|
| Minimum | ≥ 1 |
7.1.14.6.2. Property PromptPack Specification > prompts > additionalProperties > media > document > allowed_formats {#prompts_additionalProperties_media_document_allowed_formats}
| Type | array of string |
| Required | No |
Description: List of allowed document formats
Examples:
[ "pdf", "docx"][ "pdf", "step", "dwg"][ "csv", "xlsx", "ods"]| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| allowed_formats items | - |
7.1.14.6.2.1. PromptPack Specification > prompts > additionalProperties > media > document > allowed_formats > allowed_formats items {#prompts_additionalProperties_media_document_allowed_formats_items}
| Type | string |
| Required | No |
7.1.14.6.3. Property PromptPack Specification > prompts > additionalProperties > media > document > max_pages {#prompts_additionalProperties_media_document_max_pages}
| Type | integer |
| Required | No |
Description: Maximum number of pages/sheets for paginated documents
Examples:
50100| Restrictions | |
|---|---|
| Minimum | ≥ 1 |
7.1.14.6.4. Property PromptPack Specification > prompts > additionalProperties > media > document > require_metadata {#prompts_additionalProperties_media_document_require_metadata}
| Type | boolean |
| Required | No |
| Default | false |
Description: Whether document metadata (title, author, description) is required
7.1.14.6.5. Property PromptPack Specification > prompts > additionalProperties > media > document > extraction_mode {#prompts_additionalProperties_media_document_extraction_mode}
| Type | enum (of string) |
| Required | No |
| Default | "text" |
Description: How to extract content from documents. ‘text’ extracts text only, ‘structured’ preserves formatting, ‘raw’ keeps original binary format.
Examples:
"text""structured"Must be one of:
- “text”
- “structured”
- “raw”
7.1.14.7. Property PromptPack Specification > prompts > additionalProperties > media > examples {#prompts_additionalProperties_media_examples}
| Type | array |
| Required | No |
Description: Example multimodal messages showing how to use media with this prompt
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| MultimodalExample | Example multimodal message demonstrating how to use media content with a prompt |
7.1.14.7.1. PromptPack Specification > prompts > additionalProperties > media > examples > MultimodalExample {#prompts_additionalProperties_media_examples_items}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/$defs/MultimodalExample |
Description: Example multimodal message demonstrating how to use media content with a prompt
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + name | No | string | No | - | Name identifying this example |
| - description | No | string | No | - | Description of what this example demonstrates |
| + role | No | enum (of string) | No | - | Message role (typically ‘user’ or ‘assistant’) |
| + parts | No | array | No | - | Message content parts (text and/or media) |
7.1.14.7.1.1. Property PromptPack Specification > prompts > additionalProperties > media > examples > examples items > name {#prompts_additionalProperties_media_examples_items_name}
| Type | string |
| Required | Yes |
Description: Name identifying this example
Examples:
"image-analysis""audio-transcription"7.1.14.7.1.2. Property PromptPack Specification > prompts > additionalProperties > media > examples > examples items > description {#prompts_additionalProperties_media_examples_items_description}
| Type | string |
| Required | No |
Description: Description of what this example demonstrates
7.1.14.7.1.3. Property PromptPack Specification > prompts > additionalProperties > media > examples > examples items > role {#prompts_additionalProperties_media_examples_items_role}
| Type | enum (of string) |
| Required | Yes |
Description: Message role (typically ‘user’ or ‘assistant’)
Example:
"user"Must be one of:
- “user”
- “assistant”
- “system”
7.1.14.7.1.4. Property PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts {#prompts_additionalProperties_media_examples_items_parts}
| Type | array |
| Required | Yes |
Description: Message content parts (text and/or media)
| Array restrictions | |
|---|---|
| Min items | 1 |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| ContentPart | A single content part within a multimodal message. Can be text or media. |
7.1.14.7.1.4.1. PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > ContentPart {#prompts_additionalProperties_media_examples_items_parts_items}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/$defs/ContentPart |
Description: A single content part within a multimodal message. Can be text or media.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + type | No | string | No | - | Type of content part. Common types include: text, image, audio, video, document. Custom types are allowed for extensibility. |
| - text | No | string | No | - | Text content (required when type is ‘text’) |
| - media | No | object | No | In #/$defs/MediaReference | Media reference (required when type is ‘image’, ‘audio’, or ‘video’) |
7.1.14.7.1.4.1.1. Property PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > parts items > type {#prompts_additionalProperties_media_examples_items_parts_items_type}
| Type | string |
| Required | Yes |
Description: Type of content part. Common types include: text, image, audio, video, document. Custom types are allowed for extensibility.
Examples:
"text""image""audio""document"| Restrictions | |
|---|---|
| Must match regular expression | ^[a-z0-9_]+$ Test |
7.1.14.7.1.4.1.2. Property PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > parts items > text {#prompts_additionalProperties_media_examples_items_parts_items_text}
| Type | string |
| Required | No |
Description: Text content (required when type is ‘text’)
Examples:
"What's in this image?""Describe the scene"7.1.14.7.1.4.1.3. Property PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > parts items > media {#prompts_additionalProperties_media_examples_items_parts_items_media}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/$defs/MediaReference |
Description: Media reference (required when type is ‘image’, ‘audio’, or ‘video’)
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - file_path | No | string | No | - | Path to media file (relative to pack or absolute). Validated at compile time. |
| - url | No | string | No | - | URL to media file. Must be publicly accessible or require authentication. |
| - base64 | No | string | No | - | Base64-encoded media data. Use for small files or when embedding is preferred. |
| + mime_type | No | string | No | - | MIME type of the media file |
| - detail | No | enum (of string) | No | - | Detail level for image processing (images only). Overrides default_detail from ImageConfig. |
| - caption | No | string | No | - | Caption or description for the media |
7.1.14.7.1.4.1.3.1. Property PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > parts items > media > file_path {#prompts_additionalProperties_media_examples_items_parts_items_media_file_path}
| Type | string |
| Required | No |
Description: Path to media file (relative to pack or absolute). Validated at compile time.
Examples:
"images/photo.jpg""./media/audio.mp3"7.1.14.7.1.4.1.3.2. Property PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > parts items > media > url {#prompts_additionalProperties_media_examples_items_parts_items_media_url}
| Type | string |
| Required | No |
| Format | uri |
Description: URL to media file. Must be publicly accessible or require authentication.
Examples:
"https://example.com/image.jpg""https://cdn.example.com/video.mp4"7.1.14.7.1.4.1.3.3. Property PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > parts items > media > base64 {#prompts_additionalProperties_media_examples_items_parts_items_media_base64}
| Type | string |
| Required | No |
Description: Base64-encoded media data. Use for small files or when embedding is preferred.
Example:
"iVBORw0KGgoAAAANSUhEUgAAAAUA..."7.1.14.7.1.4.1.3.4. Property PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > parts items > media > mime_type {#prompts_additionalProperties_media_examples_items_parts_items_media_mime_type}
| Type | string |
| Required | Yes |
Description: MIME type of the media file
Examples:
"image/jpeg""image/png""audio/mp3""video/mp4"7.1.14.7.1.4.1.3.5. Property PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > parts items > media > detail {#prompts_additionalProperties_media_examples_items_parts_items_media_detail}
| Type | enum (of string) |
| Required | No |
Description: Detail level for image processing (images only). Overrides default_detail from ImageConfig.
Example:
"high"Must be one of:
- “low”
- “high”
- “auto”
7.1.14.7.1.4.1.3.6. Property PromptPack Specification > prompts > additionalProperties > media > examples > examples items > parts > parts items > media > caption {#prompts_additionalProperties_media_examples_items_parts_items_media_caption}
| Type | string |
| Required | No |
Description: Caption or description for the media
Examples:
"Product photo""Customer's voice recording"7.1.14.8. Pattern Property PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ {#prompts_additionalProperties_media_pattern1}
All properties whose name matches the regular expression
^[a-z0-9_]+$(Test) must respect the following conditions
| Type | combining |
| Required | No |
| Additional properties | Any type allowed |
| One of(Option) |
|---|
| ImageConfig |
| AudioConfig |
| VideoConfig |
| DocumentConfig |
| GenericMediaTypeConfig |
7.1.14.8.1. Property PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ > oneOf > ImageConfig {#prompts_additionalProperties_media_pattern1_pattern1_i0}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | image |
Description: Configuration and validation rules for image content
7.1.14.8.2. Property PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ > oneOf > AudioConfig {#prompts_additionalProperties_media_pattern1_pattern1_i1}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | audio |
Description: Configuration and validation rules for audio content
7.1.14.8.3. Property PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ > oneOf > VideoConfig {#prompts_additionalProperties_media_pattern1_pattern1_i2}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | video |
Description: Configuration and validation rules for video content
7.1.14.8.4. Property PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ > oneOf > DocumentConfig {#prompts_additionalProperties_media_pattern1_pattern1_i3}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Same definition as | document |
Description: Configuration and validation rules for document content (PDFs, CAD files, spreadsheets, etc.)
7.1.14.8.5. Property PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ > oneOf > GenericMediaTypeConfig {#prompts_additionalProperties_media_pattern1_pattern1_i4}
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
| Defined in | #/$defs/GenericMediaTypeConfig |
Description: Generic configuration for custom media types. Use this for types not covered by specific configs (ImageConfig, AudioConfig, etc.). Provides common validation properties that apply to most media types.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - max_size_mb | No | integer | No | - | Maximum file size in megabytes |
| - allowed_formats | No | array of string | No | - | List of allowed file formats/extensions |
| - require_metadata | No | boolean | No | - | Whether metadata is required for this media type |
| - validation_params | No | object | No | - | Custom validation parameters specific to this media type. Structure depends on the type. |
| - additionalProperties | No | object | No | - | - |
7.1.14.8.5.1. Property PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ > oneOf > item 4 > max_size_mb {#prompts_additionalProperties_media_pattern1_pattern1_i4_max_size_mb}
| Type | integer |
| Required | No |
Description: Maximum file size in megabytes
Examples:
1050100| Restrictions | |
|---|---|
| Minimum | ≥ 1 |
7.1.14.8.5.2. Property PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ > oneOf > item 4 > allowed_formats {#prompts_additionalProperties_media_pattern1_pattern1_i4_allowed_formats}
| Type | array of string |
| Required | No |
Description: List of allowed file formats/extensions
Examples:
[ "obj", "fbx", "gltf"][ "zip", "tar"][ "stl", "ply"]| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| allowed_formats items | - |
7.1.14.8.5.2.1. PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ > oneOf > item 4 > allowed_formats > allowed_formats items {#prompts_additionalProperties_media_pattern1_pattern1_i4_allowed_formats_items}
| Type | string |
| Required | No |
7.1.14.8.5.3. Property PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ > oneOf > item 4 > require_metadata {#prompts_additionalProperties_media_pattern1_pattern1_i4_require_metadata}
| Type | boolean |
| Required | No |
| Default | false |
Description: Whether metadata is required for this media type
7.1.14.8.5.4. Property PromptPack Specification > prompts > additionalProperties > media > ^[a-z0-9_]+$ > oneOf > item 4 > validation_params {#prompts_additionalProperties_media_pattern1_pattern1_i4_validation_params}
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
Description: Custom validation parameters specific to this media type. Structure depends on the type.
Examples:
{ "max_vertices": 100000, "require_textures": false}{ "compression": "gzip", "max_entries": 1000}| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - additionalProperties | No | object | No | - | - |
8. Property PromptPack Specification > fragments {#fragments}
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
Description: Shared template fragments that can be referenced by any prompt in the pack. Fragments are reusable text blocks resolved at compile time. Keys are fragment names, values are fragment content.
Example:
{ "customer_context": "Customer: {{customer_name}}\\nIssue: {{issue}}", "greeting": "Hello! How can I help you today?"}| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | string | No | - | - |
8.1. Property PromptPack Specification > fragments > additionalProperties {#fragments_additionalProperties}
| Type | string |
| Required | No |
9. Property PromptPack Specification > tools {#tools}
| Type | object |
| Required | No |
| Additional properties | Each additional property must conform to the schema |
Description: Tool definitions that can be referenced by prompts. Tools enable the LLM to call external functions. Keys are tool names, values are tool specifications following the JSON Schema for function calling.
9.1. Property PromptPack Specification > tools > Tool {#tools_additionalProperties}
| Type | object |
| Required | No |
| Additional properties | Not allowed |
| Defined in | #/$defs/Tool |
Description: A tool definition following OpenAI’s function calling format. Tools enable the LLM to call external functions to retrieve data or perform actions.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + name | No | string | No | - | Tool name used for referencing and calling |
| + description | No | string | No | - | Clear description of what the tool does. The LLM uses this to decide when to call the tool. |
| - parameters | No | object | No | - | JSON Schema defining the tool’s parameters. Follows JSON Schema specification. |
9.1.1. Property PromptPack Specification > tools > additionalProperties > name {#tools_additionalProperties_name}
| Type | string |
| Required | Yes |
Description: Tool name used for referencing and calling
Examples:
"lookup_order""create_ticket""search_database"| Restrictions | |
|---|---|
| Must match regular expression | ^[a-zA-Z_][a-zA-Z0-9_]*$ Test |
9.1.2. Property PromptPack Specification > tools > additionalProperties > description {#tools_additionalProperties_description}
| Type | string |
| Required | Yes |
Description: Clear description of what the tool does. The LLM uses this to decide when to call the tool.
Examples:
"Look up order details by order ID""Create a support ticket with title, description, and priority"| Restrictions | |
|---|---|
| Min length | 1 |
9.1.3. Property PromptPack Specification > tools > additionalProperties > parameters {#tools_additionalProperties_parameters}
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
Description: JSON Schema defining the tool’s parameters. Follows JSON Schema specification.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + type | No | enum (of string) | No | - | Must be ‘object’ for tool parameters |
| + properties | No | object | No | - | Parameter definitions |
| - required | No | array of string | No | - | List of required parameter names |
9.1.3.1. Property PromptPack Specification > tools > additionalProperties > parameters > type {#tools_additionalProperties_parameters_type}
| Type | enum (of string) |
| Required | Yes |
Description: Must be ‘object’ for tool parameters
Must be one of:
- “object”
9.1.3.2. Property PromptPack Specification > tools > additionalProperties > parameters > properties {#tools_additionalProperties_parameters_properties}
| Type | object |
| Required | Yes |
| Additional properties | Each additional property must conform to the schema |
Description: Parameter definitions
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - | No | object | No | - | - |
9.1.3.2.1. Property PromptPack Specification > tools > additionalProperties > parameters > properties > additionalProperties {#tools_additionalProperties_parameters_properties_additionalProperties}
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
9.1.3.3. Property PromptPack Specification > tools > additionalProperties > parameters > required {#tools_additionalProperties_parameters_required}
| Type | array of string |
| Required | No |
Description: List of required parameter names
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| required items | - |
9.1.3.3.1. PromptPack Specification > tools > additionalProperties > parameters > required > required items {#tools_additionalProperties_parameters_required_items}
| Type | string |
| Required | No |
10. Property PromptPack Specification > metadata {#metadata}
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
Description: Optional pack-level metadata for categorization, discovery, and operational planning.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - domain | No | string | No | - | Domain or category for this pack |
| - language | No | string | No | - | Primary language code (ISO 639-1) |
| - tags | No | array of string | No | - | Tags for categorization and discovery |
| - cost_estimate | No | object | No | - | Cost estimation for using this pack |
| - additionalProperties | No | object | No | - | - |
10.1. Property PromptPack Specification > metadata > domain {#metadata_domain}
| Type | string |
| Required | No |
Description: Domain or category for this pack
Examples:
"customer-service""healthcare""finance"10.2. Property PromptPack Specification > metadata > language {#metadata_language}
| Type | string |
| Required | No |
Description: Primary language code (ISO 639-1)
Examples:
"en""es""fr"| Restrictions | |
|---|---|
| Must match regular expression | ^[a-z]{2}$ Test |
10.3. Property PromptPack Specification > metadata > tags {#metadata_tags}
| Type | array of string |
| Required | No |
Description: Tags for categorization and discovery
Example:
[ "support", "sales", "technical"]| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| tags items | - |
10.3.1. PromptPack Specification > metadata > tags > tags items {#metadata_tags_items}
| Type | string |
| Required | No |
10.4. Property PromptPack Specification > metadata > cost_estimate {#metadata_cost_estimate}
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
Description: Cost estimation for using this pack
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - min_cost_usd | No | number | No | - | Minimum cost per execution in USD |
| - max_cost_usd | No | number | No | - | Maximum cost per execution in USD |
| - avg_cost_usd | No | number | No | - | Average cost per execution in USD |
10.4.1. Property PromptPack Specification > metadata > cost_estimate > min_cost_usd {#metadata_cost_estimate_min_cost_usd}
| Type | number |
| Required | No |
Description: Minimum cost per execution in USD
| Restrictions | |
|---|---|
| Minimum | ≥ 0 |
10.4.2. Property PromptPack Specification > metadata > cost_estimate > max_cost_usd {#metadata_cost_estimate_max_cost_usd}
| Type | number |
| Required | No |
Description: Maximum cost per execution in USD
| Restrictions | |
|---|---|
| Minimum | ≥ 0 |
10.4.3. Property PromptPack Specification > metadata > cost_estimate > avg_cost_usd {#metadata_cost_estimate_avg_cost_usd}
| Type | number |
| Required | No |
Description: Average cost per execution in USD
| Restrictions | |
|---|---|
| Minimum | ≥ 0 |
11. Property PromptPack Specification > compilation {#compilation}
| Type | object |
| Required | No |
| Additional properties | Any type allowed |
Description: Information about when and how this pack was compiled. Generated automatically by the packc compiler.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| + compiled_with | No | string | No | - | Version of the packc compiler used to create this pack |
| + created_at | No | string | No | - | ISO 8601 timestamp when the pack was compiled |
| + schema | No | string | No | - | Pack format schema version used |
| - source | No | string | No | - | Optional source configuration file path |
11.1. Property PromptPack Specification > compilation > compiled_with {#compilation_compiled_with}
| Type | string |
| Required | Yes |
Description: Version of the packc compiler used to create this pack
Examples:
"packc-v0.1.0""packc-v1.2.3"11.2. Property PromptPack Specification > compilation > created_at {#compilation_created_at}
| Type | string |
| Required | Yes |
| Format | date-time |
Description: ISO 8601 timestamp when the pack was compiled
Example:
"2025-10-31T12:00:00Z"11.3. Property PromptPack Specification > compilation > schema {#compilation_schema}
| Type | string |
| Required | Yes |
Description: Pack format schema version used
Examples:
"v1""v2"11.4. Property PromptPack Specification > compilation > source {#compilation_source}
| Type | string |
| Required | No |
Description: Optional source configuration file path
Examples:
"arena.yaml""config/prompts.yaml"Generated using json-schema-for-humans on 2025-11-15 at 16:29:33 +0000