Struct openai_api::Client

pub struct Client { /* fields omitted */ }

Client object. Must be constructed to talk to the API.

Implementations

impl Client

#[must_use]pub fn new(token: &str) -> Self

pub async fn engines<'_>(&'_ self) -> Result<Vec<EngineInfo>, Error>

Lists the currently available engines.

Provides basic information about each one such as the owner and availability.

Errors

• Error::APIError if the server returns an error

pub fn engines_sync(&self) -> Result<Vec<EngineInfo>, Error>

Lists the currently available engines.

Provides basic information about each one such as the owner and availability.

Errors

• Error::APIError if the server returns an error

pub async fn engine<'_>(&'_ self, engine: Engine) -> Result<EngineInfo, Error>

Retrieves an engine instance

Provides basic information about the engine such as the owner and availability.

Errors

• Error::APIError if the server returns an error

pub fn engine_sync(&self, engine: Engine) -> Result<EngineInfo, Error>

pub async fn complete_prompt<'_>(
    &'_ self,
    prompt: impl Into<CompletionArgs>
) -> Result<Completion, Error>

Get predicted completion of the prompt

Errors

• Error::APIError if the api returns an error

pub fn complete_prompt_sync(
    &self,
    prompt: impl Into<CompletionArgs>
) -> Result<Completion, Error>

Get predicted completion of the prompt synchronously

Error

• Error::APIError if the api returns an error

Trait Implementations

impl Clone for Client

pub fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.