Struct PromptDescriptor 

pub struct PromptDescriptor {
    pub id: PromptId,
    pub name: String,
    pub description: Option<String>,
    pub input_schema: Value,
    pub metadata: MetadataMap,
}

Describes a prompt template that a PromptProvider can render.

Prompt descriptors are returned by PromptProvider::list_prompts so the host can discover available templates and present them to the user or model.

Fields

id: PromptId

Unique identifier used to request this prompt.

name: String

A short, human-readable name for the prompt.

description: Option<String>

An optional longer description of when or why to use the prompt.

input_schema: Value

A JSON Schema describing the arguments the prompt template accepts.

metadata: MetadataMap

Arbitrary key-value metadata attached to the descriptor.

Implementations

impl PromptDescriptor

pub fn new( id: impl Into<PromptId>, name: impl Into<String>, input_schema: Value, ) -> Self

Builds a prompt descriptor with no description and empty metadata.

pub fn with_description(self, description: impl Into<String>) -> Self

Sets the description.

pub fn with_metadata(self, metadata: MetadataMap) -> Self

Replaces the descriptor metadata.

Trait Implementations

impl Clone for PromptDescriptor

fn clone(&self) -> PromptDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromptDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PromptDescriptor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PromptDescriptor

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for PromptDescriptor

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 PromptDescriptor