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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

use crate::{
    config::Config,
    error::OpenAIError,
    types::vectorstores::{
        CreateVectorStoreRequest, DeleteVectorStoreResponse, ListVectorStoresResponse,
        UpdateVectorStoreRequest, VectorStoreObject, VectorStoreSearchRequest,
        VectorStoreSearchResultsPage,
    },
    Client, RequestOptions, VectorStoreFileBatches, VectorStoreFiles,
};

pub struct VectorStores<'c, C: Config> {
    client: &'c Client<C>,
    pub(crate) request_options: RequestOptions,
}

impl<'c, C: Config> VectorStores<'c, C> {
    pub fn new(client: &'c Client<C>) -> Self {
        Self {
            client,
            request_options: RequestOptions::new(),
        }
    }

    /// [VectorStoreFiles] API group
    pub fn files(&self, vector_store_id: &str) -> VectorStoreFiles<'_, C> {
        VectorStoreFiles::new(self.client, vector_store_id)
    }

    /// [VectorStoreFileBatches] API group
    pub fn file_batches(&self, vector_store_id: &str) -> VectorStoreFileBatches<'_, C> {
        VectorStoreFileBatches::new(self.client, vector_store_id)
    }

    /// Create a vector store.
    #[crate::byot(T0 = serde::Serialize, R = serde::de::DeserializeOwned)]
    pub async fn create(
        &self,
        request: CreateVectorStoreRequest,
    ) -> Result<VectorStoreObject, OpenAIError> {
        self.client
            .post("/vector_stores", request, &self.request_options)
            .await
    }

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

    /// Returns a list of vector stores.
    #[crate::byot(R = serde::de::DeserializeOwned)]
    pub async fn list(&self) -> Result<ListVectorStoresResponse, OpenAIError> {
        self.client
            .get("/vector_stores", &self.request_options)
            .await
    }

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

    /// Modifies a vector store.
    #[crate::byot(T0 = std::fmt::Display, T1 = serde::Serialize, R = serde::de::DeserializeOwned)]
    pub async fn update(
        &self,
        vector_store_id: &str,
        request: UpdateVectorStoreRequest,
    ) -> Result<VectorStoreObject, OpenAIError> {
        self.client
            .post(
                &format!("/vector_stores/{vector_store_id}"),
                request,
                &self.request_options,
            )
            .await
    }

    /// Searches a vector store.
    #[crate::byot(T0 = std::fmt::Display, T1 = serde::Serialize, R = serde::de::DeserializeOwned)]
    pub async fn search(
        &self,
        vector_store_id: &str,
        request: VectorStoreSearchRequest,
    ) -> Result<VectorStoreSearchResultsPage, OpenAIError> {
        self.client
            .post(
                &format!("/vector_stores/{vector_store_id}/search"),
                request,
                &self.request_options,
            )
            .await
    }
}