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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

use crate::v1::{
    api::Client,
    error::APIError,
    helpers::format_response,
    resources::{
        shared::{DeletedObject, ListParameters, ListResponse},
        vector_store::{
            CreateVectorStoreParameters, ModifyVectorStoreParameters, SearchVectorStoreParameters,
            SearchVectorStoreResults, VectorStore,
        },
    },
};

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

impl Client {
    /// Vector stores are used to store files for use by the file_search tool.
    pub fn vector_stores(&self) -> VectorStores<'_> {
        VectorStores { client: self }
    }
}

impl VectorStores<'_> {
    /// Create a vector store.
    pub async fn create(
        &self,
        parameters: CreateVectorStoreParameters,
    ) -> Result<VectorStore, APIError> {
        let response = self
            .client
            .post("/vector_stores", &parameters, None)
            .await?;

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

        Ok(response)
    }

    /// Returns a list of vector stores.
    pub async fn list(
        &self,
        query: Option<ListParameters>,
    ) -> Result<ListResponse<VectorStore>, APIError> {
        let response = self.client.get_with_query("/vector_stores", &query).await?;

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

        Ok(response)
    }

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

        let response: VectorStore = format_response(response)?;

        Ok(response)
    }

    /// Modifies a vector store.
    pub async fn modify(
        &self,
        vector_store_id: &str,
        parameters: ModifyVectorStoreParameters,
    ) -> Result<VectorStore, APIError> {
        let response = self
            .client
            .post(
                &format!("/vector_stores/{vector_store_id}"),
                &parameters,
                None,
            )
            .await?;

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

        Ok(response)
    }

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

        let response: DeletedObject = format_response(response)?;

        Ok(response)
    }

    /// Search a vector store for relevant chunks based on a query and file attributes filter.
    pub async fn search(
        &self,
        vector_store_id: &str,
        parameters: SearchVectorStoreParameters,
    ) -> Result<SearchVectorStoreResults, APIError> {
        let response = self
            .client
            .post(
                &format!("/vector_stores/{vector_store_id}/search"),
                &parameters,
                None,
            )
            .await?;

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

        Ok(response)
    }
}