Struct Prompt 

#[non_exhaustive]
pub struct Prompt {
    pub name: String,
    pub title: Option<String>,
    pub description: Option<String>,
    pub arguments: Option<Vec<PromptArgument>>,
    pub icons: Option<Vec<Icon>>,
    pub meta: Option<Meta>,
}

A prompt that can be used to generate text from a model

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The name of the prompt

title: Option<String>

description: Option<String>

Optional description of what the prompt does

arguments: Option<Vec<PromptArgument>>

Optional arguments that can be passed to customize the prompt

icons: Option<Vec<Icon>>

Optional list of icons for the prompt

meta: Option<Meta>

Optional additional metadata for this prompt

Implementations

impl Prompt

pub fn new<N, D>( name: N, description: Option<D>, arguments: Option<Vec<PromptArgument>>, ) -> Self

where N: Into<String>, D: Into<String>,

Create a new prompt with the given name, description and arguments

pub fn from_raw( name: impl Into<String>, description: Option<impl Into<String>>, arguments: Option<Vec<PromptArgument>>, ) -> Self

Create a new prompt from raw fields (used by the macro)

pub fn with_title(self, title: impl Into<String>) -> Self

Set the human-readable title

pub fn with_icons(self, icons: Vec<Icon>) -> Self

Set the icons

pub fn with_meta(self, meta: Meta) -> Self

Set the metadata

Trait Implementations

impl Clone for Prompt

fn clone(&self) -> Prompt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Prompt

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

Formats the value using the given formatter.

impl Default for Prompt

fn default() -> Prompt

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Prompt

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Prompt

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Prompt

fn eq(&self, other: &Prompt) -> 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 Prompt

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 Prompt