Struct Prompt 

pub struct Prompt { /* private fields */ }

A FoundationModels prompt.

Implementations

impl Prompt

pub const fn new() -> Self

Create an empty prompt.

pub fn text(text: impl Into<String>) -> Self

Create a prompt from a single text segment.

pub fn structured(content: GeneratedContent) -> Self

Create a prompt from a structured content segment.

pub fn push_text(&mut self, text: impl Into<String>)

Append a text segment.

pub fn push_structured( &mut self, source: impl Into<String>, content: GeneratedContent, )

Append a structured content segment.

pub fn segments(&self) -> &[Segment]

Borrow the prompt segments.

pub fn into_segments(self) -> Vec<Segment>

Consume the prompt and return its segments.

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 From<&str> for Prompt

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<GeneratedContent> for Prompt

fn from(content: GeneratedContent) -> Self

Converts to this type from the input type.

impl From<Prompt> for ToolOutput

fn from(value: Prompt) -> Self

Converts to this type from the input type.

impl From<String> for Prompt

fn from(text: String) -> Self

Converts to this type from the input type.

impl From<Vec<Segment>> for Prompt

fn from(segments: Vec<Segment>) -> Self

Converts to this type from the input type.

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 ToPrompt for &Prompt

fn to_prompt(self) -> Result<Prompt, FMError>

Convert the value into a prompt.

impl ToPrompt for Prompt

fn to_prompt(self) -> Result<Prompt, FMError>

Convert the value into a prompt.

impl StructuralPartialEq for Prompt