axiom
Version:
Axiom AI SDK provides - an API to wrap your AI calls with observability instrumentation. - offline evals - online evals
91 lines (46 loc) • 1.42 kB
Markdown
[**axiom v0.51.1**](../../README.md)
***
[axiom](../../README.md) / [index](../README.md) / experimental\_Prompt
Type Alias: experimental\_Prompt
**experimental\_Prompt** = `object`
**`Experimental`**
Complete prompt definition with all metadata and versioning information.
Extended version of PromptInput with additional versioning and identification.
Used with parse to process templates and generate ParsedMessagesArray.
This API is experimental and may change in future versions.
# Properties
## arguments
**arguments**: `Record`\<`string`, [`experimental_TSchema`](experimental_TSchema.md)\>
[TSchema](experimental_TSchema.md) format arguments for API communication
***
## description?
`optional` **description**: `string`
Optional description of the prompt's purpose
***
## messages
**messages**: `PromptMessage`[]
Array of messages that make up the conversation
***
## model
**model**: `string`
The language model to use for this prompt
***
## name
**name**: `string`
Human-readable name for the prompt
***
## options?
`optional` **options**: `ModelParams`
Optional generation parameters
***
## promptId?
`optional` **promptId**: `string`
Optional unique identifier for the prompt
***
## slug
**slug**: `string`
Immutable user-defined identifier for the prompt
***
## version
**version**: `string`
Version identifier for the prompt