openai/openai-dotnet

Public

mirrored from https://github.com/openai/openai-dotnetAvailable

CodeCommitsIssuesPull requestsActionsInsightsSecurity
mailinhphan/clientOptions

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

OpenAI/src/Custom/Assistants/AssistantClient.Protocol.cs

331lines · modecode

1using System;
2using System.ClientModel;
3using System.ClientModel.Primitives;
4using System.Threading.Tasks;
5
6namespace OpenAI.Assistants;
7
8public partial class AssistantClient
9{
10 /// <inheritdoc cref="InternalAssistantMessageClient.CreateMessageAsync"/>
11 public virtual Task<ClientResult> CreateMessageAsync(string threadId, BinaryContent content, RequestOptions options = null)
12 => _messageSubClient.CreateMessageAsync(threadId, content, options);
13
14 /// <inheritdoc cref="InternalAssistantMessageClient.CreateMessage"/>
15 public virtual ClientResult CreateMessage(string threadId, BinaryContent content, RequestOptions options = null)
16 => _messageSubClient.CreateMessage(threadId, content, options);
17
18 /// <summary>
19 /// [Protocol Method] Returns a paginated collection of messages for a given thread.
20 /// </summary>
21 /// <param name="threadId"> The ID of the [thread](/docs/api-reference/threads) the messages belong to. </param>
22 /// <param name="limit">
23 /// A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
24 /// default is 20.
25 /// </param>
26 /// <param name="order">
27 /// Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`
28 /// for descending order. Allowed values: "asc" | "desc"
29 /// </param>
30 /// <param name="after">
31 /// A cursor for use in pagination. `after` is an object ID that defines your place in the list.
32 /// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
33 /// subsequent call can include after=obj_foo in order to fetch the next page of the list.
34 /// </param>
35 /// <param name="before">
36 /// A cursor for use in pagination. `before` is an object ID that defines your place in the list.
37 /// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
38 /// subsequent call can include before=obj_foo in order to fetch the previous page of the list.
39 /// </param>
40 /// <param name="options"> The request options, which can override default behaviors of the client pipeline on a per-call basis. </param>
41 /// <exception cref="ArgumentNullException"> <paramref name="threadId"/> is null. </exception>
42 /// <exception cref="ArgumentException"> <paramref name="threadId"/> is an empty string, and was expected to be non-empty. </exception>
43 /// <exception cref="ClientResultException"> Service returned a non-success status code. </exception>
44 /// <returns> A collection of service responses, each holding a page of values. </returns>
45 public virtual AsyncCollectionResult GetMessagesAsync(string threadId, int? limit, string order, string after, string before, RequestOptions options)
46 => _messageSubClient.GetMessagesAsync(threadId, limit, order, after, before, options);
47
48 /// <summary>
49 /// [Protocol Method] Returns a paginated collection of messages for a given thread.
50 /// </summary>
51 /// <param name="threadId"> The ID of the [thread](/docs/api-reference/threads) the messages belong to. </param>
52 /// <param name="limit">
53 /// A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
54 /// default is 20.
55 /// </param>
56 /// <param name="order">
57 /// Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`
58 /// for descending order. Allowed values: "asc" | "desc"
59 /// </param>
60 /// <param name="after">
61 /// A cursor for use in pagination. `after` is an object ID that defines your place in the list.
62 /// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
63 /// subsequent call can include after=obj_foo in order to fetch the next page of the list.
64 /// </param>
65 /// <param name="before">
66 /// A cursor for use in pagination. `before` is an object ID that defines your place in the list.
67 /// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
68 /// subsequent call can include before=obj_foo in order to fetch the previous page of the list.
69 /// </param>
70 /// <param name="options"> The request options, which can override default behaviors of the client pipeline on a per-call basis. </param>
71 /// <exception cref="ArgumentNullException"> <paramref name="threadId"/> is null. </exception>
72 /// <exception cref="ArgumentException"> <paramref name="threadId"/> is an empty string, and was expected to be non-empty. </exception>
73 /// <exception cref="ClientResultException"> Service returned a non-success status code. </exception>
74 /// <returns> A collection of service responses, each holding a page of values. </returns>
75 public virtual CollectionResult GetMessages(string threadId, int? limit, string order, string after, string before, RequestOptions options)
76 => _messageSubClient.GetMessages(threadId, limit, order, after, before, options);
77
78 /// <inheritdoc cref="InternalAssistantMessageClient.GetMessageAsync"/>
79 public virtual Task<ClientResult> GetMessageAsync(string threadId, string messageId, RequestOptions options)
80 => _messageSubClient.GetMessageAsync(threadId, messageId, options);
81
82 /// <inheritdoc cref="InternalAssistantMessageClient.GetMessage"/>
83 public virtual ClientResult GetMessage(string threadId, string messageId, RequestOptions options)
84 => _messageSubClient.GetMessage(threadId, messageId, options);
85
86 /// <inheritdoc cref="InternalAssistantMessageClient.ModifyMessageAsync"/>
87 public virtual Task<ClientResult> ModifyMessageAsync(string threadId, string messageId, BinaryContent content, RequestOptions options = null)
88 => _messageSubClient.ModifyMessageAsync(threadId, messageId, content, options);
89
90 /// <inheritdoc cref="InternalAssistantMessageClient.ModifyMessage"/>
91 public virtual ClientResult ModifyMessage(string threadId, string messageId, BinaryContent content, RequestOptions options = null)
92 => _messageSubClient.ModifyMessage(threadId, messageId, content, options);
93
94 /// <inheritdoc cref="InternalAssistantMessageClient.DeleteMessageAsync"/>
95 public virtual Task<ClientResult> DeleteMessageAsync(string threadId, string messageId, RequestOptions options)
96 => _messageSubClient.DeleteMessageAsync(threadId, messageId, options);
97
98 /// <inheritdoc cref="InternalAssistantMessageClient.DeleteMessage"/>
99 public virtual ClientResult DeleteMessage(string threadId, string messageId, RequestOptions options)
100 => _messageSubClient.DeleteMessage(threadId, messageId, options);
101
102 /// <inheritdoc cref="InternalAssistantRunClient.CreateThreadAndRunAsync"/>
103 public virtual Task<ClientResult> CreateThreadAndRunAsync(BinaryContent content, RequestOptions options = null)
104 => _runSubClient.CreateThreadAndRunAsync(content, options);
105
106 /// <inheritdoc cref="InternalAssistantRunClient.CreateThreadAndRun"/>
107 public virtual ClientResult CreateThreadAndRun(BinaryContent content, RequestOptions options = null)
108 => _runSubClient.CreateThreadAndRun(content, options = null);
109
110 /// <inheritdoc cref="InternalAssistantRunClient.CreateRunAsync"/>
111 public virtual Task<ClientResult> CreateRunAsync(string threadId, BinaryContent content, RequestOptions options = null)
112 => _runSubClient.CreateRunAsync(threadId, content, options);
113
114 /// <inheritdoc cref="InternalAssistantRunClient.CreateRun"/>
115 public virtual ClientResult CreateRun(string threadId, BinaryContent content, RequestOptions options = null)
116 => _runSubClient.CreateRun(threadId, content, options);
117
118 /// <summary>
119 /// [Protocol Method] Returns a paginated collection of runs belonging to a thread.
120 /// </summary>
121 /// <param name="threadId"> The ID of the thread the run belongs to. </param>
122 /// <param name="limit">
123 /// A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
124 /// default is 20.
125 /// </param>
126 /// <param name="order">
127 /// Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`
128 /// for descending order. Allowed values: "asc" | "desc"
129 /// </param>
130 /// <param name="after">
131 /// A cursor for use in pagination. `after` is an object ID that defines your place in the list.
132 /// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
133 /// subsequent call can include after=obj_foo in order to fetch the next page of the list.
134 /// </param>
135 /// <param name="before">
136 /// A cursor for use in pagination. `before` is an object ID that defines your place in the list.
137 /// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
138 /// subsequent call can include before=obj_foo in order to fetch the previous page of the list.
139 /// </param>
140 /// <param name="options"> The request options, which can override default behaviors of the client pipeline on a per-call basis. </param>
141 /// <exception cref="ArgumentNullException"> <paramref name="threadId"/> is null. </exception>
142 /// <exception cref="ArgumentException"> <paramref name="threadId"/> is an empty string, and was expected to be non-empty. </exception>
143 /// <exception cref="ClientResultException"> Service returned a non-success status code. </exception>
144 /// <returns> A collection of service responses, each holding a page of values. </returns>
145 public virtual AsyncCollectionResult GetRunsAsync(string threadId, int? limit, string order, string after, string before, RequestOptions options)
146 => _runSubClient.GetRunsAsync(threadId, limit, order, after, before, options);
147
148 /// <summary>
149 /// [Protocol Method] Returns a paginated collection of runs belonging to a thread.
150 /// </summary>
151 /// <param name="threadId"> The ID of the thread the run belongs to. </param>
152 /// <param name="limit">
153 /// A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
154 /// default is 20.
155 /// </param>
156 /// <param name="order">
157 /// Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`
158 /// for descending order. Allowed values: "asc" | "desc"
159 /// </param>
160 /// <param name="after">
161 /// A cursor for use in pagination. `after` is an object ID that defines your place in the list.
162 /// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
163 /// subsequent call can include after=obj_foo in order to fetch the next page of the list.
164 /// </param>
165 /// <param name="before">
166 /// A cursor for use in pagination. `before` is an object ID that defines your place in the list.
167 /// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
168 /// subsequent call can include before=obj_foo in order to fetch the previous page of the list.
169 /// </param>
170 /// <param name="options"> The request options, which can override default behaviors of the client pipeline on a per-call basis. </param>
171 /// <exception cref="ArgumentNullException"> <paramref name="threadId"/> is null. </exception>
172 /// <exception cref="ArgumentException"> <paramref name="threadId"/> is an empty string, and was expected to be non-empty. </exception>
173 /// <exception cref="ClientResultException"> Service returned a non-success status code. </exception>
174 /// <returns> A collection of service responses, each holding a page of values. </returns>
175 public virtual CollectionResult GetRuns(string threadId, int? limit, string order, string after, string before, RequestOptions options)
176 => _runSubClient.GetRuns(threadId, limit, order, after, before, options);
177
178 /// <inheritdoc cref="InternalAssistantRunClient.GetRunAsync(string, string, RequestOptions)"/>
179 public virtual Task<ClientResult> GetRunAsync(string threadId, string runId, RequestOptions options)
180 => _runSubClient.GetRunAsync(threadId, runId, options);
181
182 public virtual ClientResult GetRun(string threadId, string runId, RequestOptions options)
183 => _runSubClient.GetRun(threadId, runId, options);
184
185 /// <inheritdoc cref="InternalAssistantRunClient.GetRun(string, string, RequestOptions)"/>
186 /// <inheritdoc cref="InternalAssistantRunClient.ModifyRunAsync"/>
187 public virtual Task<ClientResult> ModifyRunAsync(string threadId, string runId, BinaryContent content, RequestOptions options = null)
188 => _runSubClient.ModifyRunAsync(threadId, runId, content, options);
189
190 /// <inheritdoc cref="InternalAssistantRunClient.ModifyRun"/>
191 public virtual ClientResult ModifyRun(string threadId, string runId, BinaryContent content, RequestOptions options = null)
192 => _runSubClient.ModifyRun(threadId, runId, content, options);
193
194 /// <inheritdoc cref="InternalAssistantRunClient.CancelRunAsync"/>
195 public virtual Task<ClientResult> CancelRunAsync(string threadId, string runId, RequestOptions options)
196 => _runSubClient.CancelRunAsync(threadId, runId, options);
197
198 /// <inheritdoc cref="InternalAssistantRunClient.CancelRun"/>
199 public virtual ClientResult CancelRun(string threadId, string runId, RequestOptions options)
200 => _runSubClient.CancelRun(threadId, runId, options);
201
202 /// <inheritdoc cref="InternalAssistantRunClient.SubmitToolOutputsToRunAsync"/>
203 public virtual Task<ClientResult> SubmitToolOutputsToRunAsync(string threadId, string runId, BinaryContent content, RequestOptions options = null)
204 => _runSubClient.SubmitToolOutputsToRunAsync(threadId, runId, content, options);
205
206 /// <inheritdoc cref="InternalAssistantRunClient.SubmitToolOutputsToRun"/>
207 public virtual ClientResult SubmitToolOutputsToRun(string threadId, string runId, BinaryContent content, RequestOptions options = null)
208 => _runSubClient.SubmitToolOutputsToRun(threadId, runId, content, options);
209
210 /// <summary>
211 /// [Protocol Method] Returns a paginated collection of run steps belonging to a run.
212 /// </summary>
213 /// <param name="threadId"> The ID of the thread the run and run steps belong to. </param>
214 /// <param name="runId"> The ID of the run the run steps belong to. </param>
215 /// <param name="limit">
216 /// A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
217 /// default is 20.
218 /// </param>
219 /// <param name="order">
220 /// Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`
221 /// for descending order. Allowed values: "asc" | "desc"
222 /// </param>
223 /// <param name="after">
224 /// A cursor for use in pagination. `after` is an object ID that defines your place in the list.
225 /// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
226 /// subsequent call can include after=obj_foo in order to fetch the next page of the list.
227 /// </param>
228 /// <param name="before">
229 /// A cursor for use in pagination. `before` is an object ID that defines your place in the list.
230 /// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
231 /// subsequent call can include before=obj_foo in order to fetch the previous page of the list.
232 /// </param>
233 /// <param name="options"> The request options, which can override default behaviors of the client pipeline on a per-call basis. </param>
234 /// <exception cref="ArgumentNullException"> <paramref name="threadId"/> or <paramref name="runId"/> is null. </exception>
235 /// <exception cref="ArgumentException"> <paramref name="threadId"/> or <paramref name="runId"/> is an empty string, and was expected to be non-empty. </exception>
236 /// <exception cref="ClientResultException"> Service returned a non-success status code. </exception>
237 /// <returns> A collection of service responses, each holding a page of values. </returns>
238 public virtual AsyncCollectionResult GetRunStepsAsync(string threadId, string runId, int? limit, string order, string after, string before, RequestOptions options)
239 => _runSubClient.GetRunStepsAsync(threadId, runId, limit, order, after, before, [InternalIncludedRunStepProperty.FileSearchResultContent], options);
240
241 /// <summary>
242 /// [Protocol Method] Returns a paginated collection of run steps belonging to a run.
243 /// </summary>
244 /// <param name="threadId"> The ID of the thread the run and run steps belong to. </param>
245 /// <param name="runId"> The ID of the run the run steps belong to. </param>
246 /// <param name="limit">
247 /// A limit on the number of objects to be returned. Limit can range between 1 and 100, and the
248 /// default is 20.
249 /// </param>
250 /// <param name="order">
251 /// Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`
252 /// for descending order. Allowed values: "asc" | "desc"
253 /// </param>
254 /// <param name="after">
255 /// A cursor for use in pagination. `after` is an object ID that defines your place in the list.
256 /// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
257 /// subsequent call can include after=obj_foo in order to fetch the next page of the list.
258 /// </param>
259 /// <param name="before">
260 /// A cursor for use in pagination. `before` is an object ID that defines your place in the list.
261 /// For instance, if you make a list request and receive 100 objects, ending with obj_foo, your
262 /// subsequent call can include before=obj_foo in order to fetch the previous page of the list.
263 /// </param>
264 /// <param name="options"> The request options, which can override default behaviors of the client pipeline on a per-call basis. </param>
265 /// <exception cref="ArgumentNullException"> <paramref name="threadId"/> or <paramref name="runId"/> is null. </exception>
266 /// <exception cref="ArgumentException"> <paramref name="threadId"/> or <paramref name="runId"/> is an empty string, and was expected to be non-empty. </exception>
267 /// <exception cref="ClientResultException"> Service returned a non-success status code. </exception>
268 /// <returns> A collection of service responses, each holding a page of values. </returns>
269 public virtual CollectionResult GetRunSteps(string threadId, string runId, int? limit, string order, string after, string before, RequestOptions options)
270 => _runSubClient.GetRunSteps(threadId, runId, limit, order, after, before, [InternalIncludedRunStepProperty.FileSearchResultContent], options);
271
272 /// <summary>
273 /// [Protocol Method] Retrieves a run step.
274 /// </summary>
275 /// <param name="threadId"> The ID of the thread to which the run and run step belongs. </param>
276 /// <param name="runId"> The ID of the run to which the run step belongs. </param>
277 /// <param name="stepId"> The ID of the run step to retrieve. </param>
278 /// <param name="options"> The request options, which can override default behaviors of the client pipeline on a per-call basis. </param>
279 /// <exception cref="ArgumentNullException"> <paramref name="threadId"/>, <paramref name="runId"/> or <paramref name="stepId"/> is null. </exception>
280 /// <exception cref="ArgumentException"> <paramref name="threadId"/>, <paramref name="runId"/> or <paramref name="stepId"/> is an empty string, and was expected to be non-empty. </exception>
281 /// <exception cref="ClientResultException"> Service returned a non-success status code. </exception>
282 /// <returns> The response returned from the service. </returns>
283 public virtual Task<ClientResult> GetRunStepAsync(string threadId, string runId, string stepId, RequestOptions options)
284 => _runSubClient.GetRunStepAsync(threadId, runId, stepId, [InternalIncludedRunStepProperty.FileSearchResultContent], options);
285
286 /// <summary>
287 /// [Protocol Method] Retrieves a run step.
288 /// </summary>
289 /// <param name="threadId"> The ID of the thread to which the run and run step belongs. </param>
290 /// <param name="runId"> The ID of the run to which the run step belongs. </param>
291 /// <param name="stepId"> The ID of the run step to retrieve. </param>
292 /// <param name="options"> The request options, which can override default behaviors of the client pipeline on a per-call basis. </param>
293 /// <exception cref="ArgumentNullException"> <paramref name="threadId"/>, <paramref name="runId"/> or <paramref name="stepId"/> is null. </exception>
294 /// <exception cref="ArgumentException"> <paramref name="threadId"/>, <paramref name="runId"/> or <paramref name="stepId"/> is an empty string, and was expected to be non-empty. </exception>
295 /// <exception cref="ClientResultException"> Service returned a non-success status code. </exception>
296 /// <returns> The response returned from the service. </returns>
297 public virtual ClientResult GetRunStep(string threadId, string runId, string stepId, RequestOptions options)
298 => _runSubClient.GetRunStep(threadId, runId, stepId, [InternalIncludedRunStepProperty.FileSearchResultContent], options);
299
300 /// <inheritdoc cref="InternalAssistantThreadClient.CreateThreadAsync"/>
301 public virtual Task<ClientResult> CreateThreadAsync(BinaryContent content, RequestOptions options = null)
302 => _threadSubClient.CreateThreadAsync(content, options);
303
304 /// <inheritdoc cref="InternalAssistantThreadClient.CreateThread"/>
305 public virtual ClientResult CreateThread(BinaryContent content, RequestOptions options = null)
306 => _threadSubClient.CreateThread(content, options);
307
308 /// <inheritdoc cref="InternalAssistantThreadClient.GetThreadAsync"/>
309 public virtual Task<ClientResult> GetThreadAsync(string threadId, RequestOptions options)
310 => _threadSubClient.GetThreadAsync(threadId, options);
311
312 /// <inheritdoc cref="InternalAssistantThreadClient.GetThread"/>
313 public virtual ClientResult GetThread(string threadId, RequestOptions options)
314 => _threadSubClient.GetThread(threadId, options);
315
316 /// <inheritdoc cref="InternalAssistantThreadClient.ModifyThreadAsync"/>
317 public virtual Task<ClientResult> ModifyThreadAsync(string threadId, BinaryContent content, RequestOptions options = null)
318 => _threadSubClient.ModifyThreadAsync(threadId, content, options);
319
320 /// <inheritdoc cref="InternalAssistantThreadClient.ModifyThread"/>
321 public virtual ClientResult ModifyThread(string threadId, BinaryContent content, RequestOptions options = null)
322 => _threadSubClient.ModifyThread(threadId, content, options);
323
324 /// <inheritdoc cref="InternalAssistantThreadClient.DeleteThreadAsync"/>
325 public virtual Task<ClientResult> DeleteThreadAsync(string threadId, RequestOptions options)
326 => _threadSubClient.DeleteThreadAsync(threadId, options);
327
328 /// <inheritdoc cref="InternalAssistantThreadClient.DeleteThread"/>
329 public virtual ClientResult DeleteThread(string threadId, RequestOptions options)
330 => _threadSubClient.DeleteThread(threadId, options);
331}
332