Struct Options 

pub struct Options {
    pub token: String,
    pub body: Option<String>,
    pub domain: String,
    pub identifier: Option<String>,
    pub after: Option<String>,
    pub limit: Option<u32>,
    pub order: Option<String>,
    pub model: Option<String>,
    pub custom_params: Vec<Param>,
}

OpenAI API options

Configuration options used across OpenAI API operations.

Fields

token: String

Bearer token for authentication

body: Option<String>

Request body payload for POST requests

domain: String

OpenAI API domain (defaults to api.openai.com)

identifier: Option<String>

Optional model identifier for model retrieval

after: Option<String>

Optional cursor for paginated list APIs

limit: Option<u32>

Optional page size for list APIs

order: Option<String>

Optional ordering value for list APIs (for example, asc or desc)

model: Option<String>

Optional model filter used by selected list APIs

custom_params: Vec<Param>

Custom API parameters to include in every request

Implementations

impl Options

pub fn with_token(token: impl Into<String>) -> OptionsBuilder

Create an instance of Options using the builder syntax

impl Options

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

Return a copy of options with list cursor set

pub fn with_limit(self, value: u32) -> Self

Return a copy of options with page size set

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

Return a copy of options with model filter set

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

Return a copy of options with order value set

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configuration for Options

fn from_env() -> Self

Build options from OpenAI-related environment variables.

• OPENAI_API_KEY -> token (defaults to empty string when unset)
• OPENAI_SERVER_HOST -> domain (defaults to api.openai.com when unset)

fn with_body(self, value: impl Into<String>) -> Self

Return a copy of options with request body payload set

fn with_domain(self, value: impl Into<String>) -> Self

Return a copy of options with OpenAI server domain set

fn with_identifier(self, value: impl Into<String>) -> Self

Return a copy of options with model identifier set

fn token(&self) -> &str

Return the authentication token

fn domain(&self) -> &str

Return the OpenAI server domain

fn identifier(&self) -> Option<&str>

Return the optional model identifier

fn with_params(self, params: Vec<Param>) -> Self

Return a copy of options with custom API parameters set

fn params(&self) -> &[Param]

Return any custom API parameters

impl Debug for Options

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

Formats the value using the given formatter.