Struct Signature 

pub struct Signature { /* private fields */ }

A signature defines the input/output contract for a prediction.

Build with Signature::builder. Field ordering is preserved and deterministic.

Implementations

impl Signature

pub fn builder(instructions: impl Into<String>) -> SignatureBuilder

Create a builder for constructing a signature.

pub fn instructions(&self) -> &str

The task instructions that guide the language model.

pub fn input_fields(&self) -> impl Iterator<Item = &FieldDef>

Iterate over input fields in declaration order.

pub fn output_fields(&self) -> impl Iterator<Item = &FieldDef>

Iterate over output fields in declaration order.

pub fn fields(&self) -> &[FieldDef]

All fields in declaration order.

pub fn dump_state(&self) -> Result<String>

Serialize this signature to a JSON string.

Errors

Returns a PredictError wrapping a serde_json error if serialization fails (not expected for valid Signature values).

pub fn set_instructions(&mut self, instructions: impl Into<String>)

Update the task instructions.

pub fn with_prepended_output(&self, field: FieldDef) -> Self

Return a new signature with an output field prepended before existing outputs.

Used by Predict::chain_of_thought to inject a reasoning field ahead of the declared outputs.

pub fn load_state(json: &str) -> Result<Self>

Deserialize a signature from a JSON string.

Errors

Returns a PredictError when the JSON is malformed or describes a signature with no input or output fields.

Trait Implementations

impl Clone for Signature

fn clone(&self) -> Signature

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Signature

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Signature

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Signature

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

where __S: Serializer,

Serialize this value into the given Serde serializer.