Struct OpenAICompatibleClient

pub struct OpenAICompatibleClient { /* private fields */ }

A client for making requests to an OpenAI compatible API.

Implementations

impl OpenAICompatibleClient

pub fn new() -> Self

Create a new client.

pub fn with_api_key(self, api_key: impl ToString) -> Self

Sets the API key for the builder. (defaults to the environment variable OPENAI_API_KEY)

The API key can be accessed from the OpenAI dashboard here.

pub fn with_base_url(self, base_url: impl ToString) -> Self

Set the base URL of the API. (defaults to https://api.openai.com/v1/)

pub fn with_organization_id(self, organization_id: impl ToString) -> Self

Set the organization ID for the builder.

The organization ID can be accessed from the OpenAI dashboard here.

pub fn with_project_id(self, project_id: impl ToString) -> Self

Set the project ID for the builder.

The project ID can be accessed from the OpenAI dashboard here.

pub fn with_reqwest_client(self, client: Client) -> Self

Set the reqwest client for the builder.

pub fn resolve_api_key(&self) -> Result<String, NoOpenAIAPIKeyError>

Resolve the openai API key from the environment variable OPENAI_API_KEY or the provided api key.

Trait Implementations

impl Clone for OpenAICompatibleClient

fn clone(&self) -> OpenAICompatibleClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAICompatibleClient

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

Formats the value using the given formatter.

impl Default for OpenAICompatibleClient

fn default() -> Self

Returns the “default value” for a type.