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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

use crate::v1::api::Client;
use crate::v1::error::APIError;
use crate::v1::helpers::format_response;
use crate::v1::resources::shared::ListResponse;
use crate::v1::resources::usage::{
    AudioSpeechUsage, AudioTranscriptionUsage, CodeInterpreterSessionUsage, CompletionUsage,
    CostUsage, EmbeddingUsage, ImageUsage, ModerationUsage, UsageBucket, UsageParameters,
    VectorStoreUsage,
};

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

impl Client {
    /// The Usage API provides detailed insights into your activity across the OpenAI API.
    pub fn usage(&self) -> Usage<'_> {
        Usage { client: self }
    }
}

impl Usage<'_> {
    /// Get completions usage details for the organization.
    pub async fn completions(
        &self,
        parameters: UsageParameters,
    ) -> Result<ListResponse<UsageBucket<CompletionUsage>>, APIError> {
        let response = self
            .client
            .get_with_query("/organization/usage/completions", &parameters)
            .await?;

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

        Ok(response)
    }

    /// Get embeddings usage details for the organization.
    pub async fn embeddings(
        &self,
        parameters: UsageParameters,
    ) -> Result<ListResponse<UsageBucket<EmbeddingUsage>>, APIError> {
        let response = self
            .client
            .get_with_query("/organization/usage/embeddings", &parameters)
            .await?;

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

        Ok(response)
    }

    /// Get moderations usage details for the organization.
    pub async fn moderations(
        &self,
        parameters: UsageParameters,
    ) -> Result<ListResponse<UsageBucket<ModerationUsage>>, APIError> {
        let response = self
            .client
            .get_with_query("/organization/usage/moderations", &parameters)
            .await?;

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

        Ok(response)
    }

    /// Get images usage details for the organization.
    pub async fn images(
        &self,
        parameters: UsageParameters,
    ) -> Result<ListResponse<UsageBucket<ImageUsage>>, APIError> {
        let response = self
            .client
            .get_with_query("/organization/usage/images", &parameters)
            .await?;

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

        Ok(response)
    }

    /// Get audio speeches usage details for the organization.
    pub async fn audio_speeches(
        &self,
        parameters: UsageParameters,
    ) -> Result<ListResponse<UsageBucket<AudioSpeechUsage>>, APIError> {
        let response = self
            .client
            .get_with_query("/organization/usage/audio_speeches", &parameters)
            .await?;

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

        Ok(response)
    }

    /// Get audio transcriptions usage details for the organization.
    pub async fn audio_transcriptions(
        &self,
        parameters: UsageParameters,
    ) -> Result<ListResponse<UsageBucket<AudioTranscriptionUsage>>, APIError> {
        let response = self
            .client
            .get_with_query("/organization/usage/audio_transcriptions", &parameters)
            .await?;

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

        Ok(response)
    }

    /// The aggregated vector stores usage details of the specific time bucket.
    pub async fn vector_stores(
        &self,
        parameters: UsageParameters,
    ) -> Result<ListResponse<UsageBucket<VectorStoreUsage>>, APIError> {
        let response = self
            .client
            .get_with_query("/organization/usage/vector_stores", &parameters)
            .await?;

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

        Ok(response)
    }

    /// Get code interpreter sessions usage details for the organization.
    pub async fn code_interpreter_sessions(
        &self,
        parameters: UsageParameters,
    ) -> Result<ListResponse<UsageBucket<CodeInterpreterSessionUsage>>, APIError> {
        let response = self
            .client
            .get_with_query("/organization/usage/code_interpreter_sessions", &parameters)
            .await?;

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

        Ok(response)
    }

    /// Get costs details for the organization.
    pub async fn costs(
        &self,
        parameters: UsageParameters,
    ) -> Result<ListResponse<UsageBucket<CostUsage>>, APIError> {
        let response = self
            .client
            .get_with_query("/organization/costs", &parameters)
            .await?;

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

        Ok(response)
    }
}