openai_dive 1.4.3

OpenAI Dive is an unofficial async Rust library that allows you to interact with the OpenAI API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

use crate::v1::{
    api::Client,
    error::APIError,
    helpers::format_response,
    resources::{
        shared::{DeletedObject, ListParameters, ListResponse},
        vector_store_file::{CreateVectorStoreFileParameters, VectorStoreFile},
    },
};

pub struct VectorStoreFiles<'a> {
    pub client: &'a Client,
}

impl Client {
    /// Vector store files represent files inside a vector store.
    pub fn vector_store_files(&self) -> VectorStoreFiles<'_> {
        VectorStoreFiles { client: self }
    }
}

impl VectorStoreFiles<'_> {
    /// Create a vector store file by attaching a File to a vector store.
    pub async fn create(
        &self,
        vector_store_id: &str,
        parameters: CreateVectorStoreFileParameters,
    ) -> Result<VectorStoreFile, APIError> {
        let response = self
            .client
            .post(
                &format!("/vector_stores/{vector_store_id}/files"),
                &parameters,
                None,
            )
            .await?;

        let response: VectorStoreFile = format_response(response.data)?;

        Ok(response)
    }

    /// Returns a list of vector store files.
    pub async fn list(
        &self,
        vector_store_id: &str,
        query: Option<ListParameters>,
    ) -> Result<ListResponse<VectorStoreFile>, APIError> {
        let response = self
            .client
            .get_with_query(&format!("/vector_stores/{vector_store_id}/files"), &query)
            .await?;

        let response: ListResponse<VectorStoreFile> = format_response(response)?;

        Ok(response)
    }

    /// Retrieves a vector store.
    pub async fn retrieve(
        &self,
        vector_store_id: &str,
        vector_store_file_id: &str,
    ) -> Result<VectorStoreFile, APIError> {
        let response = self
            .client
            .get(&format!(
                "/vector_stores/{vector_store_id}/files/{vector_store_file_id}"
            ))
            .await?;

        let response: VectorStoreFile = format_response(response)?;

        Ok(response)
    }

    /// Delete a vector store file.
    pub async fn delete(
        &self,
        vector_store_id: &str,
        vector_store_file_id: &str,
    ) -> Result<DeletedObject, APIError> {
        let response = self
            .client
            .delete(&format!(
                "/vector_stores/{vector_store_id}/files/{vector_store_file_id}"
            ))
            .await?;

        let response: DeletedObject = format_response(response)?;

        Ok(response)
    }
}