Struct OpenAI

Source
pub struct OpenAI { /* private fields */ }
Expand description

Chat Completions API

Chat models take a list of messages as input and return a model-generated message as output. Although the chat format is designed to make multi-turn conversations easy, it’s just as useful for single-turn tasks without any conversation.

Implementations§

Source§

impl OpenAI

Source

pub fn new( open_ai_key: &str, model: OpenAIModels, max_tokens: Option<usize>, temperature: Option<u32>, ) -> Self

Examples found in repository?
examples/use_openai.rs (line 21)
16async fn main() {
17    env_logger::init();
18    let api_key: String = std::env::var("OPENAI_API_KEY").expect("OPENAI_API_KEY not set");
19    let model = OpenAIModels::Gpt3_5Turbo; // Choose the model
20
21    let open_ai = OpenAI::new(&api_key, model, None, None);
22
23    // Example context and instructions
24    let instructions =
25        "Translate the following English text to all the languages in the response type";
26
27    match open_ai
28        .get_answer::<TranslationResponse>(instructions)
29        .await
30    {
31        Ok(response) => println!("Response: {:?}", response),
32        Err(e) => eprintln!("Error: {:?}", e),
33    }
34}
Source

pub fn debug(self) -> Self

Source

pub fn function_calling(self, function_call: bool) -> Self

Source

pub fn set_context<T: Serialize>( self, input_name: &str, input_data: &T, ) -> Result<Self>

Source

pub fn check_prompt_tokens<T: JsonSchema + DeserializeOwned>( &self, instructions: &str, ) -> Result<usize>

Source

pub async fn get_answer<T: JsonSchema + DeserializeOwned>( self, instructions: &str, ) -> Result<T>

Examples found in repository?
examples/use_openai.rs (line 28)
16async fn main() {
17    env_logger::init();
18    let api_key: String = std::env::var("OPENAI_API_KEY").expect("OPENAI_API_KEY not set");
19    let model = OpenAIModels::Gpt3_5Turbo; // Choose the model
20
21    let open_ai = OpenAI::new(&api_key, model, None, None);
22
23    // Example context and instructions
24    let instructions =
25        "Translate the following English text to all the languages in the response type";
26
27    match open_ai
28        .get_answer::<TranslationResponse>(instructions)
29        .await
30    {
31        Ok(response) => println!("Response: {:?}", response),
32        Err(e) => eprintln!("Error: {:?}", e),
33    }
34}

Auto Trait Implementations§

§

impl Freeze for OpenAI

§

impl RefUnwindSafe for OpenAI

§

impl Send for OpenAI

§

impl Sync for OpenAI

§

impl Unpin for OpenAI

§

impl UnwindSafe for OpenAI

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,

Source§

impl<T> MaybeSendSync for T