Qore OpenAiDataProvider Module Reference 1.3
Loading...
Searching...
No Matches
OpenAiChatCompletionDataProvider.qc.dox.h
1// -*- mode: c++; indent-tabs-mode: nil -*-
3
26namespace OpenAiDataProvider {
29
30public:
32 const ProviderInfo = ...;
33
34
37
38
41
44
46 constructor(*RestClient rest) ;
47
48
50 string getName();
51
52
54
59protected:
60 auto doRequestImpl(auto req, *hash<auto> request_options);
61public:
62
63
65
67protected:
68 *DataProvider::AbstractDataProviderType getRequestTypeImpl();
69public:
70
71
73
75protected:
76 *DataProvider::AbstractDataProviderType getResponseTypeImpl();
77public:
78
79
81protected:
82 hash<DataProviderInfo> getStaticInfoImpl();
83public:
84
85};
86
88class OpenAiMessageDataType : public HashDataType {
89
90public:
92 const Fields = ...;
93
94
97
98};
99
102
104class OpenAiChatResponseFormatType : public HashDataType {
105
106public:
108 const Fields = ...;
109
110
113
114};
115
118
120class OpenAiStreamOptionsType : public HashDataType {
121
122public:
124 const Fields = ...;
125
126
129
130};
131
134
136class OpenAiFunctionDataType : public HashDataType {
137
138public:
140 const Fields = ...;
141
142
145
146};
147
150
152class OpenAiToolDataType : public HashDataType {
153
154public:
156 const Fields = ...;
157
158
161
162};
163
166
168class OpenAiChatCompletionRequestType : public HashDataType {
169
170public:
172 const Fields = ...;
173
174
177
178};
179
182
184class OpenAiToolCallDataType : public HashDataType {
185
186public:
188 const Fields = ...;
189
190
193
194};
195
198
200class OpenAiCompletionMessageDataType : public HashDataType {
201
202public:
204 const Fields = OpenAiMessageDataType::Fields{"role", "content", "tool_calls"};
205
208
209};
210
213
215class OpenAiChoiceDataType : public HashDataType {
216
217public:
219 const Fields = ...;
220
221
224
225};
226
229
231class OpenAiChatCompletionUsageDataType : public HashDataType {
232
233public:
235 const Fields = ...;
236
237
240
241};
242
245
247class OpenAiChatCompletionResponseType : public HashDataType {
248
249public:
251 const Fields = ...;
252
253
256
257};
258
261};
The OpenAi data provider class.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:28
const ResponseType
Response type.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:43
*DataProvider::AbstractDataProviderType getResponseTypeImpl()
Returns the description of a response message, if this object represents a response message.
constructor(*RestClient rest)
Creates the object from the arguments.
const ProviderSummaryInfo
Provider summary info.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:36
string getName()
Returns the data provider name.
hash< DataProviderInfo > getStaticInfoImpl()
Returns data provider static info.
*DataProvider::AbstractDataProviderType getRequestTypeImpl()
Returns the description of a successful request message, if any.
const RequestType
Request type.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:40
const ProviderInfo
Provider info.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:32
auto doRequestImpl(auto req, *hash< auto > request_options)
Makes a request and returns the response.
The chat completion request type.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:168
const Fields
fields
Definition OpenAiChatCompletionDataProvider.qc.dox.h:172
The chat completion response type.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:247
const Fields
fields
Definition OpenAiChatCompletionDataProvider.qc.dox.h:251
The chat completion usage type.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:231
const Fields
fields
Definition OpenAiChatCompletionDataProvider.qc.dox.h:235
The chat response data type.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:104
const Fields
fields
Definition OpenAiChatCompletionDataProvider.qc.dox.h:108
Chat completion response choice type.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:215
const Fields
fields
Definition OpenAiChatCompletionDataProvider.qc.dox.h:219
Chat completion response message.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:200
const Fields
fields
Definition OpenAiChatCompletionDataProvider.qc.dox.h:204
The OpenAi data provider common base class.
Definition OpenAiDataProviderCommon.qc.dox.h:28
*RestClient::RestClient rest
The REST client object for API calls.
Definition OpenAiDataProviderCommon.qc.dox.h:54
The function data type.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:136
const Fields
fields
Definition OpenAiChatCompletionDataProvider.qc.dox.h:140
Chat completion request message.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:88
const Fields
fields
Definition OpenAiChatCompletionDataProvider.qc.dox.h:92
The stream options data type.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:120
const Fields
fields
Definition OpenAiChatCompletionDataProvider.qc.dox.h:124
Chat completion response choices.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:184
const Fields
fields
Definition OpenAiChatCompletionDataProvider.qc.dox.h:188
The tool data type.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:152
const Fields
fields
Definition OpenAiChatCompletionDataProvider.qc.dox.h:156
Qore OpenAiDataProvider module definition.
Definition OpenAiAssistantCreateDataProvider.qc.dox.h:26
const OpenAiChoiceDataType
Constant for the chat completion response choice type.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:228
const OpenAiToolCallDataType
Chat completion response choices.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:197
const OpenAiCompletionMessageDataType
Chat completion response message.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:212
const OpenAiChatCompletionResponseType
The chat completion response type.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:260
const OpenAiToolDataType
Constant for the tool data type.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:165
const OpenAiChatCompletionRequestType
The chat completion request type constant.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:181
const OpenAiChatCompletionUsageDataType
Constant for the chat completion usage type.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:244
const OpenAiFunctionDataType
Constant for the function data type.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:149
const OpenAiStreamOptionsType
Constant for the stream options data type.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:133
const OpenAiChatResponseFormatType
Constant for the chat response data type.
Definition OpenAiChatCompletionDataProvider.qc.dox.h:117