Skip to main content

LanguageModelCallOptions

Struct LanguageModelCallOptions 

Source
pub struct LanguageModelCallOptions {
Show 17 fields pub prompt: LanguageModelPrompt, pub stream: Option<bool>, pub max_output_tokens: Option<u32>, pub temperature: Option<f32>, pub top_p: Option<f32>, pub top_k: Option<u32>, pub stop_sequences: Option<Vec<String>>, pub presence_penalty: Option<f32>, pub frequency_penalty: Option<f32>, pub response_format: Option<LanguageModelResponseFormat>, pub seed: Option<u64>, pub tools: Option<Vec<LanguageModelTool>>, pub tool_choice: Option<LanguageModelToolChoice>, pub include_raw_chunks: Option<bool>, pub abort_signal: Option<CancellationToken>, pub headers: Option<HeaderMap>, pub provider_options: Option<ProviderOptions>,
}
Expand description

Options for calling a language model

Fields§

§prompt: LanguageModelPrompt

The prompt to send to the language model, which is a sequence of messages from the system, user, assistant, and tools

§stream: Option<bool>

Whether to stream the response as it’s generated, or return it all at once when complete

§max_output_tokens: Option<u32>

The maximum number of tokens to generate in the response

§temperature: Option<f32>

Sampling temperature to use, between 0 and 1

§top_p: Option<f32>

Top-p (nucleus) sampling probability

§top_k: Option<u32>

Top-k sampling

§stop_sequences: Option<Vec<String>>

Stop sequences to end generation when encountered

§presence_penalty: Option<f32>

Presence penalty to penalize new tokens based on whether they appear in the prompt

§frequency_penalty: Option<f32>

Frequency penalty to penalize new tokens based on their frequency in the prompt

§response_format: Option<LanguageModelResponseFormat>

The format of the response

§seed: Option<u64>

Seed for random number generation

§tools: Option<Vec<LanguageModelTool>>

Tools available to the language model

§tool_choice: Option<LanguageModelToolChoice>

The tool choice strategy to use when the model calls a tool

§include_raw_chunks: Option<bool>

Whether to include raw chunks in the response

§abort_signal: Option<CancellationToken>

Signal to abort the request

§headers: Option<HeaderMap>

Custom headers to include in the request

§provider_options: Option<ProviderOptions>

Provider-specific options that can be used to pass additional information to the provider or control provider-specific behavior

Trait Implementations§

Source§

impl Clone for LanguageModelCallOptions

Source§

fn clone(&self) -> LanguageModelCallOptions

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 LanguageModelCallOptions

Source§

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

Formats the value using the given formatter. 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, 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.