Struct allms::OpenAIFile

source ·

pub struct OpenAIFile {
    pub id: String,
    /* private fields */
}

👎Deprecated since 0.6.1: This struct is deprecated. Please use the assistants::OpenAIFile struct for latest functionality.

Expand description

This is a LEGACY implementation of OpenAI File API that will not be maintained going forward (after May 2024). For current implementation refer to assistants module.

Fields§

§id: String

👎Deprecated since 0.6.1: This struct is deprecated. Please use the assistants::OpenAIFile struct for latest functionality.

Implementations§

source §

impl OpenAIFile

source

pub async fn new( file_name: &str, file_bytes: Vec<u8>, open_ai_key: &str, debug: bool, ) -> Result<Self>

Examples found in repository ?

examples/deprecated_use_openai_assistant.rs (line 38)

async fn main() -> Result<()> {
    env_logger::init();
    let api_key: String = std::env::var("OPENAI_API_KEY").expect("OPENAI_API_KEY not set");
    // Read concert file
    let path = Path::new("metallica.pdf");
    let bytes = std::fs::read(path)?;
    let file_name = path
        .file_name()
        .and_then(OsStr::to_str)
        .map(|s| s.to_string())
        .ok_or_else(|| anyhow!("Failed to extract file name"))?;

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

    let bands_genres = vec![
        ("Metallica", "Metal"),
        ("The Beatles", "Rock"),
        ("Daft Punk", "Electronic"),
        ("Miles Davis", "Jazz"),
        ("Johnny Cash", "Country"),
    ];

    // Extract concert information using Assistant API
    let concert_info = OpenAIAssistant::new(OpenAIModels::Gpt4o, &api_key, true)
        .await?
        // Constructor defaults to V1
        .version(OpenAIAssistantVersion::V2)
        .set_context(
            "bands_genres",
            &bands_genres
        )
        .await?
        .get_answer::<ConcertInfo>(
            "Extract the information requested in the response type from the attached concert information.
            The response should include the genre of the music the 'band' represents.
            The mapping of bands to genres was provided in 'bands_genres' list in a previous message.",
            &[openai_file.id.clone()],
        )
        .await?;

    println!("Concert Info: {:?}", concert_info);

    //Remove the file from OpenAI
    openai_file.delete_file().await?;

    Ok(())
}

source

pub async fn delete_file(&self) -> Result<()>

Examples found in repository ?

examples/deprecated_use_openai_assistant.rs (line 69)

async fn main() -> Result<()> {
    env_logger::init();
    let api_key: String = std::env::var("OPENAI_API_KEY").expect("OPENAI_API_KEY not set");
    // Read concert file
    let path = Path::new("metallica.pdf");
    let bytes = std::fs::read(path)?;
    let file_name = path
        .file_name()
        .and_then(OsStr::to_str)
        .map(|s| s.to_string())
        .ok_or_else(|| anyhow!("Failed to extract file name"))?;

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

    let bands_genres = vec![
        ("Metallica", "Metal"),
        ("The Beatles", "Rock"),
        ("Daft Punk", "Electronic"),
        ("Miles Davis", "Jazz"),
        ("Johnny Cash", "Country"),
    ];

    // Extract concert information using Assistant API
    let concert_info = OpenAIAssistant::new(OpenAIModels::Gpt4o, &api_key, true)
        .await?
        // Constructor defaults to V1
        .version(OpenAIAssistantVersion::V2)
        .set_context(
            "bands_genres",
            &bands_genres
        )
        .await?
        .get_answer::<ConcertInfo>(
            "Extract the information requested in the response type from the attached concert information.
            The response should include the genre of the music the 'band' represents.
            The mapping of bands to genres was provided in 'bands_genres' list in a previous message.",
            &[openai_file.id.clone()],
        )
        .await?;

    println!("Concert Info: {:?}", concert_info);

    //Remove the file from OpenAI
    openai_file.delete_file().await?;

    Ok(())
}