async-openai 0.34.0

Rust library for OpenAI
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

use crate::{
    config::Config,
    error::OpenAIError,
    types::vectorstores::{
        CreateVectorStoreFileBatchRequest, ListVectorStoreFilesResponse, VectorStoreFileBatchObject,
    },
    Client, RequestOptions,
};

/// Vector store file batches represent operations to add multiple files to a vector store.
///
/// Related guide: [File Search](https://platform.openai.com/docs/assistants/tools/file-search)
pub struct VectorStoreFileBatches<'c, C: Config> {
    client: &'c Client<C>,
    pub vector_store_id: String,
    pub(crate) request_options: RequestOptions,
}

impl<'c, C: Config> VectorStoreFileBatches<'c, C> {
    pub fn new(client: &'c Client<C>, vector_store_id: &str) -> Self {
        Self {
            client,
            vector_store_id: vector_store_id.into(),
            request_options: RequestOptions::new(),
        }
    }

    /// Create vector store file batch
    #[crate::byot(T0 = serde::Serialize, R = serde::de::DeserializeOwned)]
    pub async fn create(
        &self,
        request: CreateVectorStoreFileBatchRequest,
    ) -> Result<VectorStoreFileBatchObject, OpenAIError> {
        self.client
            .post(
                &format!("/vector_stores/{}/file_batches", &self.vector_store_id),
                request,
                &self.request_options,
            )
            .await
    }

    /// Retrieves a vector store file batch.
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn retrieve(
        &self,
        batch_id: &str,
    ) -> Result<VectorStoreFileBatchObject, OpenAIError> {
        self.client
            .get(
                &format!(
                    "/vector_stores/{}/file_batches/{batch_id}",
                    &self.vector_store_id
                ),
                &self.request_options,
            )
            .await
    }

    /// Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn cancel(&self, batch_id: &str) -> Result<VectorStoreFileBatchObject, OpenAIError> {
        self.client
            .post(
                &format!(
                    "/vector_stores/{}/file_batches/{batch_id}/cancel",
                    &self.vector_store_id
                ),
                serde_json::json!({}),
                &self.request_options,
            )
            .await
    }

    /// Returns a list of vector store files in a batch.
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn list_files(
        &self,
        batch_id: &str,
    ) -> Result<ListVectorStoreFilesResponse, OpenAIError> {
        self.client
            .get(
                &format!(
                    "/vector_stores/{}/file_batches/{batch_id}/files",
                    &self.vector_store_id
                ),
                &self.request_options,
            )
            .await
    }
}