Struct RequestOptions 

pub struct RequestOptions {
    pub headers: Option<HeaderMap>,
    pub query: Option<Vec<(String, String)>>,
    pub extra_body: Option<Value>,
    pub timeout: Option<Duration>,
}

Options that customize individual API requests.

Use with OpenAI::with_options() to create a client clone that applies these options to every request:

use openai_oxide::RequestOptions;

let custom = client.with_options(
    RequestOptions::new()
        .header("X-Custom", "value")
        .timeout(Duration::from_secs(30))
);
let response = custom.chat().completions().create(request).await?;

Fields

headers: Option<HeaderMap>

Extra headers to include in the request.

query: Option<Vec<(String, String)>>

Extra query parameters to append to the URL.

extra_body: Option<Value>

Extra JSON fields to merge into the request body (JSON requests only).

timeout: Option<Duration>

Override the request timeout.

Implementations

impl RequestOptions

pub fn new() -> Self

Create empty request options.

pub fn header(self, name: impl AsRef<str>, value: impl AsRef<str>) -> Self

Add a single header.

pub fn headers(self, headers: HeaderMap) -> Self

Set multiple headers at once (replaces any previously set headers).

pub fn query_param( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add a single query parameter.

pub fn query(self, params: Vec<(String, String)>) -> Self

Set all query parameters (replaces any previously set).

pub fn extra_body(self, value: Value) -> Self

Set extra JSON fields to merge into the request body.

pub fn timeout(self, duration: Duration) -> Self

Override the request timeout.

pub fn merge(&self, other: &RequestOptions) -> RequestOptions

Merge two options. Values from other take precedence on conflict.

pub fn is_empty(&self) -> bool

Returns true if no options are set.

Trait Implementations

impl Clone for RequestOptions

fn clone(&self) -> RequestOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestOptions

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

Formats the value using the given formatter.

impl Default for RequestOptions

fn default() -> RequestOptions

Returns the “default value” for a type.