Skip to main content

ChatCompletionCreateParams

Struct ChatCompletionCreateParams 

Source
pub struct ChatCompletionCreateParams {
Show 28 fields pub messages: Vec<Message>, pub provider: Option<Provider>, pub model: String, pub frequency_penalty: Option<f64>, pub logit_bias: Option<IndexMap<String, i64>>, pub max_completion_tokens: Option<u64>, pub presence_penalty: Option<f64>, pub stop: Option<Stop>, pub temperature: Option<f64>, pub top_p: Option<f64>, pub max_tokens: Option<u64>, pub min_p: Option<f64>, pub reasoning: Option<Reasoning>, pub repetition_penalty: Option<f64>, pub top_a: Option<f64>, pub top_k: Option<u64>, pub verbosity: Option<Verbosity>, pub logprobs: Option<bool>, pub top_logprobs: Option<u64>, pub response_format: Option<ResponseFormat>, pub seed: Option<i64>, pub tool_choice: Option<ToolChoice>, pub tools: Option<Vec<Tool>>, pub parallel_tool_calls: Option<bool>, pub prediction: Option<Prediction>, pub stream: bool, pub stream_options: StreamOptions, pub usage: Usage,
}
Expand description

Chat completion request parameters formatted for the OpenRouter API.

Combines parameters from both the Ensemble LLM configuration and the incoming request to create a complete request for OpenRouter.

Fields§

§messages: Vec<Message>

Messages for the conversation, including any prefix/suffix from the Ensemble LLM.

§provider: Option<Provider>

Provider preferences merged from request and Ensemble LLM.

§model: String

The model identifier from the Ensemble LLM.

§frequency_penalty: Option<f64>

Frequency penalty from Ensemble LLM.

§logit_bias: Option<IndexMap<String, i64>>

Logit bias from Ensemble LLM.

§max_completion_tokens: Option<u64>

Maximum completion tokens from Ensemble LLM.

§presence_penalty: Option<f64>

Presence penalty from Ensemble LLM.

§stop: Option<Stop>

Stop sequences from Ensemble LLM.

§temperature: Option<f64>

Temperature from Ensemble LLM.

§top_p: Option<f64>

Top-p (nucleus sampling) from Ensemble LLM.

§max_tokens: Option<u64>

Maximum tokens (legacy) from Ensemble LLM.

§min_p: Option<f64>

Min-p sampling from Ensemble LLM.

§reasoning: Option<Reasoning>

Reasoning configuration from Ensemble LLM.

§repetition_penalty: Option<f64>

Repetition penalty from Ensemble LLM.

§top_a: Option<f64>

Top-a sampling from Ensemble LLM.

§top_k: Option<u64>

Top-k sampling from Ensemble LLM.

§verbosity: Option<Verbosity>

Verbosity setting from Ensemble LLM.

§logprobs: Option<bool>

Whether to include log probabilities from request.

§top_logprobs: Option<u64>

Number of top log probabilities to return from request.

§response_format: Option<ResponseFormat>

Response format specification from request.

§seed: Option<i64>

Random seed from request.

§tool_choice: Option<ToolChoice>

Tool choice configuration from request.

§tools: Option<Vec<Tool>>

Available tools from request.

§parallel_tool_calls: Option<bool>

Whether to allow parallel tool calls from request.

§prediction: Option<Prediction>

Prediction hints from request.

§stream: bool

Always true for streaming requests.

§stream_options: StreamOptions

Stream options for usage inclusion.

§usage: Usage

Usage reporting options.

Implementations§

Source§

impl ChatCompletionCreateParams

Source

pub fn new_for_chat( ensemble_llm: &EnsembleLlm, request: &ChatCompletionCreateParams, ) -> Self

Creates request parameters for a chat completion.

Applies the Ensemble LLM’s prefix/suffix messages and decoding parameters.

Source

pub fn new_for_vector( vector_pfx_indices: &[(String, usize)], ensemble_llm: &EnsembleLlm, request: &VectorCompletionCreateParams, ) -> Self

Creates request parameters for a vector completion vote.

Transforms the vector completion request into a chat completion that asks the LLM to select from labeled response options.

Trait Implementations§

Source§

impl Clone for ChatCompletionCreateParams

Source§

fn clone(&self) -> ChatCompletionCreateParams

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 ChatCompletionCreateParams

Source§

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

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

impl<'de> Deserialize<'de> for ChatCompletionCreateParams

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 ChatCompletionCreateParams

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> 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> ToJmespath for T
where T: Serialize,

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