Struct Message

Source
pub struct Message { /* private fields */ }
Expand description

An individual message in a chat.

Implementations§

Source§

impl Message

Source

pub fn system(content: &str) -> Self

Create a new system message.

System messages are used to provide instructions to the model. It’s not recommended to use more than one of these in a given chat.

Examples found in repository?
examples/text_generation_pipeline_with_messages.rs (line 16)
5fn main() -> Result<()> {
6    println!("Building pipeline...");
7
8    // 1. Create the pipeline, using the builder to configure the model
9    let pipeline = TextGenerationPipelineBuilder::new(ModelOptions::Phi4(Phi4Size::Size14B))
10        .temperature(0.7)
11        .build()?;
12    println!("Pipeline built successfully.");
13
14    // 2. Define messages and max length
15    let mut messages = vec![
16        Message::system("You are a helpful pirate assistant."),
17        Message::user("Explain the concept of Large Language Models in simple terms."),
18    ];
19    let max_length = 500; // Maximum number of tokens to generate
20
21    // Get the last user message in the messages vector
22    let prompt = messages
23        .iter()
24        .rev()
25        .find(|message| message.role() == "user")
26        .unwrap()
27        .content();
28
29    println!("Generating text for prompt: '{}'", prompt);
30
31    // 3. Generate text
32    let generated_text = pipeline.message_completion(messages.clone(), max_length)?;
33
34    println!("\n--- Generated Text ---");
35    println!("{}", generated_text);
36    println!("--- End of Text ---\n");
37
38    // Add the models response to the messages
39    messages.push(Message::assistant(generated_text.as_str()));
40
41    messages.push(Message::user(
42        "Explain the fibonacci sequence in simple terms. /no_think",
43    ));
44
45    let generated_text = pipeline.message_completion(messages, max_length)?;
46
47    println!("\n--- Generated Text 2 ---");
48    println!("{}", generated_text);
49    println!("--- End of Text 2 ---");
50
51    Ok(())
52}
Source

pub fn user(content: &str) -> Self

Create a new user message.

User messages are used to send messages from the user to the model.

Examples found in repository?
examples/text_generation_pipeline_with_messages.rs (line 17)
5fn main() -> Result<()> {
6    println!("Building pipeline...");
7
8    // 1. Create the pipeline, using the builder to configure the model
9    let pipeline = TextGenerationPipelineBuilder::new(ModelOptions::Phi4(Phi4Size::Size14B))
10        .temperature(0.7)
11        .build()?;
12    println!("Pipeline built successfully.");
13
14    // 2. Define messages and max length
15    let mut messages = vec![
16        Message::system("You are a helpful pirate assistant."),
17        Message::user("Explain the concept of Large Language Models in simple terms."),
18    ];
19    let max_length = 500; // Maximum number of tokens to generate
20
21    // Get the last user message in the messages vector
22    let prompt = messages
23        .iter()
24        .rev()
25        .find(|message| message.role() == "user")
26        .unwrap()
27        .content();
28
29    println!("Generating text for prompt: '{}'", prompt);
30
31    // 3. Generate text
32    let generated_text = pipeline.message_completion(messages.clone(), max_length)?;
33
34    println!("\n--- Generated Text ---");
35    println!("{}", generated_text);
36    println!("--- End of Text ---\n");
37
38    // Add the models response to the messages
39    messages.push(Message::assistant(generated_text.as_str()));
40
41    messages.push(Message::user(
42        "Explain the fibonacci sequence in simple terms. /no_think",
43    ));
44
45    let generated_text = pipeline.message_completion(messages, max_length)?;
46
47    println!("\n--- Generated Text 2 ---");
48    println!("{}", generated_text);
49    println!("--- End of Text 2 ---");
50
51    Ok(())
52}
Source

pub fn assistant(content: &str) -> Self

Create a new assistant message.

Assistant messages are used to store responses from the model.

Examples found in repository?
examples/text_generation_pipeline_with_messages.rs (line 39)
5fn main() -> Result<()> {
6    println!("Building pipeline...");
7
8    // 1. Create the pipeline, using the builder to configure the model
9    let pipeline = TextGenerationPipelineBuilder::new(ModelOptions::Phi4(Phi4Size::Size14B))
10        .temperature(0.7)
11        .build()?;
12    println!("Pipeline built successfully.");
13
14    // 2. Define messages and max length
15    let mut messages = vec![
16        Message::system("You are a helpful pirate assistant."),
17        Message::user("Explain the concept of Large Language Models in simple terms."),
18    ];
19    let max_length = 500; // Maximum number of tokens to generate
20
21    // Get the last user message in the messages vector
22    let prompt = messages
23        .iter()
24        .rev()
25        .find(|message| message.role() == "user")
26        .unwrap()
27        .content();
28
29    println!("Generating text for prompt: '{}'", prompt);
30
31    // 3. Generate text
32    let generated_text = pipeline.message_completion(messages.clone(), max_length)?;
33
34    println!("\n--- Generated Text ---");
35    println!("{}", generated_text);
36    println!("--- End of Text ---\n");
37
38    // Add the models response to the messages
39    messages.push(Message::assistant(generated_text.as_str()));
40
41    messages.push(Message::user(
42        "Explain the fibonacci sequence in simple terms. /no_think",
43    ));
44
45    let generated_text = pipeline.message_completion(messages, max_length)?;
46
47    println!("\n--- Generated Text 2 ---");
48    println!("{}", generated_text);
49    println!("--- End of Text 2 ---");
50
51    Ok(())
52}
Source

pub fn role(&self) -> &str

Get the role of the message.

Examples found in repository?
examples/text_generation_pipeline_with_messages.rs (line 25)
5fn main() -> Result<()> {
6    println!("Building pipeline...");
7
8    // 1. Create the pipeline, using the builder to configure the model
9    let pipeline = TextGenerationPipelineBuilder::new(ModelOptions::Phi4(Phi4Size::Size14B))
10        .temperature(0.7)
11        .build()?;
12    println!("Pipeline built successfully.");
13
14    // 2. Define messages and max length
15    let mut messages = vec![
16        Message::system("You are a helpful pirate assistant."),
17        Message::user("Explain the concept of Large Language Models in simple terms."),
18    ];
19    let max_length = 500; // Maximum number of tokens to generate
20
21    // Get the last user message in the messages vector
22    let prompt = messages
23        .iter()
24        .rev()
25        .find(|message| message.role() == "user")
26        .unwrap()
27        .content();
28
29    println!("Generating text for prompt: '{}'", prompt);
30
31    // 3. Generate text
32    let generated_text = pipeline.message_completion(messages.clone(), max_length)?;
33
34    println!("\n--- Generated Text ---");
35    println!("{}", generated_text);
36    println!("--- End of Text ---\n");
37
38    // Add the models response to the messages
39    messages.push(Message::assistant(generated_text.as_str()));
40
41    messages.push(Message::user(
42        "Explain the fibonacci sequence in simple terms. /no_think",
43    ));
44
45    let generated_text = pipeline.message_completion(messages, max_length)?;
46
47    println!("\n--- Generated Text 2 ---");
48    println!("{}", generated_text);
49    println!("--- End of Text 2 ---");
50
51    Ok(())
52}
Source

pub fn content(&self) -> &str

Get the content of the message.

Examples found in repository?
examples/text_generation_pipeline_with_messages.rs (line 27)
5fn main() -> Result<()> {
6    println!("Building pipeline...");
7
8    // 1. Create the pipeline, using the builder to configure the model
9    let pipeline = TextGenerationPipelineBuilder::new(ModelOptions::Phi4(Phi4Size::Size14B))
10        .temperature(0.7)
11        .build()?;
12    println!("Pipeline built successfully.");
13
14    // 2. Define messages and max length
15    let mut messages = vec![
16        Message::system("You are a helpful pirate assistant."),
17        Message::user("Explain the concept of Large Language Models in simple terms."),
18    ];
19    let max_length = 500; // Maximum number of tokens to generate
20
21    // Get the last user message in the messages vector
22    let prompt = messages
23        .iter()
24        .rev()
25        .find(|message| message.role() == "user")
26        .unwrap()
27        .content();
28
29    println!("Generating text for prompt: '{}'", prompt);
30
31    // 3. Generate text
32    let generated_text = pipeline.message_completion(messages.clone(), max_length)?;
33
34    println!("\n--- Generated Text ---");
35    println!("{}", generated_text);
36    println!("--- End of Text ---\n");
37
38    // Add the models response to the messages
39    messages.push(Message::assistant(generated_text.as_str()));
40
41    messages.push(Message::user(
42        "Explain the fibonacci sequence in simple terms. /no_think",
43    ));
44
45    let generated_text = pipeline.message_completion(messages, max_length)?;
46
47    println!("\n--- Generated Text 2 ---");
48    println!("{}", generated_text);
49    println!("--- End of Text 2 ---");
50
51    Ok(())
52}

Trait Implementations§

Source§

impl Clone for Message

Source§

fn clone(&self) -> Message

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Message

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Message

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Message

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for Message

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for Message

Source§

impl StructuralPartialEq for Message

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T