Struct PromptSpec 

pub struct PromptSpec {
    pub id: String,
    pub version: String,
    pub title: Option<String>,
    pub description: Option<String>,
    pub instructions: Vec<InstructionBlock>,
    pub variables: Vec<VariableSpec>,
    pub input_schema: Option<Value>,
    pub output_schema: Option<Value>,
    pub tags: Vec<String>,
    pub metadata: BTreeMap<String, Value>,
    pub extensions: BTreeMap<String, Value>,
}

Fields

id: String

version: String

title: Option<String>

description: Option<String>

instructions: Vec<InstructionBlock>

variables: Vec<VariableSpec>

input_schema: Option<Value>

output_schema: Option<Value>

tags: Vec<String>

metadata: BTreeMap<String, Value>

extensions: BTreeMap<String, Value>

Implementations

impl PromptSpec

pub fn new( id: String, version: String, title: Option<String>, description: Option<String>, instructions: Option<&Bound<'_, PyAny>>, variables: Option<&Bound<'_, PyAny>>, input_schema: Option<&Bound<'_, PyAny>>, output_schema: Option<&Bound<'_, PyAny>>, tags: Option<&Bound<'_, PyAny>>, metadata: Option<&Bound<'_, PyAny>>, extensions: Option<&Bound<'_, PyAny>>, ) -> Result<Self, TypeError>

pub fn from_path( path: PathBuf, prompt_id: Option<String>, ) -> Result<Self, TypeError>

pub fn model_validate_json(json_string: String) -> Result<Self, TypeError>

pub fn model_dump<'py>( &self, py: Python<'py>, ) -> Result<Bound<'py, PyAny>, TypeError>

pub fn model_dump_json(&self) -> Result<String, TypeError>

pub fn __str__(&self) -> String

Trait Implementations

impl Clone for PromptSpec

fn clone(&self) -> PromptSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromptSpec

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

Formats the value using the given formatter.

impl DerefToPyAny for PromptSpec

impl<'de> Deserialize<'de> for PromptSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, 'py> FromPyObject<'a, 'py> for PromptSpec

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for PromptSpec

type Target = PromptSpec

The Python output type

type Output = Bound<'py, <PromptSpec as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PartialEq for PromptSpec

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

Equality operator ==.

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

Inequality operator !=.

impl PyClass for PromptSpec

const NAME: &str = "PromptSpec"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PromptSpec

const MODULE: Option<&str> = ::core::option::Option::None

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = c"\x00"

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<PromptSpec as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PromptSpec>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for PromptSpec

const TEXT_SIGNATURE: &'static str = "(id, version, title=None, description=None, instructions=None, variables=None, input_schema=None, output_schema=None, tags=None, metadata=None, extensions=None)"

impl PyMethods<PromptSpec> for PyClassImplCollector<PromptSpec>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PromptSpec

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for PromptSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PromptSpec