Skip to main content

Frontmatter

Struct Frontmatter 

Source
pub struct Frontmatter {
    pub id: Option<String>,
    pub version: Option<String>,
    pub description: Option<String>,
    pub model: Option<ModelHints>,
    pub input: Option<InputSpec>,
    pub output: Option<OutputSpec>,
    pub evals: Option<Vec<Eval>>,
    pub intentry: Option<IntrEntryMeta>,
    pub extra: HashMap<String, Value>,
}
Expand description

YAML frontmatter between --- fences.

Fields follow the Dotprompt spec + Intentry extensions under the intentry: key.

Fields§

§id: Option<String>

Stable kebab-case identifier, unique within a Space. Max 64 chars. Required for Tier 2+.

§version: Option<String>

Semver version string (e.g. "1.2.0"). Required for Tier 2+.

§description: Option<String>

One-line human description of what the prompt does.

§model: Option<ModelHints>

Model preferences and generation parameters.

§input: Option<InputSpec>

Input variable declarations.

§output: Option<OutputSpec>

Output shape expectations (for evals and schema validation).

§evals: Option<Vec<Eval>>

Eval cases. Presence of this field (non-empty) promotes to Tier 3.

§intentry: Option<IntrEntryMeta>

Intentry-specific extensions (tags, license, parent fork info, etc.).

§extra: HashMap<String, Value>

Any unknown fields are preserved as raw JSON for forward-compatibility.

Trait Implementations§

Source§

impl Clone for Frontmatter

Source§

fn clone(&self) -> Frontmatter

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Frontmatter

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Frontmatter

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Frontmatter

Source§

fn eq(&self, other: &Frontmatter) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for Frontmatter

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Frontmatter

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,