Struct Client

Source
pub struct Client { /* private fields */ }

Implementations§

Source§

impl Client

Source

pub fn new(api_key: &str) -> Client

Examples found in repository?
examples/chat_example.rs (line 6)
5async fn main() {
6    let client = openai_rust::Client::new(&std::env::var("OPENAI_API_KEY").unwrap());
7    let args = openai_rust::chat::ChatArguments::new(
8        "gpt-3.5-turbo",
9        vec![openai_rust::chat::Message {
10            role: "user".to_owned(),
11            content: "Hello GPT!".to_owned(),
12        }],
13    );
14    let res = client.create_chat(args, None).await.unwrap();
15    println!("{}", res);
16}
More examples
Hide additional examples
examples/chat_stream_example.rs (line 8)
7async fn main() {
8    let client = openai_rust::Client::new(&std::env::var("OPENAI_API_KEY").unwrap());
9    let args = openai_rust::chat::ChatArguments::new(
10        "gpt-3.5-turbo",
11        vec![openai_rust::chat::Message {
12            role: "user".to_owned(),
13            content: "Hello GPT!".to_owned(),
14        }],
15    );
16    let mut res = client.create_chat_stream(args, None).await.unwrap();
17    while let Some(chunk) = res.next().await {
18        print!("{}", chunk.unwrap());
19        std::io::stdout().flush().unwrap();
20    }
21}
Source

pub fn new_with_client(api_key: &str, req_client: Client) -> Client

Source

pub fn new_with_base_url(api_key: &str, base_url: &str) -> Client

Source

pub fn new_with_client_and_base_url( api_key: &str, req_client: Client, base_url: &str, ) -> Client

Source

pub async fn list_models( &self, opt_url_path: Option<String>, ) -> Result<Vec<Model>, Error>

Source

pub async fn create_chat( &self, args: ChatArguments, opt_url_path: Option<String>, ) -> Result<ChatCompletion, Error>

Examples found in repository?
examples/chat_example.rs (line 14)
5async fn main() {
6    let client = openai_rust::Client::new(&std::env::var("OPENAI_API_KEY").unwrap());
7    let args = openai_rust::chat::ChatArguments::new(
8        "gpt-3.5-turbo",
9        vec![openai_rust::chat::Message {
10            role: "user".to_owned(),
11            content: "Hello GPT!".to_owned(),
12        }],
13    );
14    let res = client.create_chat(args, None).await.unwrap();
15    println!("{}", res);
16}
Source

pub async fn create_chat_stream( &self, args: ChatArguments, opt_url_path: Option<String>, ) -> Result<ChatCompletionChunkStream>

Examples found in repository?
examples/chat_stream_example.rs (line 16)
7async fn main() {
8    let client = openai_rust::Client::new(&std::env::var("OPENAI_API_KEY").unwrap());
9    let args = openai_rust::chat::ChatArguments::new(
10        "gpt-3.5-turbo",
11        vec![openai_rust::chat::Message {
12            role: "user".to_owned(),
13            content: "Hello GPT!".to_owned(),
14        }],
15    );
16    let mut res = client.create_chat_stream(args, None).await.unwrap();
17    while let Some(chunk) = res.next().await {
18        print!("{}", chunk.unwrap());
19        std::io::stdout().flush().unwrap();
20    }
21}
Source

pub async fn create_completion( &self, args: CompletionArguments, opt_url_path: Option<String>, ) -> Result<CompletionResponse>

Source

pub async fn create_embeddings( &self, args: EmbeddingsArguments, opt_url_path: Option<String>, ) -> Result<EmbeddingsResponse>

Source

pub async fn create_image_old( &self, args: ImageArguments, opt_url_path: Option<String>, ) -> Result<Vec<String>>

Source

pub async fn create_image( &self, args: ImageArguments, opt_url_path: Option<String>, ) -> Result<Vec<String>>

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,