Struct Client

pub struct Client { /* private fields */ }

The OpenAI client

Implementations

impl Client

pub fn new(client: Client, api_key: impl Into<String>) -> Self

Create a new Client client

pub fn simple() -> Result<Self>

Errors

Will return Err if no OpenAI key is defined

impl Client

pub async fn embed(&self, input: &str) -> Result<Vec<f32>>

Calls the embedding API

• turns an input str into a vector

Errors

Returns Err if there is a network error communicating to OpenAI

pub async fn raw_chat(&self, req: &ChatRequest) -> Result<ChatResponse>

Errors

Returns Err if there is a network error communicating to OpenAI

pub async fn chat(&self, req: impl Into<ChatRequest> + Send) -> Result<String>

Errors

Returns Err if there is a network error communicating to OpenAI

pub async fn stream_text( &self, req: TextRequest<'_>, ) -> Result<impl Stream<Item = Result<String>>>

Errors

Returns Err if there is a network error communicating to OpenAI

pub async fn stream_chat( &self, req: impl Into<ChatRequest> + Send, ) -> Result<impl Stream<Item = Result<String>>>

Errors

Returns Err if there is a network error communicating to OpenAI

pub async fn text(&self, request: TextRequest<'_>) -> Result<Vec<String>>

Errors

Will return Err if cannot properly contact OpenAI API.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.