Skip to main content

CreateMessageParams

Struct CreateMessageParams 

Source
pub struct CreateMessageParams {
    pub messages: Vec<SamplingMessage>,
    pub max_tokens: u32,
    pub system_prompt: Option<String>,
    pub temperature: Option<f64>,
    pub stop_sequences: Vec<String>,
    pub model_preferences: Option<ModelPreferences>,
    pub include_context: Option<IncludeContext>,
    pub metadata: Option<Map<String, Value>>,
    pub tools: Option<Vec<SamplingTool>>,
    pub tool_choice: Option<ToolChoice>,
}
Expand description

Parameters for sampling/createMessage request

Fields§

§messages: Vec<SamplingMessage>

The messages to send to the LLM

§max_tokens: u32

Maximum number of tokens to generate

§system_prompt: Option<String>

Optional system prompt

§temperature: Option<f64>

Sampling temperature (0.0 to 1.0)

§stop_sequences: Vec<String>

Stop sequences

§model_preferences: Option<ModelPreferences>

Model preferences

§include_context: Option<IncludeContext>

Context inclusion mode

§metadata: Option<Map<String, Value>>

Additional metadata

§tools: Option<Vec<SamplingTool>>

Tools available for the model to use (SEP-1577)

§tool_choice: Option<ToolChoice>

Tool choice mode (SEP-1577)

Implementations§

Source§

impl CreateMessageParams

Source

pub fn new(messages: Vec<SamplingMessage>, max_tokens: u32) -> Self

Create a new sampling request

Source

pub fn system_prompt(self, prompt: impl Into<String>) -> Self

Set the system prompt

Source

pub fn temperature(self, temp: f64) -> Self

Set the temperature

Source

pub fn stop_sequence(self, seq: impl Into<String>) -> Self

Add a stop sequence

Source

pub fn model_preferences(self, prefs: ModelPreferences) -> Self

Set model preferences

Source

pub fn include_context(self, mode: IncludeContext) -> Self

Set context inclusion mode

Source

pub fn tools(self, tools: Vec<SamplingTool>) -> Self

Set tools available for the model to use (SEP-1577)

Source

pub fn tool_choice(self, choice: ToolChoice) -> Self

Set tool choice mode (SEP-1577)

Trait Implementations§

Source§

impl Clone for CreateMessageParams

Source§

fn clone(&self) -> CreateMessageParams

Returns a duplicate 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 CreateMessageParams

Source§

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

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

impl<'de> Deserialize<'de> for CreateMessageParams

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 Serialize for CreateMessageParams

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

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<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> 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<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>,