Skip to main content

TokenCountsBodyArgs

Struct TokenCountsBodyArgs 

Source
pub struct TokenCountsBodyArgs { /* private fields */ }
Expand description

Builder for TokenCountsBody.

Implementations§

Source§

impl TokenCountsBodyArgs

Source

pub fn conversation<VALUE>(&mut self, value: VALUE) -> &mut TokenCountsBodyArgs
where VALUE: Into<ConversationParam>,

The conversation that this response belongs to. Items from this conversation are prepended to input_items for this response request. Input items and output items from this response are automatically added to this conversation after this response completes.

Source

pub fn input<VALUE>(&mut self, value: VALUE) -> &mut TokenCountsBodyArgs
where VALUE: Into<InputParam>,

Text, image, or file inputs to the model, used to generate a response

Source

pub fn instructions<VALUE>(&mut self, value: VALUE) -> &mut TokenCountsBodyArgs
where VALUE: Into<String>,

A system (or developer) message inserted into the model’s context.

When used along with previous_response_id, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses.

Source

pub fn model<VALUE>(&mut self, value: VALUE) -> &mut TokenCountsBodyArgs
where VALUE: Into<String>,

Model ID used to generate the response, like gpt-4o or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.

Source

pub fn parallel_tool_calls<VALUE>( &mut self, value: VALUE, ) -> &mut TokenCountsBodyArgs
where VALUE: Into<bool>,

Whether to allow the model to run tool calls in parallel.

Source

pub fn previous_response_id<VALUE>( &mut self, value: VALUE, ) -> &mut TokenCountsBodyArgs
where VALUE: Into<String>,

The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about conversation state. Cannot be used in conjunction with conversation.

Source

pub fn reasoning<VALUE>(&mut self, value: VALUE) -> &mut TokenCountsBodyArgs
where VALUE: Into<Reasoning>,

gpt-5 and o-series models only Configuration options for reasoning models.

Source

pub fn text<VALUE>(&mut self, value: VALUE) -> &mut TokenCountsBodyArgs
where VALUE: Into<ResponseTextParam>,

Configuration options for a text response from the model. Can be plain text or structured JSON data. Learn more:

Source

pub fn tool_choice<VALUE>(&mut self, value: VALUE) -> &mut TokenCountsBodyArgs
where VALUE: Into<ToolChoiceParam>,

How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call.

Source

pub fn tools<VALUE>(&mut self, value: VALUE) -> &mut TokenCountsBodyArgs
where VALUE: Into<Vec<Tool>>,

An array of tools the model may call while generating a response. You can specify which tool to use by setting the tool_choice parameter.

Source

pub fn truncation<VALUE>(&mut self, value: VALUE) -> &mut TokenCountsBodyArgs
where VALUE: Into<Truncation>,

The truncation strategy to use for the model response.

  • auto: If the input to this Response exceeds the model’s context window size, the model will truncate the response to fit the context window by dropping items from the beginning of the conversation.
  • disabled (default): If the input size will exceed the context window size for a model, the request will fail with a 400 error.
Source

pub fn build(&self) -> Result<TokenCountsBody, OpenAIError>

Builds a new TokenCountsBody.

§Errors

If a required field has not been initialized.

Trait Implementations§

Source§

impl Clone for TokenCountsBodyArgs

Source§

fn clone(&self) -> TokenCountsBodyArgs

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Default for TokenCountsBodyArgs

Source§

fn default() -> TokenCountsBodyArgs

Returns the “default value” for a type. 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> 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