Struct PromptReference

pub struct PromptReference {
    pub name: String,
    pub title: Option<String>,
    /* private fields */
}

Identifies a prompt.

JSON schema

{
 "description": "Identifies a prompt.",
 "type": "object",
 "required": [
   "name",
   "type"
 ],
 "properties": {
   "name": {
     "description": "Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn't present).",
     "type": "string"
   },
   "title": {
     "description": "Intended for UI and end-user contexts — optimized to be human-readable and easily understood,\neven by those unfamiliar with domain-specific terminology.\n\nIf not provided, the name should be used for display (except for Tool,\nwhere annotations.title should be given precedence over using name,\nif present).",
     "type": "string"
   },
   "type": {
     "type": "string",
     "const": "ref/prompt"
   }
 }
}

Fields

name: String

Intended for programmatic or logical use, but used as a display name in past specs or fallback (if title isn’t present).

title: Option<String>

Intended for UI and end-user contexts — optimized to be human-readable and easily understood, even by those unfamiliar with domain-specific terminology. If not provided, the name should be used for display (except for Tool, where annotations.title should be given precedence over using name, if present).

Implementations

impl PromptReference

pub fn new(name: String, title: Option<String>) -> PromptReference

pub fn type_(&self) -> &String

pub fn type_name() -> String

Trait Implementations

impl Clone for PromptReference

fn clone(&self) -> PromptReference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromptReference

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PromptReference

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PromptReference> for CompleteRequestParamsRef

fn from(value: PromptReference) -> CompleteRequestParamsRef

Converts to this type from the input type.

impl Serialize for PromptReference

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

where __S: Serializer,

Serialize this value into the given Serde serializer.