Chat

Struct Chat 

Source
pub struct Chat { /* private fields */ }

Implementations§

Source§

impl Chat

Source

pub fn new<T>(model: T) -> Self
where T: Into<String>,

Creates a new Chat with the selected model.

§Example
use rustylms::{
    chat::Chat,
    lmsserver::LMSServer
};

let server = LMSServer::new("http://localhost:1234");
let chat = Chat::new("model-name").system_prompt("You are a helpful assistant.").user_prompt("Why does iron rust?");
let completion = chat.get_completions(&server).await.expect("Could not get completions");

println!("From assistant: {}", completion.get_message().unwrap().content);
Source

pub fn temperature(self, temperature: f32) -> Self

Sets the temperature of the model. The default value for this is 0.7.

Source

pub fn max_tokens(self, max_tokens: i32) -> Self

Sets the maximum tokens a completion can generate. The default value is -1 meaning no limit.

Source

pub fn system_prompt<T>(self, system_prompt: T) -> Self
where T: Into<String>,

This function adds a system prompt to the messages.

NOTE: This function doesn’t clear the messages array before adding the system prompt!

Source

pub fn user_prompt<T>(self, user_prompt: T) -> Self
where T: Into<String>,

This function adds a user prompt to the messages.

NOTE: This function doesn’t clear the messages array before adding the user prompt!

Source

pub fn clear_messages(&mut self)

Clears all messages in the chat including system prompts.

Source

pub fn add_message(&mut self, message: Message)

Adds the provided Message to the chat.

Source

pub fn add_system_message<T>(&mut self, message: T)
where T: Into<String>,

Adds the provided message content as a system message.

Source

pub fn add_assistant_message<T>(&mut self, message: T)
where T: Into<String>,

Adds the provided message content as a message from the assistant.

Source

pub fn add_user_message<T>(&mut self, message: T)
where T: Into<String>,

Adds the provided message content as a message from the user.

Source

pub async fn get_completions( &self, server: &LMSServer, ) -> Result<ChatCompletionsResponse>

Gets the completion from the server by sending the current Chat struct.

Trait Implementations§

Source§

impl Debug for Chat

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Chat

§

impl RefUnwindSafe for Chat

§

impl Send for Chat

§

impl Sync for Chat

§

impl Unpin for Chat

§

impl UnwindSafe for Chat

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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<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