Struct openai_safe::OpenAIAssistant

pub struct OpenAIAssistant { /* private fields */ }

OpenAI Docs

The Assistants API allows you to build AI assistants within your own applications. An Assistant has instructions and can leverage models, tools, and knowledge to respond to user queries. The Assistants API currently supports three types of tools: Code Interpreter, Retrieval, and Function calling. In the future, we plan to release more OpenAI-built tools, and allow you to provide your own tools on our platform.

Implementations

impl OpenAIAssistant

pub async fn new( model: OpenAIModels, open_ai_key: &str, debug: bool ) -> Result<Self>

Examples found in repository

examples/use_openai_assistant.rs (line 31)

async fn main() -> Result<()> {
    env_logger::init();
    let api_key: String = std::env::var("OPENAI_API_KEY").expect("OPENAI_API_KEY not set");
    // Read invoice file
    let path = Path::new("examples/sample-bill.pdf");
    let bytes = std::fs::read(path)?;

    let openai_file = OpenAIFile::new(bytes, &api_key, true).await?;

    // Extract invoice detail using Assistant API
    let invoice = OpenAIAssistant::new(OpenAIModels::Gpt4Turbo, &api_key, true)
        .await?
        .get_answer::<Invoice>(
            "Extract the following information from the attached invoice: invoice number, vendor name, payment amount, payment date.",
            &[openai_file.id],
        )
        .await?;

    println!("Invoice: {:?}", invoice);
    Ok(())
}

pub async fn get_answer<T: JsonSchema + DeserializeOwned>( self, message: &str, file_ids: &[String] ) -> Result<T>

Examples found in repository

examples/use_openai_assistant.rs (lines 33-36)

async fn main() -> Result<()> {
    env_logger::init();
    let api_key: String = std::env::var("OPENAI_API_KEY").expect("OPENAI_API_KEY not set");
    // Read invoice file
    let path = Path::new("examples/sample-bill.pdf");
    let bytes = std::fs::read(path)?;

    let openai_file = OpenAIFile::new(bytes, &api_key, true).await?;

    // Extract invoice detail using Assistant API
    let invoice = OpenAIAssistant::new(OpenAIModels::Gpt4Turbo, &api_key, true)
        .await?
        .get_answer::<Invoice>(
            "Extract the following information from the attached invoice: invoice number, vendor name, payment amount, payment date.",
            &[openai_file.id],
        )
        .await?;

    println!("Invoice: {:?}", invoice);
    Ok(())
}

Trait Implementations

impl Clone for OpenAIAssistant

fn clone(&self) -> OpenAIAssistant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAIAssistant

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpenAIAssistant

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OpenAIAssistant

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.