ChatCompletionRequest

Struct ChatCompletionRequest 

Source
pub struct ChatCompletionRequest {
Show 21 fields pub model: String, pub messages: Vec<ChatCompletionRequestMessage>, pub frequency_penalty: Option<f32>, pub logit_bias: Option<Map<String, Value>>, pub logprobs: Option<bool>, pub top_logprobs: Option<i32>, pub max_tokens: Option<i32>, pub n: Option<i32>, pub presence_penalty: Option<f32>, pub response_format: Option<ResponseFormat>, pub seed: Option<i64>, pub stop: Option<Stop>, pub stream: Option<bool>, pub stream_options: Option<StreamOptions>, pub thinking: Option<ThinkingConfig>, pub temperature: Option<f32>, pub top_p: Option<f32>, pub tools: Option<Vec<Tool>>, pub tool_choice: Option<ToolChoice>, pub parallel_tool_calls: Option<bool>, pub user: Option<String>,
}
Expand description

Chat completion request

Fields§

§model: String

ID of the model to use

§messages: Vec<ChatCompletionRequestMessage>

A list of messages comprising the conversation

§frequency_penalty: Option<f32>

Number between -2.0 and 2.0 for frequency penalty

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

Modify the likelihood of specified tokens

§logprobs: Option<bool>

Whether to return log probabilities

§top_logprobs: Option<i32>

Number of most likely tokens to return at each position

§max_tokens: Option<i32>

Maximum number of tokens to generate

§n: Option<i32>

How many chat completion choices to generate

§presence_penalty: Option<f32>

Number between -2.0 and 2.0 for presence penalty

§response_format: Option<ResponseFormat>

Response format configuration

§seed: Option<i64>

Seed for deterministic sampling

§stop: Option<Stop>

Stop sequences

§stream: Option<bool>

Whether to stream the response

§stream_options: Option<StreamOptions>

Stream options

§thinking: Option<ThinkingConfig>

Thinking mode configuration (Claude models)

§temperature: Option<f32>

Sampling temperature (0-2)

§top_p: Option<f32>

Nucleus sampling parameter (0-1)

§tools: Option<Vec<Tool>>

List of tools the model may call

§tool_choice: Option<ToolChoice>

Controls which tool is called

§parallel_tool_calls: Option<bool>

Whether to enable parallel tool calls

§user: Option<String>

A unique identifier for the end-user

Implementations§

Source§

impl ChatCompletionRequest

Source

pub fn new( model: impl Into<String>, messages: Vec<ChatCompletionRequestMessage>, ) -> Self

Creates a new chat completion request with the minimum required fields.

§Arguments
  • model - The model ID to use (e.g., “gpt-4o”, “claude-3-5-sonnet-20241022”)
  • messages - The conversation messages
§Example
use portkey_sdk::model::{ChatCompletionRequest, ChatCompletionRequestMessage};

let request = ChatCompletionRequest::new(
    "gpt-4o",
    vec![
        ChatCompletionRequestMessage::user("Hello!"),
    ],
);

Trait Implementations§

Source§

impl Clone for ChatCompletionRequest

Source§

fn clone(&self) -> ChatCompletionRequest

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 ChatCompletionRequest

Source§

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

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

impl<'de> Deserialize<'de> for ChatCompletionRequest

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 ChatCompletionRequest

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