api_openai 0.3.0

OpenAI's API for accessing large language models (LLMs).
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
160
161
162

//! API Accessor Methods for `OpenAI` Client
//!
//! This module provides convenience accessor methods for all `OpenAI` API categories.
//! Each method returns a specialized API client configured with the parent Client.

use mod_interface::mod_interface;

mod private
{
  use crate::
  {
    client ::Client,
    environment ::{ OpenaiEnvironment, EnvironmentInterface },
    assistants ::Assistants,
    chat ::Chat,
    embeddings ::Embeddings,
    files ::Files,
    fine_tuning ::FineTuning,
    images ::Images,
    models ::Models,
    realtime ::Realtime,
    responses ::Responses,
    vector_stores ::VectorStores,
  };

  #[ cfg( feature = "audio" ) ]
  use crate::audio::Audio;

  #[ cfg( feature = "moderation" ) ]
  use crate::moderations::Moderations;

  /// Extension trait providing API accessor methods for Client
  pub trait ClientApiAccessors< E >
  where
    E : OpenaiEnvironment + EnvironmentInterface + Send + Sync + 'static,
  {
    /// Returns an `Assistants` API client.
    fn assistants( &self ) -> Assistants< '_, E >;

    /// Returns an `Audio` API client.
    #[ cfg( feature = "audio" ) ]
    fn audio( &self ) -> Audio< '_, E >;

    /// Returns a `Chat` API client.
    fn chat( &self ) -> Chat< '_, E >;

    /// Returns an `Embeddings` API client.
    fn embeddings( &self ) -> Embeddings< '_, E >;

    /// Returns a `Files` API client.
    fn files( &self ) -> Files< '_, E >;

    /// Returns a `FineTuning` API client.
    fn fine_tuning( &self ) -> FineTuning< '_, E >;

    /// Returns an `Images` API client.
    fn images( &self ) -> Images< '_, E >;

    /// Returns a `Models` API client.
    fn models( &self ) -> Models< '_, E >;

    /// Returns a `Moderations` API client.
    #[ cfg( feature = "moderation" ) ]
    fn moderations( &self ) -> Moderations< '_, E >;

    /// Returns a `Realtime` API client.
    fn realtime( &self ) -> Realtime< '_, E >;

    /// Returns a `Responses` API client.
    fn responses( &self ) -> Responses< '_, E >;

    /// Returns a `VectorStores` API client.
    fn vector_stores( &self ) -> VectorStores< '_, E >;
  }

  impl< E > ClientApiAccessors< E > for Client< E >
  where
    E : OpenaiEnvironment + EnvironmentInterface + Send + Sync + 'static,
  {
    #[ inline ]
    fn assistants( &self ) -> Assistants< '_, E >
    {
      Assistants::new( self )
    }

    #[ inline ]
    #[ cfg( feature = "audio" ) ]
    fn audio( &self ) -> Audio< '_, E >
    {
      Audio::new( self )
    }

    #[ inline ]
    fn chat( &self ) -> Chat< '_, E >
    {
      Chat::new( self )
    }

    #[ inline ]
    fn embeddings( &self ) -> Embeddings< '_, E >
    {
      Embeddings::new( self )
    }

    #[ inline ]
    fn files( &self ) -> Files< '_, E >
    {
      Files::new( self )
    }

    #[ inline ]
    fn fine_tuning( &self ) -> FineTuning< '_, E >
    {
      FineTuning::new( self )
    }

    #[ inline ]
    fn images( &self ) -> Images< '_, E >
    {
      Images::new( self )
    }

    #[ inline ]
    fn models( &self ) -> Models< '_, E >
    {
      Models::new( self )
    }

    #[ inline ]
    #[ cfg( feature = "moderation" ) ]
    fn moderations( &self ) -> Moderations< '_, E >
    {
      Moderations::new( self )
    }

    #[ inline ]
    fn realtime( &self ) -> Realtime< '_, E >
    {
      Realtime::new( self )
    }

    #[ inline ]
    fn responses( &self ) -> Responses< '_, E >
    {
      Responses::new( self )
    }

    #[ inline ]
    fn vector_stores( &self ) -> VectorStores< '_, E >
    {
      VectorStores::new( self )
    }
  }
}

mod_interface!
{
  exposed use
  {
    ClientApiAccessors,
  };
}