Struct openai_api::OpenAIClient

pub struct OpenAIClient { /* fields omitted */ }

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

Implementations

impl OpenAIClient

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

Creates a new OpenAIClient given an api token

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

Lists the currently available engines.

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

Errors

• OpenAIError::APIError if the server returns an error

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

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

Errors

• OpenAIError::APIError if the server returns an error

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

Get predicted completion of the prompt

Errors

• OpenAIError::APIError if the api returns an error