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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

use crate::{
    config::Config,
    error::OpenAIError,
    types::admin::projects::{
        Project, ProjectCreateRequest, ProjectListResponse, ProjectUpdateRequest,
    },
    Client, ProjectAPIKeys, ProjectCertificates, ProjectGroupRoles, ProjectGroups,
    ProjectRateLimits, ProjectRoles, ProjectServiceAccounts, ProjectUserRoles, ProjectUsers,
    RequestOptions,
};

/// Manage the projects within an organization includes creation, updating, and archiving or projects.
/// The Default project cannot be modified or archived.
pub struct Projects<'c, C: Config> {
    client: &'c Client<C>,
    pub(crate) request_options: RequestOptions,
}

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

    // call [ProjectUsers] group APIs
    pub fn users(&self, project_id: &str) -> ProjectUsers<'_, C> {
        ProjectUsers::new(self.client, project_id)
    }

    // call [ProjectServiceAccounts] group APIs
    pub fn service_accounts(&self, project_id: &str) -> ProjectServiceAccounts<'_, C> {
        ProjectServiceAccounts::new(self.client, project_id)
    }

    // call [ProjectAPIKeys] group APIs
    pub fn api_keys(&self, project_id: &str) -> ProjectAPIKeys<'_, C> {
        ProjectAPIKeys::new(self.client, project_id)
    }

    // call [ProjectRateLimits] group APIs
    pub fn rate_limits(&self, project_id: &str) -> ProjectRateLimits<'_, C> {
        ProjectRateLimits::new(self.client, project_id)
    }

    // call [ProjectCertificates] group APIs
    pub fn certificates(&self, project_id: &str) -> ProjectCertificates<'_, C> {
        ProjectCertificates::new(self.client, project_id)
    }

    // call [ProjectGroups] group APIs
    pub fn groups(&self, project_id: &str) -> ProjectGroups<'_, C> {
        ProjectGroups::new(self.client, project_id)
    }

    // call [ProjectRoles] group APIs
    pub fn roles(&self, project_id: &str) -> ProjectRoles<'_, C> {
        ProjectRoles::new(self.client, project_id)
    }

    // call [ProjectUserRoles] group APIs
    pub fn user_roles(&self, project_id: &str, user_id: &str) -> ProjectUserRoles<'_, C> {
        ProjectUserRoles::new(self.client, project_id, user_id)
    }

    // call [ProjectGroupRoles] group APIs
    pub fn group_roles(&self, project_id: &str, group_id: &str) -> ProjectGroupRoles<'_, C> {
        ProjectGroupRoles::new(self.client, project_id, group_id)
    }

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

    /// Create a new project in the organization. Projects can be created and archived, but cannot be deleted.
    #[crate::byot(T0 = serde::Serialize, R = serde::de::DeserializeOwned)]
    pub async fn create(&self, request: ProjectCreateRequest) -> Result<Project, OpenAIError> {
        self.client
            .post("/organization/projects", request, &self.request_options)
            .await
    }

    /// Retrieves a project.
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn retrieve(&self, project_id: String) -> Result<Project, OpenAIError> {
        self.client
            .get(
                format!("/organization/projects/{project_id}").as_str(),
                &self.request_options,
            )
            .await
    }

    /// Modifies a project in the organization.
    #[crate::byot(T0 = std::fmt::Display, T1 = serde::Serialize, R = serde::de::DeserializeOwned)]
    pub async fn modify(
        &self,
        project_id: String,
        request: ProjectUpdateRequest,
    ) -> Result<Project, OpenAIError> {
        self.client
            .post(
                format!("/organization/projects/{project_id}").as_str(),
                request,
                &self.request_options,
            )
            .await
    }

    /// Archives a project in the organization. Archived projects cannot be used or updated.
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn archive(&self, project_id: String) -> Result<Project, OpenAIError> {
        self.client
            .post(
                format!("/organization/projects/{project_id}/archive").as_str(),
                (),
                &self.request_options,
            )
            .await
    }
}