GitVita
New repositoryImport repositoryNew issue
Your repositories Your dashboard Sign in

openai/openai-dotnet

Public

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

Watch0Fork0Star0
CodeCommitsIssuesPull requestsActionsInsightsSecurity
jsquire-patch-1

Branches

Tags

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

Clone

HTTPS

Download ZIP

openai-dotnet/api

api/OpenAI.net8.0.cs

3954lines · modecode

RawDownload
Prepare 2.2.0-beta.4 release (Part 2) (#379)86407c8
1namespace OpenAI {
2 public class OpenAIClient {
3 protected OpenAIClient();
4 public OpenAIClient(ApiKeyCredential credential, OpenAIClientOptions options);
5 public OpenAIClient(ApiKeyCredential credential);
6 protected internal OpenAIClient(ClientPipeline pipeline, OpenAIClientOptions options);
7 public OpenAIClient(string apiKey);
8 public ClientPipeline Pipeline { get; }
9 [Experimental("OPENAI001")]
10 public virtual AssistantClient GetAssistantClient();
11 public virtual AudioClient GetAudioClient(string model);
12 [Experimental("OPENAI001")]
13 public virtual BatchClient GetBatchClient();
14 public virtual ChatClient GetChatClient(string model);
15 public virtual EmbeddingClient GetEmbeddingClient(string model);
16 [Experimental("OPENAI001")]
17 public virtual FineTuningClient GetFineTuningClient();
18 public virtual ImageClient GetImageClient(string model);
19 public virtual ModerationClient GetModerationClient(string model);
20 public virtual OpenAIFileClient GetOpenAIFileClient();
21 public virtual OpenAIModelClient GetOpenAIModelClient();
22 public virtual Responses.OpenAIResponseClient GetOpenAIResponseClient();
23 public virtual Responses.OpenAIResponseClient GetOpenAIResponseClient(string model);
24 [Experimental("OPENAI002")]
25 public virtual RealtimeConversation.RealtimeConversationClient GetRealtimeConversationClient(string model);
26 [Experimental("OPENAI001")]
27 public virtual VectorStoreClient GetVectorStoreClient();
28 }
29 public class OpenAIClientOptions : ClientPipelineOptions {
30 public Uri Endpoint { get; set; }
31 public string OrganizationId { get; set; }
32 public string ProjectId { get; set; }
33 public string UserAgentApplicationId { get; set; }
34 }
35}
36namespace OpenAI.Assistants {
37 [Experimental("OPENAI001")]
38 public class Assistant : IJsonModel<Assistant>, IPersistableModel<Assistant> {
39 public DateTimeOffset CreatedAt { get; }
40 public string Description { get; }
41 public string Id { get; }
42 public string Instructions { get; }
43 public IReadOnlyDictionary<string, string> Metadata { get; }
44 public string Model { get; }
45 public string Name { get; }
46 public float? NucleusSamplingFactor { get; }
47 public AssistantResponseFormat ResponseFormat { get; }
48 public float? Temperature { get; }
49 public ToolResources ToolResources { get; }
50 public IReadOnlyList<ToolDefinition> Tools { get; }
51 public static explicit operator Assistant(ClientResult result);
52 public static implicit operator BinaryContent(Assistant assistant);
53 }
54 [Experimental("OPENAI001")]
55 public class AssistantClient {
56 protected AssistantClient();
57 public AssistantClient(ApiKeyCredential credential, OpenAIClientOptions options);
58 public AssistantClient(ApiKeyCredential credential);
59 protected internal AssistantClient(ClientPipeline pipeline, OpenAIClientOptions options);
60 public AssistantClient(string apiKey);
61 public ClientPipeline Pipeline { get; }
62 [EditorBrowsable(EditorBrowsableState.Never)]
63 public virtual ClientResult CancelRun(string threadId, string runId, RequestOptions options);
64 public virtual ClientResult<ThreadRun> CancelRun(string threadId, string runId, CancellationToken cancellationToken = default);
65 [EditorBrowsable(EditorBrowsableState.Never)]
66 public virtual Task<ClientResult> CancelRunAsync(string threadId, string runId, RequestOptions options);
67 public virtual Task<ClientResult<ThreadRun>> CancelRunAsync(string threadId, string runId, CancellationToken cancellationToken = default);
68 [EditorBrowsable(EditorBrowsableState.Never)]
69 public virtual ClientResult CreateAssistant(BinaryContent content, RequestOptions options = null);
70 public virtual ClientResult<Assistant> CreateAssistant(string model, AssistantCreationOptions options = null, CancellationToken cancellationToken = default);
71 [EditorBrowsable(EditorBrowsableState.Never)]
72 public virtual Task<ClientResult> CreateAssistantAsync(BinaryContent content, RequestOptions options = null);
73 public virtual Task<ClientResult<Assistant>> CreateAssistantAsync(string model, AssistantCreationOptions options = null, CancellationToken cancellationToken = default);
74 public virtual ClientResult<ThreadMessage> CreateMessage(string threadId, MessageRole role, IEnumerable<MessageContent> content, MessageCreationOptions options = null, CancellationToken cancellationToken = default);
75 [EditorBrowsable(EditorBrowsableState.Never)]
76 public virtual ClientResult CreateMessage(string threadId, BinaryContent content, RequestOptions options = null);
77 public virtual Task<ClientResult<ThreadMessage>> CreateMessageAsync(string threadId, MessageRole role, IEnumerable<MessageContent> content, MessageCreationOptions options = null, CancellationToken cancellationToken = default);
78 [EditorBrowsable(EditorBrowsableState.Never)]
79 public virtual Task<ClientResult> CreateMessageAsync(string threadId, BinaryContent content, RequestOptions options = null);
80 [EditorBrowsable(EditorBrowsableState.Never)]
81 public virtual ClientResult CreateRun(string threadId, BinaryContent content, RequestOptions options = null);
82 public virtual ClientResult<ThreadRun> CreateRun(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
83 [EditorBrowsable(EditorBrowsableState.Never)]
84 public virtual Task<ClientResult> CreateRunAsync(string threadId, BinaryContent content, RequestOptions options = null);
85 public virtual Task<ClientResult<ThreadRun>> CreateRunAsync(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
86 public virtual CollectionResult<StreamingUpdate> CreateRunStreaming(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
87 public virtual AsyncCollectionResult<StreamingUpdate> CreateRunStreamingAsync(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
88 public virtual ClientResult<AssistantThread> CreateThread(ThreadCreationOptions options = null, CancellationToken cancellationToken = default);
89 [EditorBrowsable(EditorBrowsableState.Never)]
90 public virtual ClientResult CreateThread(BinaryContent content, RequestOptions options = null);
91 [EditorBrowsable(EditorBrowsableState.Never)]
92 public virtual ClientResult CreateThreadAndRun(BinaryContent content, RequestOptions options = null);
93 public virtual ClientResult<ThreadRun> CreateThreadAndRun(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
94 [EditorBrowsable(EditorBrowsableState.Never)]
95 public virtual Task<ClientResult> CreateThreadAndRunAsync(BinaryContent content, RequestOptions options = null);
96 public virtual Task<ClientResult<ThreadRun>> CreateThreadAndRunAsync(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
97 public virtual CollectionResult<StreamingUpdate> CreateThreadAndRunStreaming(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
98 public virtual AsyncCollectionResult<StreamingUpdate> CreateThreadAndRunStreamingAsync(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
99 public virtual Task<ClientResult<AssistantThread>> CreateThreadAsync(ThreadCreationOptions options = null, CancellationToken cancellationToken = default);
100 [EditorBrowsable(EditorBrowsableState.Never)]
101 public virtual Task<ClientResult> CreateThreadAsync(BinaryContent content, RequestOptions options = null);
102 [EditorBrowsable(EditorBrowsableState.Never)]
103 public virtual ClientResult DeleteAssistant(string assistantId, RequestOptions options);
104 public virtual ClientResult<AssistantDeletionResult> DeleteAssistant(string assistantId, CancellationToken cancellationToken = default);
105 [EditorBrowsable(EditorBrowsableState.Never)]
106 public virtual Task<ClientResult> DeleteAssistantAsync(string assistantId, RequestOptions options);
107 public virtual Task<ClientResult<AssistantDeletionResult>> DeleteAssistantAsync(string assistantId, CancellationToken cancellationToken = default);
108 [EditorBrowsable(EditorBrowsableState.Never)]
109 public virtual ClientResult DeleteMessage(string threadId, string messageId, RequestOptions options);
110 public virtual ClientResult<MessageDeletionResult> DeleteMessage(string threadId, string messageId, CancellationToken cancellationToken = default);
111 [EditorBrowsable(EditorBrowsableState.Never)]
112 public virtual Task<ClientResult> DeleteMessageAsync(string threadId, string messageId, RequestOptions options);
113 public virtual Task<ClientResult<MessageDeletionResult>> DeleteMessageAsync(string threadId, string messageId, CancellationToken cancellationToken = default);
114 [EditorBrowsable(EditorBrowsableState.Never)]
115 public virtual ClientResult DeleteThread(string threadId, RequestOptions options);
116 public virtual ClientResult<ThreadDeletionResult> DeleteThread(string threadId, CancellationToken cancellationToken = default);
117 [EditorBrowsable(EditorBrowsableState.Never)]
118 public virtual Task<ClientResult> DeleteThreadAsync(string threadId, RequestOptions options);
119 public virtual Task<ClientResult<ThreadDeletionResult>> DeleteThreadAsync(string threadId, CancellationToken cancellationToken = default);
120 [EditorBrowsable(EditorBrowsableState.Never)]
121 public virtual ClientResult GetAssistant(string assistantId, RequestOptions options);
122 public virtual ClientResult<Assistant> GetAssistant(string assistantId, CancellationToken cancellationToken = default);
123 [EditorBrowsable(EditorBrowsableState.Never)]
124 public virtual Task<ClientResult> GetAssistantAsync(string assistantId, RequestOptions options);
125 public virtual Task<ClientResult<Assistant>> GetAssistantAsync(string assistantId, CancellationToken cancellationToken = default);
126 public virtual CollectionResult<Assistant> GetAssistants(AssistantCollectionOptions options = null, CancellationToken cancellationToken = default);
127 public virtual CollectionResult<Assistant> GetAssistants(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
128 [EditorBrowsable(EditorBrowsableState.Never)]
129 public virtual CollectionResult GetAssistants(int? limit, string order, string after, string before, RequestOptions options);
130 public virtual AsyncCollectionResult<Assistant> GetAssistantsAsync(AssistantCollectionOptions options = null, CancellationToken cancellationToken = default);
131 public virtual AsyncCollectionResult<Assistant> GetAssistantsAsync(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
132 [EditorBrowsable(EditorBrowsableState.Never)]
133 public virtual AsyncCollectionResult GetAssistantsAsync(int? limit, string order, string after, string before, RequestOptions options);
134 [EditorBrowsable(EditorBrowsableState.Never)]
135 public virtual ClientResult GetMessage(string threadId, string messageId, RequestOptions options);
136 public virtual ClientResult<ThreadMessage> GetMessage(string threadId, string messageId, CancellationToken cancellationToken = default);
137 [EditorBrowsable(EditorBrowsableState.Never)]
138 public virtual Task<ClientResult> GetMessageAsync(string threadId, string messageId, RequestOptions options);
139 public virtual Task<ClientResult<ThreadMessage>> GetMessageAsync(string threadId, string messageId, CancellationToken cancellationToken = default);
140 public virtual CollectionResult<ThreadMessage> GetMessages(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
141 public virtual CollectionResult<ThreadMessage> GetMessages(string threadId, MessageCollectionOptions options = null, CancellationToken cancellationToken = default);
142 [EditorBrowsable(EditorBrowsableState.Never)]
143 public virtual CollectionResult GetMessages(string threadId, int? limit, string order, string after, string before, RequestOptions options);
144 public virtual AsyncCollectionResult<ThreadMessage> GetMessagesAsync(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
145 public virtual AsyncCollectionResult<ThreadMessage> GetMessagesAsync(string threadId, MessageCollectionOptions options = null, CancellationToken cancellationToken = default);
146 [EditorBrowsable(EditorBrowsableState.Never)]
147 public virtual AsyncCollectionResult GetMessagesAsync(string threadId, int? limit, string order, string after, string before, RequestOptions options);
148 [EditorBrowsable(EditorBrowsableState.Never)]
149 public virtual ClientResult GetRun(string threadId, string runId, RequestOptions options);
150 public virtual ClientResult<ThreadRun> GetRun(string threadId, string runId, CancellationToken cancellationToken = default);
151 [EditorBrowsable(EditorBrowsableState.Never)]
152 public virtual Task<ClientResult> GetRunAsync(string threadId, string runId, RequestOptions options);
153 public virtual Task<ClientResult<ThreadRun>> GetRunAsync(string threadId, string runId, CancellationToken cancellationToken = default);
154 public virtual CollectionResult<ThreadRun> GetRuns(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
155 public virtual CollectionResult<ThreadRun> GetRuns(string threadId, RunCollectionOptions options = null, CancellationToken cancellationToken = default);
156 [EditorBrowsable(EditorBrowsableState.Never)]
157 public virtual CollectionResult GetRuns(string threadId, int? limit, string order, string after, string before, RequestOptions options);
158 public virtual AsyncCollectionResult<ThreadRun> GetRunsAsync(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
159 public virtual AsyncCollectionResult<ThreadRun> GetRunsAsync(string threadId, RunCollectionOptions options = null, CancellationToken cancellationToken = default);
160 [EditorBrowsable(EditorBrowsableState.Never)]
161 public virtual AsyncCollectionResult GetRunsAsync(string threadId, int? limit, string order, string after, string before, RequestOptions options);
162 [EditorBrowsable(EditorBrowsableState.Never)]
163 public virtual ClientResult GetRunStep(string threadId, string runId, string stepId, RequestOptions options);
164 public virtual ClientResult<RunStep> GetRunStep(string threadId, string runId, string stepId, CancellationToken cancellationToken = default);
165 [EditorBrowsable(EditorBrowsableState.Never)]
166 public virtual Task<ClientResult> GetRunStepAsync(string threadId, string runId, string stepId, RequestOptions options);
167 public virtual Task<ClientResult<RunStep>> GetRunStepAsync(string threadId, string runId, string stepId, CancellationToken cancellationToken = default);
168 public virtual CollectionResult<RunStep> GetRunSteps(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
169 public virtual CollectionResult<RunStep> GetRunSteps(string threadId, string runId, RunStepCollectionOptions options = null, CancellationToken cancellationToken = default);
170 [EditorBrowsable(EditorBrowsableState.Never)]
171 public virtual CollectionResult GetRunSteps(string threadId, string runId, int? limit, string order, string after, string before, RequestOptions options);
172 public virtual AsyncCollectionResult<RunStep> GetRunStepsAsync(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
173 public virtual AsyncCollectionResult<RunStep> GetRunStepsAsync(string threadId, string runId, RunStepCollectionOptions options = null, CancellationToken cancellationToken = default);
174 [EditorBrowsable(EditorBrowsableState.Never)]
175 public virtual AsyncCollectionResult GetRunStepsAsync(string threadId, string runId, int? limit, string order, string after, string before, RequestOptions options);
176 [EditorBrowsable(EditorBrowsableState.Never)]
177 public virtual ClientResult GetThread(string threadId, RequestOptions options);
178 public virtual ClientResult<AssistantThread> GetThread(string threadId, CancellationToken cancellationToken = default);
179 [EditorBrowsable(EditorBrowsableState.Never)]
180 public virtual Task<ClientResult> GetThreadAsync(string threadId, RequestOptions options);
181 public virtual Task<ClientResult<AssistantThread>> GetThreadAsync(string threadId, CancellationToken cancellationToken = default);
182 public virtual ClientResult<Assistant> ModifyAssistant(string assistantId, AssistantModificationOptions options, CancellationToken cancellationToken = default);
183 [EditorBrowsable(EditorBrowsableState.Never)]
184 public virtual ClientResult ModifyAssistant(string assistantId, BinaryContent content, RequestOptions options = null);
185 public virtual Task<ClientResult<Assistant>> ModifyAssistantAsync(string assistantId, AssistantModificationOptions options, CancellationToken cancellationToken = default);
186 [EditorBrowsable(EditorBrowsableState.Never)]
187 public virtual Task<ClientResult> ModifyAssistantAsync(string assistantId, BinaryContent content, RequestOptions options = null);
188 public virtual ClientResult<ThreadMessage> ModifyMessage(string threadId, string messageId, MessageModificationOptions options, CancellationToken cancellationToken = default);
189 [EditorBrowsable(EditorBrowsableState.Never)]
190 public virtual ClientResult ModifyMessage(string threadId, string messageId, BinaryContent content, RequestOptions options = null);
191 public virtual Task<ClientResult<ThreadMessage>> ModifyMessageAsync(string threadId, string messageId, MessageModificationOptions options, CancellationToken cancellationToken = default);
192 [EditorBrowsable(EditorBrowsableState.Never)]
193 public virtual Task<ClientResult> ModifyMessageAsync(string threadId, string messageId, BinaryContent content, RequestOptions options = null);
194 [EditorBrowsable(EditorBrowsableState.Never)]
195 public virtual ClientResult ModifyRun(string threadId, string runId, BinaryContent content, RequestOptions options = null);
196 [EditorBrowsable(EditorBrowsableState.Never)]
197 public virtual Task<ClientResult> ModifyRunAsync(string threadId, string runId, BinaryContent content, RequestOptions options = null);
198 public virtual ClientResult<AssistantThread> ModifyThread(string threadId, ThreadModificationOptions options, CancellationToken cancellationToken = default);
199 [EditorBrowsable(EditorBrowsableState.Never)]
200 public virtual ClientResult ModifyThread(string threadId, BinaryContent content, RequestOptions options = null);
201 public virtual Task<ClientResult<AssistantThread>> ModifyThreadAsync(string threadId, ThreadModificationOptions options, CancellationToken cancellationToken = default);
202 [EditorBrowsable(EditorBrowsableState.Never)]
203 public virtual Task<ClientResult> ModifyThreadAsync(string threadId, BinaryContent content, RequestOptions options = null);
204 [EditorBrowsable(EditorBrowsableState.Never)]
205 public virtual ClientResult SubmitToolOutputsToRun(string threadId, string runId, BinaryContent content, RequestOptions options = null);
206 public virtual ClientResult<ThreadRun> SubmitToolOutputsToRun(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
207 [EditorBrowsable(EditorBrowsableState.Never)]
208 public virtual Task<ClientResult> SubmitToolOutputsToRunAsync(string threadId, string runId, BinaryContent content, RequestOptions options = null);
209 public virtual Task<ClientResult<ThreadRun>> SubmitToolOutputsToRunAsync(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
210 public virtual CollectionResult<StreamingUpdate> SubmitToolOutputsToRunStreaming(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
211 public virtual AsyncCollectionResult<StreamingUpdate> SubmitToolOutputsToRunStreamingAsync(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
212 }
213 [Experimental("OPENAI001")]
214 public class AssistantCollectionOptions {
215 public string AfterId { get; set; }
216 public string BeforeId { get; set; }
217 public AssistantCollectionOrder? Order { get; set; }
218 public int? PageSizeLimit { get; set; }
219 }
220 [Experimental("OPENAI001")]
221 public readonly partial struct AssistantCollectionOrder : IEquatable<AssistantCollectionOrder> {
222 public AssistantCollectionOrder(string value);
223 public static AssistantCollectionOrder Ascending { get; }
224 public static AssistantCollectionOrder Descending { get; }
225 public readonly bool Equals(AssistantCollectionOrder other);
226 [EditorBrowsable(EditorBrowsableState.Never)]
227 public override readonly bool Equals(object obj);
228 [EditorBrowsable(EditorBrowsableState.Never)]
229 public override readonly int GetHashCode();
230 public static bool operator ==(AssistantCollectionOrder left, AssistantCollectionOrder right);
231 public static implicit operator AssistantCollectionOrder(string value);
232 public static bool operator !=(AssistantCollectionOrder left, AssistantCollectionOrder right);
233 public override readonly string ToString();
234 }
235 [Experimental("OPENAI001")]
236 public class AssistantCreationOptions : IJsonModel<AssistantCreationOptions>, IPersistableModel<AssistantCreationOptions> {
237 public string Description { get; set; }
238 public string Instructions { get; set; }
239 public IDictionary<string, string> Metadata { get; }
240 public string Name { get; set; }
241 public float? NucleusSamplingFactor { get; set; }
242 public AssistantResponseFormat ResponseFormat { get; set; }
243 public float? Temperature { get; set; }
244 public ToolResources ToolResources { get; set; }
245 public IList<ToolDefinition> Tools { get; }
246 public static explicit operator AssistantCreationOptions(ClientResult result);
247 public static implicit operator BinaryContent(AssistantCreationOptions assistantCreationOptions);
248 }
249 [Experimental("OPENAI001")]
250 public class AssistantDeletionResult : IJsonModel<AssistantDeletionResult>, IPersistableModel<AssistantDeletionResult> {
251 public string AssistantId { get; }
252 public bool Deleted { get; }
253 public static explicit operator AssistantDeletionResult(ClientResult result);
254 public static implicit operator BinaryContent(AssistantDeletionResult assistantDeletionResult);
255 }
256 [Experimental("OPENAI001")]
257 public class AssistantModificationOptions : IJsonModel<AssistantModificationOptions>, IPersistableModel<AssistantModificationOptions> {
258 public IList<ToolDefinition> DefaultTools { get; }
259 public string Description { get; set; }
260 public string Instructions { get; set; }
261 public IDictionary<string, string> Metadata { get; }
262 public string Model { get; set; }
263 public string Name { get; set; }
264 public float? NucleusSamplingFactor { get; set; }
265 public AssistantResponseFormat ResponseFormat { get; set; }
266 public float? Temperature { get; set; }
267 public ToolResources ToolResources { get; set; }
268 public static explicit operator AssistantModificationOptions(ClientResult result);
269 public static implicit operator BinaryContent(AssistantModificationOptions assistantModificationOptions);
270 }
271 [Experimental("OPENAI001")]
272 public class AssistantResponseFormat : IEquatable<AssistantResponseFormat>, IEquatable<string>, IJsonModel<AssistantResponseFormat>, IPersistableModel<AssistantResponseFormat> {
273 public static AssistantResponseFormat Auto { get; }
274 public static AssistantResponseFormat JsonObject { get; }
275 public static AssistantResponseFormat Text { get; }
276 public static AssistantResponseFormat CreateAutoFormat();
277 public static AssistantResponseFormat CreateJsonObjectFormat();
278 public static AssistantResponseFormat CreateJsonSchemaFormat(string name, BinaryData jsonSchema, string description = null, bool? strictSchemaEnabled = null);
279 public static AssistantResponseFormat CreateTextFormat();
280 [EditorBrowsable(EditorBrowsableState.Never)]
281 public override bool Equals(object obj);
282 [EditorBrowsable(EditorBrowsableState.Never)]
283 public override int GetHashCode();
284 [EditorBrowsable(EditorBrowsableState.Never)]
285 public static bool operator ==(AssistantResponseFormat first, AssistantResponseFormat second);
286 public static explicit operator AssistantResponseFormat(ClientResult result);
287 public static implicit operator BinaryContent(AssistantResponseFormat assistantResponseFormat);
288 [EditorBrowsable(EditorBrowsableState.Never)]
289 public static implicit operator AssistantResponseFormat(string plainTextFormat);
290 [EditorBrowsable(EditorBrowsableState.Never)]
291 public static bool operator !=(AssistantResponseFormat first, AssistantResponseFormat second);
292 [EditorBrowsable(EditorBrowsableState.Never)]
293 bool IEquatable<AssistantResponseFormat>.Equals(AssistantResponseFormat other);
294 [EditorBrowsable(EditorBrowsableState.Never)]
295 bool IEquatable<string>.Equals(string other);
296 public override string ToString();
297 }
298 [Experimental("OPENAI001")]
299 public class AssistantThread : IJsonModel<AssistantThread>, IPersistableModel<AssistantThread> {
300 public DateTimeOffset CreatedAt { get; }
301 public string Id { get; }
302 public IReadOnlyDictionary<string, string> Metadata { get; }
303 public ToolResources ToolResources { get; }
304 public static explicit operator AssistantThread(ClientResult result);
305 public static implicit operator BinaryContent(AssistantThread assistantThread);
306 }
307 [Experimental("OPENAI001")]
308 public class CodeInterpreterToolDefinition : ToolDefinition, IJsonModel<CodeInterpreterToolDefinition>, IPersistableModel<CodeInterpreterToolDefinition> {
309 public new static explicit operator CodeInterpreterToolDefinition(ClientResult result);
310 public static implicit operator BinaryContent(CodeInterpreterToolDefinition codeInterpreterToolDefinition);
311 }
312 [Experimental("OPENAI001")]
313 public class CodeInterpreterToolResources : IJsonModel<CodeInterpreterToolResources>, IPersistableModel<CodeInterpreterToolResources> {
314 public IList<string> FileIds { get; }
315 public static explicit operator CodeInterpreterToolResources(ClientResult result);
316 public static implicit operator BinaryContent(CodeInterpreterToolResources codeInterpreterToolResources);
317 }
318 [Experimental("OPENAI001")]
319 public readonly partial struct FileSearchRanker : IEquatable<FileSearchRanker> {
320 public FileSearchRanker(string value);
321 public static FileSearchRanker Auto { get; }
322 public static FileSearchRanker Default20240821 { get; }
323 public readonly bool Equals(FileSearchRanker other);
324 [EditorBrowsable(EditorBrowsableState.Never)]
325 public override readonly bool Equals(object obj);
326 [EditorBrowsable(EditorBrowsableState.Never)]
327 public override readonly int GetHashCode();
328 public static bool operator ==(FileSearchRanker left, FileSearchRanker right);
329 public static implicit operator FileSearchRanker(string value);
330 public static bool operator !=(FileSearchRanker left, FileSearchRanker right);
331 public override readonly string ToString();
332 }
333 [Experimental("OPENAI001")]
334 public class FileSearchRankingOptions : IJsonModel<FileSearchRankingOptions>, IPersistableModel<FileSearchRankingOptions> {
335 public FileSearchRankingOptions(float scoreThreshold);
336 public FileSearchRanker? Ranker { get; set; }
337 public float ScoreThreshold { get; set; }
338 public static explicit operator FileSearchRankingOptions(ClientResult result);
339 public static implicit operator BinaryContent(FileSearchRankingOptions fileSearchRankingOptions);
340 }
341 [Experimental("OPENAI001")]
342 public class FileSearchToolDefinition : ToolDefinition, IJsonModel<FileSearchToolDefinition>, IPersistableModel<FileSearchToolDefinition> {
343 public int? MaxResults { get; set; }
344 public FileSearchRankingOptions RankingOptions { get; set; }
345 public new static explicit operator FileSearchToolDefinition(ClientResult result);
346 public static implicit operator BinaryContent(FileSearchToolDefinition fileSearchToolDefinition);
347 }
348 [Experimental("OPENAI001")]
349 public class FileSearchToolResources : IJsonModel<FileSearchToolResources>, IPersistableModel<FileSearchToolResources> {
350 public IList<VectorStoreCreationHelper> NewVectorStores { get; }
351 public IList<string> VectorStoreIds { get; }
352 public static explicit operator FileSearchToolResources(ClientResult result);
353 public static implicit operator BinaryContent(FileSearchToolResources fileSearchToolResources);
354 }
355 [Experimental("OPENAI001")]
356 public class FunctionToolDefinition : ToolDefinition, IJsonModel<FunctionToolDefinition>, IPersistableModel<FunctionToolDefinition> {
357 public FunctionToolDefinition(string name);
358 public string Description { get; set; }
359 public string FunctionName { get; set; }
360 public BinaryData Parameters { get; set; }
361 public bool? StrictParameterSchemaEnabled { get; set; }
362 public new static explicit operator FunctionToolDefinition(ClientResult result);
363 public static implicit operator BinaryContent(FunctionToolDefinition functionToolDefinition);
364 }
365 [Experimental("OPENAI001")]
366 public class MessageCollectionOptions {
367 public string AfterId { get; set; }
368 public string BeforeId { get; set; }
369 public MessageCollectionOrder? Order { get; set; }
370 public int? PageSizeLimit { get; set; }
371 }
372 [Experimental("OPENAI001")]
373 public readonly partial struct MessageCollectionOrder : IEquatable<MessageCollectionOrder> {
374 public MessageCollectionOrder(string value);
375 public static MessageCollectionOrder Ascending { get; }
376 public static MessageCollectionOrder Descending { get; }
377 public readonly bool Equals(MessageCollectionOrder other);
378 [EditorBrowsable(EditorBrowsableState.Never)]
379 public override readonly bool Equals(object obj);
380 [EditorBrowsable(EditorBrowsableState.Never)]
381 public override readonly int GetHashCode();
382 public static bool operator ==(MessageCollectionOrder left, MessageCollectionOrder right);
383 public static implicit operator MessageCollectionOrder(string value);
384 public static bool operator !=(MessageCollectionOrder left, MessageCollectionOrder right);
385 public override readonly string ToString();
386 }
387 [Experimental("OPENAI001")]
388 public abstract class MessageContent : IJsonModel<MessageContent>, IPersistableModel<MessageContent> {
389 public MessageImageDetail? ImageDetail { get; }
390 public string ImageFileId { get; }
391 public Uri ImageUri { get; }
392 public string Refusal { get; }
393 public string Text { get; }
394 public IReadOnlyList<TextAnnotation> TextAnnotations { get; }
395 public static MessageContent FromImageFileId(string imageFileId, MessageImageDetail? detail = null);
396 public static MessageContent FromImageUri(Uri imageUri, MessageImageDetail? detail = null);
397 public static MessageContent FromText(string text);
398 public static explicit operator MessageContent(ClientResult result);
399 public static implicit operator BinaryContent(MessageContent messageContent);
400 public static implicit operator MessageContent(string value);
401 }
402 [Experimental("OPENAI001")]
403 public class MessageContentUpdate : StreamingUpdate {
404 public MessageImageDetail? ImageDetail { get; }
405 public string ImageFileId { get; }
406 public string MessageId { get; }
407 public int MessageIndex { get; }
408 public string RefusalUpdate { get; }
409 public MessageRole? Role { get; }
410 public string Text { get; }
411 public TextAnnotationUpdate TextAnnotation { get; }
412 }
413 [Experimental("OPENAI001")]
414 public class MessageCreationAttachment : IJsonModel<MessageCreationAttachment>, IPersistableModel<MessageCreationAttachment> {
415 public MessageCreationAttachment(string fileId, IEnumerable<ToolDefinition> tools);
416 public string FileId { get; }
417 public IReadOnlyList<ToolDefinition> Tools { get; }
418 public static explicit operator MessageCreationAttachment(ClientResult result);
419 public static implicit operator BinaryContent(MessageCreationAttachment messageCreationAttachment);
420 }
421 [Experimental("OPENAI001")]
422 public class MessageCreationOptions : IJsonModel<MessageCreationOptions>, IPersistableModel<MessageCreationOptions> {
423 public IList<MessageCreationAttachment> Attachments { get; set; }
424 public IDictionary<string, string> Metadata { get; }
425 public static explicit operator MessageCreationOptions(ClientResult result);
426 public static implicit operator BinaryContent(MessageCreationOptions messageCreationOptions);
427 }
428 [Experimental("OPENAI001")]
429 public class MessageDeletionResult : IJsonModel<MessageDeletionResult>, IPersistableModel<MessageDeletionResult> {
430 public bool Deleted { get; }
431 public string MessageId { get; }
432 public static explicit operator MessageDeletionResult(ClientResult result);
433 public static implicit operator BinaryContent(MessageDeletionResult messageDeletionResult);
434 }
435 [Experimental("OPENAI001")]
436 public class MessageFailureDetails : IJsonModel<MessageFailureDetails>, IPersistableModel<MessageFailureDetails> {
437 public MessageFailureReason Reason { get; }
438 public static explicit operator MessageFailureDetails(ClientResult result);
439 public static implicit operator BinaryContent(MessageFailureDetails messageFailureDetails);
440 }
441 [Experimental("OPENAI001")]
442 public readonly partial struct MessageFailureReason : IEquatable<MessageFailureReason> {
443 public MessageFailureReason(string value);
444 public static MessageFailureReason ContentFilter { get; }
445 public static MessageFailureReason MaxTokens { get; }
446 public static MessageFailureReason RunCancelled { get; }
447 public static MessageFailureReason RunExpired { get; }
448 public static MessageFailureReason RunFailed { get; }
449 public readonly bool Equals(MessageFailureReason other);
450 [EditorBrowsable(EditorBrowsableState.Never)]
451 public override readonly bool Equals(object obj);
452 [EditorBrowsable(EditorBrowsableState.Never)]
453 public override readonly int GetHashCode();
454 public static bool operator ==(MessageFailureReason left, MessageFailureReason right);
455 public static implicit operator MessageFailureReason(string value);
456 public static bool operator !=(MessageFailureReason left, MessageFailureReason right);
457 public override readonly string ToString();
458 }
459 [Experimental("OPENAI001")]
460 public enum MessageImageDetail {
461 Auto = 0,
462 Low = 1,
463 High = 2
464 }
465 [Experimental("OPENAI001")]
466 public class MessageModificationOptions : IJsonModel<MessageModificationOptions>, IPersistableModel<MessageModificationOptions> {
467 public IDictionary<string, string> Metadata { get; }
468 public static explicit operator MessageModificationOptions(ClientResult result);
469 public static implicit operator BinaryContent(MessageModificationOptions messageModificationOptions);
470 }
471 [Experimental("OPENAI001")]
472 public enum MessageRole {
473 User = 0,
474 Assistant = 1
475 }
476 [Experimental("OPENAI001")]
477 public readonly partial struct MessageStatus : IEquatable<MessageStatus> {
478 public MessageStatus(string value);
479 public static MessageStatus Completed { get; }
480 public static MessageStatus Incomplete { get; }
481 public static MessageStatus InProgress { get; }
482 public readonly bool Equals(MessageStatus other);
483 [EditorBrowsable(EditorBrowsableState.Never)]
484 public override readonly bool Equals(object obj);
485 [EditorBrowsable(EditorBrowsableState.Never)]
486 public override readonly int GetHashCode();
487 public static bool operator ==(MessageStatus left, MessageStatus right);
488 public static implicit operator MessageStatus(string value);
489 public static bool operator !=(MessageStatus left, MessageStatus right);
490 public override readonly string ToString();
491 }
492 [Experimental("OPENAI001")]
493 public class MessageStatusUpdate : StreamingUpdate<ThreadMessage> {
494 }
495 [Experimental("OPENAI001")]
496 public abstract class RequiredAction {
497 public string FunctionArguments { get; }
498 public string FunctionName { get; }
499 public string ToolCallId { get; }
500 }
501 [Experimental("OPENAI001")]
502 public class RequiredActionUpdate : RunUpdate {
503 public string FunctionArguments { get; }
504 public string FunctionName { get; }
505 public string ToolCallId { get; }
506 public ThreadRun GetThreadRun();
507 }
508 [Experimental("OPENAI001")]
509 public class RunCollectionOptions {
510 public string AfterId { get; set; }
511 public string BeforeId { get; set; }
512 public RunCollectionOrder? Order { get; set; }
513 public int? PageSizeLimit { get; set; }
514 }
515 [Experimental("OPENAI001")]
516 public readonly partial struct RunCollectionOrder : IEquatable<RunCollectionOrder> {
517 public RunCollectionOrder(string value);
518 public static RunCollectionOrder Ascending { get; }
519 public static RunCollectionOrder Descending { get; }
520 public readonly bool Equals(RunCollectionOrder other);
521 [EditorBrowsable(EditorBrowsableState.Never)]
522 public override readonly bool Equals(object obj);
523 [EditorBrowsable(EditorBrowsableState.Never)]
524 public override readonly int GetHashCode();
525 public static bool operator ==(RunCollectionOrder left, RunCollectionOrder right);
526 public static implicit operator RunCollectionOrder(string value);
527 public static bool operator !=(RunCollectionOrder left, RunCollectionOrder right);
528 public override readonly string ToString();
529 }
530 [Experimental("OPENAI001")]
531 public class RunCreationOptions : IJsonModel<RunCreationOptions>, IPersistableModel<RunCreationOptions> {
532 public string AdditionalInstructions { get; set; }
533 public IList<ThreadInitializationMessage> AdditionalMessages { get; }
534 public bool? AllowParallelToolCalls { get; set; }
535 public string InstructionsOverride { get; set; }
536 public int? MaxInputTokenCount { get; set; }
537 public int? MaxOutputTokenCount { get; set; }
538 public IDictionary<string, string> Metadata { get; }
539 public string ModelOverride { get; set; }
540 public float? NucleusSamplingFactor { get; set; }
541 public AssistantResponseFormat ResponseFormat { get; set; }
542 public float? Temperature { get; set; }
543 public ToolConstraint ToolConstraint { get; set; }
544 public IList<ToolDefinition> ToolsOverride { get; }
545 public RunTruncationStrategy TruncationStrategy { get; set; }
546 public static explicit operator RunCreationOptions(ClientResult result);
547 public static implicit operator BinaryContent(RunCreationOptions runCreationOptions);
548 }
549 [Experimental("OPENAI001")]
550 public class RunError : IJsonModel<RunError>, IPersistableModel<RunError> {
551 public RunErrorCode Code { get; }
552 public string Message { get; }
553 public static explicit operator RunError(ClientResult result);
554 public static implicit operator BinaryContent(RunError runError);
555 }
556 [Experimental("OPENAI001")]
557 public readonly partial struct RunErrorCode : IEquatable<RunErrorCode> {
558 public RunErrorCode(string value);
559 public static RunErrorCode InvalidPrompt { get; }
560 public static RunErrorCode RateLimitExceeded { get; }
561 public static RunErrorCode ServerError { get; }
562 public readonly bool Equals(RunErrorCode other);
563 [EditorBrowsable(EditorBrowsableState.Never)]
564 public override readonly bool Equals(object obj);
565 [EditorBrowsable(EditorBrowsableState.Never)]
566 public override readonly int GetHashCode();
567 public static bool operator ==(RunErrorCode left, RunErrorCode right);
568 public static implicit operator RunErrorCode(string value);
569 public static bool operator !=(RunErrorCode left, RunErrorCode right);
570 public override readonly string ToString();
571 }
572 [Experimental("OPENAI001")]
573 public class RunIncompleteDetails : IJsonModel<RunIncompleteDetails>, IPersistableModel<RunIncompleteDetails> {
574 public RunIncompleteReason? Reason { get; }
575 public static explicit operator RunIncompleteDetails(ClientResult result);
576 public static implicit operator BinaryContent(RunIncompleteDetails runIncompleteDetails);
577 }
578 [Experimental("OPENAI001")]
579 public readonly partial struct RunIncompleteReason : IEquatable<RunIncompleteReason> {
580 public RunIncompleteReason(string value);
581 public static RunIncompleteReason MaxInputTokenCount { get; }
582 public static RunIncompleteReason MaxOutputTokenCount { get; }
583 public readonly bool Equals(RunIncompleteReason other);
584 [EditorBrowsable(EditorBrowsableState.Never)]
585 public override readonly bool Equals(object obj);
586 [EditorBrowsable(EditorBrowsableState.Never)]
587 public override readonly int GetHashCode();
588 public static bool operator ==(RunIncompleteReason left, RunIncompleteReason right);
589 public static implicit operator RunIncompleteReason(string value);
590 public static bool operator !=(RunIncompleteReason left, RunIncompleteReason right);
591 public override readonly string ToString();
592 }
593 [Experimental("OPENAI001")]
594 public class RunModificationOptions : IJsonModel<RunModificationOptions>, IPersistableModel<RunModificationOptions> {
595 public IDictionary<string, string> Metadata { get; }
596 public static explicit operator RunModificationOptions(ClientResult result);
597 public static implicit operator BinaryContent(RunModificationOptions runModificationOptions);
598 }
599 [Experimental("OPENAI001")]
600 public readonly partial struct RunStatus : IEquatable<RunStatus> {
601 public RunStatus(string value);
602 public static RunStatus Cancelled { get; }
603 public static RunStatus Cancelling { get; }
604 public static RunStatus Completed { get; }
605 public static RunStatus Expired { get; }
606 public static RunStatus Failed { get; }
607 public static RunStatus Incomplete { get; }
608 public static RunStatus InProgress { get; }
609 public bool IsTerminal { get; }
610 public static RunStatus Queued { get; }
611 public static RunStatus RequiresAction { get; }
612 public readonly bool Equals(RunStatus other);
613 [EditorBrowsable(EditorBrowsableState.Never)]
614 public override readonly bool Equals(object obj);
615 [EditorBrowsable(EditorBrowsableState.Never)]
616 public override readonly int GetHashCode();
617 public static bool operator ==(RunStatus left, RunStatus right);
618 public static implicit operator RunStatus(string value);
619 public static bool operator !=(RunStatus left, RunStatus right);
620 public override readonly string ToString();
621 }
622 [Experimental("OPENAI001")]
623 public class RunStep : IJsonModel<RunStep>, IPersistableModel<RunStep> {
624 public string AssistantId { get; }
625 public DateTimeOffset? CancelledAt { get; }
626 public DateTimeOffset? CompletedAt { get; }
627 public DateTimeOffset CreatedAt { get; }
628 public RunStepDetails Details { get; }
629 public DateTimeOffset? ExpiredAt { get; }
630 public DateTimeOffset? FailedAt { get; }
631 public string Id { get; }
632 public RunStepKind Kind { get; }
633 public RunStepError LastError { get; }
634 public IReadOnlyDictionary<string, string> Metadata { get; }
635 public string RunId { get; }
636 public RunStepStatus Status { get; }
637 public string ThreadId { get; }
638 public RunStepTokenUsage Usage { get; }
639 public static explicit operator RunStep(ClientResult result);
640 public static implicit operator BinaryContent(RunStep runStep);
641 }
642 [Experimental("OPENAI001")]
643 public abstract class RunStepCodeInterpreterOutput : IJsonModel<RunStepCodeInterpreterOutput>, IPersistableModel<RunStepCodeInterpreterOutput> {
644 public string ImageFileId { get; }
645 public string Logs { get; }
646 public static explicit operator RunStepCodeInterpreterOutput(ClientResult result);
647 public static implicit operator BinaryContent(RunStepCodeInterpreterOutput runStepCodeInterpreterOutput);
648 }
649 [Experimental("OPENAI001")]
650 public class RunStepCollectionOptions {
651 public string AfterId { get; set; }
652 public string BeforeId { get; set; }
653 public RunStepCollectionOrder? Order { get; set; }
654 public int? PageSizeLimit { get; set; }
655 }
656 [Experimental("OPENAI001")]
657 public readonly partial struct RunStepCollectionOrder : IEquatable<RunStepCollectionOrder> {
658 public RunStepCollectionOrder(string value);
659 public static RunStepCollectionOrder Ascending { get; }
660 public static RunStepCollectionOrder Descending { get; }
661 public readonly bool Equals(RunStepCollectionOrder other);
662 [EditorBrowsable(EditorBrowsableState.Never)]
663 public override readonly bool Equals(object obj);
664 [EditorBrowsable(EditorBrowsableState.Never)]
665 public override readonly int GetHashCode();
666 public static bool operator ==(RunStepCollectionOrder left, RunStepCollectionOrder right);
667 public static implicit operator RunStepCollectionOrder(string value);
668 public static bool operator !=(RunStepCollectionOrder left, RunStepCollectionOrder right);
669 public override readonly string ToString();
670 }
671 [Experimental("OPENAI001")]
672 public abstract class RunStepDetails : IJsonModel<RunStepDetails>, IPersistableModel<RunStepDetails> {
673 public string CreatedMessageId { get; }
674 public IReadOnlyList<RunStepToolCall> ToolCalls { get; }
675 public static explicit operator RunStepDetails(ClientResult result);
676 public static implicit operator BinaryContent(RunStepDetails runStepDetails);
677 }
678 [Experimental("OPENAI001")]
679 public class RunStepDetailsUpdate : StreamingUpdate {
680 public string CodeInterpreterInput { get; }
681 public IReadOnlyList<RunStepUpdateCodeInterpreterOutput> CodeInterpreterOutputs { get; }
682 public string CreatedMessageId { get; }
683 public FileSearchRankingOptions FileSearchRankingOptions { get; }
684 public IReadOnlyList<RunStepFileSearchResult> FileSearchResults { get; }
685 public string FunctionArguments { get; }
686 public string FunctionName { get; }
687 public string FunctionOutput { get; }
688 public string StepId { get; }
689 public string ToolCallId { get; }
690 public int? ToolCallIndex { get; }
691 }
692 [Experimental("OPENAI001")]
693 public class RunStepError : IJsonModel<RunStepError>, IPersistableModel<RunStepError> {
694 public RunStepErrorCode Code { get; }
695 public string Message { get; }
696 public static explicit operator RunStepError(ClientResult result);
697 public static implicit operator BinaryContent(RunStepError runStepError);
698 }
699 [Experimental("OPENAI001")]
700 public readonly partial struct RunStepErrorCode : IEquatable<RunStepErrorCode> {
701 public RunStepErrorCode(string value);
702 public static RunStepErrorCode RateLimitExceeded { get; }
703 public static RunStepErrorCode ServerError { get; }
704 public readonly bool Equals(RunStepErrorCode other);
705 [EditorBrowsable(EditorBrowsableState.Never)]
706 public override readonly bool Equals(object obj);
707 [EditorBrowsable(EditorBrowsableState.Never)]
708 public override readonly int GetHashCode();
709 public static bool operator ==(RunStepErrorCode left, RunStepErrorCode right);
710 public static implicit operator RunStepErrorCode(string value);
711 public static bool operator !=(RunStepErrorCode left, RunStepErrorCode right);
712 public override readonly string ToString();
713 }
714 [Experimental("OPENAI001")]
715 public class RunStepFileSearchResult : IJsonModel<RunStepFileSearchResult>, IPersistableModel<RunStepFileSearchResult> {
716 public IReadOnlyList<RunStepFileSearchResultContent> Content { get; }
717 public string FileId { get; }
718 public string FileName { get; }
719 public float Score { get; }
720 public static explicit operator RunStepFileSearchResult(ClientResult result);
721 public static implicit operator BinaryContent(RunStepFileSearchResult runStepFileSearchResult);
722 }
723 [Experimental("OPENAI001")]
724 public class RunStepFileSearchResultContent : IJsonModel<RunStepFileSearchResultContent>, IPersistableModel<RunStepFileSearchResultContent> {
725 public RunStepFileSearchResultContentKind Kind { get; }
726 public string Text { get; }
727 public static explicit operator RunStepFileSearchResultContent(ClientResult result);
728 public static implicit operator BinaryContent(RunStepFileSearchResultContent runStepFileSearchResultContent);
729 }
730 [Experimental("OPENAI001")]
731 public enum RunStepFileSearchResultContentKind {
732 Text = 0
733 }
734 [Experimental("OPENAI001")]
735 public enum RunStepKind {
736 CreatedMessage = 0,
737 ToolCall = 1
738 }
739 [Experimental("OPENAI001")]
740 public readonly partial struct RunStepStatus : IEquatable<RunStepStatus> {
741 public RunStepStatus(string value);
742 public static RunStepStatus Cancelled { get; }
743 public static RunStepStatus Completed { get; }
744 public static RunStepStatus Expired { get; }
745 public static RunStepStatus Failed { get; }
746 public static RunStepStatus InProgress { get; }
747 public readonly bool Equals(RunStepStatus other);
748 [EditorBrowsable(EditorBrowsableState.Never)]
749 public override readonly bool Equals(object obj);
750 [EditorBrowsable(EditorBrowsableState.Never)]
751 public override readonly int GetHashCode();
752 public static bool operator ==(RunStepStatus left, RunStepStatus right);
753 public static implicit operator RunStepStatus(string value);
754 public static bool operator !=(RunStepStatus left, RunStepStatus right);
755 public override readonly string ToString();
756 }
757 [Experimental("OPENAI001")]
758 public class RunStepTokenUsage : IJsonModel<RunStepTokenUsage>, IPersistableModel<RunStepTokenUsage> {
759 public int InputTokenCount { get; }
760 public int OutputTokenCount { get; }
761 public int TotalTokenCount { get; }
762 public static explicit operator RunStepTokenUsage(ClientResult result);
763 public static implicit operator BinaryContent(RunStepTokenUsage runStepTokenUsage);
764 }
765 [Experimental("OPENAI001")]
766 public class RunStepToolCall : IJsonModel<RunStepToolCall>, IPersistableModel<RunStepToolCall> {
767 public string CodeInterpreterInput { get; }
768 public IReadOnlyList<RunStepCodeInterpreterOutput> CodeInterpreterOutputs { get; }
769 public FileSearchRankingOptions FileSearchRankingOptions { get; }
770 public IReadOnlyList<RunStepFileSearchResult> FileSearchResults { get; }
771 public string FunctionArguments { get; }
772 public string FunctionName { get; }
773 public string FunctionOutput { get; }
774 public string Id { get; }
775 public RunStepToolCallKind Kind { get; }
776 public static explicit operator RunStepToolCall(ClientResult result);
777 public static implicit operator BinaryContent(RunStepToolCall runStepToolCall);
778 }
779 [Experimental("OPENAI001")]
780 public enum RunStepToolCallKind {
781 CodeInterpreter = 0,
782 FileSearch = 1,
783 Function = 2
784 }
785 [Experimental("OPENAI001")]
786 public class RunStepUpdate : StreamingUpdate<RunStep> {
787 }
788 [Experimental("OPENAI001")]
789 public class RunStepUpdateCodeInterpreterOutput : IJsonModel<RunStepUpdateCodeInterpreterOutput>, IPersistableModel<RunStepUpdateCodeInterpreterOutput> {
790 public string ImageFileId { get; }
791 public string Logs { get; }
792 public int OutputIndex { get; }
793 public static explicit operator RunStepUpdateCodeInterpreterOutput(ClientResult result);
794 public static implicit operator BinaryContent(RunStepUpdateCodeInterpreterOutput runStepUpdateCodeInterpreterOutput);
795 }
796 [Experimental("OPENAI001")]
797 public class RunTokenUsage : IJsonModel<RunTokenUsage>, IPersistableModel<RunTokenUsage> {
798 public int InputTokenCount { get; }
799 public int OutputTokenCount { get; }
800 public int TotalTokenCount { get; }
801 public static explicit operator RunTokenUsage(ClientResult result);
802 public static implicit operator BinaryContent(RunTokenUsage runTokenUsage);
803 }
804 [Experimental("OPENAI001")]
805 public class RunTruncationStrategy : IJsonModel<RunTruncationStrategy>, IPersistableModel<RunTruncationStrategy> {
806 public static RunTruncationStrategy Auto { get; }
807 public int? LastMessages { get; }
808 public static RunTruncationStrategy CreateLastMessagesStrategy(int lastMessageCount);
809 public static explicit operator RunTruncationStrategy(ClientResult result);
810 public static implicit operator BinaryContent(RunTruncationStrategy runTruncationStrategy);
811 }
812 [Experimental("OPENAI001")]
813 public class RunUpdate : StreamingUpdate<ThreadRun> {
814 }
815 [Experimental("OPENAI001")]
816 public abstract class StreamingUpdate {
817 public StreamingUpdateReason UpdateKind { get; }
818 }
819 [Experimental("OPENAI001")]
820 public enum StreamingUpdateReason {
821 Unknown = 0,
822 ThreadCreated = 1,
823 RunCreated = 2,
824 RunQueued = 3,
825 RunInProgress = 4,
826 RunRequiresAction = 5,
827 RunCompleted = 6,
828 RunIncomplete = 7,
829 RunFailed = 8,
830 RunCancelling = 9,
831 RunCancelled = 10,
832 RunExpired = 11,
833 RunStepCreated = 12,
834 RunStepInProgress = 13,
835 RunStepUpdated = 14,
836 RunStepCompleted = 15,
837 RunStepFailed = 16,
838 RunStepCancelled = 17,
839 RunStepExpired = 18,
840 MessageCreated = 19,
841 MessageInProgress = 20,
842 MessageUpdated = 21,
843 MessageCompleted = 22,
844 MessageFailed = 23,
845 Error = 24,
846 Done = 25
847 }
848 [Experimental("OPENAI001")]
849 public class StreamingUpdate<T> : StreamingUpdate where T : class {
850 public T Value { get; }
851 public static implicit operator T(StreamingUpdate<T> update);
852 }
853 [Experimental("OPENAI001")]
854 public class TextAnnotation {
855 public int EndIndex { get; }
856 public string InputFileId { get; }
857 public string OutputFileId { get; }
858 public int StartIndex { get; }
859 public string TextToReplace { get; }
860 }
861 [Experimental("OPENAI001")]
862 public class TextAnnotationUpdate {
863 public int ContentIndex { get; }
864 public int? EndIndex { get; }
865 public string InputFileId { get; }
866 public string OutputFileId { get; }
867 public int? StartIndex { get; }
868 public string TextToReplace { get; }
869 }
870 [Experimental("OPENAI001")]
871 public class ThreadCreationOptions : IJsonModel<ThreadCreationOptions>, IPersistableModel<ThreadCreationOptions> {
872 public IList<ThreadInitializationMessage> InitialMessages { get; }
873 public IDictionary<string, string> Metadata { get; }
874 public ToolResources ToolResources { get; set; }
875 public static explicit operator ThreadCreationOptions(ClientResult result);
876 public static implicit operator BinaryContent(ThreadCreationOptions threadCreationOptions);
877 }
878 [Experimental("OPENAI001")]
879 public class ThreadDeletionResult : IJsonModel<ThreadDeletionResult>, IPersistableModel<ThreadDeletionResult> {
880 public bool Deleted { get; }
881 public string ThreadId { get; }
882 public static explicit operator ThreadDeletionResult(ClientResult result);
883 public static implicit operator BinaryContent(ThreadDeletionResult threadDeletionResult);
884 }
885 [Experimental("OPENAI001")]
886 public class ThreadInitializationMessage : MessageCreationOptions {
887 public ThreadInitializationMessage(MessageRole role, IEnumerable<MessageContent> content);
888 public static implicit operator ThreadInitializationMessage(string initializationMessage);
889 }
890 [Experimental("OPENAI001")]
891 public class ThreadMessage : IJsonModel<ThreadMessage>, IPersistableModel<ThreadMessage> {
892 public string AssistantId { get; }
893 public IReadOnlyList<MessageCreationAttachment> Attachments { get; }
894 public DateTimeOffset? CompletedAt { get; }
895 public IReadOnlyList<MessageContent> Content { get; }
896 public DateTimeOffset CreatedAt { get; }
897 public string Id { get; }
898 public DateTimeOffset? IncompleteAt { get; }
899 public MessageFailureDetails IncompleteDetails { get; }
900 public IReadOnlyDictionary<string, string> Metadata { get; }
901 public MessageRole Role { get; }
902 public string RunId { get; }
903 public MessageStatus Status { get; }
904 public string ThreadId { get; }
905 public static explicit operator ThreadMessage(ClientResult result);
906 public static implicit operator BinaryContent(ThreadMessage threadMessage);
907 }
908 [Experimental("OPENAI001")]
909 public class ThreadModificationOptions : IJsonModel<ThreadModificationOptions>, IPersistableModel<ThreadModificationOptions> {
910 public IDictionary<string, string> Metadata { get; }
911 public ToolResources ToolResources { get; set; }
912 public static explicit operator ThreadModificationOptions(ClientResult result);
913 public static implicit operator BinaryContent(ThreadModificationOptions threadModificationOptions);
914 }
915 [Experimental("OPENAI001")]
916 public class ThreadRun : IJsonModel<ThreadRun>, IPersistableModel<ThreadRun> {
917 public bool? AllowParallelToolCalls { get; }
918 public string AssistantId { get; }
919 public DateTimeOffset? CancelledAt { get; }
920 public DateTimeOffset? CompletedAt { get; }
921 public DateTimeOffset CreatedAt { get; }
922 public DateTimeOffset? ExpiresAt { get; }
923 public DateTimeOffset? FailedAt { get; }
924 public string Id { get; }
925 public RunIncompleteDetails IncompleteDetails { get; }
926 public string Instructions { get; }
927 public RunError LastError { get; }
928 public int? MaxInputTokenCount { get; }
929 public int? MaxOutputTokenCount { get; }
930 public IReadOnlyDictionary<string, string> Metadata { get; }
931 public string Model { get; }
932 public float? NucleusSamplingFactor { get; }
933 public IReadOnlyList<RequiredAction> RequiredActions { get; }
934 public AssistantResponseFormat ResponseFormat { get; }
935 public DateTimeOffset? StartedAt { get; }
936 public RunStatus Status { get; }
937 public float? Temperature { get; }
938 public string ThreadId { get; }
939 public ToolConstraint ToolConstraint { get; }
940 public IReadOnlyList<ToolDefinition> Tools { get; }
941 public RunTruncationStrategy TruncationStrategy { get; }
942 public RunTokenUsage Usage { get; }
943 public static explicit operator ThreadRun(ClientResult result);
944 public static implicit operator BinaryContent(ThreadRun threadRun);
945 }
946 [Experimental("OPENAI001")]
947 public class ThreadUpdate : StreamingUpdate<AssistantThread> {
948 public DateTimeOffset CreatedAt { get; }
949 public string Id { get; }
950 public IReadOnlyDictionary<string, string> Metadata { get; }
951 public ToolResources ToolResources { get; }
952 }
953 [Experimental("OPENAI001")]
954 public class ToolConstraint : IJsonModel<ToolConstraint>, IPersistableModel<ToolConstraint> {
955 public ToolConstraint(ToolDefinition toolDefinition);
956 public static ToolConstraint Auto { get; }
957 public static ToolConstraint None { get; }
958 public static ToolConstraint Required { get; }
959 public static explicit operator ToolConstraint(ClientResult result);
960 public static implicit operator BinaryContent(ToolConstraint toolConstraint);
961 }
962 [Experimental("OPENAI001")]
963 public abstract class ToolDefinition : IJsonModel<ToolDefinition>, IPersistableModel<ToolDefinition> {
964 protected ToolDefinition();
965 protected ToolDefinition(string type);
966 public static CodeInterpreterToolDefinition CreateCodeInterpreter();
967 public static FileSearchToolDefinition CreateFileSearch(int? maxResults = null);
968 public static FunctionToolDefinition CreateFunction(string name, string description = null, BinaryData parameters = null, bool? strictParameterSchemaEnabled = null);
969 public static explicit operator ToolDefinition(ClientResult result);
970 public static implicit operator BinaryContent(ToolDefinition toolDefinition);
971 }
972 [Experimental("OPENAI001")]
973 public class ToolOutput : IJsonModel<ToolOutput>, IPersistableModel<ToolOutput> {
974 public ToolOutput();
975 public ToolOutput(string toolCallId, string output);
976 public string Output { get; set; }
977 public string ToolCallId { get; set; }
978 public static explicit operator ToolOutput(ClientResult result);
979 public static implicit operator BinaryContent(ToolOutput toolOutput);
980 }
981 [Experimental("OPENAI001")]
982 public class ToolResources : IJsonModel<ToolResources>, IPersistableModel<ToolResources> {
983 public CodeInterpreterToolResources CodeInterpreter { get; set; }
984 public FileSearchToolResources FileSearch { get; set; }
985 public static explicit operator ToolResources(ClientResult result);
986 public static implicit operator BinaryContent(ToolResources toolResources);
987 }
988 [Experimental("OPENAI001")]
989 public class VectorStoreCreationHelper : IJsonModel<VectorStoreCreationHelper>, IPersistableModel<VectorStoreCreationHelper> {
990 public VectorStoreCreationHelper();
991 public VectorStoreCreationHelper(IEnumerable<OpenAIFile> files);
992 public VectorStoreCreationHelper(IEnumerable<string> fileIds);
993 public FileChunkingStrategy ChunkingStrategy { get; set; }
994 public IList<string> FileIds { get; }
995 public IDictionary<string, string> Metadata { get; }
996 public static explicit operator VectorStoreCreationHelper(ClientResult result);
997 public static implicit operator BinaryContent(VectorStoreCreationHelper vectorStoreCreationHelper);
998 }
999}
1000namespace OpenAI.Audio {
1001 public class AudioClient {
1002 protected AudioClient();
1003 protected internal AudioClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
1004 public AudioClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
1005 public AudioClient(string model, ApiKeyCredential credential);
1006 public AudioClient(string model, string apiKey);
1007 public ClientPipeline Pipeline { get; }
1008 [EditorBrowsable(EditorBrowsableState.Never)]
1009 public virtual ClientResult GenerateSpeech(BinaryContent content, RequestOptions options = null);
1010 public virtual ClientResult<BinaryData> GenerateSpeech(string text, GeneratedSpeechVoice voice, SpeechGenerationOptions options = null, CancellationToken cancellationToken = default);
1011 [EditorBrowsable(EditorBrowsableState.Never)]
1012 public virtual Task<ClientResult> GenerateSpeechAsync(BinaryContent content, RequestOptions options = null);
1013 public virtual Task<ClientResult<BinaryData>> GenerateSpeechAsync(string text, GeneratedSpeechVoice voice, SpeechGenerationOptions options = null, CancellationToken cancellationToken = default);
1014 [EditorBrowsable(EditorBrowsableState.Never)]
1015 public virtual ClientResult TranscribeAudio(BinaryContent content, string contentType, RequestOptions options = null);
1016 public virtual ClientResult<AudioTranscription> TranscribeAudio(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
1017 public virtual ClientResult<AudioTranscription> TranscribeAudio(string audioFilePath, AudioTranscriptionOptions options = null);
1018 [EditorBrowsable(EditorBrowsableState.Never)]
1019 public virtual Task<ClientResult> TranscribeAudioAsync(BinaryContent content, string contentType, RequestOptions options = null);
1020 public virtual Task<ClientResult<AudioTranscription>> TranscribeAudioAsync(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
1021 public virtual Task<ClientResult<AudioTranscription>> TranscribeAudioAsync(string audioFilePath, AudioTranscriptionOptions options = null);
1022 public virtual ClientResult TranslateAudio(BinaryContent content, string contentType, RequestOptions options = null);
1023 public virtual ClientResult<AudioTranslation> TranslateAudio(Stream audio, string audioFilename, AudioTranslationOptions options = null, CancellationToken cancellationToken = default);
1024 public virtual ClientResult<AudioTranslation> TranslateAudio(string audioFilePath, AudioTranslationOptions options = null);
1025 public virtual Task<ClientResult> TranslateAudioAsync(BinaryContent content, string contentType, RequestOptions options = null);
1026 public virtual Task<ClientResult<AudioTranslation>> TranslateAudioAsync(Stream audio, string audioFilename, AudioTranslationOptions options = null, CancellationToken cancellationToken = default);
1027 public virtual Task<ClientResult<AudioTranslation>> TranslateAudioAsync(string audioFilePath, AudioTranslationOptions options = null);
1028 }
1029 [Flags]
1030 public enum AudioTimestampGranularities {
1031 Default = 0,
1032 Word = 1,
1033 Segment = 2
1034 }
1035 public class AudioTranscription : IJsonModel<AudioTranscription>, IPersistableModel<AudioTranscription> {
1036 public TimeSpan? Duration { get; }
1037 public string Language { get; }
1038 public IReadOnlyList<TranscribedSegment> Segments { get; }
1039 public string Text { get; }
1040 public IReadOnlyList<TranscribedWord> Words { get; }
1041 public static explicit operator AudioTranscription(ClientResult result);
1042 public static implicit operator BinaryContent(AudioTranscription audioTranscription);
1043 }
1044 public readonly partial struct AudioTranscriptionFormat : IEquatable<AudioTranscriptionFormat> {
1045 public AudioTranscriptionFormat(string value);
1046 public static AudioTranscriptionFormat Simple { get; }
1047 public static AudioTranscriptionFormat Srt { get; }
1048 [EditorBrowsable(EditorBrowsableState.Never)]
1049 public static AudioTranscriptionFormat Text { get; }
1050 public static AudioTranscriptionFormat Verbose { get; }
1051 public static AudioTranscriptionFormat Vtt { get; }
1052 public readonly bool Equals(AudioTranscriptionFormat other);
1053 [EditorBrowsable(EditorBrowsableState.Never)]
1054 public override readonly bool Equals(object obj);
1055 [EditorBrowsable(EditorBrowsableState.Never)]
1056 public override readonly int GetHashCode();
1057 public static bool operator ==(AudioTranscriptionFormat left, AudioTranscriptionFormat right);
1058 public static implicit operator AudioTranscriptionFormat(string value);
1059 public static bool operator !=(AudioTranscriptionFormat left, AudioTranscriptionFormat right);
1060 public override readonly string ToString();
1061 }
1062 public class AudioTranscriptionOptions : IJsonModel<AudioTranscriptionOptions>, IPersistableModel<AudioTranscriptionOptions> {
1063 public string Language { get; set; }
1064 public string Prompt { get; set; }
1065 public AudioTranscriptionFormat? ResponseFormat { get; set; }
1066 public float? Temperature { get; set; }
1067 public AudioTimestampGranularities TimestampGranularities { get; set; }
1068 public static explicit operator AudioTranscriptionOptions(ClientResult result);
1069 public static implicit operator BinaryContent(AudioTranscriptionOptions audioTranscriptionOptions);
1070 }
1071 public class AudioTranslation : IJsonModel<AudioTranslation>, IPersistableModel<AudioTranslation> {
1072 public TimeSpan? Duration { get; }
1073 public string Language { get; }
1074 public IReadOnlyList<TranscribedSegment> Segments { get; }
1075 public string Text { get; }
1076 public static explicit operator AudioTranslation(ClientResult result);
1077 public static implicit operator BinaryContent(AudioTranslation audioTranslation);
1078 }
1079 public readonly partial struct AudioTranslationFormat : IEquatable<AudioTranslationFormat> {
1080 public AudioTranslationFormat(string value);
1081 public static AudioTranslationFormat Simple { get; }
1082 public static AudioTranslationFormat Srt { get; }
1083 [EditorBrowsable(EditorBrowsableState.Never)]
1084 public static AudioTranslationFormat Text { get; }
1085 public static AudioTranslationFormat Verbose { get; }
1086 public static AudioTranslationFormat Vtt { get; }
1087 public readonly bool Equals(AudioTranslationFormat other);
1088 [EditorBrowsable(EditorBrowsableState.Never)]
1089 public override readonly bool Equals(object obj);
1090 [EditorBrowsable(EditorBrowsableState.Never)]
1091 public override readonly int GetHashCode();
1092 public static bool operator ==(AudioTranslationFormat left, AudioTranslationFormat right);
1093 public static implicit operator AudioTranslationFormat(string value);
1094 public static bool operator !=(AudioTranslationFormat left, AudioTranslationFormat right);
1095 public override readonly string ToString();
1096 }
1097 public class AudioTranslationOptions : IJsonModel<AudioTranslationOptions>, IPersistableModel<AudioTranslationOptions> {
1098 public string Prompt { get; set; }
1099 public AudioTranslationFormat? ResponseFormat { get; set; }
1100 public float? Temperature { get; set; }
1101 public static explicit operator AudioTranslationOptions(ClientResult result);
1102 public static implicit operator BinaryContent(AudioTranslationOptions audioTranslationOptions);
1103 }
1104 public readonly partial struct GeneratedSpeechFormat : IEquatable<GeneratedSpeechFormat> {
1105 public GeneratedSpeechFormat(string value);
1106 public static GeneratedSpeechFormat Aac { get; }
1107 public static GeneratedSpeechFormat Flac { get; }
1108 public static GeneratedSpeechFormat Mp3 { get; }
1109 public static GeneratedSpeechFormat Opus { get; }
1110 public static GeneratedSpeechFormat Pcm { get; }
1111 public static GeneratedSpeechFormat Wav { get; }
1112 public readonly bool Equals(GeneratedSpeechFormat other);
1113 [EditorBrowsable(EditorBrowsableState.Never)]
1114 public override readonly bool Equals(object obj);
1115 [EditorBrowsable(EditorBrowsableState.Never)]
1116 public override readonly int GetHashCode();
1117 public static bool operator ==(GeneratedSpeechFormat left, GeneratedSpeechFormat right);
1118 public static implicit operator GeneratedSpeechFormat(string value);
1119 public static bool operator !=(GeneratedSpeechFormat left, GeneratedSpeechFormat right);
1120 public override readonly string ToString();
1121 }
1122 public readonly partial struct GeneratedSpeechVoice : IEquatable<GeneratedSpeechVoice> {
1123 public GeneratedSpeechVoice(string value);
1124 public static GeneratedSpeechVoice Alloy { get; }
1125 public static GeneratedSpeechVoice Ash { get; }
1126 public static GeneratedSpeechVoice Coral { get; }
1127 public static GeneratedSpeechVoice Echo { get; }
1128 public static GeneratedSpeechVoice Fable { get; }
1129 public static GeneratedSpeechVoice Nova { get; }
1130 public static GeneratedSpeechVoice Onyx { get; }
1131 public static GeneratedSpeechVoice Sage { get; }
1132 public static GeneratedSpeechVoice Shimmer { get; }
1133 public readonly bool Equals(GeneratedSpeechVoice other);
1134 [EditorBrowsable(EditorBrowsableState.Never)]
1135 public override readonly bool Equals(object obj);
1136 [EditorBrowsable(EditorBrowsableState.Never)]
1137 public override readonly int GetHashCode();
1138 public static bool operator ==(GeneratedSpeechVoice left, GeneratedSpeechVoice right);
1139 public static implicit operator GeneratedSpeechVoice(string value);
1140 public static bool operator !=(GeneratedSpeechVoice left, GeneratedSpeechVoice right);
1141 public override readonly string ToString();
1142 }
1143 public static class OpenAIAudioModelFactory {
1144 public static AudioTranscription AudioTranscription(string language = null, TimeSpan? duration = null, string text = null, IEnumerable<TranscribedWord> words = null, IEnumerable<TranscribedSegment> segments = null);
1145 public static AudioTranslation AudioTranslation(string language = null, TimeSpan? duration = null, string text = null, IEnumerable<TranscribedSegment> segments = null);
1146 public static TranscribedSegment TranscribedSegment(int id = 0, int seekOffset = 0, TimeSpan startTime = default, TimeSpan endTime = default, string text = null, ReadOnlyMemory<int> tokenIds = default, float temperature = 0, float averageLogProbability = 0, float compressionRatio = 0, float noSpeechProbability = 0);
1147 public static TranscribedWord TranscribedWord(string word = null, TimeSpan startTime = default, TimeSpan endTime = default);
1148 }
1149 public class SpeechGenerationOptions : IJsonModel<SpeechGenerationOptions>, IPersistableModel<SpeechGenerationOptions> {
1150 public GeneratedSpeechFormat? ResponseFormat { get; set; }
1151 public float? SpeedRatio { get; set; }
1152 public static explicit operator SpeechGenerationOptions(ClientResult result);
1153 public static implicit operator BinaryContent(SpeechGenerationOptions speechGenerationOptions);
1154 }
1155 public readonly partial struct TranscribedSegment : IJsonModel<TranscribedSegment>, IPersistableModel<TranscribedSegment>, IJsonModel<object>, IPersistableModel<object> {
1156 public float AverageLogProbability { get; }
1157 public float CompressionRatio { get; }
1158 public TimeSpan EndTime { get; }
1159 public int Id { get; }
1160 public float NoSpeechProbability { get; }
1161 public int SeekOffset { get; }
1162 public TimeSpan StartTime { get; }
1163 public float Temperature { get; }
1164 public string Text { get; }
1165 public ReadOnlyMemory<int> TokenIds { get; }
1166 public static explicit operator TranscribedSegment(ClientResult result);
1167 public static implicit operator BinaryContent(TranscribedSegment transcribedSegment);
1168 }
1169 public readonly partial struct TranscribedWord : IJsonModel<TranscribedWord>, IPersistableModel<TranscribedWord>, IJsonModel<object>, IPersistableModel<object> {
1170 public TimeSpan EndTime { get; }
1171 public TimeSpan StartTime { get; }
1172 public string Word { get; }
1173 public static explicit operator TranscribedWord(ClientResult result);
1174 public static implicit operator BinaryContent(TranscribedWord transcribedWord);
1175 }
1176}
1177namespace OpenAI.Batch {
1178 [Experimental("OPENAI001")]
1179 public class BatchClient {
1180 protected BatchClient();
1181 public BatchClient(ApiKeyCredential credential, OpenAIClientOptions options);
1182 public BatchClient(ApiKeyCredential credential);
1183 protected internal BatchClient(ClientPipeline pipeline, OpenAIClientOptions options);
1184 public BatchClient(string apiKey);
1185 public ClientPipeline Pipeline { get; }
1186 public virtual CreateBatchOperation CreateBatch(BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
1187 public virtual Task<CreateBatchOperation> CreateBatchAsync(BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
1188 public virtual CollectionResult GetBatches(string after, int? limit, RequestOptions options);
1189 public virtual AsyncCollectionResult GetBatchesAsync(string after, int? limit, RequestOptions options);
1190 }
1191 [Experimental("OPENAI001")]
1192 public class CreateBatchOperation : OperationResult {
1193 public string BatchId { get; }
1194 public override ContinuationToken? RehydrationToken { get; protected set; }
1195 public virtual ClientResult Cancel(RequestOptions? options);
1196 public virtual Task<ClientResult> CancelAsync(RequestOptions? options);
1197 public virtual ClientResult GetBatch(RequestOptions? options);
1198 public virtual Task<ClientResult> GetBatchAsync(RequestOptions? options);
1199 public static CreateBatchOperation Rehydrate(BatchClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
1200 public static Task<CreateBatchOperation> RehydrateAsync(BatchClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
1201 public override ClientResult UpdateStatus(RequestOptions? options = null);
1202 public override ValueTask<ClientResult> UpdateStatusAsync(RequestOptions? options = null);
1203 }
1204}
1205namespace OpenAI.Chat {
1206 public class AssistantChatMessage : ChatMessage, IJsonModel<AssistantChatMessage>, IPersistableModel<AssistantChatMessage> {
1207 public AssistantChatMessage(ChatCompletion chatCompletion);
1208 [Obsolete("This constructor is obsolete. Please use the constructor that takes an IEnumerable<ChatToolCall> parameter instead.")]
1209 public AssistantChatMessage(ChatFunctionCall functionCall);
1210 public AssistantChatMessage(params ChatMessageContentPart[] contentParts);
1211 public AssistantChatMessage(ChatOutputAudioReference outputAudioReference);
1212 public AssistantChatMessage(IEnumerable<ChatMessageContentPart> contentParts);
1213 public AssistantChatMessage(IEnumerable<ChatToolCall> toolCalls);
1214 public AssistantChatMessage(string content);
1215 [Obsolete("This property is obsolete. Please use ToolCalls instead.")]
1216 public ChatFunctionCall FunctionCall { get; set; }
1217 public ChatOutputAudioReference OutputAudioReference { get; set; }
1218 public string ParticipantName { get; set; }
1219 public string Refusal { get; set; }
1220 public IList<ChatToolCall> ToolCalls { get; }
1221 public new static explicit operator AssistantChatMessage(ClientResult result);
1222 public static implicit operator BinaryContent(AssistantChatMessage assistantChatMessage);
1223 }
1224 public class ChatAudioOptions : IJsonModel<ChatAudioOptions>, IPersistableModel<ChatAudioOptions> {
1225 public ChatAudioOptions(ChatOutputAudioVoice outputAudioVoice, ChatOutputAudioFormat outputAudioFormat);
1226 public ChatOutputAudioFormat OutputAudioFormat { get; }
1227 public ChatOutputAudioVoice OutputAudioVoice { get; }
1228 public static explicit operator ChatAudioOptions(ClientResult result);
1229 public static implicit operator BinaryContent(ChatAudioOptions chatAudioOptions);
1230 }
1231 public class ChatClient {
1232 protected ChatClient();
1233 protected internal ChatClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
1234 public ChatClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
1235 public ChatClient(string model, ApiKeyCredential credential);
1236 public ChatClient(string model, string apiKey);
1237 public ClientPipeline Pipeline { get; }
1238 public virtual ClientResult<ChatCompletion> CompleteChat(params ChatMessage[] messages);
1239 [EditorBrowsable(EditorBrowsableState.Never)]
1240 public virtual ClientResult CompleteChat(BinaryContent content, RequestOptions options = null);
1241 public virtual ClientResult<ChatCompletion> CompleteChat(IEnumerable<ChatMessage> messages, ChatCompletionOptions options = null, CancellationToken cancellationToken = default);
1242 public virtual Task<ClientResult<ChatCompletion>> CompleteChatAsync(params ChatMessage[] messages);
1243 [EditorBrowsable(EditorBrowsableState.Never)]
1244 public virtual Task<ClientResult> CompleteChatAsync(BinaryContent content, RequestOptions options = null);
1245 public virtual Task<ClientResult<ChatCompletion>> CompleteChatAsync(IEnumerable<ChatMessage> messages, ChatCompletionOptions options = null, CancellationToken cancellationToken = default);
1246 public virtual CollectionResult<StreamingChatCompletionUpdate> CompleteChatStreaming(params ChatMessage[] messages);
1247 public virtual CollectionResult<StreamingChatCompletionUpdate> CompleteChatStreaming(IEnumerable<ChatMessage> messages, ChatCompletionOptions options = null, CancellationToken cancellationToken = default);
1248 public virtual AsyncCollectionResult<StreamingChatCompletionUpdate> CompleteChatStreamingAsync(params ChatMessage[] messages);
1249 public virtual AsyncCollectionResult<StreamingChatCompletionUpdate> CompleteChatStreamingAsync(IEnumerable<ChatMessage> messages, ChatCompletionOptions options = null, CancellationToken cancellationToken = default);
1250 }
1251 public class ChatCompletion : IJsonModel<ChatCompletion>, IPersistableModel<ChatCompletion> {
1252 public IReadOnlyList<ChatMessageAnnotation> Annotations { get; }
1253 public ChatMessageContent Content { get; }
1254 public IReadOnlyList<ChatTokenLogProbabilityDetails> ContentTokenLogProbabilities { get; }
1255 public DateTimeOffset CreatedAt { get; }
1256 public ChatFinishReason FinishReason { get; }
1257 [Obsolete("This property is obsolete. Please use ToolCalls instead.")]
1258 public ChatFunctionCall FunctionCall { get; }
1259 public string Id { get; }
1260 public string Model { get; }
1261 public ChatOutputAudio OutputAudio { get; }
1262 public string Refusal { get; }
1263 public IReadOnlyList<ChatTokenLogProbabilityDetails> RefusalTokenLogProbabilities { get; }
1264 public ChatMessageRole Role { get; }
1265 public string SystemFingerprint { get; }
1266 public IReadOnlyList<ChatToolCall> ToolCalls { get; }
1267 public ChatTokenUsage Usage { get; }
1268 public static explicit operator ChatCompletion(ClientResult result);
1269 public static implicit operator BinaryContent(ChatCompletion chatCompletion);
1270 }
1271 public class ChatCompletionOptions : IJsonModel<ChatCompletionOptions>, IPersistableModel<ChatCompletionOptions> {
1272 public bool? AllowParallelToolCalls { get; set; }
1273 public ChatAudioOptions AudioOptions { get; set; }
1274 public string EndUserId { get; set; }
1275 public float? FrequencyPenalty { get; set; }
1276 [Obsolete("This property is obsolete. Please use ToolChoice instead.")]
1277 public ChatFunctionChoice FunctionChoice { get; set; }
1278 [Obsolete("This property is obsolete. Please use Tools instead.")]
1279 public IList<ChatFunction> Functions { get; }
1280 public bool? IncludeLogProbabilities { get; set; }
1281 public IDictionary<int, int> LogitBiases { get; }
1282 public int? MaxOutputTokenCount { get; set; }
1283 public IDictionary<string, string> Metadata { get; }
1284 public ChatOutputPrediction OutputPrediction { get; set; }
1285 public float? PresencePenalty { get; set; }
1286 public ChatReasoningEffortLevel? ReasoningEffortLevel { get; set; }
1287 public ChatResponseFormat ResponseFormat { get; set; }
1288 public ChatResponseModalities ResponseModalities { get; set; }
1289 [Experimental("OPENAI001")]
1290 public long? Seed { get; set; }
1291 public IList<string> StopSequences { get; }
1292 public bool? StoredOutputEnabled { get; set; }
1293 public float? Temperature { get; set; }
1294 public ChatToolChoice ToolChoice { get; set; }
1295 public IList<ChatTool> Tools { get; }
1296 public int? TopLogProbabilityCount { get; set; }
1297 public float? TopP { get; set; }
1298 public ChatWebSearchOptions WebSearchOptions { get; set; }
1299 public static explicit operator ChatCompletionOptions(ClientResult result);
1300 public static implicit operator BinaryContent(ChatCompletionOptions chatCompletionOptions);
1301 }
1302 public enum ChatFinishReason {
1303 Stop = 0,
1304 Length = 1,
1305 ContentFilter = 2,
1306 ToolCalls = 3,
1307 FunctionCall = 4
1308 }
1309 [Obsolete("This class is obsolete. Please use ChatTool instead.")]
1310 public class ChatFunction : IJsonModel<ChatFunction>, IPersistableModel<ChatFunction> {
1311 public ChatFunction(string functionName);
1312 public string FunctionDescription { get; set; }
1313 public string FunctionName { get; }
1314 public BinaryData FunctionParameters { get; set; }
1315 public static explicit operator ChatFunction(ClientResult result);
1316 public static implicit operator BinaryContent(ChatFunction chatFunction);
1317 }
1318 [Obsolete("This class is obsolete. Please use ChatToolCall instead.")]
1319 public class ChatFunctionCall : IJsonModel<ChatFunctionCall>, IPersistableModel<ChatFunctionCall> {
1320 public ChatFunctionCall(string functionName, BinaryData functionArguments);
1321 public BinaryData FunctionArguments { get; }
1322 public string FunctionName { get; }
1323 public static explicit operator ChatFunctionCall(ClientResult result);
1324 public static implicit operator BinaryContent(ChatFunctionCall chatFunctionCall);
1325 }
1326 [Obsolete("This class is obsolete. Please use ChatToolChoice instead.")]
1327 public class ChatFunctionChoice : IJsonModel<ChatFunctionChoice>, IPersistableModel<ChatFunctionChoice> {
1328 public static ChatFunctionChoice CreateAutoChoice();
1329 public static ChatFunctionChoice CreateNamedChoice(string functionName);
1330 public static ChatFunctionChoice CreateNoneChoice();
1331 public static explicit operator ChatFunctionChoice(ClientResult result);
1332 public static implicit operator BinaryContent(ChatFunctionChoice chatFunctionChoice);
1333 }
1334 public readonly partial struct ChatImageDetailLevel : IEquatable<ChatImageDetailLevel> {
1335 public ChatImageDetailLevel(string value);
1336 public static ChatImageDetailLevel Auto { get; }
1337 public static ChatImageDetailLevel High { get; }
1338 public static ChatImageDetailLevel Low { get; }
1339 public readonly bool Equals(ChatImageDetailLevel other);
1340 [EditorBrowsable(EditorBrowsableState.Never)]
1341 public override readonly bool Equals(object obj);
1342 [EditorBrowsable(EditorBrowsableState.Never)]
1343 public override readonly int GetHashCode();
1344 public static bool operator ==(ChatImageDetailLevel left, ChatImageDetailLevel right);
1345 public static implicit operator ChatImageDetailLevel(string value);
1346 public static bool operator !=(ChatImageDetailLevel left, ChatImageDetailLevel right);
1347 public override readonly string ToString();
1348 }
1349 public readonly partial struct ChatInputAudioFormat : IEquatable<ChatInputAudioFormat> {
1350 public ChatInputAudioFormat(string value);
1351 public static ChatInputAudioFormat Mp3 { get; }
1352 public static ChatInputAudioFormat Wav { get; }
1353 public readonly bool Equals(ChatInputAudioFormat other);
1354 [EditorBrowsable(EditorBrowsableState.Never)]
1355 public override readonly bool Equals(object obj);
1356 [EditorBrowsable(EditorBrowsableState.Never)]
1357 public override readonly int GetHashCode();
1358 public static bool operator ==(ChatInputAudioFormat left, ChatInputAudioFormat right);
1359 public static implicit operator ChatInputAudioFormat(string value);
1360 public static bool operator !=(ChatInputAudioFormat left, ChatInputAudioFormat right);
1361 public override readonly string ToString();
1362 }
1363 public class ChatInputTokenUsageDetails : IJsonModel<ChatInputTokenUsageDetails>, IPersistableModel<ChatInputTokenUsageDetails> {
1364 public int AudioTokenCount { get; }
1365 public int CachedTokenCount { get; }
1366 public static explicit operator ChatInputTokenUsageDetails(ClientResult result);
1367 public static implicit operator BinaryContent(ChatInputTokenUsageDetails chatInputTokenUsageDetails);
1368 }
1369 public class ChatMessage : IJsonModel<ChatMessage>, IPersistableModel<ChatMessage> {
1370 public ChatMessageContent Content { get; }
1371 public static AssistantChatMessage CreateAssistantMessage(ChatCompletion chatCompletion);
1372 public static AssistantChatMessage CreateAssistantMessage(ChatFunctionCall functionCall);
1373 public static AssistantChatMessage CreateAssistantMessage(params ChatMessageContentPart[] contentParts);
1374 public static AssistantChatMessage CreateAssistantMessage(ChatOutputAudioReference outputAudioReference);
1375 public static AssistantChatMessage CreateAssistantMessage(IEnumerable<ChatMessageContentPart> contentParts);
1376 public static AssistantChatMessage CreateAssistantMessage(IEnumerable<ChatToolCall> toolCalls);
1377 public static AssistantChatMessage CreateAssistantMessage(string content);
1378 public static DeveloperChatMessage CreateDeveloperMessage(params ChatMessageContentPart[] contentParts);
1379 public static DeveloperChatMessage CreateDeveloperMessage(IEnumerable<ChatMessageContentPart> contentParts);
1380 public static DeveloperChatMessage CreateDeveloperMessage(string content);
1381 [Obsolete("This method is obsolete. Please use CreateToolMessage instead.")]
1382 public static FunctionChatMessage CreateFunctionMessage(string functionName, string content);
1383 public static SystemChatMessage CreateSystemMessage(params ChatMessageContentPart[] contentParts);
1384 public static SystemChatMessage CreateSystemMessage(IEnumerable<ChatMessageContentPart> contentParts);
1385 public static SystemChatMessage CreateSystemMessage(string content);
1386 public static ToolChatMessage CreateToolMessage(string toolCallId, params ChatMessageContentPart[] contentParts);
1387 public static ToolChatMessage CreateToolMessage(string toolCallId, IEnumerable<ChatMessageContentPart> contentParts);
1388 public static ToolChatMessage CreateToolMessage(string toolCallId, string content);
1389 public static UserChatMessage CreateUserMessage(params ChatMessageContentPart[] contentParts);
1390 public static UserChatMessage CreateUserMessage(IEnumerable<ChatMessageContentPart> contentParts);
1391 public static UserChatMessage CreateUserMessage(string content);
1392 public static explicit operator ChatMessage(ClientResult result);
1393 public static implicit operator BinaryContent(ChatMessage chatMessage);
1394 public static implicit operator ChatMessage(string content);
1395 }
1396 public class ChatMessageAnnotation : IJsonModel<ChatMessageAnnotation>, IPersistableModel<ChatMessageAnnotation> {
1397 public int EndIndex { get; }
1398 public int StartIndex { get; }
1399 public string WebResourceTitle { get; }
1400 public Uri WebResourceUri { get; }
1401 public static explicit operator ChatMessageAnnotation(ClientResult result);
1402 public static implicit operator BinaryContent(ChatMessageAnnotation chatMessageAnnotation);
1403 }
1404 public class ChatMessageContent : ObjectModel.Collection<ChatMessageContentPart> {
1405 public ChatMessageContent();
1406 public ChatMessageContent(params ChatMessageContentPart[] contentParts);
1407 public ChatMessageContent(IEnumerable<ChatMessageContentPart> contentParts);
1408 public ChatMessageContent(string content);
1409 }
1410 public class ChatMessageContentPart : IJsonModel<ChatMessageContentPart>, IPersistableModel<ChatMessageContentPart> {
1411 public BinaryData FileBytes { get; }
1412 public string FileBytesMediaType { get; }
1413 public string FileId { get; }
1414 public string Filename { get; }
1415 public BinaryData ImageBytes { get; }
1416 public string ImageBytesMediaType { get; }
1417 public ChatImageDetailLevel? ImageDetailLevel { get; }
1418 public Uri ImageUri { get; }
1419 public BinaryData InputAudioBytes { get; }
1420 public ChatInputAudioFormat? InputAudioFormat { get; }
1421 public ChatMessageContentPartKind Kind { get; }
1422 public string Refusal { get; }
1423 public string Text { get; }
1424 public static ChatMessageContentPart CreateFilePart(BinaryData fileBytes, string fileBytesMediaType, string filename);
1425 public static ChatMessageContentPart CreateFilePart(string fileId);
1426 public static ChatMessageContentPart CreateImagePart(BinaryData imageBytes, string imageBytesMediaType, ChatImageDetailLevel? imageDetailLevel = null);
1427 public static ChatMessageContentPart CreateImagePart(Uri imageUri, ChatImageDetailLevel? imageDetailLevel = null);
1428 public static ChatMessageContentPart CreateInputAudioPart(BinaryData inputAudioBytes, ChatInputAudioFormat inputAudioFormat);
1429 public static ChatMessageContentPart CreateRefusalPart(string refusal);
1430 public static ChatMessageContentPart CreateTextPart(string text);
1431 public static explicit operator ChatMessageContentPart(ClientResult result);
1432 public static implicit operator BinaryContent(ChatMessageContentPart chatMessageContentPart);
1433 public static implicit operator ChatMessageContentPart(string text);
1434 }
1435 public enum ChatMessageContentPartKind {
1436 Text = 0,
1437 Refusal = 1,
1438 Image = 2,
1439 InputAudio = 3,
1440 File = 4
1441 }
1442 public enum ChatMessageRole {
1443 System = 0,
1444 User = 1,
1445 Assistant = 2,
1446 Tool = 3,
1447 Function = 4,
1448 Developer = 5
1449 }
1450 public class ChatOutputAudio : IJsonModel<ChatOutputAudio>, IPersistableModel<ChatOutputAudio> {
1451 public BinaryData AudioBytes { get; }
1452 public DateTimeOffset ExpiresAt { get; }
1453 public string Id { get; }
1454 public string Transcript { get; }
1455 public static explicit operator ChatOutputAudio(ClientResult result);
1456 public static implicit operator BinaryContent(ChatOutputAudio chatOutputAudio);
1457 }
1458 public readonly partial struct ChatOutputAudioFormat : IEquatable<ChatOutputAudioFormat> {
1459 public ChatOutputAudioFormat(string value);
1460 public static ChatOutputAudioFormat Flac { get; }
1461 public static ChatOutputAudioFormat Mp3 { get; }
1462 public static ChatOutputAudioFormat Opus { get; }
1463 public static ChatOutputAudioFormat Pcm16 { get; }
1464 public static ChatOutputAudioFormat Wav { get; }
1465 public readonly bool Equals(ChatOutputAudioFormat other);
1466 [EditorBrowsable(EditorBrowsableState.Never)]
1467 public override readonly bool Equals(object obj);
1468 [EditorBrowsable(EditorBrowsableState.Never)]
1469 public override readonly int GetHashCode();
1470 public static bool operator ==(ChatOutputAudioFormat left, ChatOutputAudioFormat right);
1471 public static implicit operator ChatOutputAudioFormat(string value);
1472 public static bool operator !=(ChatOutputAudioFormat left, ChatOutputAudioFormat right);
1473 public override readonly string ToString();
1474 }
1475 public class ChatOutputAudioReference : IJsonModel<ChatOutputAudioReference>, IPersistableModel<ChatOutputAudioReference> {
1476 public ChatOutputAudioReference(string id);
1477 public string Id { get; }
1478 public static explicit operator ChatOutputAudioReference(ClientResult result);
1479 public static implicit operator BinaryContent(ChatOutputAudioReference chatOutputAudioReference);
1480 }
1481 public readonly partial struct ChatOutputAudioVoice : IEquatable<ChatOutputAudioVoice> {
1482 public ChatOutputAudioVoice(string value);
1483 public static ChatOutputAudioVoice Alloy { get; }
1484 public static ChatOutputAudioVoice Ash { get; }
1485 public static ChatOutputAudioVoice Ballad { get; }
1486 public static ChatOutputAudioVoice Coral { get; }
1487 public static ChatOutputAudioVoice Echo { get; }
1488 public static ChatOutputAudioVoice Sage { get; }
1489 public static ChatOutputAudioVoice Shimmer { get; }
1490 public static ChatOutputAudioVoice Verse { get; }
1491 public readonly bool Equals(ChatOutputAudioVoice other);
1492 [EditorBrowsable(EditorBrowsableState.Never)]
1493 public override readonly bool Equals(object obj);
1494 [EditorBrowsable(EditorBrowsableState.Never)]
1495 public override readonly int GetHashCode();
1496 public static bool operator ==(ChatOutputAudioVoice left, ChatOutputAudioVoice right);
1497 public static implicit operator ChatOutputAudioVoice(string value);
1498 public static bool operator !=(ChatOutputAudioVoice left, ChatOutputAudioVoice right);
1499 public override readonly string ToString();
1500 }
1501 public class ChatOutputPrediction : IJsonModel<ChatOutputPrediction>, IPersistableModel<ChatOutputPrediction> {
1502 public static ChatOutputPrediction CreateStaticContentPrediction(IEnumerable<ChatMessageContentPart> staticContentParts);
1503 public static ChatOutputPrediction CreateStaticContentPrediction(string staticContent);
1504 public static explicit operator ChatOutputPrediction(ClientResult result);
1505 public static implicit operator BinaryContent(ChatOutputPrediction chatOutputPrediction);
1506 }
1507 public class ChatOutputTokenUsageDetails : IJsonModel<ChatOutputTokenUsageDetails>, IPersistableModel<ChatOutputTokenUsageDetails> {
1508 public int AcceptedPredictionTokenCount { get; }
1509 public int AudioTokenCount { get; }
1510 public int ReasoningTokenCount { get; }
1511 public int RejectedPredictionTokenCount { get; }
1512 public static explicit operator ChatOutputTokenUsageDetails(ClientResult result);
1513 public static implicit operator BinaryContent(ChatOutputTokenUsageDetails chatOutputTokenUsageDetails);
1514 }
1515 public readonly partial struct ChatReasoningEffortLevel : IEquatable<ChatReasoningEffortLevel> {
1516 public ChatReasoningEffortLevel(string value);
1517 public static ChatReasoningEffortLevel High { get; }
1518 public static ChatReasoningEffortLevel Low { get; }
1519 public static ChatReasoningEffortLevel Medium { get; }
1520 public readonly bool Equals(ChatReasoningEffortLevel other);
1521 [EditorBrowsable(EditorBrowsableState.Never)]
1522 public override readonly bool Equals(object obj);
1523 [EditorBrowsable(EditorBrowsableState.Never)]
1524 public override readonly int GetHashCode();
1525 public static bool operator ==(ChatReasoningEffortLevel left, ChatReasoningEffortLevel right);
1526 public static implicit operator ChatReasoningEffortLevel(string value);
1527 public static bool operator !=(ChatReasoningEffortLevel left, ChatReasoningEffortLevel right);
1528 public override readonly string ToString();
1529 }
1530 public class ChatResponseFormat : IJsonModel<ChatResponseFormat>, IPersistableModel<ChatResponseFormat> {
1531 public static ChatResponseFormat CreateJsonObjectFormat();
1532 public static ChatResponseFormat CreateJsonSchemaFormat(string jsonSchemaFormatName, BinaryData jsonSchema, string jsonSchemaFormatDescription = null, bool? jsonSchemaIsStrict = null);
1533 public static ChatResponseFormat CreateTextFormat();
1534 public static explicit operator ChatResponseFormat(ClientResult result);
1535 public static implicit operator BinaryContent(ChatResponseFormat chatResponseFormat);
1536 }
1537 [Flags]
1538 public enum ChatResponseModalities {
1539 Default = 0,
1540 Text = 1,
1541 Audio = 2
1542 }
1543 public class ChatTokenLogProbabilityDetails : IJsonModel<ChatTokenLogProbabilityDetails>, IPersistableModel<ChatTokenLogProbabilityDetails> {
1544 public float LogProbability { get; }
1545 public string Token { get; }
1546 public IReadOnlyList<ChatTokenTopLogProbabilityDetails> TopLogProbabilities { get; }
1547 public ReadOnlyMemory<byte>? Utf8Bytes { get; }
1548 public static explicit operator ChatTokenLogProbabilityDetails(ClientResult result);
1549 public static implicit operator BinaryContent(ChatTokenLogProbabilityDetails chatTokenLogProbabilityDetails);
1550 }
1551 public class ChatTokenTopLogProbabilityDetails : IJsonModel<ChatTokenTopLogProbabilityDetails>, IPersistableModel<ChatTokenTopLogProbabilityDetails> {
1552 public float LogProbability { get; }
1553 public string Token { get; }
1554 public ReadOnlyMemory<byte>? Utf8Bytes { get; }
1555 public static explicit operator ChatTokenTopLogProbabilityDetails(ClientResult result);
1556 public static implicit operator BinaryContent(ChatTokenTopLogProbabilityDetails chatTokenTopLogProbabilityDetails);
1557 }
1558 public class ChatTokenUsage : IJsonModel<ChatTokenUsage>, IPersistableModel<ChatTokenUsage> {
1559 public int InputTokenCount { get; }
1560 public ChatInputTokenUsageDetails InputTokenDetails { get; }
1561 public int OutputTokenCount { get; }
1562 public ChatOutputTokenUsageDetails OutputTokenDetails { get; }
1563 public int TotalTokenCount { get; }
1564 public static explicit operator ChatTokenUsage(ClientResult result);
1565 public static implicit operator BinaryContent(ChatTokenUsage chatTokenUsage);
1566 }
1567 public class ChatTool : IJsonModel<ChatTool>, IPersistableModel<ChatTool> {
1568 public string FunctionDescription { get; }
1569 public string FunctionName { get; }
1570 public BinaryData FunctionParameters { get; }
1571 public bool? FunctionSchemaIsStrict { get; }
1572 public ChatToolKind Kind { get; }
1573 public static ChatTool CreateFunctionTool(string functionName, string functionDescription = null, BinaryData functionParameters = null, bool? functionSchemaIsStrict = null);
1574 public static explicit operator ChatTool(ClientResult result);
1575 public static implicit operator BinaryContent(ChatTool chatTool);
1576 }
1577 public class ChatToolCall : IJsonModel<ChatToolCall>, IPersistableModel<ChatToolCall> {
1578 public BinaryData FunctionArguments { get; }
1579 public string FunctionName { get; }
1580 public string Id { get; set; }
1581 public ChatToolCallKind Kind { get; }
1582 public static ChatToolCall CreateFunctionToolCall(string id, string functionName, BinaryData functionArguments);
1583 public static explicit operator ChatToolCall(ClientResult result);
1584 public static implicit operator BinaryContent(ChatToolCall chatToolCall);
1585 }
1586 public enum ChatToolCallKind {
1587 Function = 0
1588 }
1589 public class ChatToolChoice : IJsonModel<ChatToolChoice>, IPersistableModel<ChatToolChoice> {
1590 public static ChatToolChoice CreateAutoChoice();
1591 public static ChatToolChoice CreateFunctionChoice(string functionName);
1592 public static ChatToolChoice CreateNoneChoice();
1593 public static ChatToolChoice CreateRequiredChoice();
1594 public static explicit operator ChatToolChoice(ClientResult result);
1595 public static implicit operator BinaryContent(ChatToolChoice chatToolChoice);
1596 }
1597 public enum ChatToolKind {
1598 Function = 0
1599 }
1600 public class ChatWebSearchOptions : IJsonModel<ChatWebSearchOptions>, IPersistableModel<ChatWebSearchOptions> {
1601 public static explicit operator ChatWebSearchOptions(ClientResult result);
1602 public static implicit operator BinaryContent(ChatWebSearchOptions chatWebSearchOptions);
1603 }
1604 public class DeveloperChatMessage : ChatMessage, IJsonModel<DeveloperChatMessage>, IPersistableModel<DeveloperChatMessage> {
1605 public DeveloperChatMessage(params ChatMessageContentPart[] contentParts);
1606 public DeveloperChatMessage(IEnumerable<ChatMessageContentPart> contentParts);
1607 public DeveloperChatMessage(string content);
1608 public string ParticipantName { get; set; }
1609 public new static explicit operator DeveloperChatMessage(ClientResult result);
1610 public static implicit operator BinaryContent(DeveloperChatMessage developerChatMessage);
1611 }
1612 [Obsolete("This class is obsolete. Please use ToolChatMessage instead.")]
1613 public class FunctionChatMessage : ChatMessage, IJsonModel<FunctionChatMessage>, IPersistableModel<FunctionChatMessage> {
1614 public FunctionChatMessage(string functionName, string content);
1615 public string FunctionName { get; }
1616 public new static explicit operator FunctionChatMessage(ClientResult result);
1617 public static implicit operator BinaryContent(FunctionChatMessage functionChatMessage);
1618 }
1619 public static class OpenAIChatModelFactory {
1620 public static ChatCompletion ChatCompletion(string id = null, ChatFinishReason finishReason = ChatFinishReason.Stop, ChatMessageContent content = null, string refusal = null, IEnumerable<ChatToolCall> toolCalls = null, ChatMessageRole role = ChatMessageRole.System, ChatFunctionCall functionCall = null, IEnumerable<ChatTokenLogProbabilityDetails> contentTokenLogProbabilities = null, IEnumerable<ChatTokenLogProbabilityDetails> refusalTokenLogProbabilities = null, DateTimeOffset createdAt = default, string model = null, string systemFingerprint = null, ChatTokenUsage usage = null, ChatOutputAudio outputAudio = null, IEnumerable<ChatMessageAnnotation> messageAnnotations = null);
1621 [EditorBrowsable(EditorBrowsableState.Never)]
1622 public static ChatCompletion ChatCompletion(string id, ChatFinishReason finishReason, ChatMessageContent content, string refusal, IEnumerable<ChatToolCall> toolCalls, ChatMessageRole role, ChatFunctionCall functionCall, IEnumerable<ChatTokenLogProbabilityDetails> contentTokenLogProbabilities, IEnumerable<ChatTokenLogProbabilityDetails> refusalTokenLogProbabilities, DateTimeOffset createdAt, string model, string systemFingerprint, ChatTokenUsage usage);
1623 public static ChatInputTokenUsageDetails ChatInputTokenUsageDetails(int audioTokenCount = 0, int cachedTokenCount = 0);
1624 public static ChatMessageAnnotation ChatMessageAnnotation(int startIndex = 0, int endIndex = 0, Uri webResourceUri = null, string webResourceTitle = null);
1625 public static ChatOutputAudio ChatOutputAudio(BinaryData audioBytes, string id = null, string transcript = null, DateTimeOffset expiresAt = default);
1626 public static ChatOutputTokenUsageDetails ChatOutputTokenUsageDetails(int reasoningTokenCount = 0, int audioTokenCount = 0, int acceptedPredictionTokenCount = 0, int rejectedPredictionTokenCount = 0);
1627 [EditorBrowsable(EditorBrowsableState.Never)]
1628 public static ChatOutputTokenUsageDetails ChatOutputTokenUsageDetails(int reasoningTokenCount, int audioTokenCount);
1629 [EditorBrowsable(EditorBrowsableState.Never)]
1630 public static ChatOutputTokenUsageDetails ChatOutputTokenUsageDetails(int reasoningTokenCount);
1631 public static ChatTokenLogProbabilityDetails ChatTokenLogProbabilityDetails(string token = null, float logProbability = 0, ReadOnlyMemory<byte>? utf8Bytes = null, IEnumerable<ChatTokenTopLogProbabilityDetails> topLogProbabilities = null);
1632 public static ChatTokenTopLogProbabilityDetails ChatTokenTopLogProbabilityDetails(string token = null, float logProbability = 0, ReadOnlyMemory<byte>? utf8Bytes = null);
1633 public static ChatTokenUsage ChatTokenUsage(int outputTokenCount = 0, int inputTokenCount = 0, int totalTokenCount = 0, ChatOutputTokenUsageDetails outputTokenDetails = null, ChatInputTokenUsageDetails inputTokenDetails = null);
1634 [EditorBrowsable(EditorBrowsableState.Never)]
1635 public static ChatTokenUsage ChatTokenUsage(int outputTokenCount, int inputTokenCount, int totalTokenCount, ChatOutputTokenUsageDetails outputTokenDetails);
1636 public static StreamingChatCompletionUpdate StreamingChatCompletionUpdate(string completionId = null, ChatMessageContent contentUpdate = null, StreamingChatFunctionCallUpdate functionCallUpdate = null, IEnumerable<StreamingChatToolCallUpdate> toolCallUpdates = null, ChatMessageRole? role = null, string refusalUpdate = null, IEnumerable<ChatTokenLogProbabilityDetails> contentTokenLogProbabilities = null, IEnumerable<ChatTokenLogProbabilityDetails> refusalTokenLogProbabilities = null, ChatFinishReason? finishReason = null, DateTimeOffset createdAt = default, string model = null, string systemFingerprint = null, ChatTokenUsage usage = null, StreamingChatOutputAudioUpdate outputAudioUpdate = null);
1637 [EditorBrowsable(EditorBrowsableState.Never)]
1638 public static StreamingChatCompletionUpdate StreamingChatCompletionUpdate(string completionId, ChatMessageContent contentUpdate, StreamingChatFunctionCallUpdate functionCallUpdate, IEnumerable<StreamingChatToolCallUpdate> toolCallUpdates, ChatMessageRole? role, string refusalUpdate, IEnumerable<ChatTokenLogProbabilityDetails> contentTokenLogProbabilities, IEnumerable<ChatTokenLogProbabilityDetails> refusalTokenLogProbabilities, ChatFinishReason? finishReason, DateTimeOffset createdAt, string model, string systemFingerprint, ChatTokenUsage usage);
1639 [Obsolete("This class is obsolete. Please use StreamingChatToolCallUpdate instead.")]
1640 public static StreamingChatFunctionCallUpdate StreamingChatFunctionCallUpdate(string functionName = null, BinaryData functionArgumentsUpdate = null);
1641 public static StreamingChatOutputAudioUpdate StreamingChatOutputAudioUpdate(string id = null, DateTimeOffset? expiresAt = null, string transcriptUpdate = null, BinaryData audioBytesUpdate = null);
1642 public static StreamingChatToolCallUpdate StreamingChatToolCallUpdate(int index = 0, string toolCallId = null, ChatToolCallKind kind = ChatToolCallKind.Function, string functionName = null, BinaryData functionArgumentsUpdate = null);
1643 }
1644 public class StreamingChatCompletionUpdate : IJsonModel<StreamingChatCompletionUpdate>, IPersistableModel<StreamingChatCompletionUpdate> {
1645 public string CompletionId { get; }
1646 public IReadOnlyList<ChatTokenLogProbabilityDetails> ContentTokenLogProbabilities { get; }
1647 public ChatMessageContent ContentUpdate { get; }
1648 public DateTimeOffset CreatedAt { get; }
1649 public ChatFinishReason? FinishReason { get; }
1650 [Obsolete("This property is obsolete. Please use ToolCallUpdates instead.")]
1651 public StreamingChatFunctionCallUpdate FunctionCallUpdate { get; }
1652 public string Model { get; }
1653 public StreamingChatOutputAudioUpdate OutputAudioUpdate { get; }
1654 public IReadOnlyList<ChatTokenLogProbabilityDetails> RefusalTokenLogProbabilities { get; }
1655 public string RefusalUpdate { get; }
1656 public ChatMessageRole? Role { get; }
1657 public string SystemFingerprint { get; }
1658 public IReadOnlyList<StreamingChatToolCallUpdate> ToolCallUpdates { get; }
1659 public ChatTokenUsage Usage { get; }
1660 public static explicit operator StreamingChatCompletionUpdate(ClientResult result);
1661 public static implicit operator BinaryContent(StreamingChatCompletionUpdate streamingChatCompletionUpdate);
1662 }
1663 [Obsolete("This class is obsolete. Please use StreamingChatToolCallUpdate instead.")]
1664 public class StreamingChatFunctionCallUpdate : IJsonModel<StreamingChatFunctionCallUpdate>, IPersistableModel<StreamingChatFunctionCallUpdate> {
1665 public BinaryData FunctionArgumentsUpdate { get; }
1666 public string FunctionName { get; }
1667 public static explicit operator StreamingChatFunctionCallUpdate(ClientResult result);
1668 public static implicit operator BinaryContent(StreamingChatFunctionCallUpdate streamingChatFunctionCallUpdate);
1669 }
1670 public class StreamingChatOutputAudioUpdate : IJsonModel<StreamingChatOutputAudioUpdate>, IPersistableModel<StreamingChatOutputAudioUpdate> {
1671 public BinaryData AudioBytesUpdate { get; }
1672 public DateTimeOffset? ExpiresAt { get; }
1673 public string Id { get; }
1674 public string TranscriptUpdate { get; }
1675 public static explicit operator StreamingChatOutputAudioUpdate(ClientResult result);
1676 public static implicit operator BinaryContent(StreamingChatOutputAudioUpdate streamingChatOutputAudioUpdate);
1677 }
1678 public class StreamingChatToolCallUpdate : IJsonModel<StreamingChatToolCallUpdate>, IPersistableModel<StreamingChatToolCallUpdate> {
1679 public BinaryData FunctionArgumentsUpdate { get; }
1680 public string FunctionName { get; }
1681 public int Index { get; }
1682 public ChatToolCallKind Kind { get; }
1683 public string ToolCallId { get; }
1684 public static explicit operator StreamingChatToolCallUpdate(ClientResult result);
1685 public static implicit operator BinaryContent(StreamingChatToolCallUpdate streamingChatToolCallUpdate);
1686 }
1687 public class SystemChatMessage : ChatMessage, IJsonModel<SystemChatMessage>, IPersistableModel<SystemChatMessage> {
1688 public SystemChatMessage(params ChatMessageContentPart[] contentParts);
1689 public SystemChatMessage(IEnumerable<ChatMessageContentPart> contentParts);
1690 public SystemChatMessage(string content);
1691 public string ParticipantName { get; set; }
1692 public new static explicit operator SystemChatMessage(ClientResult result);
1693 public static implicit operator BinaryContent(SystemChatMessage systemChatMessage);
1694 }
1695 public class ToolChatMessage : ChatMessage, IJsonModel<ToolChatMessage>, IPersistableModel<ToolChatMessage> {
1696 public ToolChatMessage(string toolCallId, params ChatMessageContentPart[] contentParts);
1697 public ToolChatMessage(string toolCallId, IEnumerable<ChatMessageContentPart> contentParts);
1698 public ToolChatMessage(string toolCallId, string content);
1699 public string ToolCallId { get; }
1700 public new static explicit operator ToolChatMessage(ClientResult result);
1701 public static implicit operator BinaryContent(ToolChatMessage toolChatMessage);
1702 }
1703 public class UserChatMessage : ChatMessage, IJsonModel<UserChatMessage>, IPersistableModel<UserChatMessage> {
1704 public UserChatMessage(params ChatMessageContentPart[] contentParts);
1705 public UserChatMessage(IEnumerable<ChatMessageContentPart> contentParts);
1706 public UserChatMessage(string content);
1707 public string ParticipantName { get; set; }
1708 public new static explicit operator UserChatMessage(ClientResult result);
1709 public static implicit operator BinaryContent(UserChatMessage userChatMessage);
1710 }
1711}
1712namespace OpenAI.Embeddings {
1713 public class EmbeddingClient {
1714 protected EmbeddingClient();
1715 protected internal EmbeddingClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
1716 public EmbeddingClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
1717 public EmbeddingClient(string model, ApiKeyCredential credential);
1718 public EmbeddingClient(string model, string apiKey);
1719 public ClientPipeline Pipeline { get; }
1720 public virtual ClientResult<OpenAIEmbedding> GenerateEmbedding(string input, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
1721 public virtual Task<ClientResult<OpenAIEmbedding>> GenerateEmbeddingAsync(string input, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
1722 [EditorBrowsable(EditorBrowsableState.Never)]
1723 public virtual ClientResult GenerateEmbeddings(BinaryContent content, RequestOptions options = null);
1724 public virtual ClientResult<OpenAIEmbeddingCollection> GenerateEmbeddings(IEnumerable<ReadOnlyMemory<int>> inputs, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
1725 public virtual ClientResult<OpenAIEmbeddingCollection> GenerateEmbeddings(IEnumerable<string> inputs, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
1726 [EditorBrowsable(EditorBrowsableState.Never)]
1727 public virtual Task<ClientResult> GenerateEmbeddingsAsync(BinaryContent content, RequestOptions options = null);
1728 public virtual Task<ClientResult<OpenAIEmbeddingCollection>> GenerateEmbeddingsAsync(IEnumerable<ReadOnlyMemory<int>> inputs, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
1729 public virtual Task<ClientResult<OpenAIEmbeddingCollection>> GenerateEmbeddingsAsync(IEnumerable<string> inputs, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
1730 }
1731 public class EmbeddingGenerationOptions : IJsonModel<EmbeddingGenerationOptions>, IPersistableModel<EmbeddingGenerationOptions> {
1732 public int? Dimensions { get; set; }
1733 public string EndUserId { get; set; }
1734 public static explicit operator EmbeddingGenerationOptions(ClientResult result);
1735 public static implicit operator BinaryContent(EmbeddingGenerationOptions embeddingGenerationOptions);
1736 }
1737 public class EmbeddingTokenUsage : IJsonModel<EmbeddingTokenUsage>, IPersistableModel<EmbeddingTokenUsage> {
1738 public int InputTokenCount { get; }
1739 public int TotalTokenCount { get; }
1740 public static explicit operator EmbeddingTokenUsage(ClientResult result);
1741 public static implicit operator BinaryContent(EmbeddingTokenUsage embeddingTokenUsage);
1742 }
1743 public class OpenAIEmbedding : IJsonModel<OpenAIEmbedding>, IPersistableModel<OpenAIEmbedding> {
1744 public int Index { get; }
1745 public static explicit operator OpenAIEmbedding(ClientResult result);
1746 public static implicit operator BinaryContent(OpenAIEmbedding openAIEmbedding);
1747 public ReadOnlyMemory<float> ToFloats();
1748 }
1749 public class OpenAIEmbeddingCollection : ObjectModel.ReadOnlyCollection<OpenAIEmbedding>, IJsonModel<OpenAIEmbeddingCollection>, IPersistableModel<OpenAIEmbeddingCollection> {
1750 public string Model { get; }
1751 public EmbeddingTokenUsage Usage { get; }
1752 public static explicit operator OpenAIEmbeddingCollection(ClientResult result);
1753 public static implicit operator BinaryContent(OpenAIEmbeddingCollection openAIEmbeddingCollection);
1754 }
1755 public static class OpenAIEmbeddingsModelFactory {
1756 public static EmbeddingTokenUsage EmbeddingTokenUsage(int inputTokenCount = 0, int totalTokenCount = 0);
1757 public static OpenAIEmbedding OpenAIEmbedding(int index = 0, IEnumerable<float> vector = null);
1758 public static OpenAIEmbeddingCollection OpenAIEmbeddingCollection(IEnumerable<OpenAIEmbedding> items = null, string model = null, EmbeddingTokenUsage usage = null);
1759 }
1760}
1761namespace OpenAI.Files {
1762 public class FileDeletionResult : IJsonModel<FileDeletionResult>, IPersistableModel<FileDeletionResult> {
1763 public bool Deleted { get; }
1764 public string FileId { get; }
1765 public static explicit operator FileDeletionResult(ClientResult result);
1766 public static implicit operator BinaryContent(FileDeletionResult fileDeletionResult);
1767 }
1768 public enum FilePurpose {
1769 Assistants = 0,
1770 AssistantsOutput = 1,
1771 Batch = 2,
1772 BatchOutput = 3,
1773 FineTune = 4,
1774 FineTuneResults = 5,
1775 Vision = 6,
1776 UserData = 7,
1777 Evaluations = 8
1778 }
1779 [Obsolete("This struct is obsolete. If this is a fine-tuning training file, it may take some time to process after it has been uploaded. While the file is processing, you can still create a fine-tuning job but it will not start until the file processing has completed.")]
1780 public enum FileStatus {
1781 Uploaded = 0,
1782 Processed = 1,
1783 Error = 2
1784 }
1785 public readonly partial struct FileUploadPurpose : IEquatable<FileUploadPurpose> {
1786 public FileUploadPurpose(string value);
1787 public static FileUploadPurpose Assistants { get; }
1788 public static FileUploadPurpose Batch { get; }
1789 public static FileUploadPurpose Evaluations { get; }
1790 public static FileUploadPurpose FineTune { get; }
1791 public static FileUploadPurpose UserData { get; }
1792 public static FileUploadPurpose Vision { get; }
1793 public readonly bool Equals(FileUploadPurpose other);
1794 [EditorBrowsable(EditorBrowsableState.Never)]
1795 public override readonly bool Equals(object obj);
1796 [EditorBrowsable(EditorBrowsableState.Never)]
1797 public override readonly int GetHashCode();
1798 public static bool operator ==(FileUploadPurpose left, FileUploadPurpose right);
1799 public static implicit operator FileUploadPurpose(string value);
1800 public static bool operator !=(FileUploadPurpose left, FileUploadPurpose right);
1801 public override readonly string ToString();
1802 }
1803 public class OpenAIFile : IJsonModel<OpenAIFile>, IPersistableModel<OpenAIFile> {
1804 public DateTimeOffset CreatedAt { get; }
1805 public DateTimeOffset? ExpiresAt { get; }
1806 public string Filename { get; }
1807 public string Id { get; }
1808 public FilePurpose Purpose { get; }
1809 public int? SizeInBytes { get; }
1810 [Obsolete("This property is obsolete. If this is a fine-tuning training file, it may take some time to process after it has been uploaded. While the file is processing, you can still create a fine-tuning job but it will not start until the file processing has completed.")]
1811 public FileStatus Status { get; }
1812 [Obsolete("This property is obsolete. For details on why a fine-tuning training file failed validation, see the `error` field on the fine-tuning job.")]
1813 public string StatusDetails { get; }
1814 public static explicit operator OpenAIFile(ClientResult result);
1815 public static implicit operator BinaryContent(OpenAIFile openAIFile);
1816 }
1817 public class OpenAIFileClient {
1818 protected OpenAIFileClient();
1819 public OpenAIFileClient(ApiKeyCredential credential, OpenAIClientOptions options);
1820 public OpenAIFileClient(ApiKeyCredential credential);
1821 protected internal OpenAIFileClient(ClientPipeline pipeline, OpenAIClientOptions options);
1822 public OpenAIFileClient(string apiKey);
1823 public ClientPipeline Pipeline { get; }
1824 [Experimental("OPENAI001")]
1825 public virtual ClientResult AddUploadPart(string uploadId, BinaryContent content, string contentType, RequestOptions options = null);
1826 [Experimental("OPENAI001")]
1827 public virtual Task<ClientResult> AddUploadPartAsync(string uploadId, BinaryContent content, string contentType, RequestOptions options = null);
1828 [Experimental("OPENAI001")]
1829 public virtual ClientResult CancelUpload(string uploadId, RequestOptions options = null);
1830 [Experimental("OPENAI001")]
1831 public virtual Task<ClientResult> CancelUploadAsync(string uploadId, RequestOptions options = null);
1832 [Experimental("OPENAI001")]
1833 public virtual ClientResult CompleteUpload(string uploadId, BinaryContent content, RequestOptions options = null);
1834 [Experimental("OPENAI001")]
1835 public virtual Task<ClientResult> CompleteUploadAsync(string uploadId, BinaryContent content, RequestOptions options = null);
1836 [Experimental("OPENAI001")]
1837 public virtual ClientResult CreateUpload(BinaryContent content, RequestOptions options = null);
1838 [Experimental("OPENAI001")]
1839 public virtual Task<ClientResult> CreateUploadAsync(BinaryContent content, RequestOptions options = null);
1840 [EditorBrowsable(EditorBrowsableState.Never)]
1841 public virtual ClientResult DeleteFile(string fileId, RequestOptions options);
1842 public virtual ClientResult<FileDeletionResult> DeleteFile(string fileId, CancellationToken cancellationToken = default);
1843 [EditorBrowsable(EditorBrowsableState.Never)]
1844 public virtual Task<ClientResult> DeleteFileAsync(string fileId, RequestOptions options);
1845 public virtual Task<ClientResult<FileDeletionResult>> DeleteFileAsync(string fileId, CancellationToken cancellationToken = default);
1846 [EditorBrowsable(EditorBrowsableState.Never)]
1847 public virtual ClientResult DownloadFile(string fileId, RequestOptions options);
1848 public virtual ClientResult<BinaryData> DownloadFile(string fileId, CancellationToken cancellationToken = default);
1849 [EditorBrowsable(EditorBrowsableState.Never)]
1850 public virtual Task<ClientResult> DownloadFileAsync(string fileId, RequestOptions options);
1851 public virtual Task<ClientResult<BinaryData>> DownloadFileAsync(string fileId, CancellationToken cancellationToken = default);
1852 [EditorBrowsable(EditorBrowsableState.Never)]
1853 public virtual ClientResult GetFile(string fileId, RequestOptions options);
1854 public virtual ClientResult<OpenAIFile> GetFile(string fileId, CancellationToken cancellationToken = default);
1855 [EditorBrowsable(EditorBrowsableState.Never)]
1856 public virtual Task<ClientResult> GetFileAsync(string fileId, RequestOptions options);
1857 public virtual Task<ClientResult<OpenAIFile>> GetFileAsync(string fileId, CancellationToken cancellationToken = default);
1858 public virtual ClientResult<OpenAIFileCollection> GetFiles(FilePurpose purpose, CancellationToken cancellationToken = default);
1859 [EditorBrowsable(EditorBrowsableState.Never)]
1860 public virtual ClientResult GetFiles(string purpose, RequestOptions options);
1861 public virtual ClientResult<OpenAIFileCollection> GetFiles(CancellationToken cancellationToken = default);
1862 public virtual Task<ClientResult<OpenAIFileCollection>> GetFilesAsync(FilePurpose purpose, CancellationToken cancellationToken = default);
1863 [EditorBrowsable(EditorBrowsableState.Never)]
1864 public virtual Task<ClientResult> GetFilesAsync(string purpose, RequestOptions options);
1865 public virtual Task<ClientResult<OpenAIFileCollection>> GetFilesAsync(CancellationToken cancellationToken = default);
1866 public virtual ClientResult<OpenAIFile> UploadFile(BinaryData file, string filename, FileUploadPurpose purpose);
1867 [EditorBrowsable(EditorBrowsableState.Never)]
1868 public virtual ClientResult UploadFile(BinaryContent content, string contentType, RequestOptions options = null);
1869 public virtual ClientResult<OpenAIFile> UploadFile(Stream file, string filename, FileUploadPurpose purpose, CancellationToken cancellationToken = default);
1870 public virtual ClientResult<OpenAIFile> UploadFile(string filePath, FileUploadPurpose purpose);
1871 public virtual Task<ClientResult<OpenAIFile>> UploadFileAsync(BinaryData file, string filename, FileUploadPurpose purpose);
1872 [EditorBrowsable(EditorBrowsableState.Never)]
1873 public virtual Task<ClientResult> UploadFileAsync(BinaryContent content, string contentType, RequestOptions options = null);
1874 public virtual Task<ClientResult<OpenAIFile>> UploadFileAsync(Stream file, string filename, FileUploadPurpose purpose, CancellationToken cancellationToken = default);
1875 public virtual Task<ClientResult<OpenAIFile>> UploadFileAsync(string filePath, FileUploadPurpose purpose);
1876 }
1877 public class OpenAIFileCollection : ObjectModel.ReadOnlyCollection<OpenAIFile>, IJsonModel<OpenAIFileCollection>, IPersistableModel<OpenAIFileCollection> {
1878 public static explicit operator OpenAIFileCollection(ClientResult result);
1879 public static implicit operator BinaryContent(OpenAIFileCollection openAIFileCollection);
1880 }
1881 public static class OpenAIFilesModelFactory {
1882 public static FileDeletionResult FileDeletionResult(string fileId = null, bool deleted = false);
1883 public static OpenAIFileCollection OpenAIFileCollection(IEnumerable<OpenAIFile> items = null);
1884 public static OpenAIFile OpenAIFileInfo(string id = null, int? sizeInBytes = null, DateTimeOffset createdAt = default, string filename = null, FilePurpose purpose = FilePurpose.Assistants, FileStatus status = FileStatus.Uploaded, string statusDetails = null, DateTimeOffset? expiresAt = null);
1885 [EditorBrowsable(EditorBrowsableState.Never)]
1886 public static OpenAIFile OpenAIFileInfo(string id, int? sizeInBytes, DateTimeOffset createdAt, string filename, FilePurpose purpose, FileStatus status, string statusDetails);
1887 }
1888}
1889namespace OpenAI.FineTuning {
1890 [Experimental("OPENAI001")]
1891 public class FineTuningClient {
1892 protected FineTuningClient();
1893 public FineTuningClient(ApiKeyCredential credential, OpenAIClientOptions options);
1894 public FineTuningClient(ApiKeyCredential credential);
1895 protected internal FineTuningClient(ClientPipeline pipeline, OpenAIClientOptions options);
1896 public FineTuningClient(string apiKey);
1897 public ClientPipeline Pipeline { get; }
1898 public virtual FineTuningJobOperation CreateFineTuningJob(BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
1899 public virtual Task<FineTuningJobOperation> CreateFineTuningJobAsync(BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
1900 public virtual ClientResult GetJob(string fineTuningJobId, RequestOptions options);
1901 public virtual Task<ClientResult> GetJobAsync(string fineTuningJobId, RequestOptions options);
1902 public virtual CollectionResult GetJobs(string after, int? limit, RequestOptions options);
1903 public virtual AsyncCollectionResult GetJobsAsync(string after, int? limit, RequestOptions options);
1904 }
1905 [Experimental("OPENAI001")]
1906 public class FineTuningJobOperation : OperationResult {
1907 public string JobId { get; }
1908 public override ContinuationToken? RehydrationToken { get; protected set; }
1909 public virtual ClientResult Cancel(RequestOptions? options);
1910 public virtual Task<ClientResult> CancelAsync(RequestOptions? options);
1911 public virtual ClientResult GetJob(RequestOptions? options);
1912 public virtual Task<ClientResult> GetJobAsync(RequestOptions? options);
1913 public virtual CollectionResult GetJobCheckpoints(string? after, int? limit, RequestOptions? options);
1914 public virtual AsyncCollectionResult GetJobCheckpointsAsync(string? after, int? limit, RequestOptions? options);
1915 public virtual CollectionResult GetJobEvents(string? after, int? limit, RequestOptions options);
1916 public virtual AsyncCollectionResult GetJobEventsAsync(string? after, int? limit, RequestOptions options);
1917 public static FineTuningJobOperation Rehydrate(FineTuningClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
1918 public static FineTuningJobOperation Rehydrate(FineTuningClient client, string fineTuningJobId, CancellationToken cancellationToken = default);
1919 public static Task<FineTuningJobOperation> RehydrateAsync(FineTuningClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
1920 public static Task<FineTuningJobOperation> RehydrateAsync(FineTuningClient client, string fineTuningJobId, CancellationToken cancellationToken = default);
1921 public override ClientResult UpdateStatus(RequestOptions? options = null);
1922 public override ValueTask<ClientResult> UpdateStatusAsync(RequestOptions? options = null);
1923 }
1924}
1925namespace OpenAI.Images {
1926 public class GeneratedImage : IJsonModel<GeneratedImage>, IPersistableModel<GeneratedImage> {
1927 public BinaryData ImageBytes { get; }
1928 public Uri ImageUri { get; }
1929 public string RevisedPrompt { get; }
1930 public static explicit operator GeneratedImage(ClientResult result);
1931 public static implicit operator BinaryContent(GeneratedImage generatedImage);
1932 }
1933 public class GeneratedImageCollection : ObjectModel.ReadOnlyCollection<GeneratedImage>, IJsonModel<GeneratedImageCollection>, IPersistableModel<GeneratedImageCollection> {
1934 public DateTimeOffset CreatedAt { get; }
1935 public static explicit operator GeneratedImageCollection(ClientResult result);
1936 public static implicit operator BinaryContent(GeneratedImageCollection generatedImageCollection);
1937 }
1938 public readonly partial struct GeneratedImageFormat : IEquatable<GeneratedImageFormat> {
1939 public GeneratedImageFormat(string value);
1940 public static GeneratedImageFormat Bytes { get; }
1941 public static GeneratedImageFormat Uri { get; }
1942 public readonly bool Equals(GeneratedImageFormat other);
1943 [EditorBrowsable(EditorBrowsableState.Never)]
1944 public override readonly bool Equals(object obj);
1945 [EditorBrowsable(EditorBrowsableState.Never)]
1946 public override readonly int GetHashCode();
1947 public static bool operator ==(GeneratedImageFormat left, GeneratedImageFormat right);
1948 public static implicit operator GeneratedImageFormat(string value);
1949 public static bool operator !=(GeneratedImageFormat left, GeneratedImageFormat right);
1950 public override readonly string ToString();
1951 }
1952 public readonly partial struct GeneratedImageQuality : IEquatable<GeneratedImageQuality> {
1953 public GeneratedImageQuality(string value);
1954 public static GeneratedImageQuality High { get; }
1955 public static GeneratedImageQuality Standard { get; }
1956 public readonly bool Equals(GeneratedImageQuality other);
1957 [EditorBrowsable(EditorBrowsableState.Never)]
1958 public override readonly bool Equals(object obj);
1959 [EditorBrowsable(EditorBrowsableState.Never)]
1960 public override readonly int GetHashCode();
1961 public static bool operator ==(GeneratedImageQuality left, GeneratedImageQuality right);
1962 public static implicit operator GeneratedImageQuality(string value);
1963 public static bool operator !=(GeneratedImageQuality left, GeneratedImageQuality right);
1964 public override readonly string ToString();
1965 }
1966 public readonly partial struct GeneratedImageSize : IEquatable<GeneratedImageSize> {
1967 public static readonly GeneratedImageSize W1024xH1024;
1968 public static readonly GeneratedImageSize W1024xH1792;
1969 public static readonly GeneratedImageSize W1792xH1024;
1970 public static readonly GeneratedImageSize W256xH256;
1971 public static readonly GeneratedImageSize W512xH512;
1972 public GeneratedImageSize(int width, int height);
1973 public readonly bool Equals(GeneratedImageSize other);
1974 [EditorBrowsable(EditorBrowsableState.Never)]
1975 public override readonly bool Equals(object obj);
1976 [EditorBrowsable(EditorBrowsableState.Never)]
1977 public override readonly int GetHashCode();
1978 public static bool operator ==(GeneratedImageSize left, GeneratedImageSize right);
1979 public static bool operator !=(GeneratedImageSize left, GeneratedImageSize right);
1980 public override readonly string ToString();
1981 }
1982 public readonly partial struct GeneratedImageStyle : IEquatable<GeneratedImageStyle> {
1983 public GeneratedImageStyle(string value);
1984 public static GeneratedImageStyle Natural { get; }
1985 public static GeneratedImageStyle Vivid { get; }
1986 public readonly bool Equals(GeneratedImageStyle other);
1987 [EditorBrowsable(EditorBrowsableState.Never)]
1988 public override readonly bool Equals(object obj);
1989 [EditorBrowsable(EditorBrowsableState.Never)]
1990 public override readonly int GetHashCode();
1991 public static bool operator ==(GeneratedImageStyle left, GeneratedImageStyle right);
1992 public static implicit operator GeneratedImageStyle(string value);
1993 public static bool operator !=(GeneratedImageStyle left, GeneratedImageStyle right);
1994 public override readonly string ToString();
1995 }
1996 public class ImageClient {
1997 protected ImageClient();
1998 protected internal ImageClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
1999 public ImageClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
2000 public ImageClient(string model, ApiKeyCredential credential);
2001 public ImageClient(string model, string apiKey);
2002 public ClientPipeline Pipeline { get; }
2003 public virtual ClientResult<GeneratedImage> GenerateImage(string prompt, ImageGenerationOptions options = null, CancellationToken cancellationToken = default);
2004 public virtual Task<ClientResult<GeneratedImage>> GenerateImageAsync(string prompt, ImageGenerationOptions options = null, CancellationToken cancellationToken = default);
2005 public virtual ClientResult<GeneratedImage> GenerateImageEdit(Stream image, string imageFilename, string prompt, ImageEditOptions options = null, CancellationToken cancellationToken = default);
2006 public virtual ClientResult<GeneratedImage> GenerateImageEdit(Stream image, string imageFilename, string prompt, Stream mask, string maskFilename, ImageEditOptions options = null, CancellationToken cancellationToken = default);
2007 public virtual ClientResult<GeneratedImage> GenerateImageEdit(string imageFilePath, string prompt, ImageEditOptions options = null);
2008 public virtual ClientResult<GeneratedImage> GenerateImageEdit(string imageFilePath, string prompt, string maskFilePath, ImageEditOptions options = null);
2009 public virtual Task<ClientResult<GeneratedImage>> GenerateImageEditAsync(Stream image, string imageFilename, string prompt, ImageEditOptions options = null, CancellationToken cancellationToken = default);
2010 public virtual Task<ClientResult<GeneratedImage>> GenerateImageEditAsync(Stream image, string imageFilename, string prompt, Stream mask, string maskFilename, ImageEditOptions options = null, CancellationToken cancellationToken = default);
2011 public virtual Task<ClientResult<GeneratedImage>> GenerateImageEditAsync(string imageFilePath, string prompt, ImageEditOptions options = null);
2012 public virtual Task<ClientResult<GeneratedImage>> GenerateImageEditAsync(string imageFilePath, string prompt, string maskFilePath, ImageEditOptions options = null);
2013 [EditorBrowsable(EditorBrowsableState.Never)]
2014 public virtual ClientResult GenerateImageEdits(BinaryContent content, string contentType, RequestOptions options = null);
2015 public virtual ClientResult<GeneratedImageCollection> GenerateImageEdits(Stream image, string imageFilename, string prompt, int imageCount, ImageEditOptions options = null, CancellationToken cancellationToken = default);
2016 public virtual ClientResult<GeneratedImageCollection> GenerateImageEdits(Stream image, string imageFilename, string prompt, Stream mask, string maskFilename, int imageCount, ImageEditOptions options = null, CancellationToken cancellationToken = default);
2017 public virtual ClientResult<GeneratedImageCollection> GenerateImageEdits(string imageFilePath, string prompt, int imageCount, ImageEditOptions options = null);
2018 public virtual ClientResult<GeneratedImageCollection> GenerateImageEdits(string imageFilePath, string prompt, string maskFilePath, int imageCount, ImageEditOptions options = null);
2019 [EditorBrowsable(EditorBrowsableState.Never)]
2020 public virtual Task<ClientResult> GenerateImageEditsAsync(BinaryContent content, string contentType, RequestOptions options = null);
2021 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageEditsAsync(Stream image, string imageFilename, string prompt, int imageCount, ImageEditOptions options = null, CancellationToken cancellationToken = default);
2022 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageEditsAsync(Stream image, string imageFilename, string prompt, Stream mask, string maskFilename, int imageCount, ImageEditOptions options = null, CancellationToken cancellationToken = default);
2023 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageEditsAsync(string imageFilePath, string prompt, int imageCount, ImageEditOptions options = null);
2024 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageEditsAsync(string imageFilePath, string prompt, string maskFilePath, int imageCount, ImageEditOptions options = null);
2025 [EditorBrowsable(EditorBrowsableState.Never)]
2026 public virtual ClientResult GenerateImages(BinaryContent content, RequestOptions options = null);
2027 public virtual ClientResult<GeneratedImageCollection> GenerateImages(string prompt, int imageCount, ImageGenerationOptions options = null, CancellationToken cancellationToken = default);
2028 [EditorBrowsable(EditorBrowsableState.Never)]
2029 public virtual Task<ClientResult> GenerateImagesAsync(BinaryContent content, RequestOptions options = null);
2030 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImagesAsync(string prompt, int imageCount, ImageGenerationOptions options = null, CancellationToken cancellationToken = default);
2031 public virtual ClientResult<GeneratedImage> GenerateImageVariation(Stream image, string imageFilename, ImageVariationOptions options = null, CancellationToken cancellationToken = default);
2032 public virtual ClientResult<GeneratedImage> GenerateImageVariation(string imageFilePath, ImageVariationOptions options = null);
2033 public virtual Task<ClientResult<GeneratedImage>> GenerateImageVariationAsync(Stream image, string imageFilename, ImageVariationOptions options = null, CancellationToken cancellationToken = default);
2034 public virtual Task<ClientResult<GeneratedImage>> GenerateImageVariationAsync(string imageFilePath, ImageVariationOptions options = null);
2035 [EditorBrowsable(EditorBrowsableState.Never)]
2036 public virtual ClientResult GenerateImageVariations(BinaryContent content, string contentType, RequestOptions options = null);
2037 public virtual ClientResult<GeneratedImageCollection> GenerateImageVariations(Stream image, string imageFilename, int imageCount, ImageVariationOptions options = null, CancellationToken cancellationToken = default);
2038 public virtual ClientResult<GeneratedImageCollection> GenerateImageVariations(string imageFilePath, int imageCount, ImageVariationOptions options = null);
2039 [EditorBrowsable(EditorBrowsableState.Never)]
2040 public virtual Task<ClientResult> GenerateImageVariationsAsync(BinaryContent content, string contentType, RequestOptions options = null);
2041 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageVariationsAsync(Stream image, string imageFilename, int imageCount, ImageVariationOptions options = null, CancellationToken cancellationToken = default);
2042 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageVariationsAsync(string imageFilePath, int imageCount, ImageVariationOptions options = null);
2043 }
2044 public class ImageEditOptions : IJsonModel<ImageEditOptions>, IPersistableModel<ImageEditOptions> {
2045 public string EndUserId { get; set; }
2046 public GeneratedImageFormat? ResponseFormat { get; set; }
2047 public GeneratedImageSize? Size { get; set; }
2048 public static explicit operator ImageEditOptions(ClientResult result);
2049 public static implicit operator BinaryContent(ImageEditOptions imageEditOptions);
2050 }
2051 public class ImageGenerationOptions : IJsonModel<ImageGenerationOptions>, IPersistableModel<ImageGenerationOptions> {
2052 public string EndUserId { get; set; }
2053 public GeneratedImageQuality? Quality { get; set; }
2054 public GeneratedImageFormat? ResponseFormat { get; set; }
2055 public GeneratedImageSize? Size { get; set; }
2056 public GeneratedImageStyle? Style { get; set; }
2057 public static explicit operator ImageGenerationOptions(ClientResult result);
2058 public static implicit operator BinaryContent(ImageGenerationOptions imageGenerationOptions);
2059 }
2060 public class ImageVariationOptions : IJsonModel<ImageVariationOptions>, IPersistableModel<ImageVariationOptions> {
2061 public string EndUserId { get; set; }
2062 public GeneratedImageFormat? ResponseFormat { get; set; }
2063 public GeneratedImageSize? Size { get; set; }
2064 public static explicit operator ImageVariationOptions(ClientResult result);
2065 public static implicit operator BinaryContent(ImageVariationOptions imageVariationOptions);
2066 }
2067 public static class OpenAIImagesModelFactory {
2068 public static GeneratedImage GeneratedImage(BinaryData imageBytes = null, Uri imageUri = null, string revisedPrompt = null);
2069 public static GeneratedImageCollection GeneratedImageCollection(DateTimeOffset createdAt = default, IEnumerable<GeneratedImage> items = null);
2070 }
2071}
2072namespace OpenAI.Models {
2073 public class ModelDeletionResult : IJsonModel<ModelDeletionResult>, IPersistableModel<ModelDeletionResult> {
2074 public bool Deleted { get; }
2075 public string ModelId { get; }
2076 public static explicit operator ModelDeletionResult(ClientResult result);
2077 public static implicit operator BinaryContent(ModelDeletionResult modelDeletionResult);
2078 }
2079 public class OpenAIModel : IJsonModel<OpenAIModel>, IPersistableModel<OpenAIModel> {
2080 public DateTimeOffset CreatedAt { get; }
2081 public string Id { get; }
2082 public string OwnedBy { get; }
2083 public static explicit operator OpenAIModel(ClientResult result);
2084 public static implicit operator BinaryContent(OpenAIModel openAIModel);
2085 }
2086 public class OpenAIModelClient {
2087 protected OpenAIModelClient();
2088 public OpenAIModelClient(ApiKeyCredential credential, OpenAIClientOptions options);
2089 public OpenAIModelClient(ApiKeyCredential credential);
2090 protected internal OpenAIModelClient(ClientPipeline pipeline, OpenAIClientOptions options);
2091 public OpenAIModelClient(string apiKey);
2092 public ClientPipeline Pipeline { get; }
2093 [EditorBrowsable(EditorBrowsableState.Never)]
2094 public virtual ClientResult DeleteModel(string model, RequestOptions options);
2095 public virtual ClientResult<ModelDeletionResult> DeleteModel(string model, CancellationToken cancellationToken = default);
2096 [EditorBrowsable(EditorBrowsableState.Never)]
2097 public virtual Task<ClientResult> DeleteModelAsync(string model, RequestOptions options);
2098 public virtual Task<ClientResult<ModelDeletionResult>> DeleteModelAsync(string model, CancellationToken cancellationToken = default);
2099 [EditorBrowsable(EditorBrowsableState.Never)]
2100 public virtual ClientResult GetModel(string model, RequestOptions options);
2101 public virtual ClientResult<OpenAIModel> GetModel(string model, CancellationToken cancellationToken = default);
2102 [EditorBrowsable(EditorBrowsableState.Never)]
2103 public virtual Task<ClientResult> GetModelAsync(string model, RequestOptions options);
2104 public virtual Task<ClientResult<OpenAIModel>> GetModelAsync(string model, CancellationToken cancellationToken = default);
2105 [EditorBrowsable(EditorBrowsableState.Never)]
2106 public virtual ClientResult GetModels(RequestOptions options);
2107 public virtual ClientResult<OpenAIModelCollection> GetModels(CancellationToken cancellationToken = default);
2108 [EditorBrowsable(EditorBrowsableState.Never)]
2109 public virtual Task<ClientResult> GetModelsAsync(RequestOptions options);
2110 public virtual Task<ClientResult<OpenAIModelCollection>> GetModelsAsync(CancellationToken cancellationToken = default);
2111 }
2112 public class OpenAIModelCollection : ObjectModel.ReadOnlyCollection<OpenAIModel>, IJsonModel<OpenAIModelCollection>, IPersistableModel<OpenAIModelCollection> {
2113 public static explicit operator OpenAIModelCollection(ClientResult result);
2114 public static implicit operator BinaryContent(OpenAIModelCollection openAIModelCollection);
2115 }
2116 public static class OpenAIModelsModelFactory {
2117 public static ModelDeletionResult ModelDeletionResult(string modelId = null, bool deleted = false);
2118 public static OpenAIModel OpenAIModel(string id = null, DateTimeOffset createdAt = default, string ownedBy = null);
2119 public static OpenAIModelCollection OpenAIModelCollection(IEnumerable<OpenAIModel> items = null);
2120 }
2121}
2122namespace OpenAI.Moderations {
2123 public class ModerationCategory {
2124 public bool Flagged { get; }
2125 public float Score { get; }
2126 }
2127 public class ModerationClient {
2128 protected ModerationClient();
2129 protected internal ModerationClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
2130 public ModerationClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
2131 public ModerationClient(string model, ApiKeyCredential credential);
2132 public ModerationClient(string model, string apiKey);
2133 public ClientPipeline Pipeline { get; }
2134 [EditorBrowsable(EditorBrowsableState.Never)]
2135 public virtual ClientResult ClassifyText(BinaryContent content, RequestOptions options = null);
2136 public virtual ClientResult<ModerationResultCollection> ClassifyText(IEnumerable<string> inputs, CancellationToken cancellationToken = default);
2137 public virtual ClientResult<ModerationResult> ClassifyText(string input, CancellationToken cancellationToken = default);
2138 [EditorBrowsable(EditorBrowsableState.Never)]
2139 public virtual Task<ClientResult> ClassifyTextAsync(BinaryContent content, RequestOptions options = null);
2140 public virtual Task<ClientResult<ModerationResultCollection>> ClassifyTextAsync(IEnumerable<string> inputs, CancellationToken cancellationToken = default);
2141 public virtual Task<ClientResult<ModerationResult>> ClassifyTextAsync(string input, CancellationToken cancellationToken = default);
2142 }
2143 public class ModerationResult : IJsonModel<ModerationResult>, IPersistableModel<ModerationResult> {
2144 public bool Flagged { get; }
2145 public ModerationCategory Harassment { get; }
2146 public ModerationCategory HarassmentThreatening { get; }
2147 public ModerationCategory Hate { get; }
2148 public ModerationCategory HateThreatening { get; }
2149 public ModerationCategory Illicit { get; }
2150 public ModerationCategory IllicitViolent { get; }
2151 public ModerationCategory SelfHarm { get; }
2152 public ModerationCategory SelfHarmInstructions { get; }
2153 public ModerationCategory SelfHarmIntent { get; }
2154 public ModerationCategory Sexual { get; }
2155 public ModerationCategory SexualMinors { get; }
2156 public ModerationCategory Violence { get; }
2157 public ModerationCategory ViolenceGraphic { get; }
2158 public static explicit operator ModerationResult(ClientResult result);
2159 public static implicit operator BinaryContent(ModerationResult moderationResult);
2160 }
2161 public class ModerationResultCollection : ObjectModel.ReadOnlyCollection<ModerationResult>, IJsonModel<ModerationResultCollection>, IPersistableModel<ModerationResultCollection> {
2162 public string Id { get; }
2163 public string Model { get; }
2164 public static explicit operator ModerationResultCollection(ClientResult result);
2165 public static implicit operator BinaryContent(ModerationResultCollection moderationResultCollection);
2166 }
2167 public static class OpenAIModerationsModelFactory {
2168 public static ModerationCategory ModerationCategory(bool flagged = false, float score = 0);
2169 public static ModerationResult ModerationResult(bool flagged = false, ModerationCategory hate = null, ModerationCategory hateThreatening = null, ModerationCategory harassment = null, ModerationCategory harassmentThreatening = null, ModerationCategory selfHarm = null, ModerationCategory selfHarmIntent = null, ModerationCategory selfHarmInstructions = null, ModerationCategory sexual = null, ModerationCategory sexualMinors = null, ModerationCategory violence = null, ModerationCategory violenceGraphic = null, ModerationCategory illicit = null, ModerationCategory illicitViolent = null);
2170 [EditorBrowsable(EditorBrowsableState.Never)]
2171 public static ModerationResult ModerationResult(bool flagged, ModerationCategory hate, ModerationCategory hateThreatening, ModerationCategory harassment, ModerationCategory harassmentThreatening, ModerationCategory selfHarm, ModerationCategory selfHarmIntent, ModerationCategory selfHarmInstructions, ModerationCategory sexual, ModerationCategory sexualMinors, ModerationCategory violence, ModerationCategory violenceGraphic);
2172 public static ModerationResultCollection ModerationResultCollection(string id = null, string model = null, IEnumerable<ModerationResult> items = null);
2173 }
2174}
2175namespace OpenAI.RealtimeConversation {
2176 [Experimental("OPENAI002")]
2177 public readonly partial struct ConversationAudioFormat : IEquatable<ConversationAudioFormat> {
2178 public ConversationAudioFormat(string value);
2179 public static ConversationAudioFormat G711Alaw { get; }
2180 public static ConversationAudioFormat G711Ulaw { get; }
2181 public static ConversationAudioFormat Pcm16 { get; }
2182 public readonly bool Equals(ConversationAudioFormat other);
2183 [EditorBrowsable(EditorBrowsableState.Never)]
2184 public override readonly bool Equals(object obj);
2185 [EditorBrowsable(EditorBrowsableState.Never)]
2186 public override readonly int GetHashCode();
2187 public static bool operator ==(ConversationAudioFormat left, ConversationAudioFormat right);
2188 public static implicit operator ConversationAudioFormat(string value);
2189 public static bool operator !=(ConversationAudioFormat left, ConversationAudioFormat right);
2190 public override readonly string ToString();
2191 }
2192 [Experimental("OPENAI002")]
2193 [Flags]
2194 public enum ConversationContentModalities {
2195 Default = 0,
2196 Text = 1,
2197 Audio = 2
2198 }
2199 [Experimental("OPENAI002")]
2200 public class ConversationContentPart : IJsonModel<ConversationContentPart>, IPersistableModel<ConversationContentPart> {
2201 public string AudioTranscript { get; }
2202 public string Text { get; }
2203 public static ConversationContentPart CreateInputAudioTranscriptPart(string transcript = null);
2204 public static ConversationContentPart CreateInputTextPart(string text);
2205 public static ConversationContentPart CreateOutputAudioTranscriptPart(string transcript = null);
2206 public static ConversationContentPart CreateOutputTextPart(string text);
2207 public static explicit operator ConversationContentPart(ClientResult result);
2208 public static implicit operator BinaryContent(ConversationContentPart conversationContentPart);
2209 public static implicit operator ConversationContentPart(string text);
2210 }
2211 [Experimental("OPENAI002")]
2212 public readonly partial struct ConversationContentPartKind : IEquatable<ConversationContentPartKind> {
2213 public ConversationContentPartKind(string value);
2214 public static ConversationContentPartKind InputAudio { get; }
2215 public static ConversationContentPartKind InputText { get; }
2216 public static ConversationContentPartKind OutputAudio { get; }
2217 public static ConversationContentPartKind OutputText { get; }
2218 public readonly bool Equals(ConversationContentPartKind other);
2219 [EditorBrowsable(EditorBrowsableState.Never)]
2220 public override readonly bool Equals(object obj);
2221 [EditorBrowsable(EditorBrowsableState.Never)]
2222 public override readonly int GetHashCode();
2223 public static bool operator ==(ConversationContentPartKind left, ConversationContentPartKind right);
2224 public static implicit operator ConversationContentPartKind(string value);
2225 public static bool operator !=(ConversationContentPartKind left, ConversationContentPartKind right);
2226 public override readonly string ToString();
2227 }
2228 [Experimental("OPENAI002")]
2229 public class ConversationErrorUpdate : ConversationUpdate, IJsonModel<ConversationErrorUpdate>, IPersistableModel<ConversationErrorUpdate> {
2230 public string ErrorCode { get; }
2231 public string ErrorEventId { get; }
2232 public string Message { get; }
2233 public string ParameterName { get; }
2234 public new static explicit operator ConversationErrorUpdate(ClientResult result);
2235 public static implicit operator BinaryContent(ConversationErrorUpdate conversationErrorUpdate);
2236 }
2237 [Experimental("OPENAI002")]
2238 public class ConversationFunctionTool : ConversationTool, IJsonModel<ConversationFunctionTool>, IPersistableModel<ConversationFunctionTool> {
2239 public ConversationFunctionTool(string name);
2240 public string Description { get; set; }
2241 public string Name { get; set; }
2242 public BinaryData Parameters { get; set; }
2243 public new static explicit operator ConversationFunctionTool(ClientResult result);
2244 public static implicit operator BinaryContent(ConversationFunctionTool conversationFunctionTool);
2245 }
2246 [Experimental("OPENAI002")]
2247 public readonly partial struct ConversationIncompleteReason : IEquatable<ConversationIncompleteReason> {
2248 public ConversationIncompleteReason(string value);
2249 public static ConversationIncompleteReason ClientCancelled { get; }
2250 public static ConversationIncompleteReason ContentFilter { get; }
2251 public static ConversationIncompleteReason MaxOutputTokens { get; }
2252 public static ConversationIncompleteReason TurnDetected { get; }
2253 public readonly bool Equals(ConversationIncompleteReason other);
2254 [EditorBrowsable(EditorBrowsableState.Never)]
2255 public override readonly bool Equals(object obj);
2256 [EditorBrowsable(EditorBrowsableState.Never)]
2257 public override readonly int GetHashCode();
2258 public static bool operator ==(ConversationIncompleteReason left, ConversationIncompleteReason right);
2259 public static implicit operator ConversationIncompleteReason(string value);
2260 public static bool operator !=(ConversationIncompleteReason left, ConversationIncompleteReason right);
2261 public override readonly string ToString();
2262 }
2263 [Experimental("OPENAI002")]
2264 public class ConversationInputAudioClearedUpdate : ConversationUpdate, IJsonModel<ConversationInputAudioClearedUpdate>, IPersistableModel<ConversationInputAudioClearedUpdate> {
2265 public new static explicit operator ConversationInputAudioClearedUpdate(ClientResult result);
2266 public static implicit operator BinaryContent(ConversationInputAudioClearedUpdate conversationInputAudioClearedUpdate);
2267 }
2268 [Experimental("OPENAI002")]
2269 public class ConversationInputAudioCommittedUpdate : ConversationUpdate, IJsonModel<ConversationInputAudioCommittedUpdate>, IPersistableModel<ConversationInputAudioCommittedUpdate> {
2270 public string ItemId { get; }
2271 public string PreviousItemId { get; }
2272 public new static explicit operator ConversationInputAudioCommittedUpdate(ClientResult result);
2273 public static implicit operator BinaryContent(ConversationInputAudioCommittedUpdate conversationInputAudioCommittedUpdate);
2274 }
2275 [Experimental("OPENAI002")]
2276 public class ConversationInputSpeechFinishedUpdate : ConversationUpdate, IJsonModel<ConversationInputSpeechFinishedUpdate>, IPersistableModel<ConversationInputSpeechFinishedUpdate> {
2277 public TimeSpan AudioEndTime { get; }
2278 public string ItemId { get; }
2279 public new static explicit operator ConversationInputSpeechFinishedUpdate(ClientResult result);
2280 public static implicit operator BinaryContent(ConversationInputSpeechFinishedUpdate conversationInputSpeechFinishedUpdate);
2281 }
2282 [Experimental("OPENAI002")]
2283 public class ConversationInputSpeechStartedUpdate : ConversationUpdate, IJsonModel<ConversationInputSpeechStartedUpdate>, IPersistableModel<ConversationInputSpeechStartedUpdate> {
2284 public TimeSpan AudioStartTime { get; }
2285 public string ItemId { get; }
2286 public new static explicit operator ConversationInputSpeechStartedUpdate(ClientResult result);
2287 public static implicit operator BinaryContent(ConversationInputSpeechStartedUpdate conversationInputSpeechStartedUpdate);
2288 }
2289 [Experimental("OPENAI002")]
2290 public class ConversationInputTokenUsageDetails : IJsonModel<ConversationInputTokenUsageDetails>, IPersistableModel<ConversationInputTokenUsageDetails> {
2291 public int AudioTokenCount { get; }
2292 public int CachedTokenCount { get; }
2293 public int TextTokenCount { get; }
2294 public static explicit operator ConversationInputTokenUsageDetails(ClientResult result);
2295 public static implicit operator BinaryContent(ConversationInputTokenUsageDetails conversationInputTokenUsageDetails);
2296 }
2297 [Experimental("OPENAI002")]
2298 public class ConversationInputTranscriptionFailedUpdate : ConversationUpdate, IJsonModel<ConversationInputTranscriptionFailedUpdate>, IPersistableModel<ConversationInputTranscriptionFailedUpdate> {
2299 public int ContentIndex { get; }
2300 public string ErrorCode { get; }
2301 public string ErrorMessage { get; }
2302 public string ErrorParameterName { get; }
2303 public string ItemId { get; }
2304 public new static explicit operator ConversationInputTranscriptionFailedUpdate(ClientResult result);
2305 public static implicit operator BinaryContent(ConversationInputTranscriptionFailedUpdate conversationInputTranscriptionFailedUpdate);
2306 }
2307 [Experimental("OPENAI002")]
2308 public class ConversationInputTranscriptionFinishedUpdate : ConversationUpdate, IJsonModel<ConversationInputTranscriptionFinishedUpdate>, IPersistableModel<ConversationInputTranscriptionFinishedUpdate> {
2309 public int ContentIndex { get; }
2310 public string ItemId { get; }
2311 public string Transcript { get; }
2312 public new static explicit operator ConversationInputTranscriptionFinishedUpdate(ClientResult result);
2313 public static implicit operator BinaryContent(ConversationInputTranscriptionFinishedUpdate conversationInputTranscriptionFinishedUpdate);
2314 }
2315 [Experimental("OPENAI002")]
2316 public class ConversationInputTranscriptionOptions : IJsonModel<ConversationInputTranscriptionOptions>, IPersistableModel<ConversationInputTranscriptionOptions> {
2317 public ConversationTranscriptionModel? Model { get; set; }
2318 public static explicit operator ConversationInputTranscriptionOptions(ClientResult result);
2319 public static implicit operator BinaryContent(ConversationInputTranscriptionOptions conversationInputTranscriptionOptions);
2320 }
2321 [Experimental("OPENAI002")]
2322 public class ConversationItem : IJsonModel<ConversationItem>, IPersistableModel<ConversationItem> {
2323 public string FunctionArguments { get; }
2324 public string FunctionCallId { get; }
2325 public string FunctionName { get; }
2326 public string Id { get; set; }
2327 public IReadOnlyList<ConversationContentPart> MessageContentParts { get; }
2328 public ConversationMessageRole? MessageRole { get; }
2329 public static ConversationItem CreateAssistantMessage(IEnumerable<ConversationContentPart> contentItems);
2330 public static ConversationItem CreateFunctionCall(string name, string callId, string arguments);
2331 public static ConversationItem CreateFunctionCallOutput(string callId, string output);
2332 public static ConversationItem CreateSystemMessage(IEnumerable<ConversationContentPart> contentItems);
2333 public static ConversationItem CreateUserMessage(IEnumerable<ConversationContentPart> contentItems);
2334 public static explicit operator ConversationItem(ClientResult result);
2335 public static implicit operator BinaryContent(ConversationItem conversationItem);
2336 }
2337 [Experimental("OPENAI002")]
2338 public class ConversationItemCreatedUpdate : ConversationUpdate, IJsonModel<ConversationItemCreatedUpdate>, IPersistableModel<ConversationItemCreatedUpdate> {
2339 public string FunctionCallArguments { get; }
2340 public string FunctionCallId { get; }
2341 public string FunctionCallOutput { get; }
2342 public string FunctionName { get; }
2343 public string ItemId { get; }
2344 public IReadOnlyList<ConversationContentPart> MessageContentParts { get; }
2345 public ConversationMessageRole? MessageRole { get; }
2346 public string PreviousItemId { get; }
2347 public new static explicit operator ConversationItemCreatedUpdate(ClientResult result);
2348 public static implicit operator BinaryContent(ConversationItemCreatedUpdate conversationItemCreatedUpdate);
2349 }
2350 [Experimental("OPENAI002")]
2351 public class ConversationItemDeletedUpdate : ConversationUpdate, IJsonModel<ConversationItemDeletedUpdate>, IPersistableModel<ConversationItemDeletedUpdate> {
2352 public string ItemId { get; }
2353 public new static explicit operator ConversationItemDeletedUpdate(ClientResult result);
2354 public static implicit operator BinaryContent(ConversationItemDeletedUpdate conversationItemDeletedUpdate);
2355 }
2356 [Experimental("OPENAI002")]
2357 public readonly partial struct ConversationItemStatus : IEquatable<ConversationItemStatus> {
2358 public ConversationItemStatus(string value);
2359 public static ConversationItemStatus Completed { get; }
2360 public static ConversationItemStatus Incomplete { get; }
2361 public static ConversationItemStatus InProgress { get; }
2362 public readonly bool Equals(ConversationItemStatus other);
2363 [EditorBrowsable(EditorBrowsableState.Never)]
2364 public override readonly bool Equals(object obj);
2365 [EditorBrowsable(EditorBrowsableState.Never)]
2366 public override readonly int GetHashCode();
2367 public static bool operator ==(ConversationItemStatus left, ConversationItemStatus right);
2368 public static implicit operator ConversationItemStatus(string value);
2369 public static bool operator !=(ConversationItemStatus left, ConversationItemStatus right);
2370 public override readonly string ToString();
2371 }
2372 [Experimental("OPENAI002")]
2373 public class ConversationItemStreamingAudioFinishedUpdate : ConversationUpdate, IJsonModel<ConversationItemStreamingAudioFinishedUpdate>, IPersistableModel<ConversationItemStreamingAudioFinishedUpdate> {
2374 public int ContentIndex { get; }
2375 public string ItemId { get; }
2376 public int OutputIndex { get; }
2377 public string ResponseId { get; }
2378 public new static explicit operator ConversationItemStreamingAudioFinishedUpdate(ClientResult result);
2379 public static implicit operator BinaryContent(ConversationItemStreamingAudioFinishedUpdate conversationItemStreamingAudioFinishedUpdate);
2380 }
2381 [Experimental("OPENAI002")]
2382 public class ConversationItemStreamingAudioTranscriptionFinishedUpdate : ConversationUpdate, IJsonModel<ConversationItemStreamingAudioTranscriptionFinishedUpdate>, IPersistableModel<ConversationItemStreamingAudioTranscriptionFinishedUpdate> {
2383 public int ContentIndex { get; }
2384 public string ItemId { get; }
2385 public int OutputIndex { get; }
2386 public string ResponseId { get; }
2387 public string Transcript { get; }
2388 public new static explicit operator ConversationItemStreamingAudioTranscriptionFinishedUpdate(ClientResult result);
2389 public static implicit operator BinaryContent(ConversationItemStreamingAudioTranscriptionFinishedUpdate conversationItemStreamingAudioTranscriptionFinishedUpdate);
2390 }
2391 [Experimental("OPENAI002")]
2392 public class ConversationItemStreamingFinishedUpdate : ConversationUpdate, IJsonModel<ConversationItemStreamingFinishedUpdate>, IPersistableModel<ConversationItemStreamingFinishedUpdate> {
2393 public string FunctionCallArguments { get; }
2394 public string FunctionCallId { get; }
2395 public string FunctionCallOutput { get; }
2396 public string FunctionName { get; }
2397 public string ItemId { get; }
2398 public IReadOnlyList<ConversationContentPart> MessageContentParts { get; }
2399 public ConversationMessageRole? MessageRole { get; }
2400 public int OutputIndex { get; }
2401 public string ResponseId { get; }
2402 public new static explicit operator ConversationItemStreamingFinishedUpdate(ClientResult result);
2403 public static implicit operator BinaryContent(ConversationItemStreamingFinishedUpdate conversationItemStreamingFinishedUpdate);
2404 }
2405 [Experimental("OPENAI002")]
2406 public class ConversationItemStreamingPartDeltaUpdate : ConversationUpdate, IJsonModel<ConversationItemStreamingPartDeltaUpdate>, IPersistableModel<ConversationItemStreamingPartDeltaUpdate> {
2407 public BinaryData AudioBytes { get; }
2408 public string AudioTranscript { get; }
2409 public int ContentPartIndex { get; }
2410 public string FunctionArguments { get; }
2411 public string FunctionCallId { get; }
2412 public string ItemId { get; }
2413 public int ItemIndex { get; }
2414 public string ResponseId { get; }
2415 public string Text { get; }
2416 }
2417 public class ConversationItemStreamingPartFinishedUpdate : ConversationUpdate, IJsonModel<ConversationItemStreamingPartFinishedUpdate>, IPersistableModel<ConversationItemStreamingPartFinishedUpdate> {
2418 public string AudioTranscript { get; }
2419 public int ContentPartIndex { get; }
2420 public string FunctionArguments { get; }
2421 public string FunctionCallId { get; }
2422 public string ItemId { get; }
2423 public int ItemIndex { get; }
2424 public string ResponseId { get; }
2425 public string Text { get; }
2426 }
2427 [Experimental("OPENAI002")]
2428 public class ConversationItemStreamingStartedUpdate : ConversationUpdate, IJsonModel<ConversationItemStreamingStartedUpdate>, IPersistableModel<ConversationItemStreamingStartedUpdate> {
2429 public string FunctionCallArguments { get; }
2430 public string FunctionCallId { get; }
2431 public string FunctionCallOutput { get; }
2432 public string FunctionName { get; }
2433 public string ItemId { get; }
2434 public int ItemIndex { get; }
2435 public IReadOnlyList<ConversationContentPart> MessageContentParts { get; }
2436 public ConversationMessageRole? MessageRole { get; }
2437 public string ResponseId { get; }
2438 public new static explicit operator ConversationItemStreamingStartedUpdate(ClientResult result);
2439 public static implicit operator BinaryContent(ConversationItemStreamingStartedUpdate conversationItemStreamingStartedUpdate);
2440 }
2441 [Experimental("OPENAI002")]
2442 public class ConversationItemStreamingTextFinishedUpdate : ConversationUpdate, IJsonModel<ConversationItemStreamingTextFinishedUpdate>, IPersistableModel<ConversationItemStreamingTextFinishedUpdate> {
2443 public int ContentIndex { get; }
2444 public string ItemId { get; }
2445 public int OutputIndex { get; }
2446 public string ResponseId { get; }
2447 public string Text { get; }
2448 public new static explicit operator ConversationItemStreamingTextFinishedUpdate(ClientResult result);
2449 public static implicit operator BinaryContent(ConversationItemStreamingTextFinishedUpdate conversationItemStreamingTextFinishedUpdate);
2450 }
2451 [Experimental("OPENAI002")]
2452 public class ConversationItemTruncatedUpdate : ConversationUpdate, IJsonModel<ConversationItemTruncatedUpdate>, IPersistableModel<ConversationItemTruncatedUpdate> {
2453 public int AudioEndMs { get; }
2454 public int ContentIndex { get; }
2455 public string ItemId { get; }
2456 public new static explicit operator ConversationItemTruncatedUpdate(ClientResult result);
2457 public static implicit operator BinaryContent(ConversationItemTruncatedUpdate conversationItemTruncatedUpdate);
2458 }
2459 [Experimental("OPENAI002")]
2460 public class ConversationMaxTokensChoice : IJsonModel<ConversationMaxTokensChoice>, IPersistableModel<ConversationMaxTokensChoice> {
2461 public ConversationMaxTokensChoice(int numberValue);
2462 public int? NumericValue { get; }
2463 public static ConversationMaxTokensChoice CreateDefaultMaxTokensChoice();
2464 public static ConversationMaxTokensChoice CreateInfiniteMaxTokensChoice();
2465 public static ConversationMaxTokensChoice CreateNumericMaxTokensChoice(int maxTokens);
2466 public static implicit operator ConversationMaxTokensChoice(int maxTokens);
2467 }
2468 [Experimental("OPENAI002")]
2469 public readonly partial struct ConversationMessageRole : IEquatable<ConversationMessageRole> {
2470 public ConversationMessageRole(string value);
2471 public static ConversationMessageRole Assistant { get; }
2472 public static ConversationMessageRole System { get; }
2473 public static ConversationMessageRole User { get; }
2474 public readonly bool Equals(ConversationMessageRole other);
2475 [EditorBrowsable(global::EditorBrowsableState.Never)]
2476 public override readonly bool Equals(object obj);
2477 [EditorBrowsable(global::EditorBrowsableState.Never)]
2478 public override readonly int GetHashCode();
2479 public static bool operator ==(ConversationMessageRole left, ConversationMessageRole right);
2480 public static implicit operator ConversationMessageRole(string value);
2481 public static bool operator !=(ConversationMessageRole left, ConversationMessageRole right);
2482 public override readonly string ToString();
2483 }
2484 [Experimental("OPENAI002")]
2485 public class ConversationOutputTokenUsageDetails : IJsonModel<ConversationOutputTokenUsageDetails>, IPersistableModel<ConversationOutputTokenUsageDetails> {
2486 public int AudioTokenCount { get; }
2487 public int TextTokenCount { get; }
2488 public static explicit operator ConversationOutputTokenUsageDetails(ClientResult result);
2489 public static implicit operator BinaryContent(ConversationOutputTokenUsageDetails conversationOutputTokenUsageDetails);
2490 }
2491 [Experimental("OPENAI002")]
2492 public class ConversationRateLimitDetailsItem : IJsonModel<ConversationRateLimitDetailsItem>, IPersistableModel<ConversationRateLimitDetailsItem> {
2493 public int MaximumCount { get; }
2494 public string Name { get; }
2495 public int RemainingCount { get; }
2496 public TimeSpan TimeUntilReset { get; }
2497 public static explicit operator ConversationRateLimitDetailsItem(ClientResult result);
2498 public static implicit operator BinaryContent(ConversationRateLimitDetailsItem conversationRateLimitDetailsItem);
2499 }
2500 [Experimental("OPENAI002")]
2501 public class ConversationRateLimitsUpdate : ConversationUpdate, IJsonModel<ConversationRateLimitsUpdate>, IPersistableModel<ConversationRateLimitsUpdate> {
2502 public IReadOnlyList<ConversationRateLimitDetailsItem> AllDetails { get; }
2503 public ConversationRateLimitDetailsItem RequestDetails { get; }
2504 public ConversationRateLimitDetailsItem TokenDetails { get; }
2505 public new static explicit operator ConversationRateLimitsUpdate(ClientResult result);
2506 public static implicit operator BinaryContent(ConversationRateLimitsUpdate conversationRateLimitsUpdate);
2507 }
2508 [Experimental("OPENAI002")]
2509 public class ConversationResponseFinishedUpdate : ConversationUpdate, IJsonModel<ConversationResponseFinishedUpdate>, IPersistableModel<ConversationResponseFinishedUpdate> {
2510 public IReadOnlyList<ConversationItem> CreatedItems { get; }
2511 public string ResponseId { get; }
2512 public ConversationStatus? Status { get; }
2513 public ConversationStatusDetails StatusDetails { get; }
2514 public ConversationTokenUsage Usage { get; }
2515 public new static explicit operator ConversationResponseFinishedUpdate(ClientResult result);
2516 public static implicit operator BinaryContent(ConversationResponseFinishedUpdate conversationResponseFinishedUpdate);
2517 }
2518 [Experimental("OPENAI002")]
2519 public class ConversationResponseOptions : IJsonModel<ConversationResponseOptions>, IPersistableModel<ConversationResponseOptions> {
2520 public ConversationContentModalities ContentModalities { get; set; }
2521 public ResponseConversationSelection? ConversationSelection { get; set; }
2522 public string Instructions { get; set; }
2523 public ConversationMaxTokensChoice MaxOutputTokens { get; set; }
2524 public IDictionary<string, string> Metadata { get; }
2525 public ConversationAudioFormat? OutputAudioFormat { get; set; }
2526 public IList<ConversationItem> OverrideItems { get; }
2527 public float? Temperature { get; set; }
2528 public ConversationToolChoice ToolChoice { get; set; }
2529 public IList<ConversationTool> Tools { get; }
2530 public ConversationVoice? Voice { get; set; }
2531 public static explicit operator ConversationResponseOptions(ClientResult result);
2532 public static implicit operator BinaryContent(ConversationResponseOptions conversationResponseOptions);
2533 }
2534 [Experimental("OPENAI002")]
2535 public class ConversationResponseStartedUpdate : ConversationUpdate, IJsonModel<ConversationResponseStartedUpdate>, IPersistableModel<ConversationResponseStartedUpdate> {
2536 public IReadOnlyList<ConversationItem> CreatedItems { get; }
2537 public string ResponseId { get; }
2538 public ConversationStatus Status { get; }
2539 public ConversationStatusDetails StatusDetails { get; }
2540 public ConversationTokenUsage Usage { get; }
2541 public new static explicit operator ConversationResponseStartedUpdate(ClientResult result);
2542 public static implicit operator BinaryContent(ConversationResponseStartedUpdate conversationResponseStartedUpdate);
2543 }
2544 [Experimental("OPENAI002")]
2545 public class ConversationSessionConfiguredUpdate : ConversationUpdate, IJsonModel<ConversationSessionConfiguredUpdate>, IPersistableModel<ConversationSessionConfiguredUpdate> {
2546 public ConversationContentModalities ContentModalities { get; }
2547 public ConversationAudioFormat InputAudioFormat { get; }
2548 public ConversationInputTranscriptionOptions InputTranscriptionOptions { get; }
2549 public string Instructions { get; }
2550 public ConversationMaxTokensChoice MaxOutputTokens { get; }
2551 public string Model { get; }
2552 public ConversationAudioFormat OutputAudioFormat { get; }
2553 public string SessionId { get; }
2554 public float Temperature { get; }
2555 public ConversationToolChoice ToolChoice { get; }
2556 public IReadOnlyList<ConversationTool> Tools { get; }
2557 public ConversationTurnDetectionOptions TurnDetectionOptions { get; }
2558 public ConversationVoice Voice { get; }
2559 public new static explicit operator ConversationSessionConfiguredUpdate(ClientResult result);
2560 public static implicit operator BinaryContent(ConversationSessionConfiguredUpdate conversationSessionConfiguredUpdate);
2561 }
2562 [Experimental("OPENAI002")]
2563 public class ConversationSessionOptions : IJsonModel<ConversationSessionOptions>, IPersistableModel<ConversationSessionOptions> {
2564 public ConversationContentModalities ContentModalities { get; set; }
2565 public ConversationAudioFormat? InputAudioFormat { get; set; }
2566 public ConversationInputTranscriptionOptions InputTranscriptionOptions { get; set; }
2567 public string Instructions { get; set; }
2568 public ConversationMaxTokensChoice MaxOutputTokens { get; set; }
2569 public ConversationAudioFormat? OutputAudioFormat { get; set; }
2570 public float? Temperature { get; set; }
2571 public ConversationToolChoice ToolChoice { get; set; }
2572 public IList<ConversationTool> Tools { get; }
2573 public ConversationTurnDetectionOptions TurnDetectionOptions { get; set; }
2574 public ConversationVoice? Voice { get; set; }
2575 public static explicit operator ConversationSessionOptions(ClientResult result);
2576 public static implicit operator BinaryContent(ConversationSessionOptions conversationSessionOptions);
2577 }
2578 [Experimental("OPENAI002")]
2579 public class ConversationSessionStartedUpdate : ConversationUpdate, IJsonModel<ConversationSessionStartedUpdate>, IPersistableModel<ConversationSessionStartedUpdate> {
2580 public ConversationContentModalities ContentModalities { get; }
2581 public ConversationAudioFormat InputAudioFormat { get; }
2582 public ConversationInputTranscriptionOptions InputTranscriptionOptions { get; }
2583 public string Instructions { get; }
2584 public ConversationMaxTokensChoice MaxOutputTokens { get; }
2585 public string Model { get; }
2586 public ConversationAudioFormat OutputAudioFormat { get; }
2587 public string SessionId { get; }
2588 public float Temperature { get; }
2589 public ConversationToolChoice ToolChoice { get; }
2590 public IReadOnlyList<ConversationTool> Tools { get; }
2591 public ConversationTurnDetectionOptions TurnDetectionOptions { get; }
2592 public ConversationVoice Voice { get; }
2593 public new static explicit operator ConversationSessionStartedUpdate(ClientResult result);
2594 public static implicit operator BinaryContent(ConversationSessionStartedUpdate conversationSessionStartedUpdate);
2595 }
2596 [Experimental("OPENAI002")]
2597 public readonly partial struct ConversationStatus : IEquatable<ConversationStatus> {
2598 public ConversationStatus(string value);
2599 public static ConversationStatus Cancelled { get; }
2600 public static ConversationStatus Completed { get; }
2601 public static ConversationStatus Failed { get; }
2602 public static ConversationStatus Incomplete { get; }
2603 public readonly bool Equals(ConversationStatus other);
2604 [EditorBrowsable(EditorBrowsableState.Never)]
2605 public override readonly bool Equals(object obj);
2606 [EditorBrowsable(EditorBrowsableState.Never)]
2607 public override readonly int GetHashCode();
2608 public static bool operator ==(ConversationStatus left, ConversationStatus right);
2609 public static implicit operator ConversationStatus(string value);
2610 public static bool operator !=(ConversationStatus left, ConversationStatus right);
2611 public override readonly string ToString();
2612 }
2613 [Experimental("OPENAI002")]
2614 public class ConversationStatusDetails : IJsonModel<ConversationStatusDetails>, IPersistableModel<ConversationStatusDetails> {
2615 public string ErrorCode { get; }
2616 public string ErrorKind { get; }
2617 public ConversationIncompleteReason? IncompleteReason { get; }
2618 public ConversationStatus StatusKind { get; }
2619 public static explicit operator ConversationStatusDetails(ClientResult result);
2620 public static implicit operator BinaryContent(ConversationStatusDetails conversationStatusDetails);
2621 }
2622 [Experimental("OPENAI002")]
2623 public class ConversationTokenUsage : IJsonModel<ConversationTokenUsage>, IPersistableModel<ConversationTokenUsage> {
2624 public int InputTokenCount { get; }
2625 public ConversationInputTokenUsageDetails InputTokenDetails { get; }
2626 public int OutputTokenCount { get; }
2627 public ConversationOutputTokenUsageDetails OutputTokenDetails { get; }
2628 public int TotalTokenCount { get; }
2629 public static explicit operator ConversationTokenUsage(ClientResult result);
2630 public static implicit operator BinaryContent(ConversationTokenUsage conversationTokenUsage);
2631 }
2632 [Experimental("OPENAI002")]
2633 public abstract class ConversationTool : IJsonModel<ConversationTool>, IPersistableModel<ConversationTool> {
2634 public ConversationToolKind Kind { get; }
2635 public static ConversationTool CreateFunctionTool(string name, string description = null, BinaryData parameters = null);
2636 public static explicit operator ConversationTool(ClientResult result);
2637 public static implicit operator BinaryContent(ConversationTool conversationTool);
2638 }
2639 [Experimental("OPENAI002")]
2640 public class ConversationToolChoice : IJsonModel<ConversationToolChoice>, IPersistableModel<ConversationToolChoice> {
2641 public string FunctionName { get; }
2642 public ConversationToolChoiceKind Kind { get; }
2643 public static ConversationToolChoice CreateAutoToolChoice();
2644 public static ConversationToolChoice CreateFunctionToolChoice(string functionName);
2645 public static ConversationToolChoice CreateNoneToolChoice();
2646 public static ConversationToolChoice CreateRequiredToolChoice();
2647 }
2648 [Experimental("OPENAI002")]
2649 public enum ConversationToolChoiceKind {
2650 Unknown = 0,
2651 Auto = 1,
2652 None = 2,
2653 Required = 3,
2654 Function = 4
2655 }
2656 [Experimental("OPENAI002")]
2657 public readonly partial struct ConversationToolKind : IEquatable<ConversationToolKind> {
2658 public ConversationToolKind(string value);
2659 public static ConversationToolKind Function { get; }
2660 public readonly bool Equals(ConversationToolKind other);
2661 [EditorBrowsable(EditorBrowsableState.Never)]
2662 public override readonly bool Equals(object obj);
2663 [EditorBrowsable(EditorBrowsableState.Never)]
2664 public override readonly int GetHashCode();
2665 public static bool operator ==(ConversationToolKind left, ConversationToolKind right);
2666 public static implicit operator ConversationToolKind(string value);
2667 public static bool operator !=(ConversationToolKind left, ConversationToolKind right);
2668 public override readonly string ToString();
2669 }
2670 [Experimental("OPENAI002")]
2671 public readonly partial struct ConversationTranscriptionModel : IEquatable<ConversationTranscriptionModel> {
2672 public ConversationTranscriptionModel(string value);
2673 public static ConversationTranscriptionModel Whisper1 { get; }
2674 public readonly bool Equals(ConversationTranscriptionModel other);
2675 [EditorBrowsable(EditorBrowsableState.Never)]
2676 public override readonly bool Equals(object obj);
2677 [EditorBrowsable(EditorBrowsableState.Never)]
2678 public override readonly int GetHashCode();
2679 public static bool operator ==(ConversationTranscriptionModel left, ConversationTranscriptionModel right);
2680 public static implicit operator ConversationTranscriptionModel(string value);
2681 public static bool operator !=(ConversationTranscriptionModel left, ConversationTranscriptionModel right);
2682 public override readonly string ToString();
2683 }
2684 [Experimental("OPENAI002")]
2685 public enum ConversationTurnDetectionKind {
2686 ServerVoiceActivityDetection = 0,
2687 Disabled = 1
2688 }
2689 [Experimental("OPENAI002")]
2690 public class ConversationTurnDetectionOptions : IJsonModel<ConversationTurnDetectionOptions>, IPersistableModel<ConversationTurnDetectionOptions> {
2691 public ConversationTurnDetectionKind Kind { get; protected internal set; }
2692 public static ConversationTurnDetectionOptions CreateDisabledTurnDetectionOptions();
2693 public static ConversationTurnDetectionOptions CreateServerVoiceActivityTurnDetectionOptions(float? detectionThreshold = null, TimeSpan? prefixPaddingDuration = null, TimeSpan? silenceDuration = null, bool? enableAutomaticResponseCreation = null);
2694 public static explicit operator ConversationTurnDetectionOptions(ClientResult result);
2695 public static implicit operator BinaryContent(ConversationTurnDetectionOptions conversationTurnDetectionOptions);
2696 }
2697 [Experimental("OPENAI002")]
2698 public class ConversationUpdate : IJsonModel<ConversationUpdate>, IPersistableModel<ConversationUpdate> {
2699 public string EventId { get; }
2700 public ConversationUpdateKind Kind { get; protected internal set; }
2701 public BinaryData GetRawContent();
2702 public static explicit operator ConversationUpdate(ClientResult result);
2703 public static implicit operator BinaryContent(ConversationUpdate conversationUpdate);
2704 }
2705 [Experimental("OPENAI002")]
2706 public enum ConversationUpdateKind {
2707 Unknown = 0,
2708 SessionStarted = 1,
2709 SessionConfigured = 2,
2710 ItemCreated = 3,
2711 ConversationCreated = 4,
2712 ItemDeleted = 5,
2713 ItemTruncated = 6,
2714 ResponseStarted = 7,
2715 ResponseFinished = 8,
2716 RateLimitsUpdated = 9,
2717 ItemStreamingStarted = 10,
2718 ItemStreamingFinished = 11,
2719 ItemContentPartStarted = 12,
2720 ItemContentPartFinished = 13,
2721 ItemStreamingPartAudioDelta = 14,
2722 ItemStreamingPartAudioFinished = 15,
2723 ItemStreamingPartAudioTranscriptionDelta = 16,
2724 ItemStreamingPartAudioTranscriptionFinished = 17,
2725 ItemStreamingPartTextDelta = 18,
2726 ItemStreamingPartTextFinished = 19,
2727 ItemStreamingFunctionCallArgumentsDelta = 20,
2728 ItemStreamingFunctionCallArgumentsFinished = 21,
2729 InputSpeechStarted = 22,
2730 InputSpeechStopped = 23,
2731 InputTranscriptionFinished = 24,
2732 InputTranscriptionFailed = 25,
2733 InputAudioCommitted = 26,
2734 InputAudioCleared = 27,
2735 Error = 28
2736 }
2737 [Experimental("OPENAI002")]
2738 public readonly partial struct ConversationVoice : IEquatable<ConversationVoice> {
2739 public ConversationVoice(string value);
2740 public static ConversationVoice Alloy { get; }
2741 public static ConversationVoice Ash { get; }
2742 public static ConversationVoice Ballad { get; }
2743 public static ConversationVoice Coral { get; }
2744 public static ConversationVoice Echo { get; }
2745 public static ConversationVoice Sage { get; }
2746 public static ConversationVoice Shimmer { get; }
2747 public static ConversationVoice Verse { get; }
2748 public readonly bool Equals(ConversationVoice other);
2749 [EditorBrowsable(EditorBrowsableState.Never)]
2750 public override readonly bool Equals(object obj);
2751 [EditorBrowsable(EditorBrowsableState.Never)]
2752 public override readonly int GetHashCode();
2753 public static bool operator ==(ConversationVoice left, ConversationVoice right);
2754 public static implicit operator ConversationVoice(string value);
2755 public static bool operator !=(ConversationVoice left, ConversationVoice right);
2756 public override readonly string ToString();
2757 }
2758 [Experimental("OPENAI002")]
2759 public class RealtimeConversationClient {
2760 protected RealtimeConversationClient();
2761 protected internal RealtimeConversationClient(ClientPipeline pipeline, OpenAIClientOptions options);
2762 public RealtimeConversationClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
2763 public RealtimeConversationClient(string model, ApiKeyCredential credential);
2764 public ClientPipeline Pipeline { get; }
2765 public event EventHandler<BinaryData> OnReceivingCommand { add; remove; }
2766 public event EventHandler<BinaryData> OnSendingCommand { add; remove; }
2767 public RealtimeConversationSession StartConversationSession(CancellationToken cancellationToken = default);
2768 public virtual Task<RealtimeConversationSession> StartConversationSessionAsync(RequestOptions options);
2769 public virtual Task<RealtimeConversationSession> StartConversationSessionAsync(CancellationToken cancellationToken = default);
2770 }
2771 [Experimental("OPENAI002")]
2772 public class RealtimeConversationSession : IDisposable {
2773 protected internal RealtimeConversationSession(RealtimeConversationClient parentClient, Uri endpoint, ApiKeyCredential credential);
2774 public Net.WebSockets.WebSocket WebSocket { get; protected set; }
2775 public virtual void AddItem(ConversationItem item, string previousItemId, CancellationToken cancellationToken = default);
2776 public virtual void AddItem(ConversationItem item, CancellationToken cancellationToken = default);
2777 public virtual Task AddItemAsync(ConversationItem item, string previousItemId, CancellationToken cancellationToken = default);
2778 public virtual Task AddItemAsync(ConversationItem item, CancellationToken cancellationToken = default);
2779 public virtual void CancelResponse(CancellationToken cancellationToken = default);
2780 public virtual Task CancelResponseAsync(CancellationToken cancellationToken = default);
2781 public virtual void ClearInputAudio(CancellationToken cancellationToken = default);
2782 public virtual Task ClearInputAudioAsync(CancellationToken cancellationToken = default);
2783 public virtual void CommitPendingAudio(CancellationToken cancellationToken = default);
2784 public virtual Task CommitPendingAudioAsync(CancellationToken cancellationToken = default);
2785 public virtual void ConfigureSession(ConversationSessionOptions sessionOptions, CancellationToken cancellationToken = default);
2786 public virtual Task ConfigureSessionAsync(ConversationSessionOptions sessionOptions, CancellationToken cancellationToken = default);
2787 [EditorBrowsable(EditorBrowsableState.Never)]
2788 protected internal virtual void Connect(RequestOptions options);
2789 [EditorBrowsable(EditorBrowsableState.Never)]
2790 protected internal virtual Task ConnectAsync(RequestOptions options);
2791 public virtual void DeleteItem(string itemId, CancellationToken cancellationToken = default);
2792 public virtual Task DeleteItemAsync(string itemId, CancellationToken cancellationToken = default);
2793 public void Dispose();
2794 public virtual void InterruptResponse(CancellationToken cancellationToken = default);
2795 public virtual Task InterruptResponseAsync(CancellationToken cancellationToken = default);
2796 [EditorBrowsable(EditorBrowsableState.Never)]
2797 public virtual IEnumerable<ClientResult> ReceiveUpdates(RequestOptions options);
2798 public virtual IEnumerable<ConversationUpdate> ReceiveUpdates(CancellationToken cancellationToken = default);
2799 [EditorBrowsable(EditorBrowsableState.Never)]
2800 public virtual IAsyncEnumerable<ClientResult> ReceiveUpdatesAsync(RequestOptions options);
2801 public virtual IAsyncEnumerable<ConversationUpdate> ReceiveUpdatesAsync(CancellationToken cancellationToken = default);
2802 [EditorBrowsable(EditorBrowsableState.Never)]
2803 public virtual void SendCommand(BinaryData data, RequestOptions options);
2804 [EditorBrowsable(EditorBrowsableState.Never)]
2805 public virtual Task SendCommandAsync(BinaryData data, RequestOptions options);
2806 public virtual void SendInputAudio(BinaryData audio, CancellationToken cancellationToken = default);
2807 public virtual void SendInputAudio(Stream audio, CancellationToken cancellationToken = default);
2808 public virtual Task SendInputAudioAsync(BinaryData audio, CancellationToken cancellationToken = default);
2809 public virtual Task SendInputAudioAsync(Stream audio, CancellationToken cancellationToken = default);
2810 public virtual void StartResponse(ConversationResponseOptions options, CancellationToken cancellationToken = default);
2811 public void StartResponse(CancellationToken cancellationToken = default);
2812 public virtual Task StartResponseAsync(ConversationResponseOptions options, CancellationToken cancellationToken = default);
2813 public virtual Task StartResponseAsync(CancellationToken cancellationToken = default);
2814 public virtual void TruncateItem(string itemId, int contentPartIndex, TimeSpan audioDuration, CancellationToken cancellationToken = default);
2815 public virtual Task TruncateItemAsync(string itemId, int contentPartIndex, TimeSpan audioDuration, CancellationToken cancellationToken = default);
2816 }
2817 [Experimental("OPENAI002")]
2818 public readonly partial struct ResponseConversationSelection : IEquatable<ResponseConversationSelection> {
2819 public ResponseConversationSelection(string value);
2820 public static ResponseConversationSelection Auto { get; }
2821 public static ResponseConversationSelection None { get; }
2822 public readonly bool Equals(ResponseConversationSelection other);
2823 [EditorBrowsable(EditorBrowsableState.Never)]
2824 public override readonly bool Equals(object obj);
2825 [EditorBrowsable(EditorBrowsableState.Never)]
2826 public override readonly int GetHashCode();
2827 public static bool operator ==(ResponseConversationSelection left, ResponseConversationSelection right);
2828 public static implicit operator ResponseConversationSelection(string value);
2829 public static bool operator !=(ResponseConversationSelection left, ResponseConversationSelection right);
2830 public override readonly string ToString();
2831 }
2832}
2833namespace OpenAI.Responses {
2834 [Experimental("OPENAICUA001")]
2835 public class ComputerCallAction : IJsonModel<ComputerCallAction>, IPersistableModel<ComputerCallAction> {
2836 public Drawing.Point? ClickCoordinates { get; }
2837 public ComputerCallActionMouseButton? ClickMouseButton { get; }
2838 public Drawing.Point? DoubleClickCoordinates { get; }
2839 public IList<Drawing.Point> DragPath { get; }
2840 public IList<string> KeyPressKeyCodes { get; }
2841 public ComputerCallActionKind Kind { get; }
2842 public Drawing.Point? MoveCoordinates { get; }
2843 public Drawing.Point? ScrollCoordinates { get; }
2844 public int? ScrollHorizontalOffset { get; }
2845 public int? ScrollVerticalOffset { get; }
2846 public string TypeText { get; }
2847 public static ComputerCallAction CreateClickAction(Drawing.Point clickCoordinates, ComputerCallActionMouseButton clickMouseButton);
2848 public static ComputerCallAction CreateDoubleClickAction(Drawing.Point doubleClickCoordinates, ComputerCallActionMouseButton doubleClickMouseButton);
2849 public static ComputerCallAction CreateDragAction(IList<Drawing.Point> dragPath);
2850 public static ComputerCallAction CreateKeyPressAction(IList<string> keyCodes);
2851 public static ComputerCallAction CreateMoveAction(Drawing.Point moveCoordinates);
2852 public static ComputerCallAction CreateScreenshotAction();
2853 public static ComputerCallAction CreateScrollAction(Drawing.Point scrollCoordinates, int horizontalOffset, int verticalOffset);
2854 public static ComputerCallAction CreateTypeAction(string typeText);
2855 public static ComputerCallAction CreateWaitAction();
2856 public static explicit operator ComputerCallAction(ClientResult result);
2857 public static implicit operator BinaryContent(ComputerCallAction computerCallAction);
2858 }
2859 [Experimental("OPENAICUA001")]
2860 public enum ComputerCallActionKind {
2861 Click = 0,
2862 DoubleClick = 1,
2863 Drag = 2,
2864 KeyPress = 3,
2865 Move = 4,
2866 Screenshot = 5,
2867 Scroll = 6,
2868 Type = 7,
2869 Wait = 8
2870 }
2871 [Experimental("OPENAICUA001")]
2872 public enum ComputerCallActionMouseButton {
2873 Left = 0,
2874 Right = 1,
2875 Wheel = 2,
2876 Back = 3,
2877 Forward = 4
2878 }
2879 [Experimental("OPENAICUA001")]
2880 public class ComputerCallOutputResponseItem : ResponseItem, IJsonModel<ComputerCallOutputResponseItem>, IPersistableModel<ComputerCallOutputResponseItem> {
2881 public ComputerCallOutputResponseItem(string callId, IEnumerable<ComputerCallSafetyCheck> acknowledgedSafetyChecks, ComputerOutput output);
2882 public IList<ComputerCallSafetyCheck> AcknowledgedSafetyChecks { get; }
2883 public string CallId { get; set; }
2884 public ComputerOutput Output { get; set; }
2885 public ComputerCallOutputStatus? Status { get; }
2886 public new static explicit operator ComputerCallOutputResponseItem(ClientResult result);
2887 public static implicit operator BinaryContent(ComputerCallOutputResponseItem computerCallOutputResponseItem);
2888 }
2889 [Experimental("OPENAICUA001")]
2890 public enum ComputerCallOutputStatus {
2891 InProgress = 0,
2892 Completed = 1,
2893 Incomplete = 2
2894 }
2895 [Experimental("OPENAICUA001")]
2896 public class ComputerCallResponseItem : ResponseItem, IJsonModel<ComputerCallResponseItem>, IPersistableModel<ComputerCallResponseItem> {
2897 public ComputerCallResponseItem(string callId, ComputerCallAction action, IEnumerable<ComputerCallSafetyCheck> pendingSafetyChecks);
2898 public ComputerCallAction Action { get; set; }
2899 public string CallId { get; set; }
2900 public IList<ComputerCallSafetyCheck> PendingSafetyChecks { get; }
2901 public ComputerCallStatus Status { get; }
2902 public new static explicit operator ComputerCallResponseItem(ClientResult result);
2903 public static implicit operator BinaryContent(ComputerCallResponseItem computerCallResponseItem);
2904 }
2905 [Experimental("OPENAICUA001")]
2906 public class ComputerCallSafetyCheck : IJsonModel<ComputerCallSafetyCheck>, IPersistableModel<ComputerCallSafetyCheck> {
2907 public ComputerCallSafetyCheck(string id, string code, string message);
2908 public string Code { get; set; }
2909 public string Id { get; set; }
2910 public string Message { get; set; }
2911 public static explicit operator ComputerCallSafetyCheck(ClientResult result);
2912 public static implicit operator BinaryContent(ComputerCallSafetyCheck computerCallSafetyCheck);
2913 }
2914 [Experimental("OPENAICUA001")]
2915 public enum ComputerCallStatus {
2916 InProgress = 0,
2917 Completed = 1,
2918 Incomplete = 2
2919 }
2920 [Experimental("OPENAICUA001")]
2921 public class ComputerOutput : IJsonModel<ComputerOutput>, IPersistableModel<ComputerOutput> {
2922 public static ComputerOutput CreateScreenshotOutput(BinaryData screenshotImageBytes, string screenshotImageBytesMediaType);
2923 public static ComputerOutput CreateScreenshotOutput(string screenshotImageFileId);
2924 public static ComputerOutput CreateScreenshotOutput(Uri screenshotImageUri);
2925 public static explicit operator ComputerOutput(ClientResult result);
2926 public static implicit operator BinaryContent(ComputerOutput computerOutput);
2927 }
2928 [Experimental("OPENAICUA001")]
2929 public readonly partial struct ComputerToolEnvironment : IEquatable<ComputerToolEnvironment> {
2930 public ComputerToolEnvironment(string value);
2931 public static ComputerToolEnvironment Browser { get; }
2932 public static ComputerToolEnvironment Mac { get; }
2933 public static ComputerToolEnvironment Ubuntu { get; }
2934 public static ComputerToolEnvironment Windows { get; }
2935 public readonly bool Equals(ComputerToolEnvironment other);
2936 [EditorBrowsable(EditorBrowsableState.Never)]
2937 public override readonly bool Equals(object obj);
2938 [EditorBrowsable(EditorBrowsableState.Never)]
2939 public override readonly int GetHashCode();
2940 public static bool operator ==(ComputerToolEnvironment left, ComputerToolEnvironment right);
2941 public static implicit operator ComputerToolEnvironment(string value);
2942 public static bool operator !=(ComputerToolEnvironment left, ComputerToolEnvironment right);
2943 public override readonly string ToString();
2944 }
2945 public class FileSearchCallResponseItem : ResponseItem, IJsonModel<FileSearchCallResponseItem>, IPersistableModel<FileSearchCallResponseItem> {
2946 public FileSearchCallResponseItem(IEnumerable<string> queries, IEnumerable<FileSearchCallResult> results);
2947 public IList<string> Queries { get; }
2948 public IList<FileSearchCallResult> Results { get; set; }
2949 public FileSearchCallStatus Status { get; }
2950 public new static explicit operator FileSearchCallResponseItem(ClientResult result);
2951 public static implicit operator BinaryContent(FileSearchCallResponseItem fileSearchCallResponseItem);
2952 }
2953 public class FileSearchCallResult : IJsonModel<FileSearchCallResult>, IPersistableModel<FileSearchCallResult> {
2954 public IDictionary<string, BinaryData> Attributes { get; }
2955 public string FileId { get; set; }
2956 public string Filename { get; set; }
2957 public float? Score { get; set; }
2958 public string Text { get; set; }
2959 public static explicit operator FileSearchCallResult(ClientResult result);
2960 public static implicit operator BinaryContent(FileSearchCallResult fileSearchCallResult);
2961 }
2962 public enum FileSearchCallStatus {
2963 InProgress = 0,
2964 Searching = 1,
2965 Completed = 2,
2966 Incomplete = 3,
2967 Failed = 4
2968 }
2969 public readonly partial struct FileSearchToolRanker : IEquatable<FileSearchToolRanker> {
2970 public FileSearchToolRanker(string value);
2971 public static FileSearchToolRanker Auto { get; }
2972 public static FileSearchToolRanker Default20241115 { get; }
2973 public readonly bool Equals(FileSearchToolRanker other);
2974 [EditorBrowsable(EditorBrowsableState.Never)]
2975 public override readonly bool Equals(object obj);
2976 [EditorBrowsable(EditorBrowsableState.Never)]
2977 public override readonly int GetHashCode();
2978 public static bool operator ==(FileSearchToolRanker left, FileSearchToolRanker right);
2979 public static implicit operator FileSearchToolRanker(string value);
2980 public static bool operator !=(FileSearchToolRanker left, FileSearchToolRanker right);
2981 public override readonly string ToString();
2982 }
2983 public class FileSearchToolRankingOptions : IJsonModel<FileSearchToolRankingOptions>, IPersistableModel<FileSearchToolRankingOptions> {
2984 public FileSearchToolRanker? Ranker { get; set; }
2985 public float? ScoreThreshold { get; set; }
2986 public static explicit operator FileSearchToolRankingOptions(ClientResult result);
2987 public static implicit operator BinaryContent(FileSearchToolRankingOptions fileSearchToolRankingOptions);
2988 }
2989 public class FunctionCallOutputResponseItem : ResponseItem, IJsonModel<FunctionCallOutputResponseItem>, IPersistableModel<FunctionCallOutputResponseItem> {
2990 public FunctionCallOutputResponseItem(string callId, string functionOutput);
2991 public string CallId { get; set; }
2992 public string FunctionOutput { get; set; }
2993 public FunctionCallOutputStatus? Status { get; }
2994 public new static explicit operator FunctionCallOutputResponseItem(ClientResult result);
2995 public static implicit operator BinaryContent(FunctionCallOutputResponseItem functionCallOutputResponseItem);
2996 }
2997 public enum FunctionCallOutputStatus {
2998 InProgress = 0,
2999 Completed = 1,
3000 Incomplete = 2
3001 }
3002 public class FunctionCallResponseItem : ResponseItem, IJsonModel<FunctionCallResponseItem>, IPersistableModel<FunctionCallResponseItem> {
3003 public FunctionCallResponseItem(string callId, string functionName, BinaryData functionArguments);
3004 public string CallId { get; set; }
3005 public BinaryData FunctionArguments { get; set; }
3006 public string FunctionName { get; set; }
3007 public FunctionCallStatus? Status { get; }
3008 public new static explicit operator FunctionCallResponseItem(ClientResult result);
3009 public static implicit operator BinaryContent(FunctionCallResponseItem functionCallResponseItem);
3010 }
3011 public enum FunctionCallStatus {
3012 InProgress = 0,
3013 Completed = 1,
3014 Incomplete = 2
3015 }
3016 public class MessageResponseItem : ResponseItem, IJsonModel<MessageResponseItem>, IPersistableModel<MessageResponseItem> {
3017 public IList<ResponseContentPart> Content { get; }
3018 public MessageRole Role { get; }
3019 public MessageStatus? Status { get; }
3020 public new static explicit operator MessageResponseItem(ClientResult result);
3021 public static implicit operator BinaryContent(MessageResponseItem messageResponseItem);
3022 }
3023 public enum MessageRole {
3024 Unknown = 0,
3025 Assistant = 1,
3026 Developer = 2,
3027 System = 3,
3028 User = 4
3029 }
3030 public enum MessageStatus {
3031 InProgress = 0,
3032 Completed = 1,
3033 Incomplete = 2
3034 }
3035 public class OpenAIResponse : IJsonModel<OpenAIResponse>, IPersistableModel<OpenAIResponse> {
3036 public DateTimeOffset CreatedAt { get; }
3037 public string EndUserId { get; }
3038 public ResponseError Error { get; }
3039 public string Id { get; }
3040 public ResponseIncompleteStatusDetails IncompleteStatusDetails { get; }
3041 public string Instructions { get; }
3042 public int? MaxOutputTokenCount { get; }
3043 public IDictionary<string, string> Metadata { get; }
3044 public string Model { get; }
3045 public IList<ResponseItem> OutputItems { get; }
3046 public bool ParallelToolCallsEnabled { get; }
3047 public string PreviousResponseId { get; }
3048 public ResponseReasoningOptions ReasoningOptions { get; }
3049 public ResponseStatus? Status { get; }
3050 public float Temperature { get; }
3051 public ResponseTextOptions TextOptions { get; }
3052 public ResponseToolChoice ToolChoice { get; }
3053 public IList<ResponseTool> Tools { get; }
3054 public float TopP { get; }
3055 public ResponseTruncationMode? TruncationMode { get; }
3056 public ResponseTokenUsage Usage { get; }
3057 public string GetOutputText();
3058 public static explicit operator OpenAIResponse(ClientResult result);
3059 public static implicit operator BinaryContent(OpenAIResponse openAIResponse);
3060 }
3061 public class OpenAIResponseClient {
3062 protected OpenAIResponseClient();
3063 protected internal OpenAIResponseClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
3064 public OpenAIResponseClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
3065 public OpenAIResponseClient(string model, ApiKeyCredential credential);
3066 public OpenAIResponseClient(string model, string apiKey);
3067 public ClientPipeline Pipeline { get; }
3068 [EditorBrowsable(EditorBrowsableState.Never)]
3069 public virtual ClientResult CreateResponse(BinaryContent content, RequestOptions options = null);
3070 public virtual ClientResult<OpenAIResponse> CreateResponse(IEnumerable<ResponseItem> inputItems, ResponseCreationOptions options = null, CancellationToken cancellationToken = default);
3071 public virtual ClientResult<OpenAIResponse> CreateResponse(string userInputText, ResponseCreationOptions options = null, CancellationToken cancellationToken = default);
3072 [EditorBrowsable(EditorBrowsableState.Never)]
3073 public virtual Task<ClientResult> CreateResponseAsync(BinaryContent content, RequestOptions options = null);
3074 public virtual Task<ClientResult<OpenAIResponse>> CreateResponseAsync(IEnumerable<ResponseItem> inputItems, ResponseCreationOptions options = null, CancellationToken cancellationToken = default);
3075 public virtual Task<ClientResult<OpenAIResponse>> CreateResponseAsync(string userInputText, ResponseCreationOptions options = null, CancellationToken cancellationToken = default);
3076 public virtual CollectionResult<StreamingResponseUpdate> CreateResponseStreaming(IEnumerable<ResponseItem> inputItems, ResponseCreationOptions options = null, CancellationToken cancellationToken = default);
3077 public virtual CollectionResult<StreamingResponseUpdate> CreateResponseStreaming(string userInputText, ResponseCreationOptions options = null, CancellationToken cancellationToken = default);
3078 public virtual AsyncCollectionResult<StreamingResponseUpdate> CreateResponseStreamingAsync(IEnumerable<ResponseItem> inputItems, ResponseCreationOptions options = null, CancellationToken cancellationToken = default);
3079 public virtual AsyncCollectionResult<StreamingResponseUpdate> CreateResponseStreamingAsync(string userInputText, ResponseCreationOptions options = null, CancellationToken cancellationToken = default);
3080 [EditorBrowsable(EditorBrowsableState.Never)]
3081 public virtual ClientResult DeleteResponse(string responseId, RequestOptions options);
3082 public virtual ClientResult<ResponseDeletionResult> DeleteResponse(string responseId, CancellationToken cancellationToken = default);
3083 [EditorBrowsable(EditorBrowsableState.Never)]
3084 public virtual Task<ClientResult> DeleteResponseAsync(string responseId, RequestOptions options);
3085 public virtual Task<ClientResult<ResponseDeletionResult>> DeleteResponseAsync(string responseId, CancellationToken cancellationToken = default);
3086 [EditorBrowsable(EditorBrowsableState.Never)]
3087 public virtual ClientResult GetResponse(string responseId, RequestOptions options);
3088 public virtual ClientResult<OpenAIResponse> GetResponse(string responseId, CancellationToken cancellationToken = default);
3089 [EditorBrowsable(EditorBrowsableState.Never)]
3090 public virtual Task<ClientResult> GetResponseAsync(string responseId, RequestOptions options);
3091 public virtual Task<ClientResult<OpenAIResponse>> GetResponseAsync(string responseId, CancellationToken cancellationToken = default);
3092 public virtual CollectionResult<ResponseItem> GetResponseInputItems(string responseId, ResponseItemCollectionOptions options = null, CancellationToken cancellationToken = default);
3093 [EditorBrowsable(EditorBrowsableState.Never)]
3094 public virtual CollectionResult GetResponseInputItems(string responseId, int? limit, string order, string after, string before, RequestOptions options = null);
3095 public virtual AsyncCollectionResult<ResponseItem> GetResponseInputItemsAsync(string responseId, ResponseItemCollectionOptions options = null, CancellationToken cancellationToken = default);
3096 [EditorBrowsable(EditorBrowsableState.Never)]
3097 public virtual AsyncCollectionResult GetResponseInputItemsAsync(string responseId, int? limit, string order, string after, string before, RequestOptions options = null);
3098 }
3099 public class ReasoningResponseItem : ResponseItem, IJsonModel<ReasoningResponseItem>, IPersistableModel<ReasoningResponseItem> {
3100 public ReasoningResponseItem(IEnumerable<string> summaryTextParts);
3101 public ReasoningStatus? Status { get; }
3102 public IReadOnlyList<string> SummaryTextParts { get; }
3103 public new static explicit operator ReasoningResponseItem(ClientResult result);
3104 public static implicit operator BinaryContent(ReasoningResponseItem reasoningResponseItem);
3105 }
3106 public enum ReasoningStatus {
3107 InProgress = 0,
3108 Completed = 1,
3109 Incomplete = 2
3110 }
3111 public class ReferenceResponseItem : ResponseItem, IJsonModel<ReferenceResponseItem>, IPersistableModel<ReferenceResponseItem> {
3112 public ReferenceResponseItem(string id);
3113 public new static explicit operator ReferenceResponseItem(ClientResult result);
3114 public static implicit operator BinaryContent(ReferenceResponseItem referenceResponseItem);
3115 }
3116 public class ResponseContentPart : IJsonModel<ResponseContentPart>, IPersistableModel<ResponseContentPart> {
3117 public BinaryData InputFileBytes { get; }
3118 public string InputFileId { get; }
3119 public string InputFilename { get; }
3120 public ResponseImageDetailLevel? InputImageDetailLevel { get; }
3121 public string InputImageFileId { get; }
3122 public ResponseContentPartKind Kind { get; }
3123 public IReadOnlyList<ResponseMessageAnnotation> OutputTextAnnotations { get; }
3124 public string Refusal { get; }
3125 public string Text { get; }
3126 public static ResponseContentPart CreateInputFilePart(string fileId, string filename, BinaryData fileBytes);
3127 public static ResponseContentPart CreateInputImagePart(BinaryData imageBytes, string imageBytesMediaType, ResponseImageDetailLevel? imageDetailLevel = null);
3128 public static ResponseContentPart CreateInputImagePart(string imageFileId, ResponseImageDetailLevel? imageDetailLevel = null);
3129 public static ResponseContentPart CreateInputImagePart(Uri imageUri, ResponseImageDetailLevel? imageDetailLevel = null);
3130 public static ResponseContentPart CreateInputTextPart(string text);
3131 public static ResponseContentPart CreateOutputTextPart(string text, IEnumerable<ResponseMessageAnnotation> annotations);
3132 public static ResponseContentPart CreateRefusalPart(string refusal);
3133 public static explicit operator ResponseContentPart(ClientResult result);
3134 public static implicit operator BinaryContent(ResponseContentPart responseContentPart);
3135 }
3136 public enum ResponseContentPartKind {
3137 Unknown = 0,
3138 InputText = 1,
3139 InputImage = 2,
3140 InputFile = 3,
3141 OutputText = 4,
3142 Refusal = 5
3143 }
3144 public class ResponseCreationOptions : IJsonModel<ResponseCreationOptions>, IPersistableModel<ResponseCreationOptions> {
3145 public string EndUserId { get; set; }
3146 public string Instructions { get; set; }
3147 public int? MaxOutputTokenCount { get; set; }
3148 public IDictionary<string, string> Metadata { get; }
3149 public bool? ParallelToolCallsEnabled { get; set; }
3150 public string PreviousResponseId { get; set; }
3151 public ResponseReasoningOptions ReasoningOptions { get; set; }
3152 public bool? StoredOutputEnabled { get; set; }
3153 public float? Temperature { get; set; }
3154 public ResponseTextOptions TextOptions { get; set; }
3155 public ResponseToolChoice ToolChoice { get; set; }
3156 public IList<ResponseTool> Tools { get; }
3157 public float? TopP { get; set; }
3158 public ResponseTruncationMode? TruncationMode { get; set; }
3159 public static explicit operator ResponseCreationOptions(ClientResult result);
3160 public static implicit operator BinaryContent(ResponseCreationOptions responseCreationOptions);
3161 }
3162 public class ResponseDeletionResult : IJsonModel<ResponseDeletionResult>, IPersistableModel<ResponseDeletionResult> {
3163 public bool Deleted { get; }
3164 public string Id { get; }
3165 public static explicit operator ResponseDeletionResult(ClientResult result);
3166 public static implicit operator BinaryContent(ResponseDeletionResult responseDeletionResult);
3167 }
3168 public class ResponseError : IJsonModel<ResponseError>, IPersistableModel<ResponseError> {
3169 public string Code { get; }
3170 public string Message { get; }
3171 public static explicit operator ResponseError(ClientResult result);
3172 public static implicit operator BinaryContent(ResponseError responseError);
3173 }
3174 public readonly partial struct ResponseImageDetailLevel : IEquatable<ResponseImageDetailLevel> {
3175 public ResponseImageDetailLevel(string value);
3176 public static ResponseImageDetailLevel Auto { get; }
3177 public static ResponseImageDetailLevel High { get; }
3178 public static ResponseImageDetailLevel Low { get; }
3179 public readonly bool Equals(ResponseImageDetailLevel other);
3180 [EditorBrowsable(EditorBrowsableState.Never)]
3181 public override readonly bool Equals(object obj);
3182 [EditorBrowsable(EditorBrowsableState.Never)]
3183 public override readonly int GetHashCode();
3184 public static bool operator ==(ResponseImageDetailLevel left, ResponseImageDetailLevel right);
3185 public static implicit operator ResponseImageDetailLevel(string value);
3186 public static bool operator !=(ResponseImageDetailLevel left, ResponseImageDetailLevel right);
3187 public override readonly string ToString();
3188 }
3189 public class ResponseIncompleteStatusDetails : IJsonModel<ResponseIncompleteStatusDetails>, IPersistableModel<ResponseIncompleteStatusDetails> {
3190 public ResponseIncompleteStatusReason? Reason { get; }
3191 public static explicit operator ResponseIncompleteStatusDetails(ClientResult result);
3192 public static implicit operator BinaryContent(ResponseIncompleteStatusDetails responseIncompleteStatusDetails);
3193 }
3194 public readonly partial struct ResponseIncompleteStatusReason : IEquatable<ResponseIncompleteStatusReason> {
3195 public ResponseIncompleteStatusReason(string value);
3196 public static ResponseIncompleteStatusReason ContentFilter { get; }
3197 public static ResponseIncompleteStatusReason MaxOutputTokens { get; }
3198 public readonly bool Equals(ResponseIncompleteStatusReason other);
3199 [EditorBrowsable(EditorBrowsableState.Never)]
3200 public override readonly bool Equals(object obj);
3201 [EditorBrowsable(EditorBrowsableState.Never)]
3202 public override readonly int GetHashCode();
3203 public static bool operator ==(ResponseIncompleteStatusReason left, ResponseIncompleteStatusReason right);
3204 public static implicit operator ResponseIncompleteStatusReason(string value);
3205 public static bool operator !=(ResponseIncompleteStatusReason left, ResponseIncompleteStatusReason right);
3206 public override readonly string ToString();
3207 }
3208 public class ResponseItem : IJsonModel<ResponseItem>, IPersistableModel<ResponseItem> {
3209 public string Id { get; }
3210 public static MessageResponseItem CreateAssistantMessageItem(IEnumerable<ResponseContentPart> contentParts);
3211 public static MessageResponseItem CreateAssistantMessageItem(string outputTextContent, IEnumerable<ResponseMessageAnnotation> annotations = null);
3212 [Experimental("OPENAICUA001")]
3213 public static ResponseItem CreateComputerCallItem(string callId, ComputerCallAction action, IEnumerable<ComputerCallSafetyCheck> pendingSafetyChecks);
3214 [Experimental("OPENAICUA001")]
3215 public static ResponseItem CreateComputerCallOutputItem(string callId, IList<ComputerCallSafetyCheck> acknowledgedSafetyChecks, BinaryData screenshotImageBytes, string screenshotImageBytesMediaType);
3216 [Experimental("OPENAICUA001")]
3217 public static ResponseItem CreateComputerCallOutputItem(string callId, IList<ComputerCallSafetyCheck> acknowledgedSafetyChecks, string screenshotImageFileId);
3218 [Experimental("OPENAICUA001")]
3219 public static ResponseItem CreateComputerCallOutputItem(string callId, IList<ComputerCallSafetyCheck> acknowledgedSafetyChecks, Uri screenshotImageUri);
3220 public static MessageResponseItem CreateDeveloperMessageItem(IEnumerable<ResponseContentPart> contentParts);
3221 public static MessageResponseItem CreateDeveloperMessageItem(string inputTextContent);
3222 public static FileSearchCallResponseItem CreateFileSearchCallItem(IEnumerable<string> queries, IEnumerable<FileSearchCallResult> results);
3223 public static FunctionCallResponseItem CreateFunctionCallItem(string callId, string functionName, BinaryData functionArguments);
3224 public static FunctionCallOutputResponseItem CreateFunctionCallOutputItem(string callId, string functionOutput);
3225 public static ReasoningResponseItem CreateReasoningItem(IEnumerable<string> summaryTextParts);
3226 public static ReferenceResponseItem CreateReferenceItem(string id);
3227 public static MessageResponseItem CreateSystemMessageItem(IEnumerable<ResponseContentPart> contentParts);
3228 public static MessageResponseItem CreateSystemMessageItem(string inputTextContent);
3229 public static MessageResponseItem CreateUserMessageItem(IEnumerable<ResponseContentPart> contentParts);
3230 public static MessageResponseItem CreateUserMessageItem(string inputTextContent);
3231 public static WebSearchCallResponseItem CreateWebSearchCallItem();
3232 public static explicit operator ResponseItem(ClientResult result);
3233 public static implicit operator BinaryContent(ResponseItem responseItem);
3234 }
3235 [Experimental("OPENAI001")]
3236 public class ResponseItemCollectionOptions {
3237 public string AfterId { get; set; }
3238 public string BeforeId { get; set; }
3239 public ResponseItemCollectionOrder? Order { get; set; }
3240 public int? PageSizeLimit { get; set; }
3241 }
3242 [Experimental("OPENAI001")]
3243 public readonly partial struct ResponseItemCollectionOrder : IEquatable<ResponseItemCollectionOrder> {
3244 public ResponseItemCollectionOrder(string value);
3245 public static ResponseItemCollectionOrder Ascending { get; }
3246 public static ResponseItemCollectionOrder Descending { get; }
3247 public readonly bool Equals(ResponseItemCollectionOrder other);
3248 [EditorBrowsable(EditorBrowsableState.Never)]
3249 public override readonly bool Equals(object obj);
3250 [EditorBrowsable(EditorBrowsableState.Never)]
3251 public override readonly int GetHashCode();
3252 public static bool operator ==(ResponseItemCollectionOrder left, ResponseItemCollectionOrder right);
3253 public static implicit operator ResponseItemCollectionOrder(string value);
3254 public static bool operator !=(ResponseItemCollectionOrder left, ResponseItemCollectionOrder right);
3255 public override readonly string ToString();
3256 }
3257 public class ResponseMessageAnnotation : IJsonModel<ResponseMessageAnnotation>, IPersistableModel<ResponseMessageAnnotation> {
3258 public string FileCitationFileId { get; }
3259 public int? FileCitationIndex { get; }
3260 public string FilePathFileId { get; }
3261 public int? FilePathIndex { get; }
3262 public ResponseMessageAnnotationKind Kind { get; }
3263 public int? UriCitationEndIndex { get; }
3264 public int? UriCitationStartIndex { get; }
3265 public string UriCitationTitle { get; }
3266 public string UriCitationUri { get; }
3267 public static explicit operator ResponseMessageAnnotation(ClientResult result);
3268 public static implicit operator BinaryContent(ResponseMessageAnnotation responseMessageAnnotation);
3269 }
3270 public enum ResponseMessageAnnotationKind {
3271 FileCitation = 0,
3272 UriCitation = 1,
3273 FilePath = 2
3274 }
3275 public class ResponseOutputTokenUsageDetails : IJsonModel<ResponseOutputTokenUsageDetails>, IPersistableModel<ResponseOutputTokenUsageDetails> {
3276 public int ReasoningTokenCount { get; }
3277 public static explicit operator ResponseOutputTokenUsageDetails(ClientResult result);
3278 public static implicit operator BinaryContent(ResponseOutputTokenUsageDetails responseOutputTokenUsageDetails);
3279 }
3280 public readonly partial struct ResponseReasoningEffortLevel : IEquatable<ResponseReasoningEffortLevel> {
3281 public ResponseReasoningEffortLevel(string value);
3282 public static ResponseReasoningEffortLevel High { get; }
3283 public static ResponseReasoningEffortLevel Low { get; }
3284 public static ResponseReasoningEffortLevel Medium { get; }
3285 public readonly bool Equals(ResponseReasoningEffortLevel other);
3286 [EditorBrowsable(EditorBrowsableState.Never)]
3287 public override readonly bool Equals(object obj);
3288 [EditorBrowsable(EditorBrowsableState.Never)]
3289 public override readonly int GetHashCode();
3290 public static bool operator ==(ResponseReasoningEffortLevel left, ResponseReasoningEffortLevel right);
3291 public static implicit operator ResponseReasoningEffortLevel(string value);
3292 public static bool operator !=(ResponseReasoningEffortLevel left, ResponseReasoningEffortLevel right);
3293 public override readonly string ToString();
3294 }
3295 public class ResponseReasoningOptions : IJsonModel<ResponseReasoningOptions>, IPersistableModel<ResponseReasoningOptions> {
3296 public ResponseReasoningOptions();
3297 public ResponseReasoningOptions(ResponseReasoningEffortLevel? reasoningEffortLevel);
3298 public ResponseReasoningEffortLevel? ReasoningEffortLevel { get; set; }
3299 public ResponseReasoningSummaryVerbosity? ReasoningSummaryVerbosity { get; set; }
3300 public static explicit operator ResponseReasoningOptions(ClientResult result);
3301 public static implicit operator BinaryContent(ResponseReasoningOptions responseReasoningOptions);
3302 }
3303 public readonly partial struct ResponseReasoningSummaryVerbosity : IEquatable<ResponseReasoningSummaryVerbosity> {
3304 public ResponseReasoningSummaryVerbosity(string value);
3305 public static ResponseReasoningSummaryVerbosity Concise { get; }
3306 public static ResponseReasoningSummaryVerbosity Detailed { get; }
3307 public readonly bool Equals(ResponseReasoningSummaryVerbosity other);
3308 [EditorBrowsable(EditorBrowsableState.Never)]
3309 public override readonly bool Equals(object obj);
3310 [EditorBrowsable(EditorBrowsableState.Never)]
3311 public override readonly int GetHashCode();
3312 public static bool operator ==(ResponseReasoningSummaryVerbosity left, ResponseReasoningSummaryVerbosity right);
3313 public static implicit operator ResponseReasoningSummaryVerbosity(string value);
3314 public static bool operator !=(ResponseReasoningSummaryVerbosity left, ResponseReasoningSummaryVerbosity right);
3315 public override readonly string ToString();
3316 }
3317 public enum ResponseStatus {
3318 InProgress = 0,
3319 Completed = 1,
3320 Incomplete = 2,
3321 Failed = 3
3322 }
3323 public class ResponseTextFormat : IJsonModel<ResponseTextFormat>, IPersistableModel<ResponseTextFormat> {
3324 public ResponseTextFormatKind Kind { get; set; }
3325 public static ResponseTextFormat CreateJsonObjectFormat();
3326 public static ResponseTextFormat CreateJsonSchemaFormat(string jsonSchemaFormatName, BinaryData jsonSchema, string jsonSchemaFormatDescription = null, bool? jsonSchemaIsStrict = null);
3327 public static ResponseTextFormat CreateTextFormat();
3328 public static explicit operator ResponseTextFormat(ClientResult result);
3329 public static implicit operator BinaryContent(ResponseTextFormat responseTextFormat);
3330 }
3331 public enum ResponseTextFormatKind {
3332 Unknown = 0,
3333 Text = 1,
3334 JsonObject = 2,
3335 JsonSchema = 3
3336 }
3337 public class ResponseTextOptions : IJsonModel<ResponseTextOptions>, IPersistableModel<ResponseTextOptions> {
3338 public ResponseTextFormat TextFormat { get; set; }
3339 public static explicit operator ResponseTextOptions(ClientResult result);
3340 public static implicit operator BinaryContent(ResponseTextOptions responseTextOptions);
3341 }
3342 public class ResponseTokenUsage : IJsonModel<ResponseTokenUsage>, IPersistableModel<ResponseTokenUsage> {
3343 public int InputTokenCount { get; }
3344 public int OutputTokenCount { get; }
3345 public ResponseOutputTokenUsageDetails OutputTokenDetails { get; }
3346 public int TotalTokenCount { get; }
3347 public static explicit operator ResponseTokenUsage(ClientResult result);
3348 public static implicit operator BinaryContent(ResponseTokenUsage responseTokenUsage);
3349 }
3350 public class ResponseTool : IJsonModel<ResponseTool>, IPersistableModel<ResponseTool> {
3351 [Experimental("OPENAICUA001")]
3352 public static ResponseTool CreateComputerTool(int displayWidth, int displayHeight, ComputerToolEnvironment environment);
3353 public static ResponseTool CreateFileSearchTool(IEnumerable<string> vectorStoreIds, int? maxResultCount = null, FileSearchToolRankingOptions rankingOptions = null, BinaryData filters = null);
3354 public static ResponseTool CreateFunctionTool(string functionName, string functionDescription, BinaryData functionParameters, bool functionSchemaIsStrict = false);
3355 public static ResponseTool CreateWebSearchTool(WebSearchToolLocation webSearchToolUserLocation = null, WebSearchToolContextSize? webSearchToolContextSize = null);
3356 public static explicit operator ResponseTool(ClientResult result);
3357 public static implicit operator BinaryContent(ResponseTool responseTool);
3358 }
3359 public class ResponseToolChoice : IJsonModel<ResponseToolChoice>, IPersistableModel<ResponseToolChoice> {
3360 public string FunctionName { get; }
3361 public ResponseToolChoiceKind Kind { get; }
3362 public static ResponseToolChoice CreateAutoChoice();
3363 [Experimental("OPENAICUA001")]
3364 public static ResponseToolChoice CreateComputerChoice();
3365 public static ResponseToolChoice CreateFileSearchChoice();
3366 public static ResponseToolChoice CreateFunctionChoice(string functionName);
3367 public static ResponseToolChoice CreateNoneChoice();
3368 public static ResponseToolChoice CreateRequiredChoice();
3369 public static ResponseToolChoice CreateWebSearchChoice();
3370 }
3371 public enum ResponseToolChoiceKind {
3372 Unknown = 0,
3373 Auto = 1,
3374 None = 2,
3375 Required = 3,
3376 Function = 4,
3377 FileSearch = 5,
3378 WebSearch = 6,
3379 Computer = 7
3380 }
3381 public readonly partial struct ResponseTruncationMode : IEquatable<ResponseTruncationMode> {
3382 public ResponseTruncationMode(string value);
3383 public static ResponseTruncationMode Auto { get; }
3384 public static ResponseTruncationMode Disabled { get; }
3385 public readonly bool Equals(ResponseTruncationMode other);
3386 [EditorBrowsable(EditorBrowsableState.Never)]
3387 public override readonly bool Equals(object obj);
3388 [EditorBrowsable(EditorBrowsableState.Never)]
3389 public override readonly int GetHashCode();
3390 public static bool operator ==(ResponseTruncationMode left, ResponseTruncationMode right);
3391 public static implicit operator ResponseTruncationMode(string value);
3392 public static bool operator !=(ResponseTruncationMode left, ResponseTruncationMode right);
3393 public override readonly string ToString();
3394 }
3395 public class StreamingResponseCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseCompletedUpdate>, IPersistableModel<StreamingResponseCompletedUpdate> {
3396 public OpenAIResponse Response { get; }
3397 public new static explicit operator StreamingResponseCompletedUpdate(ClientResult result);
3398 public static implicit operator BinaryContent(StreamingResponseCompletedUpdate streamingResponseCompletedUpdate);
3399 }
3400 public class StreamingResponseContentPartAddedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseContentPartAddedUpdate>, IPersistableModel<StreamingResponseContentPartAddedUpdate> {
3401 public int ContentIndex { get; }
3402 public string ItemId { get; }
3403 public int OutputIndex { get; }
3404 public ResponseContentPart Part { get; }
3405 public new static explicit operator StreamingResponseContentPartAddedUpdate(ClientResult result);
3406 public static implicit operator BinaryContent(StreamingResponseContentPartAddedUpdate streamingResponseContentPartAddedUpdate);
3407 }
3408 public class StreamingResponseContentPartDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseContentPartDoneUpdate>, IPersistableModel<StreamingResponseContentPartDoneUpdate> {
3409 public int ContentIndex { get; }
3410 public string ItemId { get; }
3411 public int OutputIndex { get; }
3412 public ResponseContentPart Part { get; }
3413 public new static explicit operator StreamingResponseContentPartDoneUpdate(ClientResult result);
3414 public static implicit operator BinaryContent(StreamingResponseContentPartDoneUpdate streamingResponseContentPartDoneUpdate);
3415 }
3416 public class StreamingResponseCreatedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseCreatedUpdate>, IPersistableModel<StreamingResponseCreatedUpdate> {
3417 public OpenAIResponse Response { get; }
3418 public new static explicit operator StreamingResponseCreatedUpdate(ClientResult result);
3419 public static implicit operator BinaryContent(StreamingResponseCreatedUpdate streamingResponseCreatedUpdate);
3420 }
3421 public class StreamingResponseErrorUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseErrorUpdate>, IPersistableModel<StreamingResponseErrorUpdate> {
3422 public string Code { get; }
3423 public string Message { get; }
3424 public string Param { get; }
3425 public new static explicit operator StreamingResponseErrorUpdate(ClientResult result);
3426 public static implicit operator BinaryContent(StreamingResponseErrorUpdate streamingResponseErrorUpdate);
3427 }
3428 public class StreamingResponseFailedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFailedUpdate>, IPersistableModel<StreamingResponseFailedUpdate> {
3429 public OpenAIResponse Response { get; }
3430 public new static explicit operator StreamingResponseFailedUpdate(ClientResult result);
3431 public static implicit operator BinaryContent(StreamingResponseFailedUpdate streamingResponseFailedUpdate);
3432 }
3433 public class StreamingResponseFileSearchCallCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFileSearchCallCompletedUpdate>, IPersistableModel<StreamingResponseFileSearchCallCompletedUpdate> {
3434 public string ItemId { get; }
3435 public int OutputIndex { get; }
3436 public new static explicit operator StreamingResponseFileSearchCallCompletedUpdate(ClientResult result);
3437 public static implicit operator BinaryContent(StreamingResponseFileSearchCallCompletedUpdate streamingResponseFileSearchCallCompletedUpdate);
3438 }
3439 public class StreamingResponseFileSearchCallInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFileSearchCallInProgressUpdate>, IPersistableModel<StreamingResponseFileSearchCallInProgressUpdate> {
3440 public string ItemId { get; }
3441 public int OutputIndex { get; }
3442 public new static explicit operator StreamingResponseFileSearchCallInProgressUpdate(ClientResult result);
3443 public static implicit operator BinaryContent(StreamingResponseFileSearchCallInProgressUpdate streamingResponseFileSearchCallInProgressUpdate);
3444 }
3445 public class StreamingResponseFileSearchCallSearchingUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFileSearchCallSearchingUpdate>, IPersistableModel<StreamingResponseFileSearchCallSearchingUpdate> {
3446 public string ItemId { get; }
3447 public int OutputIndex { get; }
3448 public new static explicit operator StreamingResponseFileSearchCallSearchingUpdate(ClientResult result);
3449 public static implicit operator BinaryContent(StreamingResponseFileSearchCallSearchingUpdate streamingResponseFileSearchCallSearchingUpdate);
3450 }
3451 public class StreamingResponseFunctionCallArgumentsDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFunctionCallArgumentsDeltaUpdate>, IPersistableModel<StreamingResponseFunctionCallArgumentsDeltaUpdate> {
3452 public string Delta { get; }
3453 public string ItemId { get; }
3454 public int OutputIndex { get; }
3455 public new static explicit operator StreamingResponseFunctionCallArgumentsDeltaUpdate(ClientResult result);
3456 public static implicit operator BinaryContent(StreamingResponseFunctionCallArgumentsDeltaUpdate streamingResponseFunctionCallArgumentsDeltaUpdate);
3457 }
3458 public class StreamingResponseFunctionCallArgumentsDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFunctionCallArgumentsDoneUpdate>, IPersistableModel<StreamingResponseFunctionCallArgumentsDoneUpdate> {
3459 public string Arguments { get; }
3460 public string ItemId { get; }
3461 public int OutputIndex { get; }
3462 public new static explicit operator StreamingResponseFunctionCallArgumentsDoneUpdate(ClientResult result);
3463 public static implicit operator BinaryContent(StreamingResponseFunctionCallArgumentsDoneUpdate streamingResponseFunctionCallArgumentsDoneUpdate);
3464 }
3465 public class StreamingResponseIncompleteUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseIncompleteUpdate>, IPersistableModel<StreamingResponseIncompleteUpdate> {
3466 public OpenAIResponse Response { get; }
3467 public new static explicit operator StreamingResponseIncompleteUpdate(ClientResult result);
3468 public static implicit operator BinaryContent(StreamingResponseIncompleteUpdate streamingResponseIncompleteUpdate);
3469 }
3470 public class StreamingResponseInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseInProgressUpdate>, IPersistableModel<StreamingResponseInProgressUpdate> {
3471 public OpenAIResponse Response { get; }
3472 public new static explicit operator StreamingResponseInProgressUpdate(ClientResult result);
3473 public static implicit operator BinaryContent(StreamingResponseInProgressUpdate streamingResponseInProgressUpdate);
3474 }
3475 public class StreamingResponseOutputItemAddedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseOutputItemAddedUpdate>, IPersistableModel<StreamingResponseOutputItemAddedUpdate> {
3476 public ResponseItem Item { get; }
3477 public int OutputIndex { get; }
3478 public new static explicit operator StreamingResponseOutputItemAddedUpdate(ClientResult result);
3479 public static implicit operator BinaryContent(StreamingResponseOutputItemAddedUpdate streamingResponseOutputItemAddedUpdate);
3480 }
3481 public class StreamingResponseOutputItemDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseOutputItemDoneUpdate>, IPersistableModel<StreamingResponseOutputItemDoneUpdate> {
3482 public ResponseItem Item { get; }
3483 public int OutputIndex { get; }
3484 public new static explicit operator StreamingResponseOutputItemDoneUpdate(ClientResult result);
3485 public static implicit operator BinaryContent(StreamingResponseOutputItemDoneUpdate streamingResponseOutputItemDoneUpdate);
3486 }
3487 public class StreamingResponseOutputTextDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseOutputTextDeltaUpdate>, IPersistableModel<StreamingResponseOutputTextDeltaUpdate> {
3488 public int ContentIndex { get; }
3489 public string Delta { get; }
3490 public string ItemId { get; }
3491 public int OutputIndex { get; }
3492 public new static explicit operator StreamingResponseOutputTextDeltaUpdate(ClientResult result);
3493 public static implicit operator BinaryContent(StreamingResponseOutputTextDeltaUpdate streamingResponseOutputTextDeltaUpdate);
3494 }
3495 public class StreamingResponseOutputTextDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseOutputTextDoneUpdate>, IPersistableModel<StreamingResponseOutputTextDoneUpdate> {
3496 public int ContentIndex { get; }
3497 public string ItemId { get; }
3498 public int OutputIndex { get; }
3499 public string Text { get; }
3500 public new static explicit operator StreamingResponseOutputTextDoneUpdate(ClientResult result);
3501 public static implicit operator BinaryContent(StreamingResponseOutputTextDoneUpdate streamingResponseOutputTextDoneUpdate);
3502 }
3503 public class StreamingResponseRefusalDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseRefusalDeltaUpdate>, IPersistableModel<StreamingResponseRefusalDeltaUpdate> {
3504 public int ContentIndex { get; }
3505 public string Delta { get; }
3506 public string ItemId { get; }
3507 public int OutputIndex { get; }
3508 public new static explicit operator StreamingResponseRefusalDeltaUpdate(ClientResult result);
3509 public static implicit operator BinaryContent(StreamingResponseRefusalDeltaUpdate streamingResponseRefusalDeltaUpdate);
3510 }
3511 public class StreamingResponseRefusalDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseRefusalDoneUpdate>, IPersistableModel<StreamingResponseRefusalDoneUpdate> {
3512 public int ContentIndex { get; }
3513 public string ItemId { get; }
3514 public int OutputIndex { get; }
3515 public string Refusal { get; }
3516 public new static explicit operator StreamingResponseRefusalDoneUpdate(ClientResult result);
3517 public static implicit operator BinaryContent(StreamingResponseRefusalDoneUpdate streamingResponseRefusalDoneUpdate);
3518 }
3519 public class StreamingResponseTextAnnotationAddedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseTextAnnotationAddedUpdate>, IPersistableModel<StreamingResponseTextAnnotationAddedUpdate> {
3520 public ResponseMessageAnnotation Annotation { get; }
3521 public int ContentIndex { get; }
3522 public string ItemId { get; }
3523 public int OutputIndex { get; }
3524 public new static explicit operator StreamingResponseTextAnnotationAddedUpdate(ClientResult result);
3525 public static implicit operator BinaryContent(StreamingResponseTextAnnotationAddedUpdate streamingResponseTextAnnotationAddedUpdate);
3526 }
3527 public class StreamingResponseUpdate : IJsonModel<StreamingResponseUpdate>, IPersistableModel<StreamingResponseUpdate> {
3528 public static explicit operator StreamingResponseUpdate(ClientResult result);
3529 public static implicit operator BinaryContent(StreamingResponseUpdate streamingResponseUpdate);
3530 }
3531 public class StreamingResponseWebSearchCallCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseWebSearchCallCompletedUpdate>, IPersistableModel<StreamingResponseWebSearchCallCompletedUpdate> {
3532 public string ItemId { get; }
3533 public int OutputIndex { get; }
3534 public new static explicit operator StreamingResponseWebSearchCallCompletedUpdate(ClientResult result);
3535 public static implicit operator BinaryContent(StreamingResponseWebSearchCallCompletedUpdate streamingResponseWebSearchCallCompletedUpdate);
3536 }
3537 public class StreamingResponseWebSearchCallInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseWebSearchCallInProgressUpdate>, IPersistableModel<StreamingResponseWebSearchCallInProgressUpdate> {
3538 public string ItemId { get; }
3539 public int OutputIndex { get; }
3540 public new static explicit operator StreamingResponseWebSearchCallInProgressUpdate(ClientResult result);
3541 public static implicit operator BinaryContent(StreamingResponseWebSearchCallInProgressUpdate streamingResponseWebSearchCallInProgressUpdate);
3542 }
3543 public class StreamingResponseWebSearchCallSearchingUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseWebSearchCallSearchingUpdate>, IPersistableModel<StreamingResponseWebSearchCallSearchingUpdate> {
3544 public string ItemId { get; }
3545 public int OutputIndex { get; }
3546 public new static explicit operator StreamingResponseWebSearchCallSearchingUpdate(ClientResult result);
3547 public static implicit operator BinaryContent(StreamingResponseWebSearchCallSearchingUpdate streamingResponseWebSearchCallSearchingUpdate);
3548 }
3549 public class WebSearchCallResponseItem : ResponseItem, IJsonModel<WebSearchCallResponseItem>, IPersistableModel<WebSearchCallResponseItem> {
3550 public WebSearchCallResponseItem();
3551 public WebSearchCallStatus Status { get; }
3552 public new static explicit operator WebSearchCallResponseItem(ClientResult result);
3553 public static implicit operator BinaryContent(WebSearchCallResponseItem webSearchCallResponseItem);
3554 }
3555 public enum WebSearchCallStatus {
3556 InProgress = 0,
3557 Searching = 1,
3558 Completed = 2,
3559 Failed = 3
3560 }
3561 public readonly partial struct WebSearchToolContextSize : IEquatable<WebSearchToolContextSize> {
3562 public WebSearchToolContextSize(string value);
3563 public static WebSearchToolContextSize High { get; }
3564 public static WebSearchToolContextSize Low { get; }
3565 public static WebSearchToolContextSize Medium { get; }
3566 public readonly bool Equals(WebSearchToolContextSize other);
3567 [EditorBrowsable(EditorBrowsableState.Never)]
3568 public override readonly bool Equals(object obj);
3569 [EditorBrowsable(EditorBrowsableState.Never)]
3570 public override readonly int GetHashCode();
3571 public static bool operator ==(WebSearchToolContextSize left, WebSearchToolContextSize right);
3572 public static implicit operator WebSearchToolContextSize(string value);
3573 public static bool operator !=(WebSearchToolContextSize left, WebSearchToolContextSize right);
3574 public override readonly string ToString();
3575 }
3576 public class WebSearchToolLocation : IJsonModel<WebSearchToolLocation>, IPersistableModel<WebSearchToolLocation> {
3577 public static WebSearchToolLocation CreateApproximateLocation(string country = null, string region = null, string city = null, string timezone = null);
3578 public static explicit operator WebSearchToolLocation(ClientResult result);
3579 public static implicit operator BinaryContent(WebSearchToolLocation webSearchToolLocation);
3580 }
3581}
3582namespace OpenAI.VectorStores {
3583 [Experimental("OPENAI001")]
3584 public class AddFileToVectorStoreOperation : OperationResult {
3585 public string FileId { get; }
3586 public override ContinuationToken? RehydrationToken { get; protected set; }
3587 public VectorStoreFileAssociationStatus? Status { get; }
3588 public VectorStoreFileAssociation? Value { get; }
3589 public string VectorStoreId { get; }
3590 [EditorBrowsable(EditorBrowsableState.Never)]
3591 public virtual ClientResult GetFileAssociation(RequestOptions? options);
3592 public virtual ClientResult<VectorStoreFileAssociation> GetFileAssociation(CancellationToken cancellationToken = default);
3593 [EditorBrowsable(EditorBrowsableState.Never)]
3594 public virtual Task<ClientResult> GetFileAssociationAsync(RequestOptions? options);
3595 public virtual Task<ClientResult<VectorStoreFileAssociation>> GetFileAssociationAsync(CancellationToken cancellationToken = default);
3596 public static AddFileToVectorStoreOperation Rehydrate(VectorStoreClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
3597 public static Task<AddFileToVectorStoreOperation> RehydrateAsync(VectorStoreClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
3598 public override ClientResult UpdateStatus(RequestOptions? options = null);
3599 public override ValueTask<ClientResult> UpdateStatusAsync(RequestOptions? options = null);
3600 }
3601 [Experimental("OPENAI001")]
3602 public class CreateBatchFileJobOperation : OperationResult {
3603 public string BatchId { get; }
3604 public override ContinuationToken? RehydrationToken { get; protected set; }
3605 public VectorStoreBatchFileJobStatus? Status { get; }
3606 public VectorStoreBatchFileJob? Value { get; }
3607 public string VectorStoreId { get; }
3608 [EditorBrowsable(EditorBrowsableState.Never)]
3609 public virtual ClientResult Cancel(RequestOptions? options);
3610 public virtual ClientResult<VectorStoreBatchFileJob> Cancel(CancellationToken cancellationToken = default);
3611 [EditorBrowsable(EditorBrowsableState.Never)]
3612 public virtual Task<ClientResult> CancelAsync(RequestOptions? options);
3613 public virtual Task<ClientResult<VectorStoreBatchFileJob>> CancelAsync(CancellationToken cancellationToken = default);
3614 [EditorBrowsable(EditorBrowsableState.Never)]
3615 public virtual ClientResult GetFileBatch(RequestOptions? options);
3616 public virtual ClientResult<VectorStoreBatchFileJob> GetFileBatch(CancellationToken cancellationToken = default);
3617 [EditorBrowsable(EditorBrowsableState.Never)]
3618 public virtual Task<ClientResult> GetFileBatchAsync(RequestOptions? options);
3619 public virtual Task<ClientResult<VectorStoreBatchFileJob>> GetFileBatchAsync(CancellationToken cancellationToken = default);
3620 public static CreateBatchFileJobOperation Rehydrate(VectorStoreClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
3621 public static Task<CreateBatchFileJobOperation> RehydrateAsync(VectorStoreClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
3622 public override ClientResult UpdateStatus(RequestOptions? options = null);
3623 public override ValueTask<ClientResult> UpdateStatusAsync(RequestOptions? options = null);
3624 }
3625 [Experimental("OPENAI001")]
3626 public class CreateVectorStoreOperation : OperationResult {
3627 public override ContinuationToken? RehydrationToken { get; protected set; }
3628 public VectorStoreStatus? Status { get; }
3629 public VectorStore? Value { get; }
3630 public string VectorStoreId { get; }
3631 [EditorBrowsable(EditorBrowsableState.Never)]
3632 public virtual ClientResult GetVectorStore(RequestOptions? options);
3633 public virtual ClientResult<VectorStore> GetVectorStore(CancellationToken cancellationToken = default);
3634 [EditorBrowsable(EditorBrowsableState.Never)]
3635 public virtual Task<ClientResult> GetVectorStoreAsync(RequestOptions? options);
3636 public virtual Task<ClientResult<VectorStore>> GetVectorStoreAsync(CancellationToken cancellationToken = default);
3637 public static CreateVectorStoreOperation Rehydrate(VectorStoreClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
3638 public static Task<CreateVectorStoreOperation> RehydrateAsync(VectorStoreClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
3639 public override ClientResult UpdateStatus(RequestOptions? options = null);
3640 public override ValueTask<ClientResult> UpdateStatusAsync(RequestOptions? options = null);
3641 }
3642 [Experimental("OPENAI001")]
3643 public abstract class FileChunkingStrategy : IJsonModel<FileChunkingStrategy>, IPersistableModel<FileChunkingStrategy> {
3644 public static FileChunkingStrategy Auto { get; }
3645 public static FileChunkingStrategy Unknown { get; }
3646 public static FileChunkingStrategy CreateStaticStrategy(int maxTokensPerChunk, int overlappingTokenCount);
3647 public static explicit operator FileChunkingStrategy(ClientResult result);
3648 public static implicit operator BinaryContent(FileChunkingStrategy fileChunkingStrategy);
3649 }
3650 [Experimental("OPENAI001")]
3651 public class FileFromStoreRemovalResult : IJsonModel<FileFromStoreRemovalResult>, IPersistableModel<FileFromStoreRemovalResult> {
3652 public string FileId { get; }
3653 public bool Removed { get; }
3654 public static explicit operator FileFromStoreRemovalResult(ClientResult result);
3655 public static implicit operator BinaryContent(FileFromStoreRemovalResult fileFromStoreRemovalResult);
3656 }
3657 [Experimental("OPENAI001")]
3658 public class StaticFileChunkingStrategy : FileChunkingStrategy, IJsonModel<StaticFileChunkingStrategy>, IPersistableModel<StaticFileChunkingStrategy> {
3659 public StaticFileChunkingStrategy(int maxTokensPerChunk, int overlappingTokenCount);
3660 public int MaxTokensPerChunk { get; }
3661 public int OverlappingTokenCount { get; }
3662 public new static explicit operator StaticFileChunkingStrategy(ClientResult result);
3663 public static implicit operator BinaryContent(StaticFileChunkingStrategy staticFileChunkingStrategy);
3664 }
3665 [Experimental("OPENAI001")]
3666 public class VectorStore : IJsonModel<VectorStore>, IPersistableModel<VectorStore> {
3667 public DateTimeOffset CreatedAt { get; }
3668 public VectorStoreExpirationPolicy ExpirationPolicy { get; }
3669 public DateTimeOffset? ExpiresAt { get; }
3670 public VectorStoreFileCounts FileCounts { get; }
3671 public string Id { get; }
3672 public DateTimeOffset? LastActiveAt { get; }
3673 public IReadOnlyDictionary<string, string> Metadata { get; }
3674 public string Name { get; }
3675 public VectorStoreStatus Status { get; }
3676 public int UsageBytes { get; }
3677 public static explicit operator VectorStore(ClientResult result);
3678 public static implicit operator BinaryContent(VectorStore vectorStore);
3679 }
3680 [Experimental("OPENAI001")]
3681 public class VectorStoreBatchFileJob : IJsonModel<VectorStoreBatchFileJob>, IPersistableModel<VectorStoreBatchFileJob> {
3682 public string BatchId { get; }
3683 public DateTimeOffset CreatedAt { get; }
3684 public VectorStoreFileCounts FileCounts { get; }
3685 public VectorStoreBatchFileJobStatus Status { get; }
3686 public string VectorStoreId { get; }
3687 public static explicit operator VectorStoreBatchFileJob(ClientResult result);
3688 public static implicit operator BinaryContent(VectorStoreBatchFileJob vectorStoreBatchFileJob);
3689 }
3690 [Experimental("OPENAI001")]
3691 public readonly partial struct VectorStoreBatchFileJobStatus : IEquatable<VectorStoreBatchFileJobStatus> {
3692 public VectorStoreBatchFileJobStatus(string value);
3693 public static VectorStoreBatchFileJobStatus Cancelled { get; }
3694 public static VectorStoreBatchFileJobStatus Completed { get; }
3695 public static VectorStoreBatchFileJobStatus Failed { get; }
3696 public static VectorStoreBatchFileJobStatus InProgress { get; }
3697 public readonly bool Equals(VectorStoreBatchFileJobStatus other);
3698 [EditorBrowsable(EditorBrowsableState.Never)]
3699 public override readonly bool Equals(object obj);
3700 [EditorBrowsable(EditorBrowsableState.Never)]
3701 public override readonly int GetHashCode();
3702 public static bool operator ==(VectorStoreBatchFileJobStatus left, VectorStoreBatchFileJobStatus right);
3703 public static implicit operator VectorStoreBatchFileJobStatus(string value);
3704 public static bool operator !=(VectorStoreBatchFileJobStatus left, VectorStoreBatchFileJobStatus right);
3705 public override readonly string ToString();
3706 }
3707 [Experimental("OPENAI001")]
3708 public class VectorStoreClient {
3709 protected VectorStoreClient();
3710 public VectorStoreClient(ApiKeyCredential credential, OpenAIClientOptions options);
3711 public VectorStoreClient(ApiKeyCredential credential);
3712 protected internal VectorStoreClient(ClientPipeline pipeline, OpenAIClientOptions options);
3713 public VectorStoreClient(string apiKey);
3714 public ClientPipeline Pipeline { get; }
3715 [EditorBrowsable(EditorBrowsableState.Never)]
3716 public virtual AddFileToVectorStoreOperation AddFileToVectorStore(string vectorStoreId, BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
3717 public virtual AddFileToVectorStoreOperation AddFileToVectorStore(string vectorStoreId, string fileId, bool waitUntilCompleted, CancellationToken cancellationToken = default);
3718 [EditorBrowsable(EditorBrowsableState.Never)]
3719 public virtual Task<AddFileToVectorStoreOperation> AddFileToVectorStoreAsync(string vectorStoreId, BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
3720 public virtual Task<AddFileToVectorStoreOperation> AddFileToVectorStoreAsync(string vectorStoreId, string fileId, bool waitUntilCompleted, CancellationToken cancellationToken = default);
3721 [EditorBrowsable(EditorBrowsableState.Never)]
3722 public virtual ClientResult CancelBatchFileJob(string vectorStoreId, string batchId, RequestOptions options);
3723 public virtual ClientResult<VectorStoreBatchFileJob> CancelBatchFileJob(string vectorStoreId, string batchJobId, CancellationToken cancellationToken = default);
3724 [EditorBrowsable(EditorBrowsableState.Never)]
3725 public virtual Task<ClientResult> CancelBatchFileJobAsync(string vectorStoreId, string batchId, RequestOptions options);
3726 public virtual Task<ClientResult<VectorStoreBatchFileJob>> CancelBatchFileJobAsync(string vectorStoreId, string batchJobId, CancellationToken cancellationToken = default);
3727 [EditorBrowsable(EditorBrowsableState.Never)]
3728 public virtual CreateBatchFileJobOperation CreateBatchFileJob(string vectorStoreId, BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
3729 public virtual CreateBatchFileJobOperation CreateBatchFileJob(string vectorStoreId, IEnumerable<string> fileIds, bool waitUntilCompleted, CancellationToken cancellationToken = default);
3730 [EditorBrowsable(EditorBrowsableState.Never)]
3731 public virtual Task<CreateBatchFileJobOperation> CreateBatchFileJobAsync(string vectorStoreId, BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
3732 public virtual Task<CreateBatchFileJobOperation> CreateBatchFileJobAsync(string vectorStoreId, IEnumerable<string> fileIds, bool waitUntilCompleted, CancellationToken cancellationToken = default);
3733 public virtual CreateVectorStoreOperation CreateVectorStore(bool waitUntilCompleted, VectorStoreCreationOptions vectorStore = null, CancellationToken cancellationToken = default);
3734 [EditorBrowsable(EditorBrowsableState.Never)]
3735 public virtual CreateVectorStoreOperation CreateVectorStore(BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
3736 public virtual ClientResult CreateVectorStore(BinaryContent content, RequestOptions options = null);
3737 public virtual Task<CreateVectorStoreOperation> CreateVectorStoreAsync(bool waitUntilCompleted, VectorStoreCreationOptions vectorStore = null, CancellationToken cancellationToken = default);
3738 [EditorBrowsable(EditorBrowsableState.Never)]
3739 public virtual Task<CreateVectorStoreOperation> CreateVectorStoreAsync(BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
3740 public virtual Task<ClientResult> CreateVectorStoreAsync(BinaryContent content, RequestOptions options = null);
3741 [EditorBrowsable(EditorBrowsableState.Never)]
3742 public virtual ClientResult DeleteVectorStore(string vectorStoreId, RequestOptions options);
3743 public virtual ClientResult<VectorStoreDeletionResult> DeleteVectorStore(string vectorStoreId, CancellationToken cancellationToken = default);
3744 [EditorBrowsable(EditorBrowsableState.Never)]
3745 public virtual Task<ClientResult> DeleteVectorStoreAsync(string vectorStoreId, RequestOptions options);
3746 public virtual Task<ClientResult<VectorStoreDeletionResult>> DeleteVectorStoreAsync(string vectorStoreId, CancellationToken cancellationToken = default);
3747 public virtual ClientResult<VectorStoreBatchFileJob> GetBatchFileJob(string vectorStoreId, string batchJobId, CancellationToken cancellationToken = default);
3748 public virtual Task<ClientResult<VectorStoreBatchFileJob>> GetBatchFileJobAsync(string vectorStoreId, string batchJobId, CancellationToken cancellationToken = default);
3749 [EditorBrowsable(EditorBrowsableState.Never)]
3750 public virtual ClientResult GetFileAssociation(string vectorStoreId, string fileId, RequestOptions options);
3751 public virtual ClientResult<VectorStoreFileAssociation> GetFileAssociation(string vectorStoreId, string fileId, CancellationToken cancellationToken = default);
3752 [EditorBrowsable(EditorBrowsableState.Never)]
3753 public virtual Task<ClientResult> GetFileAssociationAsync(string vectorStoreId, string fileId, RequestOptions options);
3754 public virtual Task<ClientResult<VectorStoreFileAssociation>> GetFileAssociationAsync(string vectorStoreId, string fileId, CancellationToken cancellationToken = default);
3755 public virtual CollectionResult<VectorStoreFileAssociation> GetFileAssociations(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
3756 public virtual CollectionResult<VectorStoreFileAssociation> GetFileAssociations(string vectorStoreId, VectorStoreFileAssociationCollectionOptions options = null, CancellationToken cancellationToken = default);
3757 [EditorBrowsable(EditorBrowsableState.Never)]
3758 public virtual CollectionResult GetFileAssociations(string vectorStoreId, int? limit, string order, string after, string before, string filter, RequestOptions options);
3759 public virtual CollectionResult<VectorStoreFileAssociation> GetFileAssociations(string vectorStoreId, string batchJobId, VectorStoreFileAssociationCollectionOptions options = null, CancellationToken cancellationToken = default);
3760 public virtual CollectionResult<VectorStoreFileAssociation> GetFileAssociations(string vectorStoreId, string batchJobId, ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
3761 [EditorBrowsable(EditorBrowsableState.Never)]
3762 public virtual CollectionResult GetFileAssociations(string vectorStoreId, string batchId, int? limit, string order, string after, string before, string filter, RequestOptions options);
3763 public virtual AsyncCollectionResult<VectorStoreFileAssociation> GetFileAssociationsAsync(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
3764 public virtual AsyncCollectionResult<VectorStoreFileAssociation> GetFileAssociationsAsync(string vectorStoreId, VectorStoreFileAssociationCollectionOptions options = null, CancellationToken cancellationToken = default);
3765 [EditorBrowsable(EditorBrowsableState.Never)]
3766 public virtual AsyncCollectionResult GetFileAssociationsAsync(string vectorStoreId, int? limit, string order, string after, string before, string filter, RequestOptions options);
3767 public virtual AsyncCollectionResult<VectorStoreFileAssociation> GetFileAssociationsAsync(string vectorStoreId, string batchJobId, VectorStoreFileAssociationCollectionOptions options = null, CancellationToken cancellationToken = default);
3768 public virtual AsyncCollectionResult<VectorStoreFileAssociation> GetFileAssociationsAsync(string vectorStoreId, string batchJobId, ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
3769 [EditorBrowsable(EditorBrowsableState.Never)]
3770 public virtual AsyncCollectionResult GetFileAssociationsAsync(string vectorStoreId, string batchId, int? limit, string order, string after, string before, string filter, RequestOptions options);
3771 public virtual ClientResult<VectorStore> GetVectorStore(string vectorStoreId, CancellationToken cancellationToken = default);
3772 public virtual CollectionResult<VectorStore> GetVectorStores(VectorStoreCollectionOptions options = null, CancellationToken cancellationToken = default);
3773 public virtual CollectionResult<VectorStore> GetVectorStores(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
3774 [EditorBrowsable(EditorBrowsableState.Never)]
3775 public virtual CollectionResult GetVectorStores(int? limit, string order, string after, string before, RequestOptions options);
3776 public virtual AsyncCollectionResult<VectorStore> GetVectorStoresAsync(VectorStoreCollectionOptions options = null, CancellationToken cancellationToken = default);
3777 public virtual AsyncCollectionResult<VectorStore> GetVectorStoresAsync(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
3778 [EditorBrowsable(EditorBrowsableState.Never)]
3779 public virtual AsyncCollectionResult GetVectorStoresAsync(int? limit, string order, string after, string before, RequestOptions options);
3780 public virtual ClientResult<VectorStore> ModifyVectorStore(string vectorStoreId, VectorStoreModificationOptions vectorStore, CancellationToken cancellationToken = default);
3781 [EditorBrowsable(EditorBrowsableState.Never)]
3782 public virtual ClientResult ModifyVectorStore(string vectorStoreId, BinaryContent content, RequestOptions options = null);
3783 public virtual Task<ClientResult<VectorStore>> ModifyVectorStoreAsync(string vectorStoreId, VectorStoreModificationOptions vectorStore, CancellationToken cancellationToken = default);
3784 [EditorBrowsable(EditorBrowsableState.Never)]
3785 public virtual Task<ClientResult> ModifyVectorStoreAsync(string vectorStoreId, BinaryContent content, RequestOptions options = null);
3786 [EditorBrowsable(EditorBrowsableState.Never)]
3787 public virtual ClientResult RemoveFileFromStore(string vectorStoreId, string fileId, RequestOptions options);
3788 public virtual ClientResult<FileFromStoreRemovalResult> RemoveFileFromStore(string vectorStoreId, string fileId, CancellationToken cancellationToken = default);
3789 [EditorBrowsable(EditorBrowsableState.Never)]
3790 public virtual Task<ClientResult> RemoveFileFromStoreAsync(string vectorStoreId, string fileId, RequestOptions options);
3791 public virtual Task<ClientResult<FileFromStoreRemovalResult>> RemoveFileFromStoreAsync(string vectorStoreId, string fileId, CancellationToken cancellationToken = default);
3792 }
3793 [Experimental("OPENAI001")]
3794 public class VectorStoreCollectionOptions {
3795 public string AfterId { get; set; }
3796 public string BeforeId { get; set; }
3797 public VectorStoreCollectionOrder? Order { get; set; }
3798 public int? PageSizeLimit { get; set; }
3799 }
3800 [Experimental("OPENAI001")]
3801 public readonly partial struct VectorStoreCollectionOrder : IEquatable<VectorStoreCollectionOrder> {
3802 public VectorStoreCollectionOrder(string value);
3803 public static VectorStoreCollectionOrder Ascending { get; }
3804 public static VectorStoreCollectionOrder Descending { get; }
3805 public readonly bool Equals(VectorStoreCollectionOrder other);
3806 [EditorBrowsable(EditorBrowsableState.Never)]
3807 public override readonly bool Equals(object obj);
3808 [EditorBrowsable(EditorBrowsableState.Never)]
3809 public override readonly int GetHashCode();
3810 public static bool operator ==(VectorStoreCollectionOrder left, VectorStoreCollectionOrder right);
3811 public static implicit operator VectorStoreCollectionOrder(string value);
3812 public static bool operator !=(VectorStoreCollectionOrder left, VectorStoreCollectionOrder right);
3813 public override readonly string ToString();
3814 }
3815 [Experimental("OPENAI001")]
3816 public class VectorStoreCreationOptions : IJsonModel<VectorStoreCreationOptions>, IPersistableModel<VectorStoreCreationOptions> {
3817 public FileChunkingStrategy ChunkingStrategy { get; set; }
3818 public VectorStoreExpirationPolicy ExpirationPolicy { get; set; }
3819 public IList<string> FileIds { get; }
3820 public IDictionary<string, string> Metadata { get; }
3821 public string Name { get; set; }
3822 public static explicit operator VectorStoreCreationOptions(ClientResult result);
3823 public static implicit operator BinaryContent(VectorStoreCreationOptions vectorStoreCreationOptions);
3824 }
3825 [Experimental("OPENAI001")]
3826 public class VectorStoreDeletionResult : IJsonModel<VectorStoreDeletionResult>, IPersistableModel<VectorStoreDeletionResult> {
3827 public bool Deleted { get; }
3828 public string VectorStoreId { get; }
3829 public static explicit operator VectorStoreDeletionResult(ClientResult result);
3830 public static implicit operator BinaryContent(VectorStoreDeletionResult vectorStoreDeletionResult);
3831 }
3832 [Experimental("OPENAI001")]
3833 public enum VectorStoreExpirationAnchor {
3834 Unknown = 0,
3835 LastActiveAt = 1
3836 }
3837 [Experimental("OPENAI001")]
3838 public class VectorStoreExpirationPolicy : IJsonModel<VectorStoreExpirationPolicy>, IPersistableModel<VectorStoreExpirationPolicy> {
3839 public VectorStoreExpirationPolicy(VectorStoreExpirationAnchor anchor, int days);
3840 public VectorStoreExpirationAnchor Anchor { get; set; }
3841 public int Days { get; set; }
3842 public static explicit operator VectorStoreExpirationPolicy(ClientResult result);
3843 public static implicit operator BinaryContent(VectorStoreExpirationPolicy vectorStoreExpirationPolicy);
3844 }
3845 [Experimental("OPENAI001")]
3846 public class VectorStoreFileAssociation : IJsonModel<VectorStoreFileAssociation>, IPersistableModel<VectorStoreFileAssociation> {
3847 public IDictionary<string, BinaryData> Attributes { get; }
3848 public FileChunkingStrategy ChunkingStrategy { get; }
3849 public DateTimeOffset CreatedAt { get; }
3850 public string FileId { get; }
3851 public VectorStoreFileAssociationError LastError { get; }
3852 public int Size { get; }
3853 public VectorStoreFileAssociationStatus Status { get; }
3854 public string VectorStoreId { get; }
3855 public static explicit operator VectorStoreFileAssociation(ClientResult result);
3856 public static implicit operator BinaryContent(VectorStoreFileAssociation vectorStoreFileAssociation);
3857 }
3858 [Experimental("OPENAI001")]
3859 public class VectorStoreFileAssociationCollectionOptions {
3860 public string AfterId { get; set; }
3861 public string BeforeId { get; set; }
3862 public VectorStoreFileStatusFilter? Filter { get; set; }
3863 public VectorStoreFileAssociationCollectionOrder? Order { get; set; }
3864 public int? PageSizeLimit { get; set; }
3865 }
3866 [Experimental("OPENAI001")]
3867 public readonly partial struct VectorStoreFileAssociationCollectionOrder : IEquatable<VectorStoreFileAssociationCollectionOrder> {
3868 public VectorStoreFileAssociationCollectionOrder(string value);
3869 public static VectorStoreFileAssociationCollectionOrder Ascending { get; }
3870 public static VectorStoreFileAssociationCollectionOrder Descending { get; }
3871 public readonly bool Equals(VectorStoreFileAssociationCollectionOrder other);
3872 [EditorBrowsable(EditorBrowsableState.Never)]
3873 public override readonly bool Equals(object obj);
3874 [EditorBrowsable(EditorBrowsableState.Never)]
3875 public override readonly int GetHashCode();
3876 public static bool operator ==(VectorStoreFileAssociationCollectionOrder left, VectorStoreFileAssociationCollectionOrder right);
3877 public static implicit operator VectorStoreFileAssociationCollectionOrder(string value);
3878 public static bool operator !=(VectorStoreFileAssociationCollectionOrder left, VectorStoreFileAssociationCollectionOrder right);
3879 public override readonly string ToString();
3880 }
3881 [Experimental("OPENAI001")]
3882 public class VectorStoreFileAssociationError : IJsonModel<VectorStoreFileAssociationError>, IPersistableModel<VectorStoreFileAssociationError> {
3883 public VectorStoreFileAssociationErrorCode Code { get; }
3884 public string Message { get; }
3885 public static explicit operator VectorStoreFileAssociationError(ClientResult result);
3886 public static implicit operator BinaryContent(VectorStoreFileAssociationError vectorStoreFileAssociationError);
3887 }
3888 [Experimental("OPENAI001")]
3889 public readonly partial struct VectorStoreFileAssociationErrorCode : IEquatable<VectorStoreFileAssociationErrorCode> {
3890 public VectorStoreFileAssociationErrorCode(string value);
3891 public static VectorStoreFileAssociationErrorCode InvalidFile { get; }
3892 public static VectorStoreFileAssociationErrorCode ServerError { get; }
3893 public static VectorStoreFileAssociationErrorCode UnsupportedFile { get; }
3894 public readonly bool Equals(VectorStoreFileAssociationErrorCode other);
3895 [EditorBrowsable(EditorBrowsableState.Never)]
3896 public override readonly bool Equals(object obj);
3897 [EditorBrowsable(EditorBrowsableState.Never)]
3898 public override readonly int GetHashCode();
3899 public static bool operator ==(VectorStoreFileAssociationErrorCode left, VectorStoreFileAssociationErrorCode right);
3900 public static implicit operator VectorStoreFileAssociationErrorCode(string value);
3901 public static bool operator !=(VectorStoreFileAssociationErrorCode left, VectorStoreFileAssociationErrorCode right);
3902 public override readonly string ToString();
3903 }
3904 [Experimental("OPENAI001")]
3905 public enum VectorStoreFileAssociationStatus {
3906 Unknown = 0,
3907 InProgress = 1,
3908 Completed = 2,
3909 Cancelled = 3,
3910 Failed = 4
3911 }
3912 [Experimental("OPENAI001")]
3913 public class VectorStoreFileCounts : IJsonModel<VectorStoreFileCounts>, IPersistableModel<VectorStoreFileCounts> {
3914 public int Cancelled { get; }
3915 public int Completed { get; }
3916 public int Failed { get; }
3917 public int InProgress { get; }
3918 public int Total { get; }
3919 public static explicit operator VectorStoreFileCounts(ClientResult result);
3920 public static implicit operator BinaryContent(VectorStoreFileCounts vectorStoreFileCounts);
3921 }
3922 [Experimental("OPENAI001")]
3923 public readonly partial struct VectorStoreFileStatusFilter : IEquatable<VectorStoreFileStatusFilter> {
3924 public VectorStoreFileStatusFilter(string value);
3925 public static VectorStoreFileStatusFilter Cancelled { get; }
3926 public static VectorStoreFileStatusFilter Completed { get; }
3927 public static VectorStoreFileStatusFilter Failed { get; }
3928 public static VectorStoreFileStatusFilter InProgress { get; }
3929 public readonly bool Equals(VectorStoreFileStatusFilter other);
3930 [EditorBrowsable(EditorBrowsableState.Never)]
3931 public override readonly bool Equals(object obj);
3932 [EditorBrowsable(EditorBrowsableState.Never)]
3933 public override readonly int GetHashCode();
3934 public static bool operator ==(VectorStoreFileStatusFilter left, VectorStoreFileStatusFilter right);
3935 public static implicit operator VectorStoreFileStatusFilter(string value);
3936 public static bool operator !=(VectorStoreFileStatusFilter left, VectorStoreFileStatusFilter right);
3937 public override readonly string ToString();
3938 }
3939 [Experimental("OPENAI001")]
3940 public class VectorStoreModificationOptions : IJsonModel<VectorStoreModificationOptions>, IPersistableModel<VectorStoreModificationOptions> {
3941 public VectorStoreExpirationPolicy ExpirationPolicy { get; set; }
3942 public IDictionary<string, string> Metadata { get; }
3943 public string Name { get; set; }
3944 public static explicit operator VectorStoreModificationOptions(ClientResult result);
3945 public static implicit operator BinaryContent(VectorStoreModificationOptions vectorStoreModificationOptions);
3946 }
3947 [Experimental("OPENAI001")]
3948 public enum VectorStoreStatus {
3949 Unknown = 0,
3950 InProgress = 1,
3951 Completed = 2,
3952 Expired = 3
3953 }
3954}