Struct Prompt 

pub struct Prompt {
    pub instruction: PromptInput,
}

User input for one agent turn.

Session policy such as the filesystem workspace belongs to the agent builder rather than an individual prompt.

Examples

use nanocodex_oai_api::{ImageDetail, Prompt, UserInput};

let prompt = Prompt::content([
    UserInput::Text {
        text: "Describe the deployment diagram.".to_owned(),
    },
    UserInput::Image {
        image_url: "https://example.com/deployment.png".to_owned(),
        detail: Some(ImageDetail::High),
    },
]);

assert!(!prompt.instruction.is_empty());

Fields

instruction: PromptInput

Ordered text and multimodal content for this turn.

Implementations

impl Prompt

pub fn new(instruction: impl Into<String>) -> Prompt

Creates a text-only prompt.

pub fn content(input: impl IntoIterator<Item = UserInput>) -> Prompt

Creates a prompt from ordered content items.

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<(), Error>

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for Prompt

fn from(instruction: &str) -> Prompt

Converts to this type from the input type.

impl From<String> for Prompt

fn from(instruction: String) -> Prompt

Converts to this type from the input type.

impl Serialize for Prompt

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.