APIRequest

Struct APIRequest 

Source
pub struct APIRequest {
    pub model: String,
    pub messages: VecDeque<Message>,
    pub tools: Vec<ToolDef>,
    pub tool_choice: Value,
    pub parallel_tool_calls: Option<bool>,
    pub temperature: Option<f64>,
    pub max_completion_tokens: Option<u64>,
    pub top_p: Option<f64>,
    pub reasoning_effort: Option<String>,
    pub presence_penalty: Option<f64>,
    pub web_search_options: Option<WebSearchOptions>,
}
Expand description

API Request structure for sending prompt and function information

Fields§

§model: String

Specifies the model name

§messages: VecDeque<Message>

Array of prompt messages

§tools: Vec<ToolDef>

Defines the tools available to the model

§tool_choice: Value

Instructions for function calls:

  • “auto”: AI will make one or more function calls if needed
  • “none”: No function calls will be made
  • “required”: One or more function calls are mandatory
  • {“type”: “function”, “function”: {“name”: “<function_name>”}}: Calls the function <function_name>
§parallel_tool_calls: Option<bool>

Specifies whether to make parallel tool calls default: true

§temperature: Option<f64>

Specifies the diversity of tokens generated by the model Range: 0.0..2.0 default: 0.8 (soft specification)

§max_completion_tokens: Option<u64>

Specifies the maximum number of tokens generated by the model

§top_p: Option<f64>

Specifies the width of the probability distribution for selecting the next token Lower values result in more predictable text

§reasoning_effort: Option<String>

Specifies the level of effort for model reasoning:

  • “low”: Low effort
  • “medium”: Medium effort
  • “high”: High effort default: “medium”
§presence_penalty: Option<f64>

Specifies whether to apply a repetition penalty to the model Range: 2.0..-2.0

§web_search_options: Option<WebSearchOptions>

Options for performing web search with available models

Trait Implementations§

Source§

impl Debug for APIRequest

Source§

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

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

impl<'de> Deserialize<'de> for APIRequest

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 APIRequest

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> 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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,