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
OpenAI_2.9.1

Branches

Tags

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

Clone

HTTPS

Download ZIP

openai-dotnet/api

api/OpenAI.net10.0.cs

7142lines · modecode

RawDownload
Remove GA prefix from Realtime types (#983)e615290
1//------------------------------------------------------------------------------
2// <auto-generated>
3// This code was generated by a tool.
4//
5// Changes to this file may cause incorrect behavior and will be lost if
6// the code is regenerated.
7// </auto-generated>
8//------------------------------------------------------------------------------
9namespace OpenAI {
10 public class OpenAIClient {
11 protected OpenAIClient();
12 public OpenAIClient(ApiKeyCredential credential, OpenAIClientOptions options);
13 public OpenAIClient(ApiKeyCredential credential);
14 [Experimental("OPENAI001")]
15 public OpenAIClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
16 [Experimental("OPENAI001")]
17 public OpenAIClient(AuthenticationPolicy authenticationPolicy);
18 protected internal OpenAIClient(ClientPipeline pipeline, OpenAIClientOptions options);
19 public OpenAIClient(string apiKey);
20 [Experimental("OPENAI001")]
21 public Uri Endpoint { get; }
22 public ClientPipeline Pipeline { get; }
23 [Experimental("OPENAI001")]
24 public virtual AssistantClient GetAssistantClient();
25 public virtual AudioClient GetAudioClient(string model);
26 [Experimental("OPENAI001")]
27 public virtual BatchClient GetBatchClient();
28 public virtual ChatClient GetChatClient(string model);
29 [Experimental("OPENAI001")]
30 public virtual ContainerClient GetContainerClient();
31 [Experimental("OPENAI001")]
32 public virtual ConversationClient GetConversationClient();
33 public virtual EmbeddingClient GetEmbeddingClient(string model);
34 [Experimental("OPENAI001")]
35 public virtual EvaluationClient GetEvaluationClient();
36 [Experimental("OPENAI001")]
37 public virtual FineTuningClient GetFineTuningClient();
38 [Experimental("OPENAI001")]
39 public virtual GraderClient GetGraderClient();
40 public virtual ImageClient GetImageClient(string model);
41 public virtual ModerationClient GetModerationClient(string model);
42 public virtual OpenAIFileClient GetOpenAIFileClient();
43 public virtual OpenAIModelClient GetOpenAIModelClient();
44 [Experimental("OPENAI002")]
45 public virtual RealtimeClient GetRealtimeClient();
46 [Experimental("OPENAI001")]
47 public virtual ResponsesClient GetResponsesClient();
48 [Experimental("OPENAI001")]
49 public virtual VectorStoreClient GetVectorStoreClient();
50 [Experimental("OPENAI001")]
51 public virtual VideoClient GetVideoClient();
52 }
53 public class OpenAIClientOptions : ClientPipelineOptions {
54 public Uri Endpoint { get; set; }
55 public string OrganizationId { get; set; }
56 public string ProjectId { get; set; }
57 public string UserAgentApplicationId { get; set; }
58 }
59 [Experimental("OPENAI001")]
60 public class OpenAIContext : ModelReaderWriterContext {
61 public static OpenAIContext Default { get; }
62 protected override bool TryGetTypeBuilderCore(Type type, out ModelReaderWriterTypeBuilder builder);
63 }
64 [Experimental("SCME0002")]
65 public static class OpenAIHostBuilderExtensions {
66 public static IClientBuilder AddAssistantClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
67 public static IClientBuilder AddAudioClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
68 public static IClientBuilder AddBatchClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
69 public static IClientBuilder AddChatClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
70 public static IClientBuilder AddContainerClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
71 public static IClientBuilder AddConversationClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
72 public static IClientBuilder AddEmbeddingClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
73 public static IClientBuilder AddEvaluationClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
74 public static IClientBuilder AddFineTuningClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
75 public static IClientBuilder AddGraderClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
76 public static IClientBuilder AddImageClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
77 public static IClientBuilder AddKeyedAssistantClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
78 public static IClientBuilder AddKeyedAudioClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
79 public static IClientBuilder AddKeyedBatchClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
80 public static IClientBuilder AddKeyedChatClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
81 public static IClientBuilder AddKeyedContainerClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
82 public static IClientBuilder AddKeyedConversationClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
83 public static IClientBuilder AddKeyedEmbeddingClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
84 public static IClientBuilder AddKeyedEvaluationClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
85 public static IClientBuilder AddKeyedFineTuningClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
86 public static IClientBuilder AddKeyedGraderClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
87 public static IClientBuilder AddKeyedImageClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
88 public static IClientBuilder AddKeyedModerationClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
89 public static IClientBuilder AddKeyedOpenAIFileClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
90 public static IClientBuilder AddKeyedOpenAIModelClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
91 public static IClientBuilder AddKeyedRealtimeClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
92 public static IClientBuilder AddKeyedResponsesClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
93 public static IClientBuilder AddKeyedVectorStoreClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
94 public static IClientBuilder AddKeyedVideoClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
95 public static IClientBuilder AddModerationClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
96 public static IClientBuilder AddOpenAIFileClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
97 public static IClientBuilder AddOpenAIModelClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
98 public static IClientBuilder AddRealtimeClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
99 public static IClientBuilder AddResponsesClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
100 public static IClientBuilder AddVectorStoreClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
101 public static IClientBuilder AddVideoClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
102 }
103}
104namespace OpenAI.Assistants {
105 [Experimental("OPENAI001")]
106 public class Assistant : IJsonModel<Assistant>, IPersistableModel<Assistant> {
107 public DateTimeOffset CreatedAt { get; }
108 public string Description { get; }
109 public string Id { get; }
110 public string Instructions { get; }
111 public IReadOnlyDictionary<string, string> Metadata { get; }
112 public string Model { get; }
113 public string Name { get; }
114 public float? NucleusSamplingFactor { get; }
115 public AssistantResponseFormat ResponseFormat { get; }
116 public float? Temperature { get; }
117 public ToolResources ToolResources { get; }
118 public IReadOnlyList<ToolDefinition> Tools { get; }
119 protected virtual Assistant JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
120 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
121 public static explicit operator Assistant(ClientResult result);
122 protected virtual Assistant PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
123 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
124 }
125 [Experimental("OPENAI001")]
126 public class AssistantClient {
127 protected AssistantClient();
128 [Experimental("SCME0002")]
129 public AssistantClient(AssistantClientSettings settings);
130 public AssistantClient(ApiKeyCredential credential, OpenAIClientOptions options);
131 public AssistantClient(ApiKeyCredential credential);
132 public AssistantClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
133 public AssistantClient(AuthenticationPolicy authenticationPolicy);
134 protected internal AssistantClient(ClientPipeline pipeline, OpenAIClientOptions options);
135 public AssistantClient(string apiKey);
136 [Experimental("OPENAI001")]
137 public Uri Endpoint { get; }
138 public ClientPipeline Pipeline { get; }
139 public virtual ClientResult CancelRun(string threadId, string runId, RequestOptions options);
140 public virtual ClientResult<ThreadRun> CancelRun(string threadId, string runId, CancellationToken cancellationToken = default);
141 public virtual Task<ClientResult> CancelRunAsync(string threadId, string runId, RequestOptions options);
142 public virtual Task<ClientResult<ThreadRun>> CancelRunAsync(string threadId, string runId, CancellationToken cancellationToken = default);
143 public virtual ClientResult CreateAssistant(BinaryContent content, RequestOptions options = null);
144 public virtual ClientResult<Assistant> CreateAssistant(string model, AssistantCreationOptions options = null, CancellationToken cancellationToken = default);
145 public virtual Task<ClientResult> CreateAssistantAsync(BinaryContent content, RequestOptions options = null);
146 public virtual Task<ClientResult<Assistant>> CreateAssistantAsync(string model, AssistantCreationOptions options = null, CancellationToken cancellationToken = default);
147 public virtual ClientResult<ThreadMessage> CreateMessage(string threadId, MessageRole role, IEnumerable<MessageContent> content, MessageCreationOptions options = null, CancellationToken cancellationToken = default);
148 public virtual ClientResult CreateMessage(string threadId, BinaryContent content, RequestOptions options = null);
149 public virtual Task<ClientResult<ThreadMessage>> CreateMessageAsync(string threadId, MessageRole role, IEnumerable<MessageContent> content, MessageCreationOptions options = null, CancellationToken cancellationToken = default);
150 public virtual Task<ClientResult> CreateMessageAsync(string threadId, BinaryContent content, RequestOptions options = null);
151 public virtual ClientResult CreateRun(string threadId, BinaryContent content, RequestOptions options = null);
152 public virtual ClientResult<ThreadRun> CreateRun(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
153 public virtual Task<ClientResult> CreateRunAsync(string threadId, BinaryContent content, RequestOptions options = null);
154 public virtual Task<ClientResult<ThreadRun>> CreateRunAsync(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
155 public virtual CollectionResult<StreamingUpdate> CreateRunStreaming(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
156 public virtual AsyncCollectionResult<StreamingUpdate> CreateRunStreamingAsync(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
157 public virtual ClientResult<AssistantThread> CreateThread(ThreadCreationOptions options = null, CancellationToken cancellationToken = default);
158 public virtual ClientResult CreateThread(BinaryContent content, RequestOptions options = null);
159 public virtual ClientResult CreateThreadAndRun(BinaryContent content, RequestOptions options = null);
160 public virtual ClientResult<ThreadRun> CreateThreadAndRun(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
161 public virtual Task<ClientResult> CreateThreadAndRunAsync(BinaryContent content, RequestOptions options = null);
162 public virtual Task<ClientResult<ThreadRun>> CreateThreadAndRunAsync(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
163 public virtual CollectionResult<StreamingUpdate> CreateThreadAndRunStreaming(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
164 public virtual AsyncCollectionResult<StreamingUpdate> CreateThreadAndRunStreamingAsync(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
165 public virtual Task<ClientResult<AssistantThread>> CreateThreadAsync(ThreadCreationOptions options = null, CancellationToken cancellationToken = default);
166 public virtual Task<ClientResult> CreateThreadAsync(BinaryContent content, RequestOptions options = null);
167 public virtual ClientResult DeleteAssistant(string assistantId, RequestOptions options);
168 public virtual ClientResult<AssistantDeletionResult> DeleteAssistant(string assistantId, CancellationToken cancellationToken = default);
169 public virtual Task<ClientResult> DeleteAssistantAsync(string assistantId, RequestOptions options);
170 public virtual Task<ClientResult<AssistantDeletionResult>> DeleteAssistantAsync(string assistantId, CancellationToken cancellationToken = default);
171 public virtual ClientResult DeleteMessage(string threadId, string messageId, RequestOptions options);
172 public virtual ClientResult<MessageDeletionResult> DeleteMessage(string threadId, string messageId, CancellationToken cancellationToken = default);
173 public virtual Task<ClientResult> DeleteMessageAsync(string threadId, string messageId, RequestOptions options);
174 public virtual Task<ClientResult<MessageDeletionResult>> DeleteMessageAsync(string threadId, string messageId, CancellationToken cancellationToken = default);
175 public virtual ClientResult DeleteThread(string threadId, RequestOptions options);
176 public virtual ClientResult<ThreadDeletionResult> DeleteThread(string threadId, CancellationToken cancellationToken = default);
177 public virtual Task<ClientResult> DeleteThreadAsync(string threadId, RequestOptions options);
178 public virtual Task<ClientResult<ThreadDeletionResult>> DeleteThreadAsync(string threadId, CancellationToken cancellationToken = default);
179 public virtual ClientResult GetAssistant(string assistantId, RequestOptions options);
180 public virtual ClientResult<Assistant> GetAssistant(string assistantId, CancellationToken cancellationToken = default);
181 public virtual Task<ClientResult> GetAssistantAsync(string assistantId, RequestOptions options);
182 public virtual Task<ClientResult<Assistant>> GetAssistantAsync(string assistantId, CancellationToken cancellationToken = default);
183 public virtual CollectionResult<Assistant> GetAssistants(AssistantCollectionOptions options = null, CancellationToken cancellationToken = default);
184 public virtual CollectionResult GetAssistants(int? limit, string order, string after, string before, RequestOptions options);
185 public virtual AsyncCollectionResult<Assistant> GetAssistantsAsync(AssistantCollectionOptions options = null, CancellationToken cancellationToken = default);
186 public virtual AsyncCollectionResult GetAssistantsAsync(int? limit, string order, string after, string before, RequestOptions options);
187 public virtual ClientResult GetMessage(string threadId, string messageId, RequestOptions options);
188 public virtual ClientResult<ThreadMessage> GetMessage(string threadId, string messageId, CancellationToken cancellationToken = default);
189 public virtual Task<ClientResult> GetMessageAsync(string threadId, string messageId, RequestOptions options);
190 public virtual Task<ClientResult<ThreadMessage>> GetMessageAsync(string threadId, string messageId, CancellationToken cancellationToken = default);
191 public virtual CollectionResult<ThreadMessage> GetMessages(string threadId, MessageCollectionOptions options = null, CancellationToken cancellationToken = default);
192 public virtual CollectionResult GetMessages(string threadId, int? limit, string order, string after, string before, RequestOptions options);
193 public virtual AsyncCollectionResult<ThreadMessage> GetMessagesAsync(string threadId, MessageCollectionOptions options = null, CancellationToken cancellationToken = default);
194 public virtual AsyncCollectionResult GetMessagesAsync(string threadId, int? limit, string order, string after, string before, RequestOptions options);
195 public virtual ClientResult GetRun(string threadId, string runId, RequestOptions options);
196 public virtual ClientResult<ThreadRun> GetRun(string threadId, string runId, CancellationToken cancellationToken = default);
197 public virtual Task<ClientResult> GetRunAsync(string threadId, string runId, RequestOptions options);
198 public virtual Task<ClientResult<ThreadRun>> GetRunAsync(string threadId, string runId, CancellationToken cancellationToken = default);
199 public virtual CollectionResult<ThreadRun> GetRuns(string threadId, RunCollectionOptions options = null, CancellationToken cancellationToken = default);
200 public virtual CollectionResult GetRuns(string threadId, int? limit, string order, string after, string before, RequestOptions options);
201 public virtual AsyncCollectionResult<ThreadRun> GetRunsAsync(string threadId, RunCollectionOptions options = null, CancellationToken cancellationToken = default);
202 public virtual AsyncCollectionResult GetRunsAsync(string threadId, int? limit, string order, string after, string before, RequestOptions options);
203 public virtual ClientResult GetRunStep(string threadId, string runId, string stepId, RequestOptions options);
204 public virtual ClientResult<RunStep> GetRunStep(string threadId, string runId, string stepId, CancellationToken cancellationToken = default);
205 public virtual Task<ClientResult> GetRunStepAsync(string threadId, string runId, string stepId, RequestOptions options);
206 public virtual Task<ClientResult<RunStep>> GetRunStepAsync(string threadId, string runId, string stepId, CancellationToken cancellationToken = default);
207 public virtual CollectionResult<RunStep> GetRunSteps(string threadId, string runId, RunStepCollectionOptions options = null, CancellationToken cancellationToken = default);
208 public virtual CollectionResult GetRunSteps(string threadId, string runId, int? limit, string order, string after, string before, RequestOptions options);
209 public virtual AsyncCollectionResult<RunStep> GetRunStepsAsync(string threadId, string runId, RunStepCollectionOptions options = null, CancellationToken cancellationToken = default);
210 public virtual AsyncCollectionResult GetRunStepsAsync(string threadId, string runId, int? limit, string order, string after, string before, RequestOptions options);
211 public virtual ClientResult GetThread(string threadId, RequestOptions options);
212 public virtual ClientResult<AssistantThread> GetThread(string threadId, CancellationToken cancellationToken = default);
213 public virtual Task<ClientResult> GetThreadAsync(string threadId, RequestOptions options);
214 public virtual Task<ClientResult<AssistantThread>> GetThreadAsync(string threadId, CancellationToken cancellationToken = default);
215 public virtual ClientResult<Assistant> ModifyAssistant(string assistantId, AssistantModificationOptions options, CancellationToken cancellationToken = default);
216 public virtual ClientResult ModifyAssistant(string assistantId, BinaryContent content, RequestOptions options = null);
217 public virtual Task<ClientResult<Assistant>> ModifyAssistantAsync(string assistantId, AssistantModificationOptions options, CancellationToken cancellationToken = default);
218 public virtual Task<ClientResult> ModifyAssistantAsync(string assistantId, BinaryContent content, RequestOptions options = null);
219 public virtual ClientResult<ThreadMessage> ModifyMessage(string threadId, string messageId, MessageModificationOptions options, CancellationToken cancellationToken = default);
220 public virtual ClientResult ModifyMessage(string threadId, string messageId, BinaryContent content, RequestOptions options = null);
221 public virtual Task<ClientResult<ThreadMessage>> ModifyMessageAsync(string threadId, string messageId, MessageModificationOptions options, CancellationToken cancellationToken = default);
222 public virtual Task<ClientResult> ModifyMessageAsync(string threadId, string messageId, BinaryContent content, RequestOptions options = null);
223 public virtual ClientResult ModifyRun(string threadId, string runId, BinaryContent content, RequestOptions options = null);
224 public virtual Task<ClientResult> ModifyRunAsync(string threadId, string runId, BinaryContent content, RequestOptions options = null);
225 public virtual ClientResult<AssistantThread> ModifyThread(string threadId, ThreadModificationOptions options, CancellationToken cancellationToken = default);
226 public virtual ClientResult ModifyThread(string threadId, BinaryContent content, RequestOptions options = null);
227 public virtual Task<ClientResult<AssistantThread>> ModifyThreadAsync(string threadId, ThreadModificationOptions options, CancellationToken cancellationToken = default);
228 public virtual Task<ClientResult> ModifyThreadAsync(string threadId, BinaryContent content, RequestOptions options = null);
229 public virtual ClientResult SubmitToolOutputsToRun(string threadId, string runId, BinaryContent content, RequestOptions options = null);
230 public virtual ClientResult<ThreadRun> SubmitToolOutputsToRun(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
231 public virtual Task<ClientResult> SubmitToolOutputsToRunAsync(string threadId, string runId, BinaryContent content, RequestOptions options = null);
232 public virtual Task<ClientResult<ThreadRun>> SubmitToolOutputsToRunAsync(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
233 public virtual CollectionResult<StreamingUpdate> SubmitToolOutputsToRunStreaming(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
234 public virtual AsyncCollectionResult<StreamingUpdate> SubmitToolOutputsToRunStreamingAsync(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
235 }
236 [Experimental("SCME0002")]
237 public sealed class AssistantClientSettings : ClientSettings {
238 public OpenAIClientOptions Options { get; set; }
239 protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
240 }
241 [Experimental("OPENAI001")]
242 public class AssistantCollectionOptions : IJsonModel<AssistantCollectionOptions>, IPersistableModel<AssistantCollectionOptions> {
243 public string AfterId { get; set; }
244 public string BeforeId { get; set; }
245 public AssistantCollectionOrder? Order { get; set; }
246 public int? PageSizeLimit { get; set; }
247 protected virtual AssistantCollectionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
248 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
249 protected virtual AssistantCollectionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
250 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
251 }
252 [Experimental("OPENAI001")]
253 public readonly partial struct AssistantCollectionOrder : IEquatable<AssistantCollectionOrder> {
254 public AssistantCollectionOrder(string value);
255 public static AssistantCollectionOrder Ascending { get; }
256 public static AssistantCollectionOrder Descending { get; }
257 public readonly bool Equals(AssistantCollectionOrder other);
258 [EditorBrowsable(EditorBrowsableState.Never)]
259 public override readonly bool Equals(object obj);
260 [EditorBrowsable(EditorBrowsableState.Never)]
261 public override readonly int GetHashCode();
262 public static bool operator ==(AssistantCollectionOrder left, AssistantCollectionOrder right);
263 public static implicit operator AssistantCollectionOrder(string value);
264 public static implicit operator AssistantCollectionOrder?(string value);
265 public static bool operator !=(AssistantCollectionOrder left, AssistantCollectionOrder right);
266 public override readonly string ToString();
267 }
268 [Experimental("OPENAI001")]
269 public class AssistantCreationOptions : IJsonModel<AssistantCreationOptions>, IPersistableModel<AssistantCreationOptions> {
270 public string Description { get; set; }
271 public string Instructions { get; set; }
272 public IDictionary<string, string> Metadata { get; }
273 public string Name { get; set; }
274 public float? NucleusSamplingFactor { get; set; }
275 public AssistantResponseFormat ResponseFormat { get; set; }
276 public float? Temperature { get; set; }
277 public ToolResources ToolResources { get; set; }
278 public IList<ToolDefinition> Tools { get; }
279 protected virtual AssistantCreationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
280 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
281 protected virtual AssistantCreationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
282 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
283 }
284 [Experimental("OPENAI001")]
285 public class AssistantDeletionResult : IJsonModel<AssistantDeletionResult>, IPersistableModel<AssistantDeletionResult> {
286 public string AssistantId { get; }
287 public bool Deleted { get; }
288 protected virtual AssistantDeletionResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
289 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
290 public static explicit operator AssistantDeletionResult(ClientResult result);
291 protected virtual AssistantDeletionResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
292 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
293 }
294 [Experimental("OPENAI001")]
295 public class AssistantModificationOptions : IJsonModel<AssistantModificationOptions>, IPersistableModel<AssistantModificationOptions> {
296 public IList<ToolDefinition> DefaultTools { get; }
297 public string Description { get; set; }
298 public string Instructions { get; set; }
299 public IDictionary<string, string> Metadata { get; }
300 public string Model { get; set; }
301 public string Name { get; set; }
302 public float? NucleusSamplingFactor { get; set; }
303 public AssistantResponseFormat ResponseFormat { get; set; }
304 public float? Temperature { get; set; }
305 public ToolResources ToolResources { get; set; }
306 protected virtual AssistantModificationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
307 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
308 protected virtual AssistantModificationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
309 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
310 }
311 [Experimental("OPENAI001")]
312 public class AssistantResponseFormat : IEquatable<AssistantResponseFormat>, IEquatable<string>, IJsonModel<AssistantResponseFormat>, IPersistableModel<AssistantResponseFormat> {
313 public static AssistantResponseFormat Auto { get; }
314 public static AssistantResponseFormat JsonObject { get; }
315 public static AssistantResponseFormat Text { get; }
316 public static AssistantResponseFormat CreateAutoFormat();
317 public static AssistantResponseFormat CreateJsonObjectFormat();
318 public static AssistantResponseFormat CreateJsonSchemaFormat(string name, BinaryData jsonSchema, string description = null, bool? strictSchemaEnabled = null);
319 public static AssistantResponseFormat CreateTextFormat();
320 [EditorBrowsable(EditorBrowsableState.Never)]
321 public override bool Equals(object obj);
322 [EditorBrowsable(EditorBrowsableState.Never)]
323 public override int GetHashCode();
324 protected virtual AssistantResponseFormat JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
325 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
326 [EditorBrowsable(EditorBrowsableState.Never)]
327 public static bool operator ==(AssistantResponseFormat first, AssistantResponseFormat second);
328 [EditorBrowsable(EditorBrowsableState.Never)]
329 public static implicit operator AssistantResponseFormat(string plainTextFormat);
330 [EditorBrowsable(EditorBrowsableState.Never)]
331 public static bool operator !=(AssistantResponseFormat first, AssistantResponseFormat second);
332 protected virtual AssistantResponseFormat PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
333 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
334 [EditorBrowsable(EditorBrowsableState.Never)]
335 bool IEquatable<AssistantResponseFormat>.Equals(AssistantResponseFormat other);
336 [EditorBrowsable(EditorBrowsableState.Never)]
337 bool IEquatable<string>.Equals(string other);
338 public override string ToString();
339 }
340 [Experimental("OPENAI001")]
341 public class AssistantThread : IJsonModel<AssistantThread>, IPersistableModel<AssistantThread> {
342 public DateTimeOffset CreatedAt { get; }
343 public string Id { get; }
344 public IReadOnlyDictionary<string, string> Metadata { get; }
345 public ToolResources ToolResources { get; }
346 protected virtual AssistantThread JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
347 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
348 public static explicit operator AssistantThread(ClientResult result);
349 protected virtual AssistantThread PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
350 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
351 }
352 [Experimental("OPENAI001")]
353 public class CodeInterpreterToolDefinition : ToolDefinition, IJsonModel<CodeInterpreterToolDefinition>, IPersistableModel<CodeInterpreterToolDefinition> {
354 public CodeInterpreterToolDefinition();
355 protected override ToolDefinition JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
356 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
357 protected override ToolDefinition PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
358 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
359 }
360 [Experimental("OPENAI001")]
361 public class CodeInterpreterToolResources : IJsonModel<CodeInterpreterToolResources>, IPersistableModel<CodeInterpreterToolResources> {
362 public IList<string> FileIds { get; }
363 protected virtual CodeInterpreterToolResources JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
364 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
365 protected virtual CodeInterpreterToolResources PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
366 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
367 }
368 [Experimental("OPENAI001")]
369 public readonly partial struct FileSearchRanker : IEquatable<FileSearchRanker> {
370 public FileSearchRanker(string value);
371 public static FileSearchRanker Auto { get; }
372 public static FileSearchRanker Default20240821 { get; }
373 public readonly bool Equals(FileSearchRanker other);
374 [EditorBrowsable(EditorBrowsableState.Never)]
375 public override readonly bool Equals(object obj);
376 [EditorBrowsable(EditorBrowsableState.Never)]
377 public override readonly int GetHashCode();
378 public static bool operator ==(FileSearchRanker left, FileSearchRanker right);
379 public static implicit operator FileSearchRanker(string value);
380 public static implicit operator FileSearchRanker?(string value);
381 public static bool operator !=(FileSearchRanker left, FileSearchRanker right);
382 public override readonly string ToString();
383 }
384 [Experimental("OPENAI001")]
385 public class FileSearchRankingOptions : IJsonModel<FileSearchRankingOptions>, IPersistableModel<FileSearchRankingOptions> {
386 public FileSearchRankingOptions(float scoreThreshold);
387 public FileSearchRanker? Ranker { get; set; }
388 public float ScoreThreshold { get; set; }
389 protected virtual FileSearchRankingOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
390 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
391 protected virtual FileSearchRankingOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
392 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
393 }
394 [Experimental("OPENAI001")]
395 public class FileSearchToolDefinition : ToolDefinition, IJsonModel<FileSearchToolDefinition>, IPersistableModel<FileSearchToolDefinition> {
396 public FileSearchToolDefinition();
397 public int? MaxResults { get; set; }
398 public FileSearchRankingOptions RankingOptions { get; set; }
399 protected override ToolDefinition JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
400 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
401 protected override ToolDefinition PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
402 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
403 }
404 [Experimental("OPENAI001")]
405 public class FileSearchToolResources : IJsonModel<FileSearchToolResources>, IPersistableModel<FileSearchToolResources> {
406 public IList<VectorStoreCreationHelper> NewVectorStores { get; }
407 public IList<string> VectorStoreIds { get; }
408 protected virtual FileSearchToolResources JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
409 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
410 protected virtual FileSearchToolResources PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
411 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
412 }
413 [Experimental("OPENAI001")]
414 public class FunctionToolDefinition : ToolDefinition, IJsonModel<FunctionToolDefinition>, IPersistableModel<FunctionToolDefinition> {
415 public FunctionToolDefinition();
416 public FunctionToolDefinition(string name);
417 public string Description { get; set; }
418 public string FunctionName { get; set; }
419 public BinaryData Parameters { get; set; }
420 public bool? StrictParameterSchemaEnabled { get; set; }
421 protected override ToolDefinition JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
422 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
423 protected override ToolDefinition PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
424 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
425 }
426 [Experimental("OPENAI001")]
427 public class MessageCollectionOptions : IJsonModel<MessageCollectionOptions>, IPersistableModel<MessageCollectionOptions> {
428 public string AfterId { get; set; }
429 public string BeforeId { get; set; }
430 public MessageCollectionOrder? Order { get; set; }
431 public int? PageSizeLimit { get; set; }
432 protected virtual MessageCollectionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
433 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
434 protected virtual MessageCollectionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
435 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
436 }
437 [Experimental("OPENAI001")]
438 public readonly partial struct MessageCollectionOrder : IEquatable<MessageCollectionOrder> {
439 public MessageCollectionOrder(string value);
440 public static MessageCollectionOrder Ascending { get; }
441 public static MessageCollectionOrder Descending { get; }
442 public readonly bool Equals(MessageCollectionOrder other);
443 [EditorBrowsable(EditorBrowsableState.Never)]
444 public override readonly bool Equals(object obj);
445 [EditorBrowsable(EditorBrowsableState.Never)]
446 public override readonly int GetHashCode();
447 public static bool operator ==(MessageCollectionOrder left, MessageCollectionOrder right);
448 public static implicit operator MessageCollectionOrder(string value);
449 public static implicit operator MessageCollectionOrder?(string value);
450 public static bool operator !=(MessageCollectionOrder left, MessageCollectionOrder right);
451 public override readonly string ToString();
452 }
453 [Experimental("OPENAI001")]
454 public abstract class MessageContent : IJsonModel<MessageContent>, IPersistableModel<MessageContent> {
455 public MessageImageDetail? ImageDetail { get; }
456 public string ImageFileId { get; }
457 public Uri ImageUri { get; }
458 public string Refusal { get; }
459 public string Text { get; }
460 public IReadOnlyList<TextAnnotation> TextAnnotations { get; }
461 public static MessageContent FromImageFileId(string imageFileId, MessageImageDetail? detail = null);
462 public static MessageContent FromImageUri(Uri imageUri, MessageImageDetail? detail = null);
463 public static MessageContent FromText(string text);
464 protected virtual MessageContent JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
465 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
466 public static implicit operator MessageContent(string value);
467 protected virtual MessageContent PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
468 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
469 }
470 [Experimental("OPENAI001")]
471 public class MessageContentUpdate : StreamingUpdate {
472 public MessageImageDetail? ImageDetail { get; }
473 public string ImageFileId { get; }
474 public string MessageId { get; }
475 public int MessageIndex { get; }
476 public string RefusalUpdate { get; }
477 public MessageRole? Role { get; }
478 public string Text { get; }
479 public TextAnnotationUpdate TextAnnotation { get; }
480 }
481 [Experimental("OPENAI001")]
482 public class MessageCreationAttachment : IJsonModel<MessageCreationAttachment>, IPersistableModel<MessageCreationAttachment> {
483 public MessageCreationAttachment(string fileId, IEnumerable<ToolDefinition> tools);
484 public string FileId { get; }
485 public IReadOnlyList<ToolDefinition> Tools { get; }
486 protected virtual MessageCreationAttachment JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
487 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
488 protected virtual MessageCreationAttachment PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
489 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
490 }
491 [Experimental("OPENAI001")]
492 public class MessageCreationOptions : IJsonModel<MessageCreationOptions>, IPersistableModel<MessageCreationOptions> {
493 public IList<MessageCreationAttachment> Attachments { get; set; }
494 public IDictionary<string, string> Metadata { get; }
495 protected virtual MessageCreationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
496 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
497 protected virtual MessageCreationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
498 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
499 }
500 [Experimental("OPENAI001")]
501 public class MessageDeletionResult : IJsonModel<MessageDeletionResult>, IPersistableModel<MessageDeletionResult> {
502 public bool Deleted { get; }
503 public string MessageId { get; }
504 protected virtual MessageDeletionResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
505 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
506 public static explicit operator MessageDeletionResult(ClientResult result);
507 protected virtual MessageDeletionResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
508 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
509 }
510 [Experimental("OPENAI001")]
511 public class MessageFailureDetails : IJsonModel<MessageFailureDetails>, IPersistableModel<MessageFailureDetails> {
512 public MessageFailureReason Reason { get; }
513 protected virtual MessageFailureDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
514 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
515 protected virtual MessageFailureDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
516 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
517 }
518 [Experimental("OPENAI001")]
519 public readonly partial struct MessageFailureReason : IEquatable<MessageFailureReason> {
520 public MessageFailureReason(string value);
521 public static MessageFailureReason ContentFilter { get; }
522 public static MessageFailureReason MaxTokens { get; }
523 public static MessageFailureReason RunCancelled { get; }
524 public static MessageFailureReason RunExpired { get; }
525 public static MessageFailureReason RunFailed { get; }
526 public readonly bool Equals(MessageFailureReason other);
527 [EditorBrowsable(EditorBrowsableState.Never)]
528 public override readonly bool Equals(object obj);
529 [EditorBrowsable(EditorBrowsableState.Never)]
530 public override readonly int GetHashCode();
531 public static bool operator ==(MessageFailureReason left, MessageFailureReason right);
532 public static implicit operator MessageFailureReason(string value);
533 public static implicit operator MessageFailureReason?(string value);
534 public static bool operator !=(MessageFailureReason left, MessageFailureReason right);
535 public override readonly string ToString();
536 }
537 [Experimental("OPENAI001")]
538 public enum MessageImageDetail {
539 Auto = 0,
540 Low = 1,
541 High = 2
542 }
543 [Experimental("OPENAI001")]
544 public class MessageModificationOptions : IJsonModel<MessageModificationOptions>, IPersistableModel<MessageModificationOptions> {
545 public IDictionary<string, string> Metadata { get; }
546 protected virtual MessageModificationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
547 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
548 protected virtual MessageModificationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
549 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
550 }
551 [Experimental("OPENAI001")]
552 public enum MessageRole {
553 User = 0,
554 Assistant = 1
555 }
556 [Experimental("OPENAI001")]
557 public readonly partial struct MessageStatus : IEquatable<MessageStatus> {
558 public MessageStatus(string value);
559 public static MessageStatus Completed { get; }
560 public static MessageStatus Incomplete { get; }
561 public static MessageStatus InProgress { get; }
562 public readonly bool Equals(MessageStatus 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 ==(MessageStatus left, MessageStatus right);
568 public static implicit operator MessageStatus(string value);
569 public static implicit operator MessageStatus?(string value);
570 public static bool operator !=(MessageStatus left, MessageStatus right);
571 public override readonly string ToString();
572 }
573 [Experimental("OPENAI001")]
574 public class MessageStatusUpdate : StreamingUpdate<ThreadMessage> {
575 }
576 [Experimental("OPENAI001")]
577 public abstract class RequiredAction {
578 public string FunctionArguments { get; }
579 public string FunctionName { get; }
580 public string ToolCallId { get; }
581 }
582 [Experimental("OPENAI001")]
583 public class RequiredActionUpdate : RunUpdate {
584 public string FunctionArguments { get; }
585 public string FunctionName { get; }
586 public string ToolCallId { get; }
587 public ThreadRun GetThreadRun();
588 }
589 [Experimental("OPENAI001")]
590 public class RunCollectionOptions : IJsonModel<RunCollectionOptions>, IPersistableModel<RunCollectionOptions> {
591 public string AfterId { get; set; }
592 public string BeforeId { get; set; }
593 public RunCollectionOrder? Order { get; set; }
594 public int? PageSizeLimit { get; set; }
595 protected virtual RunCollectionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
596 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
597 protected virtual RunCollectionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
598 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
599 }
600 [Experimental("OPENAI001")]
601 public readonly partial struct RunCollectionOrder : IEquatable<RunCollectionOrder> {
602 public RunCollectionOrder(string value);
603 public static RunCollectionOrder Ascending { get; }
604 public static RunCollectionOrder Descending { get; }
605 public readonly bool Equals(RunCollectionOrder other);
606 [EditorBrowsable(EditorBrowsableState.Never)]
607 public override readonly bool Equals(object obj);
608 [EditorBrowsable(EditorBrowsableState.Never)]
609 public override readonly int GetHashCode();
610 public static bool operator ==(RunCollectionOrder left, RunCollectionOrder right);
611 public static implicit operator RunCollectionOrder(string value);
612 public static implicit operator RunCollectionOrder?(string value);
613 public static bool operator !=(RunCollectionOrder left, RunCollectionOrder right);
614 public override readonly string ToString();
615 }
616 [Experimental("OPENAI001")]
617 public class RunCreationOptions : IJsonModel<RunCreationOptions>, IPersistableModel<RunCreationOptions> {
618 public string AdditionalInstructions { get; set; }
619 public IList<ThreadInitializationMessage> AdditionalMessages { get; }
620 public bool? AllowParallelToolCalls { get; set; }
621 public string InstructionsOverride { get; set; }
622 public int? MaxInputTokenCount { get; set; }
623 public int? MaxOutputTokenCount { get; set; }
624 public IDictionary<string, string> Metadata { get; }
625 public string ModelOverride { get; set; }
626 public float? NucleusSamplingFactor { get; set; }
627 public AssistantResponseFormat ResponseFormat { get; set; }
628 public float? Temperature { get; set; }
629 public ToolConstraint ToolConstraint { get; set; }
630 public IList<ToolDefinition> ToolsOverride { get; }
631 public RunTruncationStrategy TruncationStrategy { get; set; }
632 protected virtual RunCreationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
633 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
634 protected virtual RunCreationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
635 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
636 }
637 [Experimental("OPENAI001")]
638 public class RunError : IJsonModel<RunError>, IPersistableModel<RunError> {
639 public RunErrorCode Code { get; }
640 public string Message { get; }
641 protected virtual RunError JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
642 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
643 protected virtual RunError PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
644 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
645 }
646 [Experimental("OPENAI001")]
647 public readonly partial struct RunErrorCode : IEquatable<RunErrorCode> {
648 public RunErrorCode(string value);
649 public static RunErrorCode InvalidPrompt { get; }
650 public static RunErrorCode RateLimitExceeded { get; }
651 public static RunErrorCode ServerError { get; }
652 public readonly bool Equals(RunErrorCode other);
653 [EditorBrowsable(EditorBrowsableState.Never)]
654 public override readonly bool Equals(object obj);
655 [EditorBrowsable(EditorBrowsableState.Never)]
656 public override readonly int GetHashCode();
657 public static bool operator ==(RunErrorCode left, RunErrorCode right);
658 public static implicit operator RunErrorCode(string value);
659 public static implicit operator RunErrorCode?(string value);
660 public static bool operator !=(RunErrorCode left, RunErrorCode right);
661 public override readonly string ToString();
662 }
663 [Experimental("OPENAI001")]
664 public class RunIncompleteDetails : IJsonModel<RunIncompleteDetails>, IPersistableModel<RunIncompleteDetails> {
665 public RunIncompleteReason? Reason { get; }
666 protected virtual RunIncompleteDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
667 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
668 protected virtual RunIncompleteDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
669 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
670 }
671 [Experimental("OPENAI001")]
672 public readonly partial struct RunIncompleteReason : IEquatable<RunIncompleteReason> {
673 public RunIncompleteReason(string value);
674 public static RunIncompleteReason MaxInputTokenCount { get; }
675 public static RunIncompleteReason MaxOutputTokenCount { get; }
676 public readonly bool Equals(RunIncompleteReason other);
677 [EditorBrowsable(EditorBrowsableState.Never)]
678 public override readonly bool Equals(object obj);
679 [EditorBrowsable(EditorBrowsableState.Never)]
680 public override readonly int GetHashCode();
681 public static bool operator ==(RunIncompleteReason left, RunIncompleteReason right);
682 public static implicit operator RunIncompleteReason(string value);
683 public static implicit operator RunIncompleteReason?(string value);
684 public static bool operator !=(RunIncompleteReason left, RunIncompleteReason right);
685 public override readonly string ToString();
686 }
687 [Experimental("OPENAI001")]
688 public class RunModificationOptions : IJsonModel<RunModificationOptions>, IPersistableModel<RunModificationOptions> {
689 public IDictionary<string, string> Metadata { get; }
690 protected virtual RunModificationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
691 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
692 protected virtual RunModificationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
693 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
694 }
695 [Experimental("OPENAI001")]
696 public readonly partial struct RunStatus : IEquatable<RunStatus> {
697 public RunStatus(string value);
698 public static RunStatus Cancelled { get; }
699 public static RunStatus Cancelling { get; }
700 public static RunStatus Completed { get; }
701 public static RunStatus Expired { get; }
702 public static RunStatus Failed { get; }
703 public static RunStatus Incomplete { get; }
704 public static RunStatus InProgress { get; }
705 public bool IsTerminal { get; }
706 public static RunStatus Queued { get; }
707 public static RunStatus RequiresAction { get; }
708 public readonly bool Equals(RunStatus other);
709 [EditorBrowsable(EditorBrowsableState.Never)]
710 public override readonly bool Equals(object obj);
711 [EditorBrowsable(EditorBrowsableState.Never)]
712 public override readonly int GetHashCode();
713 public static bool operator ==(RunStatus left, RunStatus right);
714 public static implicit operator RunStatus(string value);
715 public static implicit operator RunStatus?(string value);
716 public static bool operator !=(RunStatus left, RunStatus right);
717 public override readonly string ToString();
718 }
719 [Experimental("OPENAI001")]
720 public class RunStep : IJsonModel<RunStep>, IPersistableModel<RunStep> {
721 public string AssistantId { get; }
722 public DateTimeOffset? CancelledAt { get; }
723 public DateTimeOffset? CompletedAt { get; }
724 public DateTimeOffset CreatedAt { get; }
725 public RunStepDetails Details { get; }
726 public DateTimeOffset? ExpiredAt { get; }
727 public DateTimeOffset? FailedAt { get; }
728 public string Id { get; }
729 public RunStepKind Kind { get; }
730 public RunStepError LastError { get; }
731 public IReadOnlyDictionary<string, string> Metadata { get; }
732 public string RunId { get; }
733 public RunStepStatus Status { get; }
734 public string ThreadId { get; }
735 public RunStepTokenUsage Usage { get; }
736 protected virtual RunStep JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
737 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
738 public static explicit operator RunStep(ClientResult result);
739 protected virtual RunStep PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
740 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
741 }
742 [Experimental("OPENAI001")]
743 public abstract class RunStepCodeInterpreterOutput : IJsonModel<RunStepCodeInterpreterOutput>, IPersistableModel<RunStepCodeInterpreterOutput> {
744 public string ImageFileId { get; }
745 public string Logs { get; }
746 protected virtual RunStepCodeInterpreterOutput JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
747 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
748 protected virtual RunStepCodeInterpreterOutput PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
749 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
750 }
751 [Experimental("OPENAI001")]
752 public class RunStepCollectionOptions : IJsonModel<RunStepCollectionOptions>, IPersistableModel<RunStepCollectionOptions> {
753 public string AfterId { get; set; }
754 public string BeforeId { get; set; }
755 public RunStepCollectionOrder? Order { get; set; }
756 public int? PageSizeLimit { get; set; }
757 protected virtual RunStepCollectionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
758 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
759 protected virtual RunStepCollectionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
760 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
761 }
762 [Experimental("OPENAI001")]
763 public readonly partial struct RunStepCollectionOrder : IEquatable<RunStepCollectionOrder> {
764 public RunStepCollectionOrder(string value);
765 public static RunStepCollectionOrder Ascending { get; }
766 public static RunStepCollectionOrder Descending { get; }
767 public readonly bool Equals(RunStepCollectionOrder other);
768 [EditorBrowsable(EditorBrowsableState.Never)]
769 public override readonly bool Equals(object obj);
770 [EditorBrowsable(EditorBrowsableState.Never)]
771 public override readonly int GetHashCode();
772 public static bool operator ==(RunStepCollectionOrder left, RunStepCollectionOrder right);
773 public static implicit operator RunStepCollectionOrder(string value);
774 public static implicit operator RunStepCollectionOrder?(string value);
775 public static bool operator !=(RunStepCollectionOrder left, RunStepCollectionOrder right);
776 public override readonly string ToString();
777 }
778 [Experimental("OPENAI001")]
779 public abstract class RunStepDetails : IJsonModel<RunStepDetails>, IPersistableModel<RunStepDetails> {
780 public string CreatedMessageId { get; }
781 public IReadOnlyList<RunStepToolCall> ToolCalls { get; }
782 protected virtual RunStepDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
783 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
784 protected virtual RunStepDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
785 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
786 }
787 [Experimental("OPENAI001")]
788 public class RunStepDetailsUpdate : StreamingUpdate {
789 public string CodeInterpreterInput { get; }
790 public IReadOnlyList<RunStepUpdateCodeInterpreterOutput> CodeInterpreterOutputs { get; }
791 public string CreatedMessageId { get; }
792 public FileSearchRankingOptions FileSearchRankingOptions { get; }
793 public IReadOnlyList<RunStepFileSearchResult> FileSearchResults { get; }
794 public string FunctionArguments { get; }
795 public string FunctionName { get; }
796 public string FunctionOutput { get; }
797 public string StepId { get; }
798 public string ToolCallId { get; }
799 public int? ToolCallIndex { get; }
800 }
801 [Experimental("OPENAI001")]
802 public class RunStepError : IJsonModel<RunStepError>, IPersistableModel<RunStepError> {
803 public RunStepErrorCode Code { get; }
804 public string Message { get; }
805 protected virtual RunStepError JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
806 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
807 protected virtual RunStepError PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
808 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
809 }
810 [Experimental("OPENAI001")]
811 public readonly partial struct RunStepErrorCode : IEquatable<RunStepErrorCode> {
812 public RunStepErrorCode(string value);
813 public static RunStepErrorCode RateLimitExceeded { get; }
814 public static RunStepErrorCode ServerError { get; }
815 public readonly bool Equals(RunStepErrorCode other);
816 [EditorBrowsable(EditorBrowsableState.Never)]
817 public override readonly bool Equals(object obj);
818 [EditorBrowsable(EditorBrowsableState.Never)]
819 public override readonly int GetHashCode();
820 public static bool operator ==(RunStepErrorCode left, RunStepErrorCode right);
821 public static implicit operator RunStepErrorCode(string value);
822 public static implicit operator RunStepErrorCode?(string value);
823 public static bool operator !=(RunStepErrorCode left, RunStepErrorCode right);
824 public override readonly string ToString();
825 }
826 [Experimental("OPENAI001")]
827 public class RunStepFileSearchResult : IJsonModel<RunStepFileSearchResult>, IPersistableModel<RunStepFileSearchResult> {
828 public IReadOnlyList<RunStepFileSearchResultContent> Content { get; }
829 public string FileId { get; }
830 public string FileName { get; }
831 public float Score { get; }
832 protected virtual RunStepFileSearchResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
833 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
834 protected virtual RunStepFileSearchResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
835 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
836 }
837 [Experimental("OPENAI001")]
838 public class RunStepFileSearchResultContent : IJsonModel<RunStepFileSearchResultContent>, IPersistableModel<RunStepFileSearchResultContent> {
839 public RunStepFileSearchResultContentKind Kind { get; }
840 public string Text { get; }
841 protected virtual RunStepFileSearchResultContent JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
842 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
843 protected virtual RunStepFileSearchResultContent PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
844 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
845 }
846 [Experimental("OPENAI001")]
847 public enum RunStepFileSearchResultContentKind {
848 Text = 0
849 }
850 [Experimental("OPENAI001")]
851 public enum RunStepKind {
852 CreatedMessage = 0,
853 ToolCall = 1
854 }
855 [Experimental("OPENAI001")]
856 public readonly partial struct RunStepStatus : IEquatable<RunStepStatus> {
857 public RunStepStatus(string value);
858 public static RunStepStatus Cancelled { get; }
859 public static RunStepStatus Completed { get; }
860 public static RunStepStatus Expired { get; }
861 public static RunStepStatus Failed { get; }
862 public static RunStepStatus InProgress { get; }
863 public readonly bool Equals(RunStepStatus other);
864 [EditorBrowsable(EditorBrowsableState.Never)]
865 public override readonly bool Equals(object obj);
866 [EditorBrowsable(EditorBrowsableState.Never)]
867 public override readonly int GetHashCode();
868 public static bool operator ==(RunStepStatus left, RunStepStatus right);
869 public static implicit operator RunStepStatus(string value);
870 public static implicit operator RunStepStatus?(string value);
871 public static bool operator !=(RunStepStatus left, RunStepStatus right);
872 public override readonly string ToString();
873 }
874 [Experimental("OPENAI001")]
875 public class RunStepTokenUsage : IJsonModel<RunStepTokenUsage>, IPersistableModel<RunStepTokenUsage> {
876 public int InputTokenCount { get; }
877 public int OutputTokenCount { get; }
878 public int TotalTokenCount { get; }
879 protected virtual RunStepTokenUsage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
880 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
881 protected virtual RunStepTokenUsage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
882 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
883 }
884 [Experimental("OPENAI001")]
885 public class RunStepToolCall : IJsonModel<RunStepToolCall>, IPersistableModel<RunStepToolCall> {
886 public string CodeInterpreterInput { get; }
887 public IReadOnlyList<RunStepCodeInterpreterOutput> CodeInterpreterOutputs { get; }
888 public FileSearchRankingOptions FileSearchRankingOptions { get; }
889 public IReadOnlyList<RunStepFileSearchResult> FileSearchResults { get; }
890 public string FunctionArguments { get; }
891 public string FunctionName { get; }
892 public string FunctionOutput { get; }
893 public string Id { get; }
894 public RunStepToolCallKind Kind { get; }
895 protected virtual RunStepToolCall JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
896 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
897 protected virtual RunStepToolCall PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
898 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
899 }
900 [Experimental("OPENAI001")]
901 public enum RunStepToolCallKind {
902 CodeInterpreter = 0,
903 FileSearch = 1,
904 Function = 2
905 }
906 [Experimental("OPENAI001")]
907 public class RunStepUpdate : StreamingUpdate<RunStep> {
908 }
909 [Experimental("OPENAI001")]
910 public class RunStepUpdateCodeInterpreterOutput : IJsonModel<RunStepUpdateCodeInterpreterOutput>, IPersistableModel<RunStepUpdateCodeInterpreterOutput> {
911 public string ImageFileId { get; }
912 public string Logs { get; }
913 public int OutputIndex { get; }
914 protected virtual RunStepUpdateCodeInterpreterOutput JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
915 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
916 protected virtual RunStepUpdateCodeInterpreterOutput PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
917 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
918 }
919 [Experimental("OPENAI001")]
920 public class RunTokenUsage : IJsonModel<RunTokenUsage>, IPersistableModel<RunTokenUsage> {
921 public int InputTokenCount { get; }
922 public int OutputTokenCount { get; }
923 public int TotalTokenCount { get; }
924 protected virtual RunTokenUsage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
925 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
926 protected virtual RunTokenUsage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
927 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
928 }
929 [Experimental("OPENAI001")]
930 public class RunTruncationStrategy : IJsonModel<RunTruncationStrategy>, IPersistableModel<RunTruncationStrategy> {
931 public static RunTruncationStrategy Auto { get; }
932 public int? LastMessages { get; }
933 public static RunTruncationStrategy CreateLastMessagesStrategy(int lastMessageCount);
934 protected virtual RunTruncationStrategy JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
935 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
936 protected virtual RunTruncationStrategy PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
937 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
938 }
939 [Experimental("OPENAI001")]
940 public class RunUpdate : StreamingUpdate<ThreadRun> {
941 }
942 [Experimental("OPENAI001")]
943 public abstract class StreamingUpdate {
944 public StreamingUpdateReason UpdateKind { get; }
945 }
946 [Experimental("OPENAI001")]
947 public enum StreamingUpdateReason {
948 Unknown = 0,
949 ThreadCreated = 1,
950 RunCreated = 2,
951 RunQueued = 3,
952 RunInProgress = 4,
953 RunRequiresAction = 5,
954 RunCompleted = 6,
955 RunIncomplete = 7,
956 RunFailed = 8,
957 RunCancelling = 9,
958 RunCancelled = 10,
959 RunExpired = 11,
960 RunStepCreated = 12,
961 RunStepInProgress = 13,
962 RunStepUpdated = 14,
963 RunStepCompleted = 15,
964 RunStepFailed = 16,
965 RunStepCancelled = 17,
966 RunStepExpired = 18,
967 MessageCreated = 19,
968 MessageInProgress = 20,
969 MessageUpdated = 21,
970 MessageCompleted = 22,
971 MessageFailed = 23,
972 Error = 24,
973 Done = 25
974 }
975 [Experimental("OPENAI001")]
976 public class StreamingUpdate<T> : StreamingUpdate where T : class {
977 public T Value { get; }
978 public static implicit operator T(StreamingUpdate<T> update);
979 }
980 [Experimental("OPENAI001")]
981 public class TextAnnotation {
982 public int EndIndex { get; }
983 public string InputFileId { get; }
984 public string OutputFileId { get; }
985 public int StartIndex { get; }
986 public string TextToReplace { get; }
987 }
988 [Experimental("OPENAI001")]
989 public class TextAnnotationUpdate {
990 public int ContentIndex { get; }
991 public int? EndIndex { get; }
992 public string InputFileId { get; }
993 public string OutputFileId { get; }
994 public int? StartIndex { get; }
995 public string TextToReplace { get; }
996 }
997 [Experimental("OPENAI001")]
998 public class ThreadCreationOptions : IJsonModel<ThreadCreationOptions>, IPersistableModel<ThreadCreationOptions> {
999 public IList<ThreadInitializationMessage> InitialMessages { get; }
1000 public IDictionary<string, string> Metadata { get; }
1001 public ToolResources ToolResources { get; set; }
1002 protected virtual ThreadCreationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1003 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1004 protected virtual ThreadCreationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1005 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1006 }
1007 [Experimental("OPENAI001")]
1008 public class ThreadDeletionResult : IJsonModel<ThreadDeletionResult>, IPersistableModel<ThreadDeletionResult> {
1009 public bool Deleted { get; }
1010 public string ThreadId { get; }
1011 protected virtual ThreadDeletionResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1012 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1013 public static explicit operator ThreadDeletionResult(ClientResult result);
1014 protected virtual ThreadDeletionResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1015 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1016 }
1017 [Experimental("OPENAI001")]
1018 public class ThreadInitializationMessage : MessageCreationOptions {
1019 public ThreadInitializationMessage(MessageRole role, IEnumerable<MessageContent> content);
1020 public static implicit operator ThreadInitializationMessage(string initializationMessage);
1021 }
1022 [Experimental("OPENAI001")]
1023 public class ThreadMessage : IJsonModel<ThreadMessage>, IPersistableModel<ThreadMessage> {
1024 public string AssistantId { get; }
1025 public IReadOnlyList<MessageCreationAttachment> Attachments { get; }
1026 public DateTimeOffset? CompletedAt { get; }
1027 public IReadOnlyList<MessageContent> Content { get; }
1028 public DateTimeOffset CreatedAt { get; }
1029 public string Id { get; }
1030 public DateTimeOffset? IncompleteAt { get; }
1031 public MessageFailureDetails IncompleteDetails { get; }
1032 public IReadOnlyDictionary<string, string> Metadata { get; }
1033 public MessageRole Role { get; }
1034 public string RunId { get; }
1035 public MessageStatus Status { get; }
1036 public string ThreadId { get; }
1037 protected virtual ThreadMessage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1038 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1039 public static explicit operator ThreadMessage(ClientResult result);
1040 protected virtual ThreadMessage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1041 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1042 }
1043 [Experimental("OPENAI001")]
1044 public class ThreadModificationOptions : IJsonModel<ThreadModificationOptions>, IPersistableModel<ThreadModificationOptions> {
1045 public IDictionary<string, string> Metadata { get; }
1046 public ToolResources ToolResources { get; set; }
1047 protected virtual ThreadModificationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1048 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1049 protected virtual ThreadModificationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1050 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1051 }
1052 [Experimental("OPENAI001")]
1053 public class ThreadRun : IJsonModel<ThreadRun>, IPersistableModel<ThreadRun> {
1054 public bool? AllowParallelToolCalls { get; }
1055 public string AssistantId { get; }
1056 public DateTimeOffset? CancelledAt { get; }
1057 public DateTimeOffset? CompletedAt { get; }
1058 public DateTimeOffset CreatedAt { get; }
1059 public DateTimeOffset? ExpiresAt { get; }
1060 public DateTimeOffset? FailedAt { get; }
1061 public string Id { get; }
1062 public RunIncompleteDetails IncompleteDetails { get; }
1063 public string Instructions { get; }
1064 public RunError LastError { get; }
1065 public int? MaxInputTokenCount { get; }
1066 public int? MaxOutputTokenCount { get; }
1067 public IReadOnlyDictionary<string, string> Metadata { get; }
1068 public string Model { get; }
1069 public float? NucleusSamplingFactor { get; }
1070 public IReadOnlyList<RequiredAction> RequiredActions { get; }
1071 public AssistantResponseFormat ResponseFormat { get; }
1072 public DateTimeOffset? StartedAt { get; }
1073 public RunStatus Status { get; }
1074 public float? Temperature { get; }
1075 public string ThreadId { get; }
1076 public ToolConstraint ToolConstraint { get; }
1077 public IReadOnlyList<ToolDefinition> Tools { get; }
1078 public RunTruncationStrategy TruncationStrategy { get; }
1079 public RunTokenUsage Usage { get; }
1080 protected virtual ThreadRun JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1081 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1082 public static explicit operator ThreadRun(ClientResult result);
1083 protected virtual ThreadRun PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1084 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1085 }
1086 [Experimental("OPENAI001")]
1087 public class ThreadUpdate : StreamingUpdate<AssistantThread> {
1088 public DateTimeOffset CreatedAt { get; }
1089 public string Id { get; }
1090 public IReadOnlyDictionary<string, string> Metadata { get; }
1091 public ToolResources ToolResources { get; }
1092 }
1093 [Experimental("OPENAI001")]
1094 public class ToolConstraint : IJsonModel<ToolConstraint>, IPersistableModel<ToolConstraint> {
1095 public ToolConstraint(ToolDefinition toolDefinition);
1096 public static ToolConstraint Auto { get; }
1097 public static ToolConstraint None { get; }
1098 public static ToolConstraint Required { get; }
1099 protected virtual ToolConstraint JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1100 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1101 protected virtual ToolConstraint PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1102 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1103 }
1104 [Experimental("OPENAI001")]
1105 public class ToolDefinition : IJsonModel<ToolDefinition>, IPersistableModel<ToolDefinition> {
1106 public static CodeInterpreterToolDefinition CreateCodeInterpreter();
1107 public static FileSearchToolDefinition CreateFileSearch(int? maxResults = null);
1108 public static FunctionToolDefinition CreateFunction(string name, string description = null, BinaryData parameters = null, bool? strictParameterSchemaEnabled = null);
1109 protected virtual ToolDefinition JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1110 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1111 protected virtual ToolDefinition PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1112 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1113 }
1114 [Experimental("OPENAI001")]
1115 public class ToolOutput : IJsonModel<ToolOutput>, IPersistableModel<ToolOutput> {
1116 public ToolOutput();
1117 public ToolOutput(string toolCallId, string output);
1118 public string Output { get; set; }
1119 public string ToolCallId { get; set; }
1120 protected virtual ToolOutput JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1121 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1122 protected virtual ToolOutput PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1123 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1124 }
1125 [Experimental("OPENAI001")]
1126 public class ToolResources : IJsonModel<ToolResources>, IPersistableModel<ToolResources> {
1127 public CodeInterpreterToolResources CodeInterpreter { get; set; }
1128 public FileSearchToolResources FileSearch { get; set; }
1129 protected virtual ToolResources JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1130 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1131 protected virtual ToolResources PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1132 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1133 }
1134 [Experimental("OPENAI001")]
1135 public class VectorStoreCreationHelper : IJsonModel<VectorStoreCreationHelper>, IPersistableModel<VectorStoreCreationHelper> {
1136 public VectorStoreCreationHelper();
1137 public VectorStoreCreationHelper(IEnumerable<OpenAIFile> files);
1138 public VectorStoreCreationHelper(IEnumerable<string> fileIds);
1139 public FileChunkingStrategy ChunkingStrategy { get; set; }
1140 public IList<string> FileIds { get; }
1141 public IDictionary<string, string> Metadata { get; }
1142 protected virtual VectorStoreCreationHelper JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1143 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1144 protected virtual VectorStoreCreationHelper PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1145 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1146 }
1147}
1148namespace OpenAI.Audio {
1149 public class AudioClient {
1150 protected AudioClient();
1151 [Experimental("SCME0002")]
1152 public AudioClient(AudioClientSettings settings);
1153 protected internal AudioClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
1154 public AudioClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
1155 public AudioClient(string model, ApiKeyCredential credential);
1156 [Experimental("OPENAI001")]
1157 public AudioClient(string model, AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
1158 [Experimental("OPENAI001")]
1159 public AudioClient(string model, AuthenticationPolicy authenticationPolicy);
1160 public AudioClient(string model, string apiKey);
1161 [Experimental("OPENAI001")]
1162 public Uri Endpoint { get; }
1163 [Experimental("OPENAI001")]
1164 public string Model { get; }
1165 public ClientPipeline Pipeline { get; }
1166 public virtual ClientResult GenerateSpeech(BinaryContent content, RequestOptions options = null);
1167 public virtual ClientResult<BinaryData> GenerateSpeech(string text, GeneratedSpeechVoice voice, SpeechGenerationOptions options = null, CancellationToken cancellationToken = default);
1168 public virtual Task<ClientResult> GenerateSpeechAsync(BinaryContent content, RequestOptions options = null);
1169 public virtual Task<ClientResult<BinaryData>> GenerateSpeechAsync(string text, GeneratedSpeechVoice voice, SpeechGenerationOptions options = null, CancellationToken cancellationToken = default);
1170 public virtual ClientResult TranscribeAudio(BinaryContent content, string contentType, RequestOptions options = null);
1171 public virtual ClientResult<AudioTranscription> TranscribeAudio(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
1172 public virtual ClientResult<AudioTranscription> TranscribeAudio(string audioFilePath, AudioTranscriptionOptions options = null);
1173 public virtual Task<ClientResult> TranscribeAudioAsync(BinaryContent content, string contentType, RequestOptions options = null);
1174 public virtual Task<ClientResult<AudioTranscription>> TranscribeAudioAsync(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
1175 public virtual Task<ClientResult<AudioTranscription>> TranscribeAudioAsync(string audioFilePath, AudioTranscriptionOptions options = null);
1176 [Experimental("OPENAI001")]
1177 public virtual CollectionResult<StreamingAudioTranscriptionUpdate> TranscribeAudioStreaming(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
1178 [Experimental("OPENAI001")]
1179 public virtual CollectionResult<StreamingAudioTranscriptionUpdate> TranscribeAudioStreaming(string audioFilePath, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
1180 [Experimental("OPENAI001")]
1181 public virtual AsyncCollectionResult<StreamingAudioTranscriptionUpdate> TranscribeAudioStreamingAsync(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
1182 [Experimental("OPENAI001")]
1183 public virtual AsyncCollectionResult<StreamingAudioTranscriptionUpdate> TranscribeAudioStreamingAsync(string audioFilePath, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
1184 public virtual ClientResult TranslateAudio(BinaryContent content, string contentType, RequestOptions options = null);
1185 public virtual ClientResult<AudioTranslation> TranslateAudio(Stream audio, string audioFilename, AudioTranslationOptions options = null, CancellationToken cancellationToken = default);
1186 public virtual ClientResult<AudioTranslation> TranslateAudio(string audioFilePath, AudioTranslationOptions options = null);
1187 public virtual Task<ClientResult> TranslateAudioAsync(BinaryContent content, string contentType, RequestOptions options = null);
1188 public virtual Task<ClientResult<AudioTranslation>> TranslateAudioAsync(Stream audio, string audioFilename, AudioTranslationOptions options = null, CancellationToken cancellationToken = default);
1189 public virtual Task<ClientResult<AudioTranslation>> TranslateAudioAsync(string audioFilePath, AudioTranslationOptions options = null);
1190 }
1191 [Experimental("SCME0002")]
1192 public sealed class AudioClientSettings : ClientSettings {
1193 public string Model { get; set; }
1194 public OpenAIClientOptions Options { get; set; }
1195 protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
1196 }
1197 [Flags]
1198 public enum AudioTimestampGranularities {
1199 Default = 0,
1200 Word = 1,
1201 Segment = 2
1202 }
1203 [Experimental("OPENAI001")]
1204 public class AudioTokenLogProbabilityDetails : IJsonModel<AudioTokenLogProbabilityDetails>, IPersistableModel<AudioTokenLogProbabilityDetails> {
1205 public float LogProbability { get; }
1206 public string Token { get; }
1207 public ReadOnlyMemory<byte> Utf8Bytes { get; }
1208 protected virtual AudioTokenLogProbabilityDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1209 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1210 protected virtual AudioTokenLogProbabilityDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1211 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1212 }
1213 public class AudioTranscription : IJsonModel<AudioTranscription>, IPersistableModel<AudioTranscription> {
1214 public TimeSpan? Duration { get; }
1215 public string Language { get; }
1216 public IReadOnlyList<TranscribedSegment> Segments { get; }
1217 public string Text { get; }
1218 [Experimental("OPENAI001")]
1219 public IReadOnlyList<AudioTokenLogProbabilityDetails> TranscriptionTokenLogProbabilities { get; }
1220 public IReadOnlyList<TranscribedWord> Words { get; }
1221 [Experimental("OPENAI001")]
1222 protected virtual AudioTranscription JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1223 [Experimental("OPENAI001")]
1224 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1225 [Experimental("OPENAI001")]
1226 public static explicit operator AudioTranscription(ClientResult result);
1227 [Experimental("OPENAI001")]
1228 protected virtual AudioTranscription PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1229 [Experimental("OPENAI001")]
1230 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1231 }
1232 public readonly partial struct AudioTranscriptionFormat : IEquatable<AudioTranscriptionFormat> {
1233 public AudioTranscriptionFormat(string value);
1234 public static AudioTranscriptionFormat Simple { get; }
1235 public static AudioTranscriptionFormat Srt { get; }
1236 [EditorBrowsable(EditorBrowsableState.Never)]
1237 public static AudioTranscriptionFormat Text { get; }
1238 public static AudioTranscriptionFormat Verbose { get; }
1239 public static AudioTranscriptionFormat Vtt { get; }
1240 public readonly bool Equals(AudioTranscriptionFormat other);
1241 [EditorBrowsable(EditorBrowsableState.Never)]
1242 public override readonly bool Equals(object obj);
1243 [EditorBrowsable(EditorBrowsableState.Never)]
1244 public override readonly int GetHashCode();
1245 public static bool operator ==(AudioTranscriptionFormat left, AudioTranscriptionFormat right);
1246 public static implicit operator AudioTranscriptionFormat(string value);
1247 public static implicit operator AudioTranscriptionFormat?(string value);
1248 public static bool operator !=(AudioTranscriptionFormat left, AudioTranscriptionFormat right);
1249 public override readonly string ToString();
1250 }
1251 [Experimental("OPENAI001")]
1252 [Flags]
1253 public enum AudioTranscriptionIncludes {
1254 Default = 0,
1255 Logprobs = 1
1256 }
1257 public class AudioTranscriptionOptions : IJsonModel<AudioTranscriptionOptions>, IPersistableModel<AudioTranscriptionOptions> {
1258 [Experimental("OPENAI001")]
1259 public AudioTranscriptionIncludes Includes { get; set; }
1260 public string Language { get; set; }
1261 public string Prompt { get; set; }
1262 public AudioTranscriptionFormat? ResponseFormat { get; set; }
1263 public float? Temperature { get; set; }
1264 public AudioTimestampGranularities TimestampGranularities { get; set; }
1265 [Experimental("OPENAI001")]
1266 protected virtual AudioTranscriptionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1267 [Experimental("OPENAI001")]
1268 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1269 [Experimental("OPENAI001")]
1270 protected virtual AudioTranscriptionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1271 [Experimental("OPENAI001")]
1272 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1273 }
1274 public class AudioTranslation : IJsonModel<AudioTranslation>, IPersistableModel<AudioTranslation> {
1275 public TimeSpan? Duration { get; }
1276 public string Language { get; }
1277 public IReadOnlyList<TranscribedSegment> Segments { get; }
1278 public string Text { get; }
1279 [Experimental("OPENAI001")]
1280 protected virtual AudioTranslation JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1281 [Experimental("OPENAI001")]
1282 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1283 [Experimental("OPENAI001")]
1284 public static explicit operator AudioTranslation(ClientResult result);
1285 [Experimental("OPENAI001")]
1286 protected virtual AudioTranslation PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1287 [Experimental("OPENAI001")]
1288 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1289 }
1290 public readonly partial struct AudioTranslationFormat : IEquatable<AudioTranslationFormat> {
1291 public AudioTranslationFormat(string value);
1292 public static AudioTranslationFormat Simple { get; }
1293 public static AudioTranslationFormat Srt { get; }
1294 [EditorBrowsable(EditorBrowsableState.Never)]
1295 public static AudioTranslationFormat Text { get; }
1296 public static AudioTranslationFormat Verbose { get; }
1297 public static AudioTranslationFormat Vtt { get; }
1298 public readonly bool Equals(AudioTranslationFormat other);
1299 [EditorBrowsable(EditorBrowsableState.Never)]
1300 public override readonly bool Equals(object obj);
1301 [EditorBrowsable(EditorBrowsableState.Never)]
1302 public override readonly int GetHashCode();
1303 public static bool operator ==(AudioTranslationFormat left, AudioTranslationFormat right);
1304 public static implicit operator AudioTranslationFormat(string value);
1305 public static implicit operator AudioTranslationFormat?(string value);
1306 public static bool operator !=(AudioTranslationFormat left, AudioTranslationFormat right);
1307 public override readonly string ToString();
1308 }
1309 public class AudioTranslationOptions : IJsonModel<AudioTranslationOptions>, IPersistableModel<AudioTranslationOptions> {
1310 public string Prompt { get; set; }
1311 public AudioTranslationFormat? ResponseFormat { get; set; }
1312 public float? Temperature { get; set; }
1313 [Experimental("OPENAI001")]
1314 protected virtual AudioTranslationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1315 [Experimental("OPENAI001")]
1316 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1317 [Experimental("OPENAI001")]
1318 protected virtual AudioTranslationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1319 [Experimental("OPENAI001")]
1320 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1321 }
1322 public readonly partial struct GeneratedSpeechFormat : IEquatable<GeneratedSpeechFormat> {
1323 public GeneratedSpeechFormat(string value);
1324 public static GeneratedSpeechFormat Aac { get; }
1325 public static GeneratedSpeechFormat Flac { get; }
1326 public static GeneratedSpeechFormat Mp3 { get; }
1327 public static GeneratedSpeechFormat Opus { get; }
1328 public static GeneratedSpeechFormat Pcm { get; }
1329 public static GeneratedSpeechFormat Wav { get; }
1330 public readonly bool Equals(GeneratedSpeechFormat other);
1331 [EditorBrowsable(EditorBrowsableState.Never)]
1332 public override readonly bool Equals(object obj);
1333 [EditorBrowsable(EditorBrowsableState.Never)]
1334 public override readonly int GetHashCode();
1335 public static bool operator ==(GeneratedSpeechFormat left, GeneratedSpeechFormat right);
1336 public static implicit operator GeneratedSpeechFormat(string value);
1337 public static implicit operator GeneratedSpeechFormat?(string value);
1338 public static bool operator !=(GeneratedSpeechFormat left, GeneratedSpeechFormat right);
1339 public override readonly string ToString();
1340 }
1341 public readonly partial struct GeneratedSpeechVoice : IEquatable<GeneratedSpeechVoice> {
1342 public GeneratedSpeechVoice(string value);
1343 public static GeneratedSpeechVoice Alloy { get; }
1344 [Experimental("OPENAI001")]
1345 public static GeneratedSpeechVoice Ash { get; }
1346 [Experimental("OPENAI001")]
1347 public static GeneratedSpeechVoice Ballad { get; }
1348 [Experimental("OPENAI001")]
1349 public static GeneratedSpeechVoice Coral { get; }
1350 public static GeneratedSpeechVoice Echo { get; }
1351 public static GeneratedSpeechVoice Fable { get; }
1352 public static GeneratedSpeechVoice Nova { get; }
1353 public static GeneratedSpeechVoice Onyx { get; }
1354 [Experimental("OPENAI001")]
1355 public static GeneratedSpeechVoice Sage { get; }
1356 public static GeneratedSpeechVoice Shimmer { get; }
1357 [Experimental("OPENAI001")]
1358 public static GeneratedSpeechVoice Verse { get; }
1359 public readonly bool Equals(GeneratedSpeechVoice other);
1360 [EditorBrowsable(EditorBrowsableState.Never)]
1361 public override readonly bool Equals(object obj);
1362 [EditorBrowsable(EditorBrowsableState.Never)]
1363 public override readonly int GetHashCode();
1364 public static bool operator ==(GeneratedSpeechVoice left, GeneratedSpeechVoice right);
1365 public static implicit operator GeneratedSpeechVoice(string value);
1366 public static implicit operator GeneratedSpeechVoice?(string value);
1367 public static bool operator !=(GeneratedSpeechVoice left, GeneratedSpeechVoice right);
1368 public override readonly string ToString();
1369 }
1370 public static class OpenAIAudioModelFactory {
1371 [Experimental("OPENAI001")]
1372 public static AudioTranscription AudioTranscription(string language = null, TimeSpan? duration = null, string text = null, IEnumerable<TranscribedWord> words = null, IEnumerable<TranscribedSegment> segments = null, IEnumerable<AudioTokenLogProbabilityDetails> transcriptionTokenLogProbabilities = null);
1373 [EditorBrowsable(EditorBrowsableState.Never)]
1374 public static AudioTranscription AudioTranscription(string language, TimeSpan? duration, string text, IEnumerable<TranscribedWord> words, IEnumerable<TranscribedSegment> segments);
1375 public static AudioTranslation AudioTranslation(string language = null, TimeSpan? duration = null, string text = null, IEnumerable<TranscribedSegment> segments = null);
1376 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);
1377 public static TranscribedWord TranscribedWord(string word = null, TimeSpan startTime = default, TimeSpan endTime = default);
1378 }
1379 public class SpeechGenerationOptions : IJsonModel<SpeechGenerationOptions>, IPersistableModel<SpeechGenerationOptions> {
1380 [Experimental("OPENAI001")]
1381 public string Instructions { get; set; }
1382 public GeneratedSpeechFormat? ResponseFormat { get; set; }
1383 public float? SpeedRatio { get; set; }
1384 [Experimental("OPENAI001")]
1385 protected virtual SpeechGenerationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1386 [Experimental("OPENAI001")]
1387 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1388 [Experimental("OPENAI001")]
1389 protected virtual SpeechGenerationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1390 [Experimental("OPENAI001")]
1391 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1392 }
1393 [Experimental("OPENAI001")]
1394 public class StreamingAudioTranscriptionTextDeltaUpdate : StreamingAudioTranscriptionUpdate, IJsonModel<StreamingAudioTranscriptionTextDeltaUpdate>, IPersistableModel<StreamingAudioTranscriptionTextDeltaUpdate> {
1395 public string Delta { get; }
1396 public string SegmentId { get; }
1397 public IReadOnlyList<AudioTokenLogProbabilityDetails> TranscriptionTokenLogProbabilities { get; }
1398 protected override StreamingAudioTranscriptionUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1399 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1400 protected override StreamingAudioTranscriptionUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1401 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1402 }
1403 [Experimental("OPENAI001")]
1404 public class StreamingAudioTranscriptionTextDoneUpdate : StreamingAudioTranscriptionUpdate, IJsonModel<StreamingAudioTranscriptionTextDoneUpdate>, IPersistableModel<StreamingAudioTranscriptionTextDoneUpdate> {
1405 public string Text { get; }
1406 public IReadOnlyList<AudioTokenLogProbabilityDetails> TranscriptionTokenLogProbabilities { get; }
1407 protected override StreamingAudioTranscriptionUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1408 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1409 protected override StreamingAudioTranscriptionUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1410 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1411 }
1412 [Experimental("OPENAI001")]
1413 public class StreamingAudioTranscriptionTextSegmentUpdate : StreamingAudioTranscriptionUpdate, IJsonModel<StreamingAudioTranscriptionTextSegmentUpdate>, IPersistableModel<StreamingAudioTranscriptionTextSegmentUpdate> {
1414 public TimeSpan EndTime { get; }
1415 public string SegmentId { get; }
1416 public string SpeakerLabel { get; }
1417 public TimeSpan StartTime { get; }
1418 public string Text { get; }
1419 protected override StreamingAudioTranscriptionUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1420 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1421 protected override StreamingAudioTranscriptionUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1422 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1423 }
1424 [Experimental("OPENAI001")]
1425 public class StreamingAudioTranscriptionUpdate : IJsonModel<StreamingAudioTranscriptionUpdate>, IPersistableModel<StreamingAudioTranscriptionUpdate> {
1426 protected virtual StreamingAudioTranscriptionUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1427 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1428 protected virtual StreamingAudioTranscriptionUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1429 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1430 }
1431 [Experimental("OPENAI001")]
1432 public readonly partial struct StreamingAudioTranscriptionUpdateKind : IEquatable<StreamingAudioTranscriptionUpdateKind> {
1433 public StreamingAudioTranscriptionUpdateKind(string value);
1434 public static StreamingAudioTranscriptionUpdateKind TranscriptTextDelta { get; }
1435 public static StreamingAudioTranscriptionUpdateKind TranscriptTextDone { get; }
1436 public static StreamingAudioTranscriptionUpdateKind TranscriptTextSegment { get; }
1437 public readonly bool Equals(StreamingAudioTranscriptionUpdateKind other);
1438 [EditorBrowsable(EditorBrowsableState.Never)]
1439 public override readonly bool Equals(object obj);
1440 [EditorBrowsable(EditorBrowsableState.Never)]
1441 public override readonly int GetHashCode();
1442 public static bool operator ==(StreamingAudioTranscriptionUpdateKind left, StreamingAudioTranscriptionUpdateKind right);
1443 public static implicit operator StreamingAudioTranscriptionUpdateKind(string value);
1444 public static implicit operator StreamingAudioTranscriptionUpdateKind?(string value);
1445 public static bool operator !=(StreamingAudioTranscriptionUpdateKind left, StreamingAudioTranscriptionUpdateKind right);
1446 public override readonly string ToString();
1447 }
1448 public readonly partial struct TranscribedSegment : IJsonModel<TranscribedSegment>, IPersistableModel<TranscribedSegment>, IJsonModel<object>, IPersistableModel<object> {
1449 public float AverageLogProbability { get; }
1450 public float CompressionRatio { get; }
1451 public TimeSpan EndTime { get; }
1452 public int Id { get; }
1453 public float NoSpeechProbability { get; }
1454 public int SeekOffset { get; }
1455 public TimeSpan StartTime { get; }
1456 public float Temperature { get; }
1457 public string Text { get; }
1458 public ReadOnlyMemory<int> TokenIds { get; }
1459 }
1460 public readonly partial struct TranscribedWord : IJsonModel<TranscribedWord>, IPersistableModel<TranscribedWord>, IJsonModel<object>, IPersistableModel<object> {
1461 public TimeSpan EndTime { get; }
1462 public TimeSpan StartTime { get; }
1463 public string Word { get; }
1464 }
1465}
1466namespace OpenAI.Batch {
1467 [Experimental("OPENAI001")]
1468 public class BatchClient {
1469 protected BatchClient();
1470 [Experimental("SCME0002")]
1471 public BatchClient(BatchClientSettings settings);
1472 public BatchClient(ApiKeyCredential credential, OpenAIClientOptions options);
1473 public BatchClient(ApiKeyCredential credential);
1474 public BatchClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
1475 public BatchClient(AuthenticationPolicy authenticationPolicy);
1476 protected internal BatchClient(ClientPipeline pipeline, OpenAIClientOptions options);
1477 public BatchClient(string apiKey);
1478 [Experimental("OPENAI001")]
1479 public Uri Endpoint { get; }
1480 public ClientPipeline Pipeline { get; }
1481 public virtual CreateBatchOperation CreateBatch(BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
1482 public virtual Task<CreateBatchOperation> CreateBatchAsync(BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
1483 public virtual ClientResult GetBatch(string batchId, RequestOptions options);
1484 public virtual Task<ClientResult> GetBatchAsync(string batchId, RequestOptions options);
1485 public virtual CollectionResult<BatchJob> GetBatches(BatchCollectionOptions options = null, CancellationToken cancellationToken = default);
1486 public virtual CollectionResult GetBatches(string after, int? limit, RequestOptions options);
1487 public virtual AsyncCollectionResult<BatchJob> GetBatchesAsync(BatchCollectionOptions options = null, CancellationToken cancellationToken = default);
1488 public virtual AsyncCollectionResult GetBatchesAsync(string after, int? limit, RequestOptions options);
1489 }
1490 [Experimental("SCME0002")]
1491 public sealed class BatchClientSettings : ClientSettings {
1492 public OpenAIClientOptions Options { get; set; }
1493 protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
1494 }
1495 [Experimental("OPENAI001")]
1496 public class BatchCollectionOptions : IJsonModel<BatchCollectionOptions>, IPersistableModel<BatchCollectionOptions> {
1497 public string AfterId { get; set; }
1498 public int? PageSizeLimit { get; set; }
1499 protected virtual BatchCollectionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1500 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1501 protected virtual BatchCollectionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1502 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1503 }
1504 [Experimental("OPENAI001")]
1505 public class BatchJob : IJsonModel<BatchJob>, IPersistableModel<BatchJob> {
1506 public DateTimeOffset? CancelledAt { get; }
1507 public DateTimeOffset? CancellingAt { get; }
1508 public DateTimeOffset? CompletedAt { get; }
1509 public string CompletionWindow { get; }
1510 public DateTimeOffset CreatedAt { get; }
1511 public string Endpoint { get; }
1512 public string ErrorFileId { get; }
1513 public DateTimeOffset? ExpiredAt { get; }
1514 public DateTimeOffset? ExpiresAt { get; }
1515 public DateTimeOffset? FailedAt { get; }
1516 public DateTimeOffset? FinalizingAt { get; }
1517 public string Id { get; }
1518 public DateTimeOffset? InProgressAt { get; }
1519 public string InputFileId { get; }
1520 public IDictionary<string, string> Metadata { get; }
1521 public string Object { get; }
1522 public string OutputFileId { get; }
1523 protected virtual BatchJob JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1524 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1525 public static explicit operator BatchJob(ClientResult result);
1526 protected virtual BatchJob PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1527 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1528 }
1529 [Experimental("OPENAI001")]
1530 public class CreateBatchOperation : OperationResult {
1531 public string BatchId { get; }
1532 public override ContinuationToken? RehydrationToken { get; protected set; }
1533 public virtual ClientResult Cancel(RequestOptions? options);
1534 public virtual Task<ClientResult> CancelAsync(RequestOptions? options);
1535 public virtual ClientResult GetBatch(RequestOptions? options);
1536 public virtual Task<ClientResult> GetBatchAsync(RequestOptions? options);
1537 public static CreateBatchOperation Rehydrate(BatchClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
1538 public static CreateBatchOperation Rehydrate(BatchClient client, string batchId, CancellationToken cancellationToken = default);
1539 public static Task<CreateBatchOperation> RehydrateAsync(BatchClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
1540 public static Task<CreateBatchOperation> RehydrateAsync(BatchClient client, string batchId, CancellationToken cancellationToken = default);
1541 public override ClientResult UpdateStatus(RequestOptions? options = null);
1542 public override ValueTask<ClientResult> UpdateStatusAsync(RequestOptions? options = null);
1543 }
1544}
1545namespace OpenAI.Chat {
1546 public class AssistantChatMessage : ChatMessage, IJsonModel<AssistantChatMessage>, IPersistableModel<AssistantChatMessage> {
1547 public AssistantChatMessage(ChatCompletion chatCompletion);
1548 [Obsolete("This constructor is obsolete. Please use the constructor that takes an IEnumerable<ChatToolCall> parameter instead.")]
1549 public AssistantChatMessage(ChatFunctionCall functionCall);
1550 public AssistantChatMessage(params ChatMessageContentPart[] contentParts);
1551 [Experimental("OPENAI001")]
1552 public AssistantChatMessage(ChatOutputAudioReference outputAudioReference);
1553 public AssistantChatMessage(IEnumerable<ChatMessageContentPart> contentParts);
1554 public AssistantChatMessage(IEnumerable<ChatToolCall> toolCalls);
1555 public AssistantChatMessage(string content);
1556 [Obsolete("This property is obsolete. Please use ToolCalls instead.")]
1557 public ChatFunctionCall FunctionCall { get; set; }
1558 [Experimental("OPENAI001")]
1559 public ChatOutputAudioReference OutputAudioReference { get; set; }
1560 public string ParticipantName { get; set; }
1561 public string Refusal { get; set; }
1562 public IList<ChatToolCall> ToolCalls { get; }
1563 [Experimental("OPENAI001")]
1564 protected override ChatMessage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1565 [Experimental("OPENAI001")]
1566 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1567 [Experimental("OPENAI001")]
1568 protected override ChatMessage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1569 [Experimental("OPENAI001")]
1570 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1571 }
1572 [Experimental("OPENAI001")]
1573 public class ChatAudioOptions : IJsonModel<ChatAudioOptions>, IPersistableModel<ChatAudioOptions> {
1574 public ChatAudioOptions(ChatOutputAudioVoice outputAudioVoice, ChatOutputAudioFormat outputAudioFormat);
1575 public ChatOutputAudioFormat OutputAudioFormat { get; }
1576 public ChatOutputAudioVoice OutputAudioVoice { get; }
1577 [Serialization.JsonIgnore]
1578 [EditorBrowsable(EditorBrowsableState.Never)]
1579 [Experimental("SCME0001")]
1580 public ref JsonPatch Patch { get; }
1581 protected virtual ChatAudioOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1582 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1583 protected virtual ChatAudioOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1584 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1585 }
1586 public class ChatClient {
1587 protected ChatClient();
1588 [Experimental("SCME0002")]
1589 public ChatClient(ChatClientSettings settings);
1590 protected internal ChatClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
1591 public ChatClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
1592 public ChatClient(string model, ApiKeyCredential credential);
1593 [Experimental("OPENAI001")]
1594 public ChatClient(string model, AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
1595 [Experimental("OPENAI001")]
1596 public ChatClient(string model, AuthenticationPolicy authenticationPolicy);
1597 public ChatClient(string model, string apiKey);
1598 [Experimental("OPENAI001")]
1599 public Uri Endpoint { get; }
1600 [Experimental("OPENAI001")]
1601 public string Model { get; }
1602 public ClientPipeline Pipeline { get; }
1603 public virtual ClientResult<ChatCompletion> CompleteChat(params ChatMessage[] messages);
1604 public virtual ClientResult CompleteChat(BinaryContent content, RequestOptions options = null);
1605 public virtual ClientResult<ChatCompletion> CompleteChat(IEnumerable<ChatMessage> messages, ChatCompletionOptions options = null, CancellationToken cancellationToken = default);
1606 public virtual Task<ClientResult<ChatCompletion>> CompleteChatAsync(params ChatMessage[] messages);
1607 public virtual Task<ClientResult> CompleteChatAsync(BinaryContent content, RequestOptions options = null);
1608 public virtual Task<ClientResult<ChatCompletion>> CompleteChatAsync(IEnumerable<ChatMessage> messages, ChatCompletionOptions options = null, CancellationToken cancellationToken = default);
1609 public virtual CollectionResult<StreamingChatCompletionUpdate> CompleteChatStreaming(params ChatMessage[] messages);
1610 public virtual CollectionResult<StreamingChatCompletionUpdate> CompleteChatStreaming(IEnumerable<ChatMessage> messages, ChatCompletionOptions options = null, CancellationToken cancellationToken = default);
1611 public virtual AsyncCollectionResult<StreamingChatCompletionUpdate> CompleteChatStreamingAsync(params ChatMessage[] messages);
1612 public virtual AsyncCollectionResult<StreamingChatCompletionUpdate> CompleteChatStreamingAsync(IEnumerable<ChatMessage> messages, ChatCompletionOptions options = null, CancellationToken cancellationToken = default);
1613 [Experimental("OPENAI001")]
1614 public virtual ClientResult DeleteChatCompletion(string completionId, RequestOptions options);
1615 [Experimental("OPENAI001")]
1616 public virtual ClientResult<ChatCompletionDeletionResult> DeleteChatCompletion(string completionId, CancellationToken cancellationToken = default);
1617 [Experimental("OPENAI001")]
1618 public virtual Task<ClientResult> DeleteChatCompletionAsync(string completionId, RequestOptions options);
1619 [Experimental("OPENAI001")]
1620 public virtual Task<ClientResult<ChatCompletionDeletionResult>> DeleteChatCompletionAsync(string completionId, CancellationToken cancellationToken = default);
1621 [Experimental("OPENAI001")]
1622 public virtual ClientResult GetChatCompletion(string completionId, RequestOptions options);
1623 [Experimental("OPENAI001")]
1624 public virtual ClientResult<ChatCompletion> GetChatCompletion(string completionId, CancellationToken cancellationToken = default);
1625 [Experimental("OPENAI001")]
1626 public virtual Task<ClientResult> GetChatCompletionAsync(string completionId, RequestOptions options);
1627 [Experimental("OPENAI001")]
1628 public virtual Task<ClientResult<ChatCompletion>> GetChatCompletionAsync(string completionId, CancellationToken cancellationToken = default);
1629 [Experimental("OPENAI001")]
1630 public virtual CollectionResult<ChatCompletionMessageListDatum> GetChatCompletionMessages(string completionId, ChatCompletionMessageCollectionOptions options = null, CancellationToken cancellationToken = default);
1631 [Experimental("OPENAI001")]
1632 public virtual CollectionResult GetChatCompletionMessages(string completionId, string after, int? limit, string order, RequestOptions options);
1633 [Experimental("OPENAI001")]
1634 public virtual AsyncCollectionResult<ChatCompletionMessageListDatum> GetChatCompletionMessagesAsync(string completionId, ChatCompletionMessageCollectionOptions options = null, CancellationToken cancellationToken = default);
1635 [Experimental("OPENAI001")]
1636 public virtual AsyncCollectionResult GetChatCompletionMessagesAsync(string completionId, string after, int? limit, string order, RequestOptions options);
1637 [Experimental("OPENAI001")]
1638 public virtual CollectionResult<ChatCompletion> GetChatCompletions(ChatCompletionCollectionOptions options = null, CancellationToken cancellationToken = default);
1639 [Experimental("OPENAI001")]
1640 public virtual CollectionResult GetChatCompletions(string after, int? limit, string order, IDictionary<string, string> metadata, string model, RequestOptions options);
1641 [Experimental("OPENAI001")]
1642 public virtual AsyncCollectionResult<ChatCompletion> GetChatCompletionsAsync(ChatCompletionCollectionOptions options = null, CancellationToken cancellationToken = default);
1643 [Experimental("OPENAI001")]
1644 public virtual AsyncCollectionResult GetChatCompletionsAsync(string after, int? limit, string order, IDictionary<string, string> metadata, string model, RequestOptions options);
1645 [Experimental("OPENAI001")]
1646 public virtual ClientResult UpdateChatCompletion(string completionId, BinaryContent content, RequestOptions options = null);
1647 [Experimental("OPENAI001")]
1648 public virtual ClientResult<ChatCompletion> UpdateChatCompletion(string completionId, IDictionary<string, string> metadata, CancellationToken cancellationToken = default);
1649 [Experimental("OPENAI001")]
1650 public virtual Task<ClientResult> UpdateChatCompletionAsync(string completionId, BinaryContent content, RequestOptions options = null);
1651 [Experimental("OPENAI001")]
1652 public virtual Task<ClientResult<ChatCompletion>> UpdateChatCompletionAsync(string completionId, IDictionary<string, string> metadata, CancellationToken cancellationToken = default);
1653 }
1654 [Experimental("SCME0002")]
1655 public sealed class ChatClientSettings : ClientSettings {
1656 public string Model { get; set; }
1657 public OpenAIClientOptions Options { get; set; }
1658 protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
1659 }
1660 public class ChatCompletion : IJsonModel<ChatCompletion>, IPersistableModel<ChatCompletion> {
1661 [Experimental("OPENAI001")]
1662 public IReadOnlyList<ChatMessageAnnotation> Annotations { get; }
1663 public ChatMessageContent Content { get; }
1664 public IReadOnlyList<ChatTokenLogProbabilityDetails> ContentTokenLogProbabilities { get; }
1665 public DateTimeOffset CreatedAt { get; }
1666 public ChatFinishReason FinishReason { get; }
1667 [Obsolete("This property is obsolete. Please use ToolCalls instead.")]
1668 public ChatFunctionCall FunctionCall { get; }
1669 public string Id { get; }
1670 public string Model { get; }
1671 [Experimental("OPENAI001")]
1672 public ChatOutputAudio OutputAudio { get; }
1673 [Serialization.JsonIgnore]
1674 [EditorBrowsable(EditorBrowsableState.Never)]
1675 [Experimental("SCME0001")]
1676 public ref JsonPatch Patch { get; }
1677 public string Refusal { get; }
1678 public IReadOnlyList<ChatTokenLogProbabilityDetails> RefusalTokenLogProbabilities { get; }
1679 public ChatMessageRole Role { get; }
1680 [Experimental("OPENAI001")]
1681 public ChatServiceTier? ServiceTier { get; }
1682 public string SystemFingerprint { get; }
1683 public IReadOnlyList<ChatToolCall> ToolCalls { get; }
1684 public ChatTokenUsage Usage { get; }
1685 [Experimental("OPENAI001")]
1686 protected virtual ChatCompletion JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1687 [Experimental("OPENAI001")]
1688 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1689 [Experimental("OPENAI001")]
1690 public static explicit operator ChatCompletion(ClientResult result);
1691 [Experimental("OPENAI001")]
1692 protected virtual ChatCompletion PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1693 [Experimental("OPENAI001")]
1694 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1695 }
1696 [Experimental("OPENAI001")]
1697 public class ChatCompletionCollectionOptions : IJsonModel<ChatCompletionCollectionOptions>, IPersistableModel<ChatCompletionCollectionOptions> {
1698 public string AfterId { get; set; }
1699 public IDictionary<string, string> Metadata { get; }
1700 public string Model { get; set; }
1701 public ChatCompletionCollectionOrder? Order { get; set; }
1702 public int? PageSizeLimit { get; set; }
1703 [Serialization.JsonIgnore]
1704 [EditorBrowsable(EditorBrowsableState.Never)]
1705 [Experimental("SCME0001")]
1706 public ref JsonPatch Patch { get; }
1707 protected virtual ChatCompletionCollectionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1708 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1709 protected virtual ChatCompletionCollectionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1710 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1711 }
1712 [Experimental("OPENAI001")]
1713 public readonly partial struct ChatCompletionCollectionOrder : IEquatable<ChatCompletionCollectionOrder> {
1714 public ChatCompletionCollectionOrder(string value);
1715 public static ChatCompletionCollectionOrder Ascending { get; }
1716 public static ChatCompletionCollectionOrder Descending { get; }
1717 public readonly bool Equals(ChatCompletionCollectionOrder other);
1718 [EditorBrowsable(EditorBrowsableState.Never)]
1719 public override readonly bool Equals(object obj);
1720 [EditorBrowsable(EditorBrowsableState.Never)]
1721 public override readonly int GetHashCode();
1722 public static bool operator ==(ChatCompletionCollectionOrder left, ChatCompletionCollectionOrder right);
1723 public static implicit operator ChatCompletionCollectionOrder(string value);
1724 public static implicit operator ChatCompletionCollectionOrder?(string value);
1725 public static bool operator !=(ChatCompletionCollectionOrder left, ChatCompletionCollectionOrder right);
1726 public override readonly string ToString();
1727 }
1728 [Experimental("OPENAI001")]
1729 public class ChatCompletionDeletionResult : IJsonModel<ChatCompletionDeletionResult>, IPersistableModel<ChatCompletionDeletionResult> {
1730 public string ChatCompletionId { get; }
1731 public bool Deleted { get; }
1732 [Serialization.JsonIgnore]
1733 [EditorBrowsable(EditorBrowsableState.Never)]
1734 [Experimental("SCME0001")]
1735 public ref JsonPatch Patch { get; }
1736 protected virtual ChatCompletionDeletionResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1737 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1738 public static explicit operator ChatCompletionDeletionResult(ClientResult result);
1739 protected virtual ChatCompletionDeletionResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1740 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1741 }
1742 [Experimental("OPENAI001")]
1743 public class ChatCompletionMessageCollectionOptions : IJsonModel<ChatCompletionMessageCollectionOptions>, IPersistableModel<ChatCompletionMessageCollectionOptions> {
1744 public string AfterId { get; set; }
1745 public ChatCompletionMessageCollectionOrder? Order { get; set; }
1746 public int? PageSizeLimit { get; set; }
1747 [Serialization.JsonIgnore]
1748 [EditorBrowsable(EditorBrowsableState.Never)]
1749 [Experimental("SCME0001")]
1750 public ref JsonPatch Patch { get; }
1751 protected virtual ChatCompletionMessageCollectionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1752 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1753 protected virtual ChatCompletionMessageCollectionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1754 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1755 }
1756 [Experimental("OPENAI001")]
1757 public readonly partial struct ChatCompletionMessageCollectionOrder : IEquatable<ChatCompletionMessageCollectionOrder> {
1758 public ChatCompletionMessageCollectionOrder(string value);
1759 public static ChatCompletionMessageCollectionOrder Ascending { get; }
1760 public static ChatCompletionMessageCollectionOrder Descending { get; }
1761 public readonly bool Equals(ChatCompletionMessageCollectionOrder other);
1762 [EditorBrowsable(EditorBrowsableState.Never)]
1763 public override readonly bool Equals(object obj);
1764 [EditorBrowsable(EditorBrowsableState.Never)]
1765 public override readonly int GetHashCode();
1766 public static bool operator ==(ChatCompletionMessageCollectionOrder left, ChatCompletionMessageCollectionOrder right);
1767 public static implicit operator ChatCompletionMessageCollectionOrder(string value);
1768 public static implicit operator ChatCompletionMessageCollectionOrder?(string value);
1769 public static bool operator !=(ChatCompletionMessageCollectionOrder left, ChatCompletionMessageCollectionOrder right);
1770 public override readonly string ToString();
1771 }
1772 [Experimental("OPENAI001")]
1773 public class ChatCompletionMessageListDatum : IJsonModel<ChatCompletionMessageListDatum>, IPersistableModel<ChatCompletionMessageListDatum> {
1774 public IReadOnlyList<ChatMessageAnnotation> Annotations { get; }
1775 public string Content { get; }
1776 public IList<ChatMessageContentPart> ContentParts { get; }
1777 public string Id { get; }
1778 public ChatOutputAudio OutputAudio { get; }
1779 [Serialization.JsonIgnore]
1780 [EditorBrowsable(EditorBrowsableState.Never)]
1781 [Experimental("SCME0001")]
1782 public ref JsonPatch Patch { get; }
1783 public string Refusal { get; }
1784 public IReadOnlyList<ChatToolCall> ToolCalls { get; }
1785 protected virtual ChatCompletionMessageListDatum JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1786 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1787 protected virtual ChatCompletionMessageListDatum PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1788 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1789 }
1790 public class ChatCompletionOptions : IJsonModel<ChatCompletionOptions>, IPersistableModel<ChatCompletionOptions> {
1791 public bool? AllowParallelToolCalls { get; set; }
1792 [Experimental("OPENAI001")]
1793 public ChatAudioOptions AudioOptions { get; set; }
1794 public string EndUserId { get; set; }
1795 public float? FrequencyPenalty { get; set; }
1796 [Obsolete("This property is obsolete. Please use ToolChoice instead.")]
1797 public ChatFunctionChoice FunctionChoice { get; set; }
1798 [Obsolete("This property is obsolete. Please use Tools instead.")]
1799 public IList<ChatFunction> Functions { get; }
1800 public bool? IncludeLogProbabilities { get; set; }
1801 public IDictionary<int, int> LogitBiases { get; }
1802 public int? MaxOutputTokenCount { get; set; }
1803 public IDictionary<string, string> Metadata { get; }
1804 [Experimental("OPENAI001")]
1805 public ChatOutputPrediction OutputPrediction { get; set; }
1806 [Serialization.JsonIgnore]
1807 [EditorBrowsable(EditorBrowsableState.Never)]
1808 [Experimental("SCME0001")]
1809 public ref JsonPatch Patch { get; }
1810 public float? PresencePenalty { get; set; }
1811 [Experimental("OPENAI001")]
1812 public ChatReasoningEffortLevel? ReasoningEffortLevel { get; set; }
1813 public ChatResponseFormat ResponseFormat { get; set; }
1814 [Experimental("OPENAI001")]
1815 public ChatResponseModalities ResponseModalities { get; set; }
1816 [Experimental("OPENAI001")]
1817 public string SafetyIdentifier { get; set; }
1818 [Experimental("OPENAI001")]
1819 public long? Seed { get; set; }
1820 [Experimental("OPENAI001")]
1821 public ChatServiceTier? ServiceTier { get; set; }
1822 public IList<string> StopSequences { get; }
1823 public bool? StoredOutputEnabled { get; set; }
1824 public float? Temperature { get; set; }
1825 public ChatToolChoice ToolChoice { get; set; }
1826 public IList<ChatTool> Tools { get; }
1827 public int? TopLogProbabilityCount { get; set; }
1828 public float? TopP { get; set; }
1829 [Experimental("OPENAI001")]
1830 public ChatWebSearchOptions WebSearchOptions { get; set; }
1831 [Experimental("OPENAI001")]
1832 protected virtual ChatCompletionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1833 [Experimental("OPENAI001")]
1834 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1835 [Experimental("OPENAI001")]
1836 protected virtual ChatCompletionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1837 [Experimental("OPENAI001")]
1838 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1839 }
1840 public enum ChatFinishReason {
1841 Stop = 0,
1842 Length = 1,
1843 ContentFilter = 2,
1844 ToolCalls = 3,
1845 FunctionCall = 4
1846 }
1847 [Obsolete("This class is obsolete. Please use ChatTool instead.")]
1848 public class ChatFunction : IJsonModel<ChatFunction>, IPersistableModel<ChatFunction> {
1849 public ChatFunction(string functionName);
1850 public string FunctionDescription { get; set; }
1851 public string FunctionName { get; }
1852 public BinaryData FunctionParameters { get; set; }
1853 [Serialization.JsonIgnore]
1854 [EditorBrowsable(EditorBrowsableState.Never)]
1855 [Experimental("SCME0001")]
1856 public ref JsonPatch Patch { get; }
1857 [Experimental("OPENAI001")]
1858 protected virtual ChatFunction JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1859 [Experimental("OPENAI001")]
1860 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1861 [Experimental("OPENAI001")]
1862 protected virtual ChatFunction PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1863 [Experimental("OPENAI001")]
1864 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1865 }
1866 [Obsolete("This class is obsolete. Please use ChatToolCall instead.")]
1867 public class ChatFunctionCall : IJsonModel<ChatFunctionCall>, IPersistableModel<ChatFunctionCall> {
1868 public ChatFunctionCall(string functionName, BinaryData functionArguments);
1869 public BinaryData FunctionArguments { get; }
1870 public string FunctionName { get; }
1871 [Serialization.JsonIgnore]
1872 [EditorBrowsable(EditorBrowsableState.Never)]
1873 [Experimental("SCME0001")]
1874 public ref JsonPatch Patch { get; }
1875 [Experimental("OPENAI001")]
1876 protected virtual ChatFunctionCall JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1877 [Experimental("OPENAI001")]
1878 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1879 [Experimental("OPENAI001")]
1880 protected virtual ChatFunctionCall PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1881 [Experimental("OPENAI001")]
1882 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1883 }
1884 [Obsolete("This class is obsolete. Please use ChatToolChoice instead.")]
1885 public class ChatFunctionChoice : IJsonModel<ChatFunctionChoice>, IPersistableModel<ChatFunctionChoice> {
1886 [Serialization.JsonIgnore]
1887 [EditorBrowsable(EditorBrowsableState.Never)]
1888 [Experimental("SCME0001")]
1889 public ref JsonPatch Patch { get; }
1890 public static ChatFunctionChoice CreateAutoChoice();
1891 public static ChatFunctionChoice CreateNamedChoice(string functionName);
1892 public static ChatFunctionChoice CreateNoneChoice();
1893 [Experimental("OPENAI001")]
1894 protected virtual ChatFunctionChoice JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1895 [Experimental("OPENAI001")]
1896 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1897 [Experimental("OPENAI001")]
1898 protected virtual ChatFunctionChoice PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1899 [Experimental("OPENAI001")]
1900 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1901 }
1902 public readonly partial struct ChatImageDetailLevel : IEquatable<ChatImageDetailLevel> {
1903 public ChatImageDetailLevel(string value);
1904 public static ChatImageDetailLevel Auto { get; }
1905 public static ChatImageDetailLevel High { get; }
1906 public static ChatImageDetailLevel Low { get; }
1907 public readonly bool Equals(ChatImageDetailLevel other);
1908 [EditorBrowsable(EditorBrowsableState.Never)]
1909 public override readonly bool Equals(object obj);
1910 [EditorBrowsable(EditorBrowsableState.Never)]
1911 public override readonly int GetHashCode();
1912 public static bool operator ==(ChatImageDetailLevel left, ChatImageDetailLevel right);
1913 public static implicit operator ChatImageDetailLevel(string value);
1914 public static implicit operator ChatImageDetailLevel?(string value);
1915 public static bool operator !=(ChatImageDetailLevel left, ChatImageDetailLevel right);
1916 public override readonly string ToString();
1917 }
1918 [Experimental("OPENAI001")]
1919 public readonly partial struct ChatInputAudioFormat : IEquatable<ChatInputAudioFormat> {
1920 public ChatInputAudioFormat(string value);
1921 public static ChatInputAudioFormat Mp3 { get; }
1922 public static ChatInputAudioFormat Wav { get; }
1923 public readonly bool Equals(ChatInputAudioFormat other);
1924 [EditorBrowsable(EditorBrowsableState.Never)]
1925 public override readonly bool Equals(object obj);
1926 [EditorBrowsable(EditorBrowsableState.Never)]
1927 public override readonly int GetHashCode();
1928 public static bool operator ==(ChatInputAudioFormat left, ChatInputAudioFormat right);
1929 public static implicit operator ChatInputAudioFormat(string value);
1930 public static implicit operator ChatInputAudioFormat?(string value);
1931 public static bool operator !=(ChatInputAudioFormat left, ChatInputAudioFormat right);
1932 public override readonly string ToString();
1933 }
1934 public class ChatInputTokenUsageDetails : IJsonModel<ChatInputTokenUsageDetails>, IPersistableModel<ChatInputTokenUsageDetails> {
1935 public int AudioTokenCount { get; }
1936 public int CachedTokenCount { get; }
1937 [Serialization.JsonIgnore]
1938 [EditorBrowsable(EditorBrowsableState.Never)]
1939 [Experimental("SCME0001")]
1940 public ref JsonPatch Patch { get; }
1941 [Experimental("OPENAI001")]
1942 protected virtual ChatInputTokenUsageDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1943 [Experimental("OPENAI001")]
1944 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1945 [Experimental("OPENAI001")]
1946 protected virtual ChatInputTokenUsageDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1947 [Experimental("OPENAI001")]
1948 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1949 }
1950 public class ChatMessage : IJsonModel<ChatMessage>, IPersistableModel<ChatMessage> {
1951 public ChatMessageContent Content { get; }
1952 [Serialization.JsonIgnore]
1953 [EditorBrowsable(EditorBrowsableState.Never)]
1954 [Experimental("SCME0001")]
1955 public ref JsonPatch Patch { get; }
1956 public static AssistantChatMessage CreateAssistantMessage(ChatCompletion chatCompletion);
1957 public static AssistantChatMessage CreateAssistantMessage(ChatFunctionCall functionCall);
1958 public static AssistantChatMessage CreateAssistantMessage(params ChatMessageContentPart[] contentParts);
1959 [Experimental("OPENAI001")]
1960 public static AssistantChatMessage CreateAssistantMessage(ChatOutputAudioReference outputAudioReference);
1961 public static AssistantChatMessage CreateAssistantMessage(IEnumerable<ChatMessageContentPart> contentParts);
1962 public static AssistantChatMessage CreateAssistantMessage(IEnumerable<ChatToolCall> toolCalls);
1963 public static AssistantChatMessage CreateAssistantMessage(string content);
1964 [Experimental("OPENAI001")]
1965 public static DeveloperChatMessage CreateDeveloperMessage(params ChatMessageContentPart[] contentParts);
1966 [Experimental("OPENAI001")]
1967 public static DeveloperChatMessage CreateDeveloperMessage(IEnumerable<ChatMessageContentPart> contentParts);
1968 [Experimental("OPENAI001")]
1969 public static DeveloperChatMessage CreateDeveloperMessage(string content);
1970 [Obsolete("This method is obsolete. Please use CreateToolMessage instead.")]
1971 public static FunctionChatMessage CreateFunctionMessage(string functionName, string content);
1972 public static SystemChatMessage CreateSystemMessage(params ChatMessageContentPart[] contentParts);
1973 public static SystemChatMessage CreateSystemMessage(IEnumerable<ChatMessageContentPart> contentParts);
1974 public static SystemChatMessage CreateSystemMessage(string content);
1975 public static ToolChatMessage CreateToolMessage(string toolCallId, params ChatMessageContentPart[] contentParts);
1976 public static ToolChatMessage CreateToolMessage(string toolCallId, IEnumerable<ChatMessageContentPart> contentParts);
1977 public static ToolChatMessage CreateToolMessage(string toolCallId, string content);
1978 public static UserChatMessage CreateUserMessage(params ChatMessageContentPart[] contentParts);
1979 public static UserChatMessage CreateUserMessage(IEnumerable<ChatMessageContentPart> contentParts);
1980 public static UserChatMessage CreateUserMessage(string content);
1981 [Experimental("OPENAI001")]
1982 protected virtual ChatMessage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1983 [Experimental("OPENAI001")]
1984 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1985 public static implicit operator ChatMessage(string content);
1986 [Experimental("OPENAI001")]
1987 protected virtual ChatMessage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1988 [Experimental("OPENAI001")]
1989 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1990 }
1991 [Experimental("OPENAI001")]
1992 public class ChatMessageAnnotation : IJsonModel<ChatMessageAnnotation>, IPersistableModel<ChatMessageAnnotation> {
1993 public int EndIndex { get; }
1994 [Serialization.JsonIgnore]
1995 [EditorBrowsable(EditorBrowsableState.Never)]
1996 [Experimental("SCME0001")]
1997 public ref JsonPatch Patch { get; }
1998 public int StartIndex { get; }
1999 public string WebResourceTitle { get; }
2000 public Uri WebResourceUri { get; }
2001 protected virtual ChatMessageAnnotation JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2002 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2003 protected virtual ChatMessageAnnotation PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2004 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2005 }
2006 public class ChatMessageContent : ObjectModel.Collection<ChatMessageContentPart> {
2007 public ChatMessageContent();
2008 public ChatMessageContent(params ChatMessageContentPart[] contentParts);
2009 public ChatMessageContent(IEnumerable<ChatMessageContentPart> contentParts);
2010 public ChatMessageContent(string content);
2011 }
2012 public class ChatMessageContentPart : IJsonModel<ChatMessageContentPart>, IPersistableModel<ChatMessageContentPart> {
2013 [Experimental("OPENAI001")]
2014 public BinaryData FileBytes { get; }
2015 [Experimental("OPENAI001")]
2016 public string FileBytesMediaType { get; }
2017 [Experimental("OPENAI001")]
2018 public string FileId { get; }
2019 [Experimental("OPENAI001")]
2020 public string Filename { get; }
2021 public BinaryData ImageBytes { get; }
2022 public string ImageBytesMediaType { get; }
2023 public ChatImageDetailLevel? ImageDetailLevel { get; }
2024 public Uri ImageUri { get; }
2025 [Experimental("OPENAI001")]
2026 public BinaryData InputAudioBytes { get; }
2027 [Experimental("OPENAI001")]
2028 public ChatInputAudioFormat? InputAudioFormat { get; }
2029 public ChatMessageContentPartKind Kind { get; }
2030 [Serialization.JsonIgnore]
2031 [EditorBrowsable(EditorBrowsableState.Never)]
2032 [Experimental("SCME0001")]
2033 public ref JsonPatch Patch { get; }
2034 public string Refusal { get; }
2035 public string Text { get; }
2036 [Experimental("OPENAI001")]
2037 public static ChatMessageContentPart CreateFilePart(BinaryData fileBytes, string fileBytesMediaType, string filename);
2038 [Experimental("OPENAI001")]
2039 public static ChatMessageContentPart CreateFilePart(string fileId);
2040 public static ChatMessageContentPart CreateImagePart(BinaryData imageBytes, string imageBytesMediaType, ChatImageDetailLevel? imageDetailLevel = null);
2041 public static ChatMessageContentPart CreateImagePart(Uri imageUri, ChatImageDetailLevel? imageDetailLevel = null);
2042 [Experimental("OPENAI001")]
2043 public static ChatMessageContentPart CreateInputAudioPart(BinaryData inputAudioBytes, ChatInputAudioFormat inputAudioFormat);
2044 public static ChatMessageContentPart CreateRefusalPart(string refusal);
2045 public static ChatMessageContentPart CreateTextPart(string text);
2046 [Experimental("OPENAI001")]
2047 protected virtual ChatMessageContentPart JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2048 [Experimental("OPENAI001")]
2049 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2050 public static implicit operator ChatMessageContentPart(string text);
2051 [Experimental("OPENAI001")]
2052 protected virtual ChatMessageContentPart PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2053 [Experimental("OPENAI001")]
2054 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2055 }
2056 public enum ChatMessageContentPartKind {
2057 Text = 0,
2058 Refusal = 1,
2059 Image = 2,
2060 InputAudio = 3,
2061 File = 4
2062 }
2063 public enum ChatMessageRole {
2064 System = 0,
2065 User = 1,
2066 Assistant = 2,
2067 Tool = 3,
2068 Function = 4,
2069 Developer = 5
2070 }
2071 [Experimental("OPENAI001")]
2072 public class ChatOutputAudio : IJsonModel<ChatOutputAudio>, IPersistableModel<ChatOutputAudio> {
2073 public BinaryData AudioBytes { get; }
2074 public DateTimeOffset ExpiresAt { get; }
2075 public string Id { get; }
2076 [Serialization.JsonIgnore]
2077 [EditorBrowsable(EditorBrowsableState.Never)]
2078 [Experimental("SCME0001")]
2079 public ref JsonPatch Patch { get; }
2080 public string Transcript { get; }
2081 protected virtual ChatOutputAudio JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2082 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2083 protected virtual ChatOutputAudio PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2084 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2085 }
2086 [Experimental("OPENAI001")]
2087 public readonly partial struct ChatOutputAudioFormat : IEquatable<ChatOutputAudioFormat> {
2088 public ChatOutputAudioFormat(string value);
2089 public static ChatOutputAudioFormat Aac { get; }
2090 public static ChatOutputAudioFormat Flac { get; }
2091 public static ChatOutputAudioFormat Mp3 { get; }
2092 public static ChatOutputAudioFormat Opus { get; }
2093 public static ChatOutputAudioFormat Pcm16 { get; }
2094 public static ChatOutputAudioFormat Wav { get; }
2095 public readonly bool Equals(ChatOutputAudioFormat other);
2096 [EditorBrowsable(EditorBrowsableState.Never)]
2097 public override readonly bool Equals(object obj);
2098 [EditorBrowsable(EditorBrowsableState.Never)]
2099 public override readonly int GetHashCode();
2100 public static bool operator ==(ChatOutputAudioFormat left, ChatOutputAudioFormat right);
2101 public static implicit operator ChatOutputAudioFormat(string value);
2102 public static implicit operator ChatOutputAudioFormat?(string value);
2103 public static bool operator !=(ChatOutputAudioFormat left, ChatOutputAudioFormat right);
2104 public override readonly string ToString();
2105 }
2106 [Experimental("OPENAI001")]
2107 public class ChatOutputAudioReference : IJsonModel<ChatOutputAudioReference>, IPersistableModel<ChatOutputAudioReference> {
2108 public ChatOutputAudioReference(string id);
2109 public string Id { get; }
2110 [Serialization.JsonIgnore]
2111 [EditorBrowsable(EditorBrowsableState.Never)]
2112 [Experimental("SCME0001")]
2113 public ref JsonPatch Patch { get; }
2114 protected virtual ChatOutputAudioReference JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2115 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2116 protected virtual ChatOutputAudioReference PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2117 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2118 }
2119 [Experimental("OPENAI001")]
2120 public readonly partial struct ChatOutputAudioVoice : IEquatable<ChatOutputAudioVoice> {
2121 public ChatOutputAudioVoice(string value);
2122 public static ChatOutputAudioVoice Alloy { get; }
2123 public static ChatOutputAudioVoice Ash { get; }
2124 public static ChatOutputAudioVoice Ballad { get; }
2125 public static ChatOutputAudioVoice Coral { get; }
2126 public static ChatOutputAudioVoice Echo { get; }
2127 public static ChatOutputAudioVoice Fable { get; }
2128 public static ChatOutputAudioVoice Nova { get; }
2129 public static ChatOutputAudioVoice Onyx { get; }
2130 public static ChatOutputAudioVoice Sage { get; }
2131 public static ChatOutputAudioVoice Shimmer { get; }
2132 public static ChatOutputAudioVoice Verse { get; }
2133 public readonly bool Equals(ChatOutputAudioVoice other);
2134 [EditorBrowsable(EditorBrowsableState.Never)]
2135 public override readonly bool Equals(object obj);
2136 [EditorBrowsable(EditorBrowsableState.Never)]
2137 public override readonly int GetHashCode();
2138 public static bool operator ==(ChatOutputAudioVoice left, ChatOutputAudioVoice right);
2139 public static implicit operator ChatOutputAudioVoice(string value);
2140 public static implicit operator ChatOutputAudioVoice?(string value);
2141 public static bool operator !=(ChatOutputAudioVoice left, ChatOutputAudioVoice right);
2142 public override readonly string ToString();
2143 }
2144 [Experimental("OPENAI001")]
2145 public class ChatOutputPrediction : IJsonModel<ChatOutputPrediction>, IPersistableModel<ChatOutputPrediction> {
2146 [Serialization.JsonIgnore]
2147 [EditorBrowsable(EditorBrowsableState.Never)]
2148 [Experimental("SCME0001")]
2149 public ref JsonPatch Patch { get; }
2150 public static ChatOutputPrediction CreateStaticContentPrediction(IEnumerable<ChatMessageContentPart> staticContentParts);
2151 public static ChatOutputPrediction CreateStaticContentPrediction(string staticContent);
2152 protected virtual ChatOutputPrediction JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2153 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2154 protected virtual ChatOutputPrediction PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2155 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2156 }
2157 public class ChatOutputTokenUsageDetails : IJsonModel<ChatOutputTokenUsageDetails>, IPersistableModel<ChatOutputTokenUsageDetails> {
2158 [Experimental("OPENAI001")]
2159 public int AcceptedPredictionTokenCount { get; }
2160 public int AudioTokenCount { get; }
2161 [Serialization.JsonIgnore]
2162 [EditorBrowsable(EditorBrowsableState.Never)]
2163 [Experimental("SCME0001")]
2164 public ref JsonPatch Patch { get; }
2165 public int ReasoningTokenCount { get; }
2166 [Experimental("OPENAI001")]
2167 public int RejectedPredictionTokenCount { get; }
2168 [Experimental("OPENAI001")]
2169 protected virtual ChatOutputTokenUsageDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2170 [Experimental("OPENAI001")]
2171 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2172 [Experimental("OPENAI001")]
2173 protected virtual ChatOutputTokenUsageDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2174 [Experimental("OPENAI001")]
2175 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2176 }
2177 [Experimental("OPENAI001")]
2178 public readonly partial struct ChatReasoningEffortLevel : IEquatable<ChatReasoningEffortLevel> {
2179 public ChatReasoningEffortLevel(string value);
2180 public static ChatReasoningEffortLevel High { get; }
2181 public static ChatReasoningEffortLevel Low { get; }
2182 public static ChatReasoningEffortLevel Medium { get; }
2183 public static ChatReasoningEffortLevel Minimal { get; }
2184 public static ChatReasoningEffortLevel None { get; }
2185 public readonly bool Equals(ChatReasoningEffortLevel other);
2186 [EditorBrowsable(EditorBrowsableState.Never)]
2187 public override readonly bool Equals(object obj);
2188 [EditorBrowsable(EditorBrowsableState.Never)]
2189 public override readonly int GetHashCode();
2190 public static bool operator ==(ChatReasoningEffortLevel left, ChatReasoningEffortLevel right);
2191 public static implicit operator ChatReasoningEffortLevel(string value);
2192 public static implicit operator ChatReasoningEffortLevel?(string value);
2193 public static bool operator !=(ChatReasoningEffortLevel left, ChatReasoningEffortLevel right);
2194 public override readonly string ToString();
2195 }
2196 public class ChatResponseFormat : IJsonModel<ChatResponseFormat>, IPersistableModel<ChatResponseFormat> {
2197 [Serialization.JsonIgnore]
2198 [EditorBrowsable(EditorBrowsableState.Never)]
2199 [Experimental("SCME0001")]
2200 public ref JsonPatch Patch { get; }
2201 public static ChatResponseFormat CreateJsonObjectFormat();
2202 public static ChatResponseFormat CreateJsonSchemaFormat(string jsonSchemaFormatName, BinaryData jsonSchema, string jsonSchemaFormatDescription = null, bool? jsonSchemaIsStrict = null);
2203 public static ChatResponseFormat CreateTextFormat();
2204 [Experimental("OPENAI001")]
2205 protected virtual ChatResponseFormat JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2206 [Experimental("OPENAI001")]
2207 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2208 [Experimental("OPENAI001")]
2209 protected virtual ChatResponseFormat PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2210 [Experimental("OPENAI001")]
2211 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2212 }
2213 [Experimental("OPENAI001")]
2214 [Flags]
2215 public enum ChatResponseModalities {
2216 Default = 0,
2217 Text = 1,
2218 Audio = 2
2219 }
2220 [Experimental("OPENAI001")]
2221 public readonly partial struct ChatServiceTier : IEquatable<ChatServiceTier> {
2222 public ChatServiceTier(string value);
2223 public static ChatServiceTier Auto { get; }
2224 public static ChatServiceTier Default { get; }
2225 public static ChatServiceTier Flex { get; }
2226 public static ChatServiceTier Scale { get; }
2227 public readonly bool Equals(ChatServiceTier other);
2228 [EditorBrowsable(EditorBrowsableState.Never)]
2229 public override readonly bool Equals(object obj);
2230 [EditorBrowsable(EditorBrowsableState.Never)]
2231 public override readonly int GetHashCode();
2232 public static bool operator ==(ChatServiceTier left, ChatServiceTier right);
2233 public static implicit operator ChatServiceTier(string value);
2234 public static implicit operator ChatServiceTier?(string value);
2235 public static bool operator !=(ChatServiceTier left, ChatServiceTier right);
2236 public override readonly string ToString();
2237 }
2238 public class ChatTokenLogProbabilityDetails : IJsonModel<ChatTokenLogProbabilityDetails>, IPersistableModel<ChatTokenLogProbabilityDetails> {
2239 public float LogProbability { get; }
2240 [Serialization.JsonIgnore]
2241 [EditorBrowsable(EditorBrowsableState.Never)]
2242 [Experimental("SCME0001")]
2243 public ref JsonPatch Patch { get; }
2244 public string Token { get; }
2245 public IReadOnlyList<ChatTokenTopLogProbabilityDetails> TopLogProbabilities { get; }
2246 public ReadOnlyMemory<byte>? Utf8Bytes { get; }
2247 [Experimental("OPENAI001")]
2248 protected virtual ChatTokenLogProbabilityDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2249 [Experimental("OPENAI001")]
2250 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2251 [Experimental("OPENAI001")]
2252 protected virtual ChatTokenLogProbabilityDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2253 [Experimental("OPENAI001")]
2254 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2255 }
2256 public class ChatTokenTopLogProbabilityDetails : IJsonModel<ChatTokenTopLogProbabilityDetails>, IPersistableModel<ChatTokenTopLogProbabilityDetails> {
2257 public float LogProbability { get; }
2258 [Serialization.JsonIgnore]
2259 [EditorBrowsable(EditorBrowsableState.Never)]
2260 [Experimental("SCME0001")]
2261 public ref JsonPatch Patch { get; }
2262 public string Token { get; }
2263 public ReadOnlyMemory<byte>? Utf8Bytes { get; }
2264 [Experimental("OPENAI001")]
2265 protected virtual ChatTokenTopLogProbabilityDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2266 [Experimental("OPENAI001")]
2267 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2268 [Experimental("OPENAI001")]
2269 protected virtual ChatTokenTopLogProbabilityDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2270 [Experimental("OPENAI001")]
2271 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2272 }
2273 public class ChatTokenUsage : IJsonModel<ChatTokenUsage>, IPersistableModel<ChatTokenUsage> {
2274 public int InputTokenCount { get; }
2275 public ChatInputTokenUsageDetails InputTokenDetails { get; }
2276 public int OutputTokenCount { get; }
2277 public ChatOutputTokenUsageDetails OutputTokenDetails { get; }
2278 [Serialization.JsonIgnore]
2279 [EditorBrowsable(EditorBrowsableState.Never)]
2280 [Experimental("SCME0001")]
2281 public ref JsonPatch Patch { get; }
2282 public int TotalTokenCount { get; }
2283 [Experimental("OPENAI001")]
2284 protected virtual ChatTokenUsage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2285 [Experimental("OPENAI001")]
2286 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2287 [Experimental("OPENAI001")]
2288 protected virtual ChatTokenUsage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2289 [Experimental("OPENAI001")]
2290 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2291 }
2292 public class ChatTool : IJsonModel<ChatTool>, IPersistableModel<ChatTool> {
2293 public string FunctionDescription { get; }
2294 public string FunctionName { get; }
2295 public BinaryData FunctionParameters { get; }
2296 public bool? FunctionSchemaIsStrict { get; }
2297 public ChatToolKind Kind { get; }
2298 [Serialization.JsonIgnore]
2299 [EditorBrowsable(EditorBrowsableState.Never)]
2300 [Experimental("SCME0001")]
2301 public ref JsonPatch Patch { get; }
2302 public static ChatTool CreateFunctionTool(string functionName, string functionDescription = null, BinaryData functionParameters = null, bool? functionSchemaIsStrict = null);
2303 [Experimental("OPENAI001")]
2304 protected virtual ChatTool JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2305 [Experimental("OPENAI001")]
2306 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2307 [Experimental("OPENAI001")]
2308 protected virtual ChatTool PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2309 [Experimental("OPENAI001")]
2310 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2311 }
2312 public class ChatToolCall : IJsonModel<ChatToolCall>, IPersistableModel<ChatToolCall> {
2313 public BinaryData FunctionArguments { get; }
2314 public string FunctionName { get; }
2315 public string Id { get; set; }
2316 public ChatToolCallKind Kind { get; }
2317 [Serialization.JsonIgnore]
2318 [EditorBrowsable(EditorBrowsableState.Never)]
2319 [Experimental("SCME0001")]
2320 public ref JsonPatch Patch { get; }
2321 public static ChatToolCall CreateFunctionToolCall(string id, string functionName, BinaryData functionArguments);
2322 [Experimental("OPENAI001")]
2323 protected virtual ChatToolCall JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2324 [Experimental("OPENAI001")]
2325 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2326 [Experimental("OPENAI001")]
2327 protected virtual ChatToolCall PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2328 [Experimental("OPENAI001")]
2329 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2330 }
2331 public enum ChatToolCallKind {
2332 Function = 0
2333 }
2334 public class ChatToolChoice : IJsonModel<ChatToolChoice>, IPersistableModel<ChatToolChoice> {
2335 [Serialization.JsonIgnore]
2336 [EditorBrowsable(EditorBrowsableState.Never)]
2337 [Experimental("SCME0001")]
2338 public ref JsonPatch Patch { get; }
2339 public static ChatToolChoice CreateAutoChoice();
2340 public static ChatToolChoice CreateFunctionChoice(string functionName);
2341 public static ChatToolChoice CreateNoneChoice();
2342 public static ChatToolChoice CreateRequiredChoice();
2343 [Experimental("OPENAI001")]
2344 protected virtual ChatToolChoice JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2345 [Experimental("OPENAI001")]
2346 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2347 [Experimental("OPENAI001")]
2348 protected virtual ChatToolChoice PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2349 [Experimental("OPENAI001")]
2350 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2351 }
2352 public enum ChatToolKind {
2353 Function = 0
2354 }
2355 [Experimental("OPENAI001")]
2356 public class ChatWebSearchOptions : IJsonModel<ChatWebSearchOptions>, IPersistableModel<ChatWebSearchOptions> {
2357 [Serialization.JsonIgnore]
2358 [EditorBrowsable(EditorBrowsableState.Never)]
2359 [Experimental("SCME0001")]
2360 public ref JsonPatch Patch { get; }
2361 protected virtual ChatWebSearchOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2362 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2363 protected virtual ChatWebSearchOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2364 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2365 }
2366 [Experimental("OPENAI001")]
2367 public class DeveloperChatMessage : ChatMessage, IJsonModel<DeveloperChatMessage>, IPersistableModel<DeveloperChatMessage> {
2368 public DeveloperChatMessage(params ChatMessageContentPart[] contentParts);
2369 public DeveloperChatMessage(IEnumerable<ChatMessageContentPart> contentParts);
2370 public DeveloperChatMessage(string content);
2371 public string ParticipantName { get; set; }
2372 protected override ChatMessage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2373 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2374 protected override ChatMessage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2375 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2376 }
2377 [Obsolete("This class is obsolete. Please use ToolChatMessage instead.")]
2378 public class FunctionChatMessage : ChatMessage, IJsonModel<FunctionChatMessage>, IPersistableModel<FunctionChatMessage> {
2379 public FunctionChatMessage(string functionName, string content);
2380 public string FunctionName { get; }
2381 [Experimental("OPENAI001")]
2382 protected override ChatMessage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2383 [Experimental("OPENAI001")]
2384 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2385 [Experimental("OPENAI001")]
2386 protected override ChatMessage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2387 [Experimental("OPENAI001")]
2388 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2389 }
2390 public static class OpenAIChatModelFactory {
2391 [Experimental("OPENAI001")]
2392 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, ChatServiceTier? serviceTier = null, string systemFingerprint = null, ChatTokenUsage usage = null, ChatOutputAudio outputAudio = null, IEnumerable<ChatMessageAnnotation> messageAnnotations = null);
2393 [EditorBrowsable(EditorBrowsableState.Never)]
2394 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);
2395 [Experimental("OPENAI001")]
2396 public static ChatCompletionMessageListDatum ChatCompletionMessageListDatum(string id, string content, string refusal, ChatMessageRole role, IList<ChatMessageContentPart> contentParts = null, IList<ChatToolCall> toolCalls = null, IList<ChatMessageAnnotation> annotations = null, string functionName = null, string functionArguments = null, ChatOutputAudio outputAudio = null);
2397 public static ChatInputTokenUsageDetails ChatInputTokenUsageDetails(int audioTokenCount = 0, int cachedTokenCount = 0);
2398 [Experimental("OPENAI001")]
2399 public static ChatMessageAnnotation ChatMessageAnnotation(int startIndex = 0, int endIndex = 0, Uri webResourceUri = null, string webResourceTitle = null);
2400 [Experimental("OPENAI001")]
2401 public static ChatOutputAudio ChatOutputAudio(BinaryData audioBytes, string id = null, string transcript = null, DateTimeOffset expiresAt = default);
2402 [Experimental("OPENAI001")]
2403 public static ChatOutputTokenUsageDetails ChatOutputTokenUsageDetails(int reasoningTokenCount = 0, int audioTokenCount = 0, int acceptedPredictionTokenCount = 0, int rejectedPredictionTokenCount = 0);
2404 [EditorBrowsable(EditorBrowsableState.Never)]
2405 public static ChatOutputTokenUsageDetails ChatOutputTokenUsageDetails(int reasoningTokenCount, int audioTokenCount);
2406 [EditorBrowsable(EditorBrowsableState.Never)]
2407 public static ChatOutputTokenUsageDetails ChatOutputTokenUsageDetails(int reasoningTokenCount);
2408 public static ChatTokenLogProbabilityDetails ChatTokenLogProbabilityDetails(string token = null, float logProbability = 0, ReadOnlyMemory<byte>? utf8Bytes = null, IEnumerable<ChatTokenTopLogProbabilityDetails> topLogProbabilities = null);
2409 public static ChatTokenTopLogProbabilityDetails ChatTokenTopLogProbabilityDetails(string token = null, float logProbability = 0, ReadOnlyMemory<byte>? utf8Bytes = null);
2410 public static ChatTokenUsage ChatTokenUsage(int outputTokenCount = 0, int inputTokenCount = 0, int totalTokenCount = 0, ChatOutputTokenUsageDetails outputTokenDetails = null, ChatInputTokenUsageDetails inputTokenDetails = null);
2411 [EditorBrowsable(EditorBrowsableState.Never)]
2412 public static ChatTokenUsage ChatTokenUsage(int outputTokenCount, int inputTokenCount, int totalTokenCount, ChatOutputTokenUsageDetails outputTokenDetails);
2413 [Experimental("OPENAI001")]
2414 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, ChatServiceTier? serviceTier = null, string systemFingerprint = null, ChatTokenUsage usage = null, StreamingChatOutputAudioUpdate outputAudioUpdate = null);
2415 [EditorBrowsable(EditorBrowsableState.Never)]
2416 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);
2417 [Obsolete("This class is obsolete. Please use StreamingChatToolCallUpdate instead.")]
2418 public static StreamingChatFunctionCallUpdate StreamingChatFunctionCallUpdate(string functionName = null, BinaryData functionArgumentsUpdate = null);
2419 [Experimental("OPENAI001")]
2420 public static StreamingChatOutputAudioUpdate StreamingChatOutputAudioUpdate(string id = null, DateTimeOffset? expiresAt = null, string transcriptUpdate = null, BinaryData audioBytesUpdate = null);
2421 public static StreamingChatToolCallUpdate StreamingChatToolCallUpdate(int index = 0, string toolCallId = null, ChatToolCallKind kind = ChatToolCallKind.Function, string functionName = null, BinaryData functionArgumentsUpdate = null);
2422 }
2423 public class StreamingChatCompletionUpdate : IJsonModel<StreamingChatCompletionUpdate>, IPersistableModel<StreamingChatCompletionUpdate> {
2424 public string CompletionId { get; }
2425 public IReadOnlyList<ChatTokenLogProbabilityDetails> ContentTokenLogProbabilities { get; }
2426 public ChatMessageContent ContentUpdate { get; }
2427 public DateTimeOffset CreatedAt { get; }
2428 public ChatFinishReason? FinishReason { get; }
2429 [Obsolete("This property is obsolete. Please use ToolCallUpdates instead.")]
2430 public StreamingChatFunctionCallUpdate FunctionCallUpdate { get; }
2431 public string Model { get; }
2432 [Experimental("OPENAI001")]
2433 public StreamingChatOutputAudioUpdate OutputAudioUpdate { get; }
2434 [Serialization.JsonIgnore]
2435 [EditorBrowsable(EditorBrowsableState.Never)]
2436 [Experimental("SCME0001")]
2437 public ref JsonPatch Patch { get; }
2438 public IReadOnlyList<ChatTokenLogProbabilityDetails> RefusalTokenLogProbabilities { get; }
2439 public string RefusalUpdate { get; }
2440 public ChatMessageRole? Role { get; }
2441 [Experimental("OPENAI001")]
2442 public ChatServiceTier? ServiceTier { get; }
2443 public string SystemFingerprint { get; }
2444 public IReadOnlyList<StreamingChatToolCallUpdate> ToolCallUpdates { get; }
2445 public ChatTokenUsage Usage { get; }
2446 [Experimental("OPENAI001")]
2447 protected virtual StreamingChatCompletionUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2448 [Experimental("OPENAI001")]
2449 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2450 [Experimental("OPENAI001")]
2451 protected virtual StreamingChatCompletionUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2452 [Experimental("OPENAI001")]
2453 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2454 }
2455 [Obsolete("This class is obsolete. Please use StreamingChatToolCallUpdate instead.")]
2456 public class StreamingChatFunctionCallUpdate : IJsonModel<StreamingChatFunctionCallUpdate>, IPersistableModel<StreamingChatFunctionCallUpdate> {
2457 public BinaryData FunctionArgumentsUpdate { get; }
2458 public string FunctionName { get; }
2459 [Serialization.JsonIgnore]
2460 [EditorBrowsable(EditorBrowsableState.Never)]
2461 [Experimental("SCME0001")]
2462 public ref JsonPatch Patch { get; }
2463 [Experimental("OPENAI001")]
2464 protected virtual StreamingChatFunctionCallUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2465 [Experimental("OPENAI001")]
2466 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2467 [Experimental("OPENAI001")]
2468 protected virtual StreamingChatFunctionCallUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2469 [Experimental("OPENAI001")]
2470 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2471 }
2472 [Experimental("OPENAI001")]
2473 public class StreamingChatOutputAudioUpdate : IJsonModel<StreamingChatOutputAudioUpdate>, IPersistableModel<StreamingChatOutputAudioUpdate> {
2474 public BinaryData AudioBytesUpdate { get; }
2475 public DateTimeOffset? ExpiresAt { get; }
2476 public string Id { get; }
2477 [Serialization.JsonIgnore]
2478 [EditorBrowsable(EditorBrowsableState.Never)]
2479 [Experimental("SCME0001")]
2480 public ref JsonPatch Patch { get; }
2481 public string TranscriptUpdate { get; }
2482 protected virtual StreamingChatOutputAudioUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2483 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2484 protected virtual StreamingChatOutputAudioUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2485 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2486 }
2487 public class StreamingChatToolCallUpdate : IJsonModel<StreamingChatToolCallUpdate>, IPersistableModel<StreamingChatToolCallUpdate> {
2488 public BinaryData FunctionArgumentsUpdate { get; }
2489 public string FunctionName { get; }
2490 public int Index { get; }
2491 public ChatToolCallKind Kind { get; }
2492 [Serialization.JsonIgnore]
2493 [EditorBrowsable(EditorBrowsableState.Never)]
2494 [Experimental("SCME0001")]
2495 public ref JsonPatch Patch { get; }
2496 public string ToolCallId { get; }
2497 [Experimental("OPENAI001")]
2498 protected virtual StreamingChatToolCallUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2499 [Experimental("OPENAI001")]
2500 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2501 [Experimental("OPENAI001")]
2502 protected virtual StreamingChatToolCallUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2503 [Experimental("OPENAI001")]
2504 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2505 }
2506 public class SystemChatMessage : ChatMessage, IJsonModel<SystemChatMessage>, IPersistableModel<SystemChatMessage> {
2507 public SystemChatMessage(params ChatMessageContentPart[] contentParts);
2508 public SystemChatMessage(IEnumerable<ChatMessageContentPart> contentParts);
2509 public SystemChatMessage(string content);
2510 public string ParticipantName { get; set; }
2511 [Experimental("OPENAI001")]
2512 protected override ChatMessage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2513 [Experimental("OPENAI001")]
2514 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2515 [Experimental("OPENAI001")]
2516 protected override ChatMessage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2517 [Experimental("OPENAI001")]
2518 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2519 }
2520 public class ToolChatMessage : ChatMessage, IJsonModel<ToolChatMessage>, IPersistableModel<ToolChatMessage> {
2521 public ToolChatMessage(string toolCallId, params ChatMessageContentPart[] contentParts);
2522 public ToolChatMessage(string toolCallId, IEnumerable<ChatMessageContentPart> contentParts);
2523 public ToolChatMessage(string toolCallId, string content);
2524 public string ToolCallId { get; }
2525 [Experimental("OPENAI001")]
2526 protected override ChatMessage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2527 [Experimental("OPENAI001")]
2528 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2529 [Experimental("OPENAI001")]
2530 protected override ChatMessage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2531 [Experimental("OPENAI001")]
2532 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2533 }
2534 public class UserChatMessage : ChatMessage, IJsonModel<UserChatMessage>, IPersistableModel<UserChatMessage> {
2535 public UserChatMessage(params ChatMessageContentPart[] contentParts);
2536 public UserChatMessage(IEnumerable<ChatMessageContentPart> contentParts);
2537 public UserChatMessage(string content);
2538 public string ParticipantName { get; set; }
2539 [Experimental("OPENAI001")]
2540 protected override ChatMessage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2541 [Experimental("OPENAI001")]
2542 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2543 [Experimental("OPENAI001")]
2544 protected override ChatMessage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2545 [Experimental("OPENAI001")]
2546 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2547 }
2548}
2549namespace OpenAI.Containers {
2550 [Experimental("OPENAI001")]
2551 public class ContainerClient {
2552 protected ContainerClient();
2553 [Experimental("SCME0002")]
2554 public ContainerClient(ContainerClientSettings settings);
2555 public ContainerClient(ApiKeyCredential credential, OpenAIClientOptions options);
2556 public ContainerClient(ApiKeyCredential credential);
2557 public ContainerClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
2558 public ContainerClient(AuthenticationPolicy authenticationPolicy);
2559 protected internal ContainerClient(ClientPipeline pipeline, OpenAIClientOptions options);
2560 public ContainerClient(string apiKey);
2561 [Experimental("OPENAI001")]
2562 public Uri Endpoint { get; }
2563 public ClientPipeline Pipeline { get; }
2564 public virtual ClientResult<ContainerResource> CreateContainer(CreateContainerBody body, CancellationToken cancellationToken = default);
2565 public virtual ClientResult CreateContainer(BinaryContent content, RequestOptions options = null);
2566 public virtual Task<ClientResult<ContainerResource>> CreateContainerAsync(CreateContainerBody body, CancellationToken cancellationToken = default);
2567 public virtual Task<ClientResult> CreateContainerAsync(BinaryContent content, RequestOptions options = null);
2568 public virtual ClientResult CreateContainerFile(string containerId, BinaryContent content, string contentType, RequestOptions options = null);
2569 public virtual Task<ClientResult> CreateContainerFileAsync(string containerId, BinaryContent content, string contentType, RequestOptions options = null);
2570 public virtual ClientResult DeleteContainer(string containerId, RequestOptions options);
2571 public virtual ClientResult<DeleteContainerResponse> DeleteContainer(string containerId, CancellationToken cancellationToken = default);
2572 public virtual Task<ClientResult> DeleteContainerAsync(string containerId, RequestOptions options);
2573 public virtual Task<ClientResult<DeleteContainerResponse>> DeleteContainerAsync(string containerId, CancellationToken cancellationToken = default);
2574 public virtual ClientResult DeleteContainerFile(string containerId, string fileId, RequestOptions options);
2575 public virtual ClientResult<DeleteContainerFileResponse> DeleteContainerFile(string containerId, string fileId, CancellationToken cancellationToken = default);
2576 public virtual Task<ClientResult> DeleteContainerFileAsync(string containerId, string fileId, RequestOptions options);
2577 public virtual Task<ClientResult<DeleteContainerFileResponse>> DeleteContainerFileAsync(string containerId, string fileId, CancellationToken cancellationToken = default);
2578 public virtual ClientResult DownloadContainerFile(string containerId, string fileId, RequestOptions options);
2579 public virtual ClientResult<BinaryData> DownloadContainerFile(string containerId, string fileId, CancellationToken cancellationToken = default);
2580 public virtual Task<ClientResult> DownloadContainerFileAsync(string containerId, string fileId, RequestOptions options);
2581 public virtual Task<ClientResult<BinaryData>> DownloadContainerFileAsync(string containerId, string fileId, CancellationToken cancellationToken = default);
2582 public virtual ClientResult GetContainer(string containerId, RequestOptions options);
2583 public virtual ClientResult<ContainerResource> GetContainer(string containerId, CancellationToken cancellationToken = default);
2584 public virtual Task<ClientResult> GetContainerAsync(string containerId, RequestOptions options);
2585 public virtual Task<ClientResult<ContainerResource>> GetContainerAsync(string containerId, CancellationToken cancellationToken = default);
2586 public virtual ClientResult GetContainerFile(string containerId, string fileId, RequestOptions options);
2587 public virtual ClientResult<ContainerFileResource> GetContainerFile(string containerId, string fileId, CancellationToken cancellationToken = default);
2588 public virtual Task<ClientResult> GetContainerFileAsync(string containerId, string fileId, RequestOptions options);
2589 public virtual Task<ClientResult<ContainerFileResource>> GetContainerFileAsync(string containerId, string fileId, CancellationToken cancellationToken = default);
2590 public virtual CollectionResult<ContainerFileResource> GetContainerFiles(string containerId, ContainerFileCollectionOptions options = null, CancellationToken cancellationToken = default);
2591 public virtual CollectionResult GetContainerFiles(string containerId, int? limit, string order, string after, RequestOptions options);
2592 public virtual AsyncCollectionResult<ContainerFileResource> GetContainerFilesAsync(string containerId, ContainerFileCollectionOptions options = null, CancellationToken cancellationToken = default);
2593 public virtual AsyncCollectionResult GetContainerFilesAsync(string containerId, int? limit, string order, string after, RequestOptions options);
2594 public virtual CollectionResult<ContainerResource> GetContainers(ContainerCollectionOptions options = null, CancellationToken cancellationToken = default);
2595 public virtual CollectionResult GetContainers(int? limit, string order, string after, RequestOptions options);
2596 public virtual AsyncCollectionResult<ContainerResource> GetContainersAsync(ContainerCollectionOptions options = null, CancellationToken cancellationToken = default);
2597 public virtual AsyncCollectionResult GetContainersAsync(int? limit, string order, string after, RequestOptions options);
2598 }
2599 [Experimental("SCME0002")]
2600 public sealed class ContainerClientSettings : ClientSettings {
2601 public OpenAIClientOptions Options { get; set; }
2602 protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
2603 }
2604 [Experimental("OPENAI001")]
2605 public class ContainerCollectionOptions : IJsonModel<ContainerCollectionOptions>, IPersistableModel<ContainerCollectionOptions> {
2606 public string AfterId { get; set; }
2607 public ContainerCollectionOrder? Order { get; set; }
2608 public int? PageSizeLimit { get; set; }
2609 protected virtual ContainerCollectionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2610 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2611 protected virtual ContainerCollectionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2612 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2613 }
2614 [Experimental("OPENAI001")]
2615 public readonly partial struct ContainerCollectionOrder : IEquatable<ContainerCollectionOrder> {
2616 public ContainerCollectionOrder(string value);
2617 public static ContainerCollectionOrder Ascending { get; }
2618 public static ContainerCollectionOrder Descending { get; }
2619 public readonly bool Equals(ContainerCollectionOrder other);
2620 [EditorBrowsable(EditorBrowsableState.Never)]
2621 public override readonly bool Equals(object obj);
2622 [EditorBrowsable(EditorBrowsableState.Never)]
2623 public override readonly int GetHashCode();
2624 public static bool operator ==(ContainerCollectionOrder left, ContainerCollectionOrder right);
2625 public static implicit operator ContainerCollectionOrder(string value);
2626 public static implicit operator ContainerCollectionOrder?(string value);
2627 public static bool operator !=(ContainerCollectionOrder left, ContainerCollectionOrder right);
2628 public override readonly string ToString();
2629 }
2630 [Experimental("OPENAI001")]
2631 public class ContainerFileCollectionOptions : IJsonModel<ContainerFileCollectionOptions>, IPersistableModel<ContainerFileCollectionOptions> {
2632 public string AfterId { get; set; }
2633 public ContainerCollectionOrder? Order { get; set; }
2634 public int? PageSizeLimit { get; set; }
2635 protected virtual ContainerFileCollectionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2636 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2637 protected virtual ContainerFileCollectionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2638 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2639 }
2640 [Experimental("OPENAI001")]
2641 public class ContainerFileResource : IJsonModel<ContainerFileResource>, IPersistableModel<ContainerFileResource> {
2642 public int Bytes { get; }
2643 public string ContainerId { get; }
2644 public DateTimeOffset CreatedAt { get; }
2645 public string Id { get; }
2646 public string Object { get; }
2647 public string Path { get; }
2648 public string Source { get; }
2649 protected virtual ContainerFileResource JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2650 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2651 public static explicit operator ContainerFileResource(ClientResult result);
2652 protected virtual ContainerFileResource PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2653 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2654 }
2655 [Experimental("OPENAI001")]
2656 public class ContainerResource : IJsonModel<ContainerResource>, IPersistableModel<ContainerResource> {
2657 public DateTimeOffset CreatedAt { get; }
2658 public ContainerResourceExpiresAfter ExpiresAfter { get; }
2659 public string Id { get; }
2660 public string Name { get; }
2661 public string Object { get; }
2662 public string Status { get; }
2663 protected virtual ContainerResource JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2664 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2665 public static explicit operator ContainerResource(ClientResult result);
2666 protected virtual ContainerResource PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2667 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2668 }
2669 [Experimental("OPENAI001")]
2670 public class ContainerResourceExpiresAfter : IJsonModel<ContainerResourceExpiresAfter>, IPersistableModel<ContainerResourceExpiresAfter> {
2671 public string Anchor { get; }
2672 public int? Minutes { get; }
2673 protected virtual ContainerResourceExpiresAfter JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2674 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2675 protected virtual ContainerResourceExpiresAfter PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2676 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2677 }
2678 [Experimental("OPENAI001")]
2679 public class CreateContainerBody : IJsonModel<CreateContainerBody>, IPersistableModel<CreateContainerBody> {
2680 public CreateContainerBody(string name);
2681 public CreateContainerBodyExpiresAfter ExpiresAfter { get; set; }
2682 public IList<string> FileIds { get; }
2683 public string Name { get; }
2684 protected virtual CreateContainerBody JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2685 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2686 public static implicit operator BinaryContent(CreateContainerBody createContainerBody);
2687 protected virtual CreateContainerBody PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2688 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2689 }
2690 [Experimental("OPENAI001")]
2691 public class CreateContainerBodyExpiresAfter : IJsonModel<CreateContainerBodyExpiresAfter>, IPersistableModel<CreateContainerBodyExpiresAfter> {
2692 public CreateContainerBodyExpiresAfter(int minutes);
2693 public string Anchor { get; }
2694 public int Minutes { get; }
2695 protected virtual CreateContainerBodyExpiresAfter JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2696 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2697 protected virtual CreateContainerBodyExpiresAfter PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2698 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2699 }
2700 [Experimental("OPENAI001")]
2701 public class CreateContainerFileBody : IJsonModel<CreateContainerFileBody>, IPersistableModel<CreateContainerFileBody> {
2702 public BinaryData File { get; set; }
2703 public string FileId { get; set; }
2704 protected virtual CreateContainerFileBody JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2705 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2706 protected virtual CreateContainerFileBody PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2707 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2708 }
2709 [Experimental("OPENAI001")]
2710 public class DeleteContainerFileResponse : IJsonModel<DeleteContainerFileResponse>, IPersistableModel<DeleteContainerFileResponse> {
2711 public bool Deleted { get; }
2712 public string Id { get; }
2713 public string Object { get; }
2714 protected virtual DeleteContainerFileResponse JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2715 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2716 public static explicit operator DeleteContainerFileResponse(ClientResult result);
2717 protected virtual DeleteContainerFileResponse PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2718 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2719 }
2720 [Experimental("OPENAI001")]
2721 public class DeleteContainerResponse : IJsonModel<DeleteContainerResponse>, IPersistableModel<DeleteContainerResponse> {
2722 public bool Deleted { get; }
2723 public string Id { get; }
2724 public string Object { get; }
2725 protected virtual DeleteContainerResponse JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2726 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2727 public static explicit operator DeleteContainerResponse(ClientResult result);
2728 protected virtual DeleteContainerResponse PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2729 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2730 }
2731}
2732namespace OpenAI.Conversations {
2733 [Experimental("OPENAI001")]
2734 public class ConversationClient {
2735 protected ConversationClient();
2736 [Experimental("SCME0002")]
2737 public ConversationClient(ConversationClientSettings settings);
2738 public ConversationClient(ApiKeyCredential credential, OpenAIClientOptions options);
2739 public ConversationClient(ApiKeyCredential credential);
2740 public ConversationClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
2741 public ConversationClient(AuthenticationPolicy authenticationPolicy);
2742 protected internal ConversationClient(ClientPipeline pipeline, OpenAIClientOptions options);
2743 public ConversationClient(string apiKey);
2744 [Experimental("OPENAI001")]
2745 public Uri Endpoint { get; }
2746 public ClientPipeline Pipeline { get; }
2747 public virtual ClientResult CreateConversation(BinaryContent content, RequestOptions options = null);
2748 public virtual Task<ClientResult> CreateConversationAsync(BinaryContent content, RequestOptions options = null);
2749 public virtual ClientResult CreateConversationItems(string conversationId, BinaryContent content, IEnumerable<IncludedConversationItemProperty> include = null, RequestOptions options = null);
2750 public virtual Task<ClientResult> CreateConversationItemsAsync(string conversationId, BinaryContent content, IEnumerable<IncludedConversationItemProperty> include = null, RequestOptions options = null);
2751 public virtual ClientResult DeleteConversation(string conversationId, RequestOptions options = null);
2752 public virtual Task<ClientResult> DeleteConversationAsync(string conversationId, RequestOptions options = null);
2753 public virtual ClientResult DeleteConversationItem(string conversationId, string itemId, RequestOptions options = null);
2754 public virtual Task<ClientResult> DeleteConversationItemAsync(string conversationId, string itemId, RequestOptions options = null);
2755 public virtual ClientResult GetConversation(string conversationId, RequestOptions options = null);
2756 public virtual Task<ClientResult> GetConversationAsync(string conversationId, RequestOptions options = null);
2757 public virtual ClientResult GetConversationItem(string conversationId, string itemId, IEnumerable<IncludedConversationItemProperty> include = null, RequestOptions options = null);
2758 public virtual Task<ClientResult> GetConversationItemAsync(string conversationId, string itemId, IEnumerable<IncludedConversationItemProperty> include = null, RequestOptions options = null);
2759 public virtual CollectionResult GetConversationItems(string conversationId, long? limit = null, string order = null, string after = null, IEnumerable<IncludedConversationItemProperty> include = null, RequestOptions options = null);
2760 public virtual AsyncCollectionResult GetConversationItemsAsync(string conversationId, long? limit = null, string order = null, string after = null, IEnumerable<IncludedConversationItemProperty> include = null, RequestOptions options = null);
2761 public virtual ClientResult UpdateConversation(string conversationId, BinaryContent content, RequestOptions options = null);
2762 public virtual Task<ClientResult> UpdateConversationAsync(string conversationId, BinaryContent content, RequestOptions options = null);
2763 }
2764 [Experimental("SCME0002")]
2765 public sealed class ConversationClientSettings : ClientSettings {
2766 public OpenAIClientOptions Options { get; set; }
2767 protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
2768 }
2769 [Experimental("OPENAI001")]
2770 public readonly partial struct IncludedConversationItemProperty : IEquatable<IncludedConversationItemProperty> {
2771 public IncludedConversationItemProperty(string value);
2772 public static IncludedConversationItemProperty CodeInterpreterCallOutputs { get; }
2773 public static IncludedConversationItemProperty ComputerCallOutputImageUri { get; }
2774 public static IncludedConversationItemProperty FileSearchCallResults { get; }
2775 public static IncludedConversationItemProperty MessageInputImageUri { get; }
2776 public static IncludedConversationItemProperty MessageOutputTextLogprobs { get; }
2777 public static IncludedConversationItemProperty ReasoningEncryptedContent { get; }
2778 public static IncludedConversationItemProperty WebSearchCallActionSources { get; }
2779 public static IncludedConversationItemProperty WebSearchCallResults { get; }
2780 public readonly bool Equals(IncludedConversationItemProperty other);
2781 [EditorBrowsable(EditorBrowsableState.Never)]
2782 public override readonly bool Equals(object obj);
2783 [EditorBrowsable(EditorBrowsableState.Never)]
2784 public override readonly int GetHashCode();
2785 public static bool operator ==(IncludedConversationItemProperty left, IncludedConversationItemProperty right);
2786 public static implicit operator IncludedConversationItemProperty(string value);
2787 public static implicit operator IncludedConversationItemProperty?(string value);
2788 public static bool operator !=(IncludedConversationItemProperty left, IncludedConversationItemProperty right);
2789 public override readonly string ToString();
2790 }
2791}
2792namespace OpenAI.Embeddings {
2793 public class EmbeddingClient {
2794 protected EmbeddingClient();
2795 [Experimental("SCME0002")]
2796 public EmbeddingClient(EmbeddingClientSettings settings);
2797 protected internal EmbeddingClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
2798 public EmbeddingClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
2799 public EmbeddingClient(string model, ApiKeyCredential credential);
2800 [Experimental("OPENAI001")]
2801 public EmbeddingClient(string model, AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
2802 [Experimental("OPENAI001")]
2803 public EmbeddingClient(string model, AuthenticationPolicy authenticationPolicy);
2804 public EmbeddingClient(string model, string apiKey);
2805 [Experimental("OPENAI001")]
2806 public Uri Endpoint { get; }
2807 [Experimental("OPENAI001")]
2808 public string Model { get; }
2809 public ClientPipeline Pipeline { get; }
2810 public virtual ClientResult<OpenAIEmbedding> GenerateEmbedding(string input, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
2811 public virtual Task<ClientResult<OpenAIEmbedding>> GenerateEmbeddingAsync(string input, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
2812 public virtual ClientResult GenerateEmbeddings(BinaryContent content, RequestOptions options = null);
2813 public virtual ClientResult<OpenAIEmbeddingCollection> GenerateEmbeddings(IEnumerable<ReadOnlyMemory<int>> inputs, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
2814 public virtual ClientResult<OpenAIEmbeddingCollection> GenerateEmbeddings(IEnumerable<string> inputs, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
2815 public virtual Task<ClientResult> GenerateEmbeddingsAsync(BinaryContent content, RequestOptions options = null);
2816 public virtual Task<ClientResult<OpenAIEmbeddingCollection>> GenerateEmbeddingsAsync(IEnumerable<ReadOnlyMemory<int>> inputs, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
2817 public virtual Task<ClientResult<OpenAIEmbeddingCollection>> GenerateEmbeddingsAsync(IEnumerable<string> inputs, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
2818 }
2819 [Experimental("SCME0002")]
2820 public sealed class EmbeddingClientSettings : ClientSettings {
2821 public string Model { get; set; }
2822 public OpenAIClientOptions Options { get; set; }
2823 protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
2824 }
2825 public class EmbeddingGenerationOptions : IJsonModel<EmbeddingGenerationOptions>, IPersistableModel<EmbeddingGenerationOptions> {
2826 public int? Dimensions { get; set; }
2827 public string EndUserId { get; set; }
2828 [Serialization.JsonIgnore]
2829 [EditorBrowsable(EditorBrowsableState.Never)]
2830 [Experimental("SCME0001")]
2831 public ref JsonPatch Patch { get; }
2832 [Experimental("OPENAI001")]
2833 protected virtual EmbeddingGenerationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2834 [Experimental("OPENAI001")]
2835 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2836 [Experimental("OPENAI001")]
2837 protected virtual EmbeddingGenerationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2838 [Experimental("OPENAI001")]
2839 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2840 }
2841 public class EmbeddingTokenUsage : IJsonModel<EmbeddingTokenUsage>, IPersistableModel<EmbeddingTokenUsage> {
2842 public int InputTokenCount { get; }
2843 [Serialization.JsonIgnore]
2844 [EditorBrowsable(EditorBrowsableState.Never)]
2845 [Experimental("SCME0001")]
2846 public ref JsonPatch Patch { get; }
2847 public int TotalTokenCount { get; }
2848 [Experimental("OPENAI001")]
2849 protected virtual EmbeddingTokenUsage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2850 [Experimental("OPENAI001")]
2851 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2852 [Experimental("OPENAI001")]
2853 protected virtual EmbeddingTokenUsage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2854 [Experimental("OPENAI001")]
2855 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2856 }
2857 public class OpenAIEmbedding : IJsonModel<OpenAIEmbedding>, IPersistableModel<OpenAIEmbedding> {
2858 public int Index { get; }
2859 [Serialization.JsonIgnore]
2860 [EditorBrowsable(EditorBrowsableState.Never)]
2861 [Experimental("SCME0001")]
2862 public ref JsonPatch Patch { get; }
2863 [Experimental("OPENAI001")]
2864 protected virtual OpenAIEmbedding JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2865 [Experimental("OPENAI001")]
2866 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2867 [Experimental("OPENAI001")]
2868 protected virtual OpenAIEmbedding PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2869 [Experimental("OPENAI001")]
2870 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2871 public ReadOnlyMemory<float> ToFloats();
2872 }
2873 public class OpenAIEmbeddingCollection : ObjectModel.ReadOnlyCollection<OpenAIEmbedding>, IJsonModel<OpenAIEmbeddingCollection>, IPersistableModel<OpenAIEmbeddingCollection> {
2874 public string Model { get; }
2875 [Serialization.JsonIgnore]
2876 [EditorBrowsable(EditorBrowsableState.Never)]
2877 [Experimental("SCME0001")]
2878 public ref JsonPatch Patch { get; }
2879 public EmbeddingTokenUsage Usage { get; }
2880 [Experimental("OPENAI001")]
2881 protected virtual OpenAIEmbeddingCollection JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2882 [Experimental("OPENAI001")]
2883 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2884 [Experimental("OPENAI001")]
2885 public static explicit operator OpenAIEmbeddingCollection(ClientResult result);
2886 [Experimental("OPENAI001")]
2887 protected virtual OpenAIEmbeddingCollection PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2888 [Experimental("OPENAI001")]
2889 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2890 }
2891 public static class OpenAIEmbeddingsModelFactory {
2892 public static EmbeddingTokenUsage EmbeddingTokenUsage(int inputTokenCount = 0, int totalTokenCount = 0);
2893 public static OpenAIEmbedding OpenAIEmbedding(int index = 0, IEnumerable<float> vector = null);
2894 public static OpenAIEmbeddingCollection OpenAIEmbeddingCollection(IEnumerable<OpenAIEmbedding> items = null, string model = null, EmbeddingTokenUsage usage = null);
2895 }
2896}
2897namespace OpenAI.Evals {
2898 [Experimental("OPENAI001")]
2899 public class EvaluationClient {
2900 protected EvaluationClient();
2901 [Experimental("SCME0002")]
2902 public EvaluationClient(EvaluationClientSettings settings);
2903 public EvaluationClient(ApiKeyCredential credential, OpenAIClientOptions options);
2904 public EvaluationClient(ApiKeyCredential credential);
2905 public EvaluationClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
2906 public EvaluationClient(AuthenticationPolicy authenticationPolicy);
2907 protected internal EvaluationClient(ClientPipeline pipeline, OpenAIClientOptions options);
2908 public EvaluationClient(string apiKey);
2909 [Experimental("OPENAI001")]
2910 public Uri Endpoint { get; }
2911 public ClientPipeline Pipeline { get; }
2912 public virtual ClientResult CancelEvaluationRun(string evaluationId, string evaluationRunId, RequestOptions options);
2913 public virtual Task<ClientResult> CancelEvaluationRunAsync(string evaluationId, string evaluationRunId, RequestOptions options);
2914 public virtual ClientResult CreateEvaluation(BinaryContent content, RequestOptions options = null);
2915 public virtual Task<ClientResult> CreateEvaluationAsync(BinaryContent content, RequestOptions options = null);
2916 public virtual ClientResult CreateEvaluationRun(string evaluationId, BinaryContent content, RequestOptions options = null);
2917 public virtual Task<ClientResult> CreateEvaluationRunAsync(string evaluationId, BinaryContent content, RequestOptions options = null);
2918 public virtual ClientResult DeleteEvaluation(string evaluationId, RequestOptions options);
2919 public virtual Task<ClientResult> DeleteEvaluationAsync(string evaluationId, RequestOptions options);
2920 public virtual ClientResult DeleteEvaluationRun(string evaluationId, string evaluationRunId, RequestOptions options);
2921 public virtual Task<ClientResult> DeleteEvaluationRunAsync(string evaluationId, string evaluationRunId, RequestOptions options);
2922 public virtual ClientResult GetEvaluation(string evaluationId, RequestOptions options);
2923 public virtual Task<ClientResult> GetEvaluationAsync(string evaluationId, RequestOptions options);
2924 public virtual ClientResult GetEvaluationRun(string evaluationId, string evaluationRunId, RequestOptions options);
2925 public virtual Task<ClientResult> GetEvaluationRunAsync(string evaluationId, string evaluationRunId, RequestOptions options);
2926 public virtual ClientResult GetEvaluationRunOutputItem(string evaluationId, string evaluationRunId, string outputItemId, RequestOptions options);
2927 public virtual Task<ClientResult> GetEvaluationRunOutputItemAsync(string evaluationId, string evaluationRunId, string outputItemId, RequestOptions options);
2928 public virtual ClientResult GetEvaluationRunOutputItems(string evaluationId, string evaluationRunId, int? limit, string order, string after, string outputItemStatus, RequestOptions options);
2929 public virtual Task<ClientResult> GetEvaluationRunOutputItemsAsync(string evaluationId, string evaluationRunId, int? limit, string order, string after, string outputItemStatus, RequestOptions options);
2930 public virtual ClientResult GetEvaluationRuns(string evaluationId, int? limit, string order, string after, string evaluationRunStatus, RequestOptions options);
2931 public virtual Task<ClientResult> GetEvaluationRunsAsync(string evaluationId, int? limit, string order, string after, string evaluationRunStatus, RequestOptions options);
2932 public virtual ClientResult GetEvaluations(int? limit, string orderBy, string order, string after, RequestOptions options);
2933 public virtual Task<ClientResult> GetEvaluationsAsync(int? limit, string orderBy, string order, string after, RequestOptions options);
2934 public virtual ClientResult UpdateEvaluation(string evaluationId, BinaryContent content, RequestOptions options = null);
2935 public virtual Task<ClientResult> UpdateEvaluationAsync(string evaluationId, BinaryContent content, RequestOptions options = null);
2936 }
2937 [Experimental("SCME0002")]
2938 public sealed class EvaluationClientSettings : ClientSettings {
2939 public OpenAIClientOptions Options { get; set; }
2940 protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
2941 }
2942}
2943namespace OpenAI.Files {
2944 public class FileDeletionResult : IJsonModel<FileDeletionResult>, IPersistableModel<FileDeletionResult> {
2945 public bool Deleted { get; }
2946 public string FileId { get; }
2947 [Experimental("OPENAI001")]
2948 protected virtual FileDeletionResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2949 [Experimental("OPENAI001")]
2950 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2951 [Experimental("OPENAI001")]
2952 public static explicit operator FileDeletionResult(ClientResult result);
2953 [Experimental("OPENAI001")]
2954 protected virtual FileDeletionResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2955 [Experimental("OPENAI001")]
2956 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2957 }
2958 public enum FilePurpose {
2959 Assistants = 0,
2960 AssistantsOutput = 1,
2961 Batch = 2,
2962 BatchOutput = 3,
2963 FineTune = 4,
2964 FineTuneResults = 5,
2965 Vision = 6,
2966 UserData = 7,
2967 Evaluations = 8
2968 }
2969 [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.")]
2970 public enum FileStatus {
2971 Uploaded = 0,
2972 Processed = 1,
2973 Error = 2
2974 }
2975 public readonly partial struct FileUploadPurpose : IEquatable<FileUploadPurpose> {
2976 public FileUploadPurpose(string value);
2977 public static FileUploadPurpose Assistants { get; }
2978 public static FileUploadPurpose Batch { get; }
2979 [Experimental("OPENAI001")]
2980 public static FileUploadPurpose Evaluations { get; }
2981 public static FileUploadPurpose FineTune { get; }
2982 [Experimental("OPENAI001")]
2983 public static FileUploadPurpose UserData { get; }
2984 public static FileUploadPurpose Vision { get; }
2985 public readonly bool Equals(FileUploadPurpose other);
2986 [EditorBrowsable(EditorBrowsableState.Never)]
2987 public override readonly bool Equals(object obj);
2988 [EditorBrowsable(EditorBrowsableState.Never)]
2989 public override readonly int GetHashCode();
2990 public static bool operator ==(FileUploadPurpose left, FileUploadPurpose right);
2991 public static implicit operator FileUploadPurpose(string value);
2992 public static implicit operator FileUploadPurpose?(string value);
2993 public static bool operator !=(FileUploadPurpose left, FileUploadPurpose right);
2994 public override readonly string ToString();
2995 }
2996 public class OpenAIFile : IJsonModel<OpenAIFile>, IPersistableModel<OpenAIFile> {
2997 public DateTimeOffset CreatedAt { get; }
2998 [Experimental("OPENAI001")]
2999 public DateTimeOffset? ExpiresAt { get; }
3000 public string Filename { get; }
3001 public string Id { get; }
3002 public FilePurpose Purpose { get; }
3003 [EditorBrowsable(EditorBrowsableState.Never)]
3004 public int? SizeInBytes { get; }
3005 [Experimental("OPENAI001")]
3006 public long? SizeInBytesLong { get; }
3007 [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.")]
3008 public FileStatus Status { get; }
3009 [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.")]
3010 public string StatusDetails { get; }
3011 [Experimental("OPENAI001")]
3012 protected virtual OpenAIFile JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3013 [Experimental("OPENAI001")]
3014 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3015 [Experimental("OPENAI001")]
3016 public static explicit operator OpenAIFile(ClientResult result);
3017 [Experimental("OPENAI001")]
3018 protected virtual OpenAIFile PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3019 [Experimental("OPENAI001")]
3020 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3021 }
3022 public class OpenAIFileClient {
3023 protected OpenAIFileClient();
3024 [Experimental("SCME0002")]
3025 public OpenAIFileClient(OpenAIFileClientSettings settings);
3026 public OpenAIFileClient(ApiKeyCredential credential, OpenAIClientOptions options);
3027 public OpenAIFileClient(ApiKeyCredential credential);
3028 [Experimental("OPENAI001")]
3029 public OpenAIFileClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
3030 [Experimental("OPENAI001")]
3031 public OpenAIFileClient(AuthenticationPolicy authenticationPolicy);
3032 protected internal OpenAIFileClient(ClientPipeline pipeline, OpenAIClientOptions options);
3033 public OpenAIFileClient(string apiKey);
3034 [Experimental("OPENAI001")]
3035 public Uri Endpoint { get; }
3036 public ClientPipeline Pipeline { get; }
3037 [Experimental("OPENAI001")]
3038 public virtual ClientResult AddUploadPart(string uploadId, BinaryContent content, string contentType, RequestOptions options = null);
3039 [Experimental("OPENAI001")]
3040 public virtual Task<ClientResult> AddUploadPartAsync(string uploadId, BinaryContent content, string contentType, RequestOptions options = null);
3041 [Experimental("OPENAI001")]
3042 public virtual ClientResult CancelUpload(string uploadId, RequestOptions options = null);
3043 [Experimental("OPENAI001")]
3044 public virtual Task<ClientResult> CancelUploadAsync(string uploadId, RequestOptions options = null);
3045 [Experimental("OPENAI001")]
3046 public virtual ClientResult CompleteUpload(string uploadId, BinaryContent content, RequestOptions options = null);
3047 [Experimental("OPENAI001")]
3048 public virtual Task<ClientResult> CompleteUploadAsync(string uploadId, BinaryContent content, RequestOptions options = null);
3049 [Experimental("OPENAI001")]
3050 public virtual ClientResult CreateUpload(BinaryContent content, RequestOptions options = null);
3051 [Experimental("OPENAI001")]
3052 public virtual Task<ClientResult> CreateUploadAsync(BinaryContent content, RequestOptions options = null);
3053 public virtual ClientResult DeleteFile(string fileId, RequestOptions options);
3054 public virtual ClientResult<FileDeletionResult> DeleteFile(string fileId, CancellationToken cancellationToken = default);
3055 public virtual Task<ClientResult> DeleteFileAsync(string fileId, RequestOptions options);
3056 public virtual Task<ClientResult<FileDeletionResult>> DeleteFileAsync(string fileId, CancellationToken cancellationToken = default);
3057 public virtual ClientResult DownloadFile(string fileId, RequestOptions options);
3058 public virtual ClientResult<BinaryData> DownloadFile(string fileId, CancellationToken cancellationToken = default);
3059 public virtual Task<ClientResult> DownloadFileAsync(string fileId, RequestOptions options);
3060 public virtual Task<ClientResult<BinaryData>> DownloadFileAsync(string fileId, CancellationToken cancellationToken = default);
3061 public virtual ClientResult GetFile(string fileId, RequestOptions options);
3062 public virtual ClientResult<OpenAIFile> GetFile(string fileId, CancellationToken cancellationToken = default);
3063 public virtual Task<ClientResult> GetFileAsync(string fileId, RequestOptions options);
3064 public virtual Task<ClientResult<OpenAIFile>> GetFileAsync(string fileId, CancellationToken cancellationToken = default);
3065 public virtual ClientResult<OpenAIFileCollection> GetFiles(FilePurpose purpose, CancellationToken cancellationToken = default);
3066 public virtual ClientResult GetFiles(string purpose, RequestOptions options);
3067 [Experimental("OPENAI001")]
3068 public virtual ClientResult GetFiles(string purpose, long? limit, string order, string after, RequestOptions options);
3069 public virtual ClientResult<OpenAIFileCollection> GetFiles(CancellationToken cancellationToken = default);
3070 public virtual Task<ClientResult<OpenAIFileCollection>> GetFilesAsync(FilePurpose purpose, CancellationToken cancellationToken = default);
3071 public virtual Task<ClientResult> GetFilesAsync(string purpose, RequestOptions options);
3072 [Experimental("OPENAI001")]
3073 public virtual Task<ClientResult> GetFilesAsync(string purpose, long? limit, string order, string after, RequestOptions options);
3074 public virtual Task<ClientResult<OpenAIFileCollection>> GetFilesAsync(CancellationToken cancellationToken = default);
3075 public virtual ClientResult<OpenAIFile> UploadFile(BinaryData file, string filename, FileUploadPurpose purpose);
3076 public virtual ClientResult UploadFile(BinaryContent content, string contentType, RequestOptions options = null);
3077 public virtual ClientResult<OpenAIFile> UploadFile(Stream file, string filename, FileUploadPurpose purpose, CancellationToken cancellationToken = default);
3078 public virtual ClientResult<OpenAIFile> UploadFile(string filePath, FileUploadPurpose purpose);
3079 public virtual Task<ClientResult<OpenAIFile>> UploadFileAsync(BinaryData file, string filename, FileUploadPurpose purpose);
3080 public virtual Task<ClientResult> UploadFileAsync(BinaryContent content, string contentType, RequestOptions options = null);
3081 public virtual Task<ClientResult<OpenAIFile>> UploadFileAsync(Stream file, string filename, FileUploadPurpose purpose, CancellationToken cancellationToken = default);
3082 public virtual Task<ClientResult<OpenAIFile>> UploadFileAsync(string filePath, FileUploadPurpose purpose);
3083 }
3084 [Experimental("SCME0002")]
3085 public sealed class OpenAIFileClientSettings : ClientSettings {
3086 public OpenAIClientOptions Options { get; set; }
3087 protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
3088 }
3089 public class OpenAIFileCollection : ObjectModel.ReadOnlyCollection<OpenAIFile>, IJsonModel<OpenAIFileCollection>, IPersistableModel<OpenAIFileCollection> {
3090 [Experimental("OPENAI001")]
3091 protected virtual OpenAIFileCollection JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3092 [Experimental("OPENAI001")]
3093 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3094 [Experimental("OPENAI001")]
3095 public static explicit operator OpenAIFileCollection(ClientResult result);
3096 [Experimental("OPENAI001")]
3097 protected virtual OpenAIFileCollection PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3098 [Experimental("OPENAI001")]
3099 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3100 }
3101 public static class OpenAIFilesModelFactory {
3102 public static FileDeletionResult FileDeletionResult(string fileId = null, bool deleted = false);
3103 public static OpenAIFileCollection OpenAIFileCollection(IEnumerable<OpenAIFile> items = null);
3104 [Experimental("OPENAI001")]
3105 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, long? sizeInBytesLong = null);
3106 [EditorBrowsable(EditorBrowsableState.Never)]
3107 public static OpenAIFile OpenAIFileInfo(string id, int? sizeInBytes, DateTimeOffset createdAt, string filename, FilePurpose purpose, FileStatus status, string statusDetails);
3108 }
3109}
3110namespace OpenAI.FineTuning {
3111 [Experimental("OPENAI001")]
3112 public class FineTuningCheckpoint : IJsonModel<FineTuningCheckpoint>, IPersistableModel<FineTuningCheckpoint> {
3113 public DateTimeOffset CreatedAt { get; }
3114 public string Id { get; }
3115 public string JobId { get; }
3116 public FineTuningCheckpointMetrics Metrics { get; }
3117 public string ModelId { get; }
3118 public int StepNumber { get; }
3119 protected virtual FineTuningCheckpoint JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3120 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3121 protected virtual FineTuningCheckpoint PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3122 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3123 public override string ToString();
3124 }
3125 [Experimental("OPENAI001")]
3126 public class FineTuningCheckpointMetrics : IJsonModel<FineTuningCheckpointMetrics>, IPersistableModel<FineTuningCheckpointMetrics> {
3127 public float? FullValidLoss { get; }
3128 public float? FullValidMeanTokenAccuracy { get; }
3129 public int StepNumber { get; }
3130 public float? TrainLoss { get; }
3131 public float? TrainMeanTokenAccuracy { get; }
3132 public float? ValidLoss { get; }
3133 public float? ValidMeanTokenAccuracy { get; }
3134 protected virtual FineTuningCheckpointMetrics JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3135 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3136 protected virtual FineTuningCheckpointMetrics PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3137 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3138 }
3139 [Experimental("OPENAI001")]
3140 public class FineTuningClient {
3141 protected FineTuningClient();
3142 [Experimental("SCME0002")]
3143 public FineTuningClient(FineTuningClientSettings settings);
3144 public FineTuningClient(ApiKeyCredential credential, OpenAIClientOptions options);
3145 public FineTuningClient(ApiKeyCredential credential);
3146 public FineTuningClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
3147 public FineTuningClient(AuthenticationPolicy authenticationPolicy);
3148 protected internal FineTuningClient(ClientPipeline pipeline, OpenAIClientOptions options);
3149 protected internal FineTuningClient(ClientPipeline pipeline, Uri endpoint);
3150 public FineTuningClient(string apiKey);
3151 [Experimental("OPENAI001")]
3152 public Uri Endpoint { get; }
3153 public ClientPipeline Pipeline { get; }
3154 public virtual ClientResult CreateFineTuningCheckpointPermission(string fineTunedModelCheckpoint, BinaryContent content, RequestOptions options = null);
3155 public virtual Task<ClientResult> CreateFineTuningCheckpointPermissionAsync(string fineTunedModelCheckpoint, BinaryContent content, RequestOptions options = null);
3156 public virtual ClientResult DeleteFineTuningCheckpointPermission(string fineTunedModelCheckpoint, string permissionId, RequestOptions options);
3157 public virtual Task<ClientResult> DeleteFineTuningCheckpointPermissionAsync(string fineTunedModelCheckpoint, string permissionId, RequestOptions options);
3158 public virtual FineTuningJob FineTune(BinaryContent content, bool waitUntilCompleted, RequestOptions options);
3159 public virtual FineTuningJob FineTune(string baseModel, string trainingFileId, bool waitUntilCompleted, FineTuningOptions options = null, CancellationToken cancellationToken = default);
3160 public virtual Task<FineTuningJob> FineTuneAsync(BinaryContent content, bool waitUntilCompleted, RequestOptions options);
3161 public virtual Task<FineTuningJob> FineTuneAsync(string baseModel, string trainingFileId, bool waitUntilCompleted, FineTuningOptions options = null, CancellationToken cancellationToken = default);
3162 public virtual ClientResult GetFineTuningCheckpointPermissions(string fineTunedModelCheckpoint, string after, int? limit, string order, string projectId, RequestOptions options);
3163 public virtual Task<ClientResult> GetFineTuningCheckpointPermissionsAsync(string fineTunedModelCheckpoint, string after, int? limit, string order, string projectId, RequestOptions options);
3164 public virtual FineTuningJob GetJob(string jobId, CancellationToken cancellationToken = default);
3165 public virtual Task<FineTuningJob> GetJobAsync(string jobId, CancellationToken cancellationToken = default);
3166 public virtual CollectionResult<FineTuningJob> GetJobs(FineTuningJobCollectionOptions options = null, CancellationToken cancellationToken = default);
3167 public virtual AsyncCollectionResult<FineTuningJob> GetJobsAsync(FineTuningJobCollectionOptions options = null, CancellationToken cancellationToken = default);
3168 public virtual ClientResult PauseFineTuningJob(string fineTuningJobId, RequestOptions options);
3169 public virtual Task<ClientResult> PauseFineTuningJobAsync(string fineTuningJobId, RequestOptions options);
3170 public virtual ClientResult ResumeFineTuningJob(string fineTuningJobId, RequestOptions options);
3171 public virtual Task<ClientResult> ResumeFineTuningJobAsync(string fineTuningJobId, RequestOptions options);
3172 }
3173 [Experimental("SCME0002")]
3174 public sealed class FineTuningClientSettings : ClientSettings {
3175 public OpenAIClientOptions Options { get; set; }
3176 protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
3177 }
3178 [Experimental("OPENAI001")]
3179 public class FineTuningError : IJsonModel<FineTuningError>, IPersistableModel<FineTuningError> {
3180 public string Code { get; }
3181 public string InvalidParameter { get; }
3182 public string Message { get; }
3183 protected virtual FineTuningError JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3184 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3185 protected virtual FineTuningError PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3186 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3187 }
3188 [Experimental("OPENAI001")]
3189 public class FineTuningEvent : IJsonModel<FineTuningEvent>, IPersistableModel<FineTuningEvent> {
3190 public string Level;
3191 public DateTimeOffset CreatedAt { get; }
3192 public BinaryData Data { get; }
3193 public string Id { get; }
3194 public FineTuningJobEventKind? Kind { get; }
3195 public string Message { get; }
3196 protected virtual FineTuningEvent JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3197 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3198 protected virtual FineTuningEvent PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3199 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3200 }
3201 [Experimental("OPENAI001")]
3202 public readonly partial struct FineTuningHyperparameters : IJsonModel<FineTuningHyperparameters>, IPersistableModel<FineTuningHyperparameters>, IJsonModel<object>, IPersistableModel<object> {
3203 public int BatchSize { get; }
3204 public int EpochCount { get; }
3205 public float LearningRateMultiplier { get; }
3206 }
3207 [Experimental("OPENAI001")]
3208 public class FineTuningIntegration : IJsonModel<FineTuningIntegration>, IPersistableModel<FineTuningIntegration> {
3209 protected virtual FineTuningIntegration JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3210 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3211 protected virtual FineTuningIntegration PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3212 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3213 }
3214 [Experimental("OPENAI001")]
3215 public class FineTuningJob : OperationResult {
3216 public string? Value;
3217 public string BaseModel { get; }
3218 public int BillableTrainedTokenCount { get; }
3219 public DateTimeOffset? EstimatedFinishAt { get; }
3220 [Obsolete("This property is deprecated. Use the MethodHyperparameters property instead.")]
3221 public FineTuningHyperparameters Hyperparameters { get; }
3222 public IReadOnlyList<FineTuningIntegration> Integrations { get; }
3223 public string JobId { get; }
3224 public IDictionary<string, string> Metadata { get; }
3225 public MethodHyperparameters? MethodHyperparameters { get; }
3226 public override ContinuationToken? RehydrationToken { get; protected set; }
3227 public IReadOnlyList<string> ResultFileIds { get; }
3228 public int? Seed { get; }
3229 public FineTuningStatus Status { get; }
3230 public string TrainingFileId { get; }
3231 public FineTuningTrainingMethod? TrainingMethod { get; }
3232 public string? UserProvidedSuffix { get; }
3233 public string ValidationFileId { get; }
3234 public virtual ClientResult Cancel(RequestOptions options);
3235 public virtual ClientResult CancelAndUpdate(CancellationToken cancellationToken = default);
3236 public virtual Task<ClientResult> CancelAndUpdateAsync(CancellationToken cancellationToken = default);
3237 public virtual Task<ClientResult> CancelAsync(RequestOptions options);
3238 public virtual CollectionResult<FineTuningCheckpoint> GetCheckpoints(GetCheckpointsOptions? options = null, CancellationToken cancellationToken = default);
3239 public virtual CollectionResult GetCheckpoints(string? after, int? limit, RequestOptions? options);
3240 public virtual AsyncCollectionResult<FineTuningCheckpoint> GetCheckpointsAsync(GetCheckpointsOptions? options = null, CancellationToken cancellationToken = default);
3241 public virtual AsyncCollectionResult GetCheckpointsAsync(string? after, int? limit, RequestOptions? options);
3242 public virtual CollectionResult<FineTuningEvent> GetEvents(GetEventsOptions options, CancellationToken cancellationToken = default);
3243 public virtual CollectionResult GetEvents(string? after, int? limit, RequestOptions options);
3244 public virtual AsyncCollectionResult<FineTuningEvent> GetEventsAsync(GetEventsOptions options, CancellationToken cancellationToken = default);
3245 public virtual AsyncCollectionResult GetEventsAsync(string? after, int? limit, RequestOptions options);
3246 public static FineTuningJob Rehydrate(FineTuningClient client, ContinuationToken rehydrationToken, RequestOptions options);
3247 public static FineTuningJob Rehydrate(FineTuningClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
3248 public static FineTuningJob Rehydrate(FineTuningClient client, string JobId, RequestOptions options);
3249 public static FineTuningJob Rehydrate(FineTuningClient client, string JobId, CancellationToken cancellationToken = default);
3250 public static Task<FineTuningJob> RehydrateAsync(FineTuningClient client, ContinuationToken rehydrationToken, RequestOptions options);
3251 public static Task<FineTuningJob> RehydrateAsync(FineTuningClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
3252 public static Task<FineTuningJob> RehydrateAsync(FineTuningClient client, string JobId, RequestOptions options);
3253 public static Task<FineTuningJob> RehydrateAsync(FineTuningClient client, string JobId, CancellationToken cancellationToken = default);
3254 public override ClientResult UpdateStatus(RequestOptions? options);
3255 public ClientResult UpdateStatus(CancellationToken cancellationToken = default);
3256 public override ValueTask<ClientResult> UpdateStatusAsync(RequestOptions? options);
3257 public ValueTask<ClientResult> UpdateStatusAsync(CancellationToken cancellationToken = default);
3258 public override void WaitForCompletion(CancellationToken cancellationToken = default);
3259 public override ValueTask WaitForCompletionAsync(CancellationToken cancellationToken = default);
3260 }
3261 [Experimental("OPENAI001")]
3262 public class FineTuningJobCollectionOptions {
3263 public string AfterJobId { get; set; }
3264 public int? PageSize { get; set; }
3265 }
3266 [Experimental("OPENAI001")]
3267 public readonly partial struct FineTuningJobEventKind : IEquatable<FineTuningJobEventKind> {
3268 public FineTuningJobEventKind(string value);
3269 public static FineTuningJobEventKind Message { get; }
3270 public static FineTuningJobEventKind Metrics { get; }
3271 public readonly bool Equals(FineTuningJobEventKind other);
3272 [EditorBrowsable(EditorBrowsableState.Never)]
3273 public override readonly bool Equals(object obj);
3274 [EditorBrowsable(EditorBrowsableState.Never)]
3275 public override readonly int GetHashCode();
3276 public static bool operator ==(FineTuningJobEventKind left, FineTuningJobEventKind right);
3277 public static implicit operator FineTuningJobEventKind(string value);
3278 public static implicit operator FineTuningJobEventKind?(string value);
3279 public static bool operator !=(FineTuningJobEventKind left, FineTuningJobEventKind right);
3280 public override readonly string ToString();
3281 }
3282 [Experimental("OPENAI001")]
3283 public class FineTuningOptions : IJsonModel<FineTuningOptions>, IPersistableModel<FineTuningOptions> {
3284 public IList<FineTuningIntegration> Integrations { get; }
3285 public IDictionary<string, string> Metadata { get; }
3286 public int? Seed { get; set; }
3287 public string Suffix { get; set; }
3288 public FineTuningTrainingMethod TrainingMethod { get; set; }
3289 public string ValidationFile { get; set; }
3290 protected virtual FineTuningOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3291 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3292 protected virtual FineTuningOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3293 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3294 }
3295 [Experimental("OPENAI001")]
3296 public readonly partial struct FineTuningStatus : IEquatable<string>, IEquatable<FineTuningStatus> {
3297 public FineTuningStatus(string value);
3298 public static FineTuningStatus Cancelled { get; }
3299 public static FineTuningStatus Failed { get; }
3300 public bool InProgress { get; }
3301 public static FineTuningStatus Queued { get; }
3302 public static FineTuningStatus Running { get; }
3303 public static FineTuningStatus Succeeded { get; }
3304 public static FineTuningStatus ValidatingFiles { get; }
3305 public readonly bool Equals(FineTuningStatus other);
3306 [EditorBrowsable(EditorBrowsableState.Never)]
3307 public override readonly bool Equals(object obj);
3308 public readonly bool Equals(string other);
3309 [EditorBrowsable(EditorBrowsableState.Never)]
3310 public override readonly int GetHashCode();
3311 public static bool operator ==(FineTuningStatus left, FineTuningStatus right);
3312 public static implicit operator FineTuningStatus(string value);
3313 public static implicit operator FineTuningStatus?(string value);
3314 public static bool operator !=(FineTuningStatus left, FineTuningStatus right);
3315 public override readonly string ToString();
3316 }
3317 [Experimental("OPENAI001")]
3318 public class FineTuningTrainingMethod : IJsonModel<FineTuningTrainingMethod>, IPersistableModel<FineTuningTrainingMethod> {
3319 public static FineTuningTrainingMethod CreateDirectPreferenceOptimization(HyperparameterBatchSize batchSize = null, HyperparameterEpochCount epochCount = null, HyperparameterLearningRate learningRate = null, HyperparameterBetaFactor betaFactor = null);
3320 public static FineTuningTrainingMethod CreateSupervised(HyperparameterBatchSize batchSize = null, HyperparameterEpochCount epochCount = null, HyperparameterLearningRate learningRate = null);
3321 protected virtual FineTuningTrainingMethod JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3322 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3323 protected virtual FineTuningTrainingMethod PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3324 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3325 }
3326 [Experimental("OPENAI001")]
3327 public class GetCheckpointsOptions {
3328 public string AfterCheckpointId { get; set; }
3329 public int? PageSize { get; set; }
3330 }
3331 [Experimental("OPENAI001")]
3332 public class GetEventsOptions {
3333 public string AfterEventId { get; set; }
3334 public int? PageSize { get; set; }
3335 }
3336 [Experimental("OPENAI001")]
3337 public class HyperparameterBatchSize : IEquatable<int>, IEquatable<string>, IJsonModel<HyperparameterBatchSize>, IPersistableModel<HyperparameterBatchSize> {
3338 public HyperparameterBatchSize(int batchSize);
3339 public static HyperparameterBatchSize CreateAuto();
3340 public static HyperparameterBatchSize CreateSize(int batchSize);
3341 [EditorBrowsable(EditorBrowsableState.Never)]
3342 public bool Equals(int other);
3343 [EditorBrowsable(EditorBrowsableState.Never)]
3344 public override bool Equals(object other);
3345 [EditorBrowsable(EditorBrowsableState.Never)]
3346 public bool Equals(string other);
3347 [EditorBrowsable(EditorBrowsableState.Never)]
3348 public override int GetHashCode();
3349 [EditorBrowsable(EditorBrowsableState.Never)]
3350 public static bool operator ==(HyperparameterBatchSize first, HyperparameterBatchSize second);
3351 public static implicit operator HyperparameterBatchSize(int batchSize);
3352 [EditorBrowsable(EditorBrowsableState.Never)]
3353 public static bool operator !=(HyperparameterBatchSize first, HyperparameterBatchSize second);
3354 }
3355 [Experimental("OPENAI001")]
3356 public class HyperparameterBetaFactor : IEquatable<int>, IEquatable<string>, IJsonModel<HyperparameterBetaFactor>, IPersistableModel<HyperparameterBetaFactor> {
3357 public HyperparameterBetaFactor(int beta);
3358 public static HyperparameterBetaFactor CreateAuto();
3359 public static HyperparameterBetaFactor CreateBeta(int beta);
3360 [EditorBrowsable(EditorBrowsableState.Never)]
3361 public bool Equals(int other);
3362 [EditorBrowsable(EditorBrowsableState.Never)]
3363 public override bool Equals(object other);
3364 [EditorBrowsable(EditorBrowsableState.Never)]
3365 public bool Equals(string other);
3366 [EditorBrowsable(EditorBrowsableState.Never)]
3367 public override int GetHashCode();
3368 [EditorBrowsable(EditorBrowsableState.Never)]
3369 public static bool operator ==(HyperparameterBetaFactor first, HyperparameterBetaFactor second);
3370 public static implicit operator HyperparameterBetaFactor(int beta);
3371 [EditorBrowsable(EditorBrowsableState.Never)]
3372 public static bool operator !=(HyperparameterBetaFactor first, HyperparameterBetaFactor second);
3373 }
3374 [Experimental("OPENAI001")]
3375 public class HyperparameterEpochCount : IEquatable<int>, IEquatable<string>, IJsonModel<HyperparameterEpochCount>, IPersistableModel<HyperparameterEpochCount> {
3376 public HyperparameterEpochCount(int epochCount);
3377 public static HyperparameterEpochCount CreateAuto();
3378 public static HyperparameterEpochCount CreateEpochCount(int epochCount);
3379 [EditorBrowsable(EditorBrowsableState.Never)]
3380 public bool Equals(int other);
3381 [EditorBrowsable(EditorBrowsableState.Never)]
3382 public override bool Equals(object other);
3383 [EditorBrowsable(EditorBrowsableState.Never)]
3384 public bool Equals(string other);
3385 [EditorBrowsable(EditorBrowsableState.Never)]
3386 public override int GetHashCode();
3387 [EditorBrowsable(EditorBrowsableState.Never)]
3388 public static bool operator ==(HyperparameterEpochCount first, HyperparameterEpochCount second);
3389 public static implicit operator HyperparameterEpochCount(int epochCount);
3390 [EditorBrowsable(EditorBrowsableState.Never)]
3391 public static bool operator !=(HyperparameterEpochCount first, HyperparameterEpochCount second);
3392 }
3393 [Experimental("OPENAI001")]
3394 public class HyperparameterLearningRate : IEquatable<double>, IEquatable<int>, IEquatable<string>, IJsonModel<HyperparameterLearningRate>, IPersistableModel<HyperparameterLearningRate> {
3395 public HyperparameterLearningRate(double learningRateMultiplier);
3396 public static HyperparameterLearningRate CreateAuto();
3397 public static HyperparameterLearningRate CreateMultiplier(double learningRateMultiplier);
3398 [EditorBrowsable(EditorBrowsableState.Never)]
3399 public bool Equals(double other);
3400 [EditorBrowsable(EditorBrowsableState.Never)]
3401 public bool Equals(int other);
3402 [EditorBrowsable(EditorBrowsableState.Never)]
3403 public override bool Equals(object other);
3404 [EditorBrowsable(EditorBrowsableState.Never)]
3405 public bool Equals(string other);
3406 [EditorBrowsable(EditorBrowsableState.Never)]
3407 public override int GetHashCode();
3408 [EditorBrowsable(EditorBrowsableState.Never)]
3409 public static bool operator ==(HyperparameterLearningRate first, HyperparameterLearningRate second);
3410 public static implicit operator HyperparameterLearningRate(double learningRateMultiplier);
3411 [EditorBrowsable(EditorBrowsableState.Never)]
3412 public static bool operator !=(HyperparameterLearningRate first, HyperparameterLearningRate second);
3413 }
3414 [Experimental("OPENAI001")]
3415 public class HyperparametersForDPO : MethodHyperparameters, IJsonModel<HyperparametersForDPO>, IPersistableModel<HyperparametersForDPO> {
3416 public int BatchSize { get; }
3417 public float Beta { get; }
3418 public int EpochCount { get; }
3419 public float LearningRateMultiplier { get; }
3420 protected virtual HyperparametersForDPO JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3421 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3422 protected virtual HyperparametersForDPO PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3423 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3424 }
3425 [Experimental("OPENAI001")]
3426 public class HyperparametersForSupervised : MethodHyperparameters, IJsonModel<HyperparametersForSupervised>, IPersistableModel<HyperparametersForSupervised> {
3427 public int BatchSize { get; }
3428 public int EpochCount { get; }
3429 public float LearningRateMultiplier { get; }
3430 protected virtual HyperparametersForSupervised JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3431 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3432 protected virtual HyperparametersForSupervised PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3433 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3434 }
3435 [Experimental("OPENAI001")]
3436 public class MethodHyperparameters {
3437 }
3438 [Experimental("OPENAI001")]
3439 public class WeightsAndBiasesIntegration : FineTuningIntegration, IJsonModel<WeightsAndBiasesIntegration>, IPersistableModel<WeightsAndBiasesIntegration> {
3440 public WeightsAndBiasesIntegration(string projectName);
3441 public string DisplayName { get; set; }
3442 public string EntityName { get; set; }
3443 public string ProjectName { get; set; }
3444 public IList<string> Tags { get; }
3445 protected override FineTuningIntegration JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3446 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3447 protected override FineTuningIntegration PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3448 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3449 }
3450}
3451namespace OpenAI.Graders {
3452 [Experimental("OPENAI001")]
3453 public class FineTuneReinforcementHyperparameters : IJsonModel<FineTuneReinforcementHyperparameters>, IPersistableModel<FineTuneReinforcementHyperparameters> {
3454 public BinaryData BatchSize { get; set; }
3455 public BinaryData ComputeMultiplier { get; set; }
3456 public BinaryData EvalInterval { get; set; }
3457 public BinaryData EvalSamples { get; set; }
3458 public BinaryData LearningRateMultiplier { get; set; }
3459 public BinaryData NEpochs { get; set; }
3460 protected virtual FineTuneReinforcementHyperparameters JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3461 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3462 protected virtual FineTuneReinforcementHyperparameters PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3463 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3464 }
3465 [Experimental("OPENAI001")]
3466 [PersistableModelProxy(typeof(UnknownGrader))]
3467 public class Grader : IJsonModel<Grader>, IPersistableModel<Grader> {
3468 protected virtual Grader JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3469 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3470 protected virtual Grader PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3471 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3472 }
3473 [Experimental("OPENAI001")]
3474 public class GraderClient {
3475 protected GraderClient();
3476 [Experimental("SCME0002")]
3477 public GraderClient(GraderClientSettings settings);
3478 public GraderClient(ApiKeyCredential credential, OpenAIClientOptions options);
3479 public GraderClient(ApiKeyCredential credential);
3480 public GraderClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
3481 public GraderClient(AuthenticationPolicy authenticationPolicy);
3482 protected internal GraderClient(ClientPipeline pipeline, OpenAIClientOptions options);
3483 public GraderClient(string apiKey);
3484 [Experimental("OPENAI001")]
3485 public Uri Endpoint { get; }
3486 public ClientPipeline Pipeline { get; }
3487 public virtual ClientResult RunGrader(BinaryContent content, RequestOptions options = null);
3488 public virtual Task<ClientResult> RunGraderAsync(BinaryContent content, RequestOptions options = null);
3489 public virtual ClientResult ValidateGrader(BinaryContent content, RequestOptions options = null);
3490 public virtual Task<ClientResult> ValidateGraderAsync(BinaryContent content, RequestOptions options = null);
3491 }
3492 [Experimental("SCME0002")]
3493 public sealed class GraderClientSettings : ClientSettings {
3494 public OpenAIClientOptions Options { get; set; }
3495 protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
3496 }
3497 [Experimental("OPENAI001")]
3498 public class GraderLabelModel : Grader, IJsonModel<GraderLabelModel>, IPersistableModel<GraderLabelModel> {
3499 public IList<string> Labels { get; }
3500 public string Model { get; set; }
3501 public string Name { get; set; }
3502 public IList<string> PassingLabels { get; }
3503 protected override Grader JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3504 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3505 protected override Grader PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3506 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3507 }
3508 [Experimental("OPENAI001")]
3509 public class GraderMulti : Grader, IJsonModel<GraderMulti>, IPersistableModel<GraderMulti> {
3510 public GraderMulti(string name, BinaryData graders, string calculateOutput);
3511 public string CalculateOutput { get; set; }
3512 public BinaryData Graders { get; set; }
3513 public string Name { get; set; }
3514 protected override Grader JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3515 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3516 protected override Grader PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3517 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3518 }
3519 [Experimental("OPENAI001")]
3520 public class GraderPython : Grader, IJsonModel<GraderPython>, IPersistableModel<GraderPython> {
3521 public GraderPython(string name, string source);
3522 public string ImageTag { get; set; }
3523 public string Name { get; set; }
3524 public string Source { get; set; }
3525 protected override Grader JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3526 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3527 protected override Grader PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3528 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3529 }
3530 [Experimental("OPENAI001")]
3531 public class GraderScoreModel : Grader, IJsonModel<GraderScoreModel>, IPersistableModel<GraderScoreModel> {
3532 public string Model { get; set; }
3533 public string Name { get; set; }
3534 public IList<float> Range { get; }
3535 public BinaryData SamplingParams { get; set; }
3536 protected override Grader JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3537 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3538 protected override Grader PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3539 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3540 }
3541 [Experimental("OPENAI001")]
3542 public class GraderStringCheck : Grader, IJsonModel<GraderStringCheck>, IPersistableModel<GraderStringCheck> {
3543 public GraderStringCheck(string name, string input, string reference, GraderStringCheckOperation operation);
3544 public string Input { get; set; }
3545 public string Name { get; set; }
3546 public GraderStringCheckOperation Operation { get; set; }
3547 public string Reference { get; set; }
3548 protected override Grader JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3549 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3550 protected override Grader PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3551 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3552 }
3553 [Experimental("OPENAI001")]
3554 public readonly partial struct GraderStringCheckOperation : IEquatable<GraderStringCheckOperation> {
3555 public GraderStringCheckOperation(string value);
3556 public static GraderStringCheckOperation Eq { get; }
3557 public static GraderStringCheckOperation Ilike { get; }
3558 public static GraderStringCheckOperation Like { get; }
3559 public static GraderStringCheckOperation Ne { get; }
3560 public readonly bool Equals(GraderStringCheckOperation other);
3561 [EditorBrowsable(EditorBrowsableState.Never)]
3562 public override readonly bool Equals(object obj);
3563 [EditorBrowsable(EditorBrowsableState.Never)]
3564 public override readonly int GetHashCode();
3565 public static bool operator ==(GraderStringCheckOperation left, GraderStringCheckOperation right);
3566 public static implicit operator GraderStringCheckOperation(string value);
3567 public static implicit operator GraderStringCheckOperation?(string value);
3568 public static bool operator !=(GraderStringCheckOperation left, GraderStringCheckOperation right);
3569 public override readonly string ToString();
3570 }
3571 [Experimental("OPENAI001")]
3572 public class GraderTextSimilarity : Grader, IJsonModel<GraderTextSimilarity>, IPersistableModel<GraderTextSimilarity> {
3573 public GraderTextSimilarity(string name, string input, string reference, GraderTextSimilarityEvaluationMetric evaluationMetric);
3574 public GraderTextSimilarityEvaluationMetric EvaluationMetric { get; set; }
3575 public string Input { get; set; }
3576 public string Name { get; set; }
3577 public string Reference { get; set; }
3578 protected override Grader JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3579 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3580 protected override Grader PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3581 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3582 }
3583 [Experimental("OPENAI001")]
3584 public readonly partial struct GraderTextSimilarityEvaluationMetric : IEquatable<GraderTextSimilarityEvaluationMetric> {
3585 public GraderTextSimilarityEvaluationMetric(string value);
3586 public static GraderTextSimilarityEvaluationMetric Bleu { get; }
3587 public static GraderTextSimilarityEvaluationMetric FuzzyMatch { get; }
3588 public static GraderTextSimilarityEvaluationMetric Gleu { get; }
3589 public static GraderTextSimilarityEvaluationMetric Meteor { get; }
3590 public static GraderTextSimilarityEvaluationMetric Rouge1 { get; }
3591 public static GraderTextSimilarityEvaluationMetric Rouge2 { get; }
3592 public static GraderTextSimilarityEvaluationMetric Rouge3 { get; }
3593 public static GraderTextSimilarityEvaluationMetric Rouge4 { get; }
3594 public static GraderTextSimilarityEvaluationMetric Rouge5 { get; }
3595 public static GraderTextSimilarityEvaluationMetric RougeL { get; }
3596 public readonly bool Equals(GraderTextSimilarityEvaluationMetric other);
3597 [EditorBrowsable(EditorBrowsableState.Never)]
3598 public override readonly bool Equals(object obj);
3599 [EditorBrowsable(EditorBrowsableState.Never)]
3600 public override readonly int GetHashCode();
3601 public static bool operator ==(GraderTextSimilarityEvaluationMetric left, GraderTextSimilarityEvaluationMetric right);
3602 public static implicit operator GraderTextSimilarityEvaluationMetric(string value);
3603 public static implicit operator GraderTextSimilarityEvaluationMetric?(string value);
3604 public static bool operator !=(GraderTextSimilarityEvaluationMetric left, GraderTextSimilarityEvaluationMetric right);
3605 public override readonly string ToString();
3606 }
3607 [Experimental("OPENAI001")]
3608 public readonly partial struct GraderType : IEquatable<GraderType> {
3609 public GraderType(string value);
3610 public static GraderType LabelModel { get; }
3611 public static GraderType Multi { get; }
3612 public static GraderType Python { get; }
3613 public static GraderType ScoreModel { get; }
3614 public static GraderType StringCheck { get; }
3615 public static GraderType TextSimilarity { get; }
3616 public readonly bool Equals(GraderType other);
3617 [EditorBrowsable(EditorBrowsableState.Never)]
3618 public override readonly bool Equals(object obj);
3619 [EditorBrowsable(EditorBrowsableState.Never)]
3620 public override readonly int GetHashCode();
3621 public static bool operator ==(GraderType left, GraderType right);
3622 public static implicit operator GraderType(string value);
3623 public static implicit operator GraderType?(string value);
3624 public static bool operator !=(GraderType left, GraderType right);
3625 public override readonly string ToString();
3626 }
3627 [Experimental("OPENAI001")]
3628 public class RunGraderRequest : IJsonModel<RunGraderRequest>, IPersistableModel<RunGraderRequest> {
3629 public BinaryData Grader { get; }
3630 public BinaryData Item { get; }
3631 public string ModelSample { get; }
3632 protected virtual RunGraderRequest JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3633 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3634 protected virtual RunGraderRequest PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3635 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3636 }
3637 [Experimental("OPENAI001")]
3638 public class RunGraderResponse : IJsonModel<RunGraderResponse>, IPersistableModel<RunGraderResponse> {
3639 public RunGraderResponseMetadata Metadata { get; }
3640 public BinaryData ModelGraderTokenUsagePerModel { get; }
3641 public float Reward { get; }
3642 public BinaryData SubRewards { get; }
3643 protected virtual RunGraderResponse JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3644 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3645 public static explicit operator RunGraderResponse(ClientResult result);
3646 protected virtual RunGraderResponse PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3647 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3648 }
3649 [Experimental("OPENAI001")]
3650 public class RunGraderResponseMetadata : IJsonModel<RunGraderResponseMetadata>, IPersistableModel<RunGraderResponseMetadata> {
3651 public RunGraderResponseMetadataErrors Errors { get; }
3652 public float ExecutionTime { get; }
3653 public string Kind { get; }
3654 public string Name { get; }
3655 public string SampledModelName { get; }
3656 public BinaryData Scores { get; }
3657 public int? TokenUsage { get; }
3658 protected virtual RunGraderResponseMetadata JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3659 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3660 protected virtual RunGraderResponseMetadata PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3661 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3662 }
3663 [Experimental("OPENAI001")]
3664 public class RunGraderResponseMetadataErrors : IJsonModel<RunGraderResponseMetadataErrors>, IPersistableModel<RunGraderResponseMetadataErrors> {
3665 public bool FormulaParseError { get; }
3666 public bool InvalidVariableError { get; }
3667 public bool ModelGraderParseError { get; }
3668 public bool ModelGraderRefusalError { get; }
3669 public bool ModelGraderServerError { get; }
3670 public string ModelGraderServerErrorDetails { get; }
3671 public bool OtherError { get; }
3672 public bool PythonGraderRuntimeError { get; }
3673 public string PythonGraderRuntimeErrorDetails { get; }
3674 public bool PythonGraderServerError { get; }
3675 public string PythonGraderServerErrorType { get; }
3676 public bool SampleParseError { get; }
3677 public bool TruncatedObservationError { get; }
3678 public bool UnresponsiveRewardError { get; }
3679 protected virtual RunGraderResponseMetadataErrors JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3680 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3681 protected virtual RunGraderResponseMetadataErrors PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3682 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3683 }
3684 [Experimental("OPENAI001")]
3685 public class UnknownGrader : Grader, IJsonModel<Grader>, IPersistableModel<Grader> {
3686 protected override Grader JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3687 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3688 protected override Grader PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3689 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3690 }
3691 [Experimental("OPENAI001")]
3692 public class ValidateGraderRequest : IJsonModel<ValidateGraderRequest>, IPersistableModel<ValidateGraderRequest> {
3693 public BinaryData Grader { get; }
3694 protected virtual ValidateGraderRequest JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3695 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3696 protected virtual ValidateGraderRequest PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3697 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3698 }
3699 [Experimental("OPENAI001")]
3700 public class ValidateGraderResponse : IJsonModel<ValidateGraderResponse>, IPersistableModel<ValidateGraderResponse> {
3701 public BinaryData Grader { get; }
3702 protected virtual ValidateGraderResponse JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3703 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3704 public static explicit operator ValidateGraderResponse(ClientResult result);
3705 protected virtual ValidateGraderResponse PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3706 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3707 }
3708}
3709namespace OpenAI.Images {
3710 public class GeneratedImage : IJsonModel<GeneratedImage>, IPersistableModel<GeneratedImage> {
3711 public BinaryData ImageBytes { get; }
3712 public Uri ImageUri { get; }
3713 public string RevisedPrompt { get; }
3714 [Experimental("OPENAI001")]
3715 protected virtual GeneratedImage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3716 [Experimental("OPENAI001")]
3717 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3718 [Experimental("OPENAI001")]
3719 protected virtual GeneratedImage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3720 [Experimental("OPENAI001")]
3721 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3722 }
3723 [Experimental("OPENAI001")]
3724 public readonly partial struct GeneratedImageBackground : IEquatable<GeneratedImageBackground> {
3725 public GeneratedImageBackground(string value);
3726 public static GeneratedImageBackground Auto { get; }
3727 public static GeneratedImageBackground Opaque { get; }
3728 public static GeneratedImageBackground Transparent { get; }
3729 public readonly bool Equals(GeneratedImageBackground other);
3730 [EditorBrowsable(EditorBrowsableState.Never)]
3731 public override readonly bool Equals(object obj);
3732 [EditorBrowsable(EditorBrowsableState.Never)]
3733 public override readonly int GetHashCode();
3734 public static bool operator ==(GeneratedImageBackground left, GeneratedImageBackground right);
3735 public static implicit operator GeneratedImageBackground(string value);
3736 public static implicit operator GeneratedImageBackground?(string value);
3737 public static bool operator !=(GeneratedImageBackground left, GeneratedImageBackground right);
3738 public override readonly string ToString();
3739 }
3740 public class GeneratedImageCollection : ObjectModel.ReadOnlyCollection<GeneratedImage>, IJsonModel<GeneratedImageCollection>, IPersistableModel<GeneratedImageCollection> {
3741 [Experimental("OPENAI001")]
3742 public GeneratedImageBackground? Background { get; }
3743 public DateTimeOffset CreatedAt { get; }
3744 [Experimental("OPENAI001")]
3745 public GeneratedImageFileFormat? OutputFileFormat { get; }
3746 [Experimental("OPENAI001")]
3747 public GeneratedImageQuality? Quality { get; }
3748 [Experimental("OPENAI001")]
3749 public GeneratedImageSize? Size { get; }
3750 [Experimental("OPENAI001")]
3751 public ImageTokenUsage Usage { get; }
3752 [Experimental("OPENAI001")]
3753 protected virtual GeneratedImageCollection JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3754 [Experimental("OPENAI001")]
3755 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3756 [Experimental("OPENAI001")]
3757 public static explicit operator GeneratedImageCollection(ClientResult result);
3758 [Experimental("OPENAI001")]
3759 protected virtual GeneratedImageCollection PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3760 [Experimental("OPENAI001")]
3761 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3762 }
3763 [Experimental("OPENAI001")]
3764 public readonly partial struct GeneratedImageFileFormat : IEquatable<GeneratedImageFileFormat> {
3765 public GeneratedImageFileFormat(string value);
3766 public static GeneratedImageFileFormat Jpeg { get; }
3767 public static GeneratedImageFileFormat Png { get; }
3768 public static GeneratedImageFileFormat Webp { get; }
3769 public readonly bool Equals(GeneratedImageFileFormat other);
3770 [EditorBrowsable(EditorBrowsableState.Never)]
3771 public override readonly bool Equals(object obj);
3772 [EditorBrowsable(EditorBrowsableState.Never)]
3773 public override readonly int GetHashCode();
3774 public static bool operator ==(GeneratedImageFileFormat left, GeneratedImageFileFormat right);
3775 public static implicit operator GeneratedImageFileFormat(string value);
3776 public static implicit operator GeneratedImageFileFormat?(string value);
3777 public static bool operator !=(GeneratedImageFileFormat left, GeneratedImageFileFormat right);
3778 public override readonly string ToString();
3779 }
3780 public readonly partial struct GeneratedImageFormat : IEquatable<GeneratedImageFormat> {
3781 public GeneratedImageFormat(string value);
3782 public static GeneratedImageFormat Bytes { get; }
3783 public static GeneratedImageFormat Uri { get; }
3784 public readonly bool Equals(GeneratedImageFormat other);
3785 [EditorBrowsable(EditorBrowsableState.Never)]
3786 public override readonly bool Equals(object obj);
3787 [EditorBrowsable(EditorBrowsableState.Never)]
3788 public override readonly int GetHashCode();
3789 public static bool operator ==(GeneratedImageFormat left, GeneratedImageFormat right);
3790 public static implicit operator GeneratedImageFormat(string value);
3791 public static implicit operator GeneratedImageFormat?(string value);
3792 public static bool operator !=(GeneratedImageFormat left, GeneratedImageFormat right);
3793 public override readonly string ToString();
3794 }
3795 [Experimental("OPENAI001")]
3796 public readonly partial struct GeneratedImageModerationLevel : IEquatable<GeneratedImageModerationLevel> {
3797 public GeneratedImageModerationLevel(string value);
3798 public static GeneratedImageModerationLevel Auto { get; }
3799 public static GeneratedImageModerationLevel Low { get; }
3800 public readonly bool Equals(GeneratedImageModerationLevel other);
3801 [EditorBrowsable(EditorBrowsableState.Never)]
3802 public override readonly bool Equals(object obj);
3803 [EditorBrowsable(EditorBrowsableState.Never)]
3804 public override readonly int GetHashCode();
3805 public static bool operator ==(GeneratedImageModerationLevel left, GeneratedImageModerationLevel right);
3806 public static implicit operator GeneratedImageModerationLevel(string value);
3807 public static implicit operator GeneratedImageModerationLevel?(string value);
3808 public static bool operator !=(GeneratedImageModerationLevel left, GeneratedImageModerationLevel right);
3809 public override readonly string ToString();
3810 }
3811 public readonly partial struct GeneratedImageQuality : IEquatable<GeneratedImageQuality> {
3812 public GeneratedImageQuality(string value);
3813 [Experimental("OPENAI001")]
3814 public static GeneratedImageQuality Auto { get; }
3815 public static GeneratedImageQuality High { get; }
3816 [Experimental("OPENAI001")]
3817 public static GeneratedImageQuality HighQuality { get; }
3818 [Experimental("OPENAI001")]
3819 public static GeneratedImageQuality LowQuality { get; }
3820 [Experimental("OPENAI001")]
3821 public static GeneratedImageQuality MediumQuality { get; }
3822 public static GeneratedImageQuality Standard { get; }
3823 public readonly bool Equals(GeneratedImageQuality other);
3824 [EditorBrowsable(EditorBrowsableState.Never)]
3825 public override readonly bool Equals(object obj);
3826 [EditorBrowsable(EditorBrowsableState.Never)]
3827 public override readonly int GetHashCode();
3828 public static bool operator ==(GeneratedImageQuality left, GeneratedImageQuality right);
3829 public static implicit operator GeneratedImageQuality(string value);
3830 public static implicit operator GeneratedImageQuality?(string value);
3831 public static bool operator !=(GeneratedImageQuality left, GeneratedImageQuality right);
3832 public override readonly string ToString();
3833 }
3834 public readonly partial struct GeneratedImageSize : IEquatable<GeneratedImageSize> {
3835 public static readonly GeneratedImageSize W1024xH1024;
3836 [Experimental("OPENAI001")]
3837 public static readonly GeneratedImageSize W1024xH1536;
3838 public static readonly GeneratedImageSize W1024xH1792;
3839 [Experimental("OPENAI001")]
3840 public static readonly GeneratedImageSize W1536xH1024;
3841 public static readonly GeneratedImageSize W1792xH1024;
3842 public static readonly GeneratedImageSize W256xH256;
3843 public static readonly GeneratedImageSize W512xH512;
3844 public GeneratedImageSize(int width, int height);
3845 [Experimental("OPENAI001")]
3846 public static GeneratedImageSize Auto { get; }
3847 public readonly bool Equals(GeneratedImageSize other);
3848 [EditorBrowsable(EditorBrowsableState.Never)]
3849 public override readonly bool Equals(object obj);
3850 [EditorBrowsable(EditorBrowsableState.Never)]
3851 public override readonly int GetHashCode();
3852 public static bool operator ==(GeneratedImageSize left, GeneratedImageSize right);
3853 public static bool operator !=(GeneratedImageSize left, GeneratedImageSize right);
3854 public override readonly string ToString();
3855 }
3856 public readonly partial struct GeneratedImageStyle : IEquatable<GeneratedImageStyle> {
3857 public GeneratedImageStyle(string value);
3858 public static GeneratedImageStyle Natural { get; }
3859 public static GeneratedImageStyle Vivid { get; }
3860 public readonly bool Equals(GeneratedImageStyle other);
3861 [EditorBrowsable(EditorBrowsableState.Never)]
3862 public override readonly bool Equals(object obj);
3863 [EditorBrowsable(EditorBrowsableState.Never)]
3864 public override readonly int GetHashCode();
3865 public static bool operator ==(GeneratedImageStyle left, GeneratedImageStyle right);
3866 public static implicit operator GeneratedImageStyle(string value);
3867 public static implicit operator GeneratedImageStyle?(string value);
3868 public static bool operator !=(GeneratedImageStyle left, GeneratedImageStyle right);
3869 public override readonly string ToString();
3870 }
3871 public class ImageClient {
3872 protected ImageClient();
3873 [Experimental("SCME0002")]
3874 public ImageClient(ImageClientSettings settings);
3875 protected internal ImageClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
3876 public ImageClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
3877 public ImageClient(string model, ApiKeyCredential credential);
3878 [Experimental("OPENAI001")]
3879 public ImageClient(string model, AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
3880 [Experimental("OPENAI001")]
3881 public ImageClient(string model, AuthenticationPolicy authenticationPolicy);
3882 public ImageClient(string model, string apiKey);
3883 [Experimental("OPENAI001")]
3884 public Uri Endpoint { get; }
3885 [Experimental("OPENAI001")]
3886 public string Model { get; }
3887 public ClientPipeline Pipeline { get; }
3888 public virtual ClientResult<GeneratedImage> GenerateImage(string prompt, ImageGenerationOptions options = null, CancellationToken cancellationToken = default);
3889 public virtual Task<ClientResult<GeneratedImage>> GenerateImageAsync(string prompt, ImageGenerationOptions options = null, CancellationToken cancellationToken = default);
3890 public virtual ClientResult<GeneratedImage> GenerateImageEdit(Stream image, string imageFilename, string prompt, ImageEditOptions options = null, CancellationToken cancellationToken = default);
3891 public virtual ClientResult<GeneratedImage> GenerateImageEdit(Stream image, string imageFilename, string prompt, Stream mask, string maskFilename, ImageEditOptions options = null, CancellationToken cancellationToken = default);
3892 public virtual ClientResult<GeneratedImage> GenerateImageEdit(string imageFilePath, string prompt, ImageEditOptions options = null);
3893 public virtual ClientResult<GeneratedImage> GenerateImageEdit(string imageFilePath, string prompt, string maskFilePath, ImageEditOptions options = null);
3894 public virtual Task<ClientResult<GeneratedImage>> GenerateImageEditAsync(Stream image, string imageFilename, string prompt, ImageEditOptions options = null, CancellationToken cancellationToken = default);
3895 public virtual Task<ClientResult<GeneratedImage>> GenerateImageEditAsync(Stream image, string imageFilename, string prompt, Stream mask, string maskFilename, ImageEditOptions options = null, CancellationToken cancellationToken = default);
3896 public virtual Task<ClientResult<GeneratedImage>> GenerateImageEditAsync(string imageFilePath, string prompt, ImageEditOptions options = null);
3897 public virtual Task<ClientResult<GeneratedImage>> GenerateImageEditAsync(string imageFilePath, string prompt, string maskFilePath, ImageEditOptions options = null);
3898 public virtual ClientResult GenerateImageEdits(BinaryContent content, string contentType, RequestOptions options = null);
3899 public virtual ClientResult<GeneratedImageCollection> GenerateImageEdits(Stream image, string imageFilename, string prompt, int imageCount, ImageEditOptions options = null, CancellationToken cancellationToken = default);
3900 public virtual ClientResult<GeneratedImageCollection> GenerateImageEdits(Stream image, string imageFilename, string prompt, Stream mask, string maskFilename, int imageCount, ImageEditOptions options = null, CancellationToken cancellationToken = default);
3901 public virtual ClientResult<GeneratedImageCollection> GenerateImageEdits(string imageFilePath, string prompt, int imageCount, ImageEditOptions options = null);
3902 public virtual ClientResult<GeneratedImageCollection> GenerateImageEdits(string imageFilePath, string prompt, string maskFilePath, int imageCount, ImageEditOptions options = null);
3903 public virtual Task<ClientResult> GenerateImageEditsAsync(BinaryContent content, string contentType, RequestOptions options = null);
3904 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageEditsAsync(Stream image, string imageFilename, string prompt, int imageCount, ImageEditOptions options = null, CancellationToken cancellationToken = default);
3905 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageEditsAsync(Stream image, string imageFilename, string prompt, Stream mask, string maskFilename, int imageCount, ImageEditOptions options = null, CancellationToken cancellationToken = default);
3906 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageEditsAsync(string imageFilePath, string prompt, int imageCount, ImageEditOptions options = null);
3907 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageEditsAsync(string imageFilePath, string prompt, string maskFilePath, int imageCount, ImageEditOptions options = null);
3908 public virtual ClientResult GenerateImages(BinaryContent content, RequestOptions options = null);
3909 public virtual ClientResult<GeneratedImageCollection> GenerateImages(string prompt, int imageCount, ImageGenerationOptions options = null, CancellationToken cancellationToken = default);
3910 public virtual Task<ClientResult> GenerateImagesAsync(BinaryContent content, RequestOptions options = null);
3911 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImagesAsync(string prompt, int imageCount, ImageGenerationOptions options = null, CancellationToken cancellationToken = default);
3912 public virtual ClientResult<GeneratedImage> GenerateImageVariation(Stream image, string imageFilename, ImageVariationOptions options = null, CancellationToken cancellationToken = default);
3913 public virtual ClientResult<GeneratedImage> GenerateImageVariation(string imageFilePath, ImageVariationOptions options = null);
3914 public virtual Task<ClientResult<GeneratedImage>> GenerateImageVariationAsync(Stream image, string imageFilename, ImageVariationOptions options = null, CancellationToken cancellationToken = default);
3915 public virtual Task<ClientResult<GeneratedImage>> GenerateImageVariationAsync(string imageFilePath, ImageVariationOptions options = null);
3916 public virtual ClientResult GenerateImageVariations(BinaryContent content, string contentType, RequestOptions options = null);
3917 public virtual ClientResult<GeneratedImageCollection> GenerateImageVariations(Stream image, string imageFilename, int imageCount, ImageVariationOptions options = null, CancellationToken cancellationToken = default);
3918 public virtual ClientResult<GeneratedImageCollection> GenerateImageVariations(string imageFilePath, int imageCount, ImageVariationOptions options = null);
3919 public virtual Task<ClientResult> GenerateImageVariationsAsync(BinaryContent content, string contentType, RequestOptions options = null);
3920 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageVariationsAsync(Stream image, string imageFilename, int imageCount, ImageVariationOptions options = null, CancellationToken cancellationToken = default);
3921 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageVariationsAsync(string imageFilePath, int imageCount, ImageVariationOptions options = null);
3922 }
3923 [Experimental("SCME0002")]
3924 public sealed class ImageClientSettings : ClientSettings {
3925 public string Model { get; set; }
3926 public OpenAIClientOptions Options { get; set; }
3927 protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
3928 }
3929 public class ImageEditOptions : IJsonModel<ImageEditOptions>, IPersistableModel<ImageEditOptions> {
3930 [Experimental("OPENAI001")]
3931 public GeneratedImageBackground? Background { get; set; }
3932 public string EndUserId { get; set; }
3933 [Experimental("OPENAI001")]
3934 public ImageInputFidelity? InputFidelity { get; set; }
3935 [Experimental("OPENAI001")]
3936 public int? OutputCompressionFactor { get; set; }
3937 [Experimental("OPENAI001")]
3938 public GeneratedImageFileFormat? OutputFileFormat { get; set; }
3939 [Experimental("OPENAI001")]
3940 public GeneratedImageQuality? Quality { get; set; }
3941 public GeneratedImageFormat? ResponseFormat { get; set; }
3942 public GeneratedImageSize? Size { get; set; }
3943 [Experimental("OPENAI001")]
3944 protected virtual ImageEditOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3945 [Experimental("OPENAI001")]
3946 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3947 [Experimental("OPENAI001")]
3948 protected virtual ImageEditOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3949 [Experimental("OPENAI001")]
3950 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3951 }
3952 public class ImageGenerationOptions : IJsonModel<ImageGenerationOptions>, IPersistableModel<ImageGenerationOptions> {
3953 [Experimental("OPENAI001")]
3954 public GeneratedImageBackground? Background { get; set; }
3955 public string EndUserId { get; set; }
3956 [Experimental("OPENAI001")]
3957 public GeneratedImageModerationLevel? ModerationLevel { get; set; }
3958 [Experimental("OPENAI001")]
3959 public int? OutputCompressionFactor { get; set; }
3960 [Experimental("OPENAI001")]
3961 public GeneratedImageFileFormat? OutputFileFormat { get; set; }
3962 public GeneratedImageQuality? Quality { get; set; }
3963 public GeneratedImageFormat? ResponseFormat { get; set; }
3964 public GeneratedImageSize? Size { get; set; }
3965 public GeneratedImageStyle? Style { get; set; }
3966 [Experimental("OPENAI001")]
3967 protected virtual ImageGenerationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3968 [Experimental("OPENAI001")]
3969 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3970 [Experimental("OPENAI001")]
3971 protected virtual ImageGenerationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3972 [Experimental("OPENAI001")]
3973 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3974 }
3975 [Experimental("OPENAI001")]
3976 public readonly partial struct ImageInputFidelity : IEquatable<ImageInputFidelity> {
3977 public ImageInputFidelity(string value);
3978 public static ImageInputFidelity High { get; }
3979 public static ImageInputFidelity Low { get; }
3980 public readonly bool Equals(ImageInputFidelity other);
3981 [EditorBrowsable(EditorBrowsableState.Never)]
3982 public override readonly bool Equals(object obj);
3983 [EditorBrowsable(EditorBrowsableState.Never)]
3984 public override readonly int GetHashCode();
3985 public static bool operator ==(ImageInputFidelity left, ImageInputFidelity right);
3986 public static implicit operator ImageInputFidelity(string value);
3987 public static implicit operator ImageInputFidelity?(string value);
3988 public static bool operator !=(ImageInputFidelity left, ImageInputFidelity right);
3989 public override readonly string ToString();
3990 }
3991 [Experimental("OPENAI001")]
3992 public class ImageInputTokenUsageDetails : IJsonModel<ImageInputTokenUsageDetails>, IPersistableModel<ImageInputTokenUsageDetails> {
3993 public long ImageTokenCount { get; }
3994 public long TextTokenCount { get; }
3995 protected virtual ImageInputTokenUsageDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3996 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3997 protected virtual ImageInputTokenUsageDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3998 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3999 }
4000 [Experimental("OPENAI001")]
4001 public class ImageOutputTokenUsageDetails : IJsonModel<ImageOutputTokenUsageDetails>, IPersistableModel<ImageOutputTokenUsageDetails> {
4002 public long ImageTokenCount { get; }
4003 public long TextTokenCount { get; }
4004 protected virtual ImageOutputTokenUsageDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4005 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4006 protected virtual ImageOutputTokenUsageDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4007 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4008 }
4009 [Experimental("OPENAI001")]
4010 public class ImageTokenUsage : IJsonModel<ImageTokenUsage>, IPersistableModel<ImageTokenUsage> {
4011 public long InputTokenCount { get; }
4012 public ImageInputTokenUsageDetails InputTokenDetails { get; }
4013 public long OutputTokenCount { get; }
4014 public ImageOutputTokenUsageDetails OutputTokenDetails { get; }
4015 public long TotalTokenCount { get; }
4016 protected virtual ImageTokenUsage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4017 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4018 protected virtual ImageTokenUsage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4019 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4020 }
4021 public class ImageVariationOptions : IJsonModel<ImageVariationOptions>, IPersistableModel<ImageVariationOptions> {
4022 public string EndUserId { get; set; }
4023 public GeneratedImageFormat? ResponseFormat { get; set; }
4024 public GeneratedImageSize? Size { get; set; }
4025 [Experimental("OPENAI001")]
4026 protected virtual ImageVariationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4027 [Experimental("OPENAI001")]
4028 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4029 [Experimental("OPENAI001")]
4030 protected virtual ImageVariationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4031 [Experimental("OPENAI001")]
4032 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4033 }
4034 public static class OpenAIImagesModelFactory {
4035 public static GeneratedImage GeneratedImage(BinaryData imageBytes = null, Uri imageUri = null, string revisedPrompt = null);
4036 [Experimental("OPENAI001")]
4037 public static GeneratedImageCollection GeneratedImageCollection(DateTimeOffset createdAt = default, IEnumerable<GeneratedImage> items = null, GeneratedImageBackground? background = null, GeneratedImageFileFormat? outputFileFormat = null, GeneratedImageSize? size = null, GeneratedImageQuality? quality = null, ImageTokenUsage usage = null);
4038 [EditorBrowsable(EditorBrowsableState.Never)]
4039 public static GeneratedImageCollection GeneratedImageCollection(DateTimeOffset createdAt, IEnumerable<GeneratedImage> items);
4040 [Experimental("OPENAI001")]
4041 public static ImageInputTokenUsageDetails ImageInputTokenUsageDetails(long textTokenCount = 0, long imageTokenCount = 0);
4042 [Experimental("OPENAI001")]
4043 public static ImageTokenUsage ImageTokenUsage(long inputTokenCount = 0, long outputTokenCount = 0, long totalTokenCount = 0, ImageInputTokenUsageDetails inputTokenDetails = null, ImageOutputTokenUsageDetails outputTokenDetails = null);
4044 }
4045}
4046namespace OpenAI.Models {
4047 public class ModelDeletionResult : IJsonModel<ModelDeletionResult>, IPersistableModel<ModelDeletionResult> {
4048 public bool Deleted { get; }
4049 public string ModelId { get; }
4050 [Experimental("OPENAI001")]
4051 protected virtual ModelDeletionResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4052 [Experimental("OPENAI001")]
4053 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4054 [Experimental("OPENAI001")]
4055 public static explicit operator ModelDeletionResult(ClientResult result);
4056 [Experimental("OPENAI001")]
4057 protected virtual ModelDeletionResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4058 [Experimental("OPENAI001")]
4059 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4060 }
4061 public class OpenAIModel : IJsonModel<OpenAIModel>, IPersistableModel<OpenAIModel> {
4062 public DateTimeOffset CreatedAt { get; }
4063 public string Id { get; }
4064 public string OwnedBy { get; }
4065 [Experimental("OPENAI001")]
4066 protected virtual OpenAIModel JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4067 [Experimental("OPENAI001")]
4068 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4069 [Experimental("OPENAI001")]
4070 public static explicit operator OpenAIModel(ClientResult result);
4071 [Experimental("OPENAI001")]
4072 protected virtual OpenAIModel PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4073 [Experimental("OPENAI001")]
4074 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4075 }
4076 public class OpenAIModelClient {
4077 protected OpenAIModelClient();
4078 [Experimental("SCME0002")]
4079 public OpenAIModelClient(OpenAIModelClientSettings settings);
4080 public OpenAIModelClient(ApiKeyCredential credential, OpenAIClientOptions options);
4081 public OpenAIModelClient(ApiKeyCredential credential);
4082 [Experimental("OPENAI001")]
4083 public OpenAIModelClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
4084 [Experimental("OPENAI001")]
4085 public OpenAIModelClient(AuthenticationPolicy authenticationPolicy);
4086 protected internal OpenAIModelClient(ClientPipeline pipeline, OpenAIClientOptions options);
4087 public OpenAIModelClient(string apiKey);
4088 [Experimental("OPENAI001")]
4089 public Uri Endpoint { get; }
4090 public ClientPipeline Pipeline { get; }
4091 public virtual ClientResult DeleteModel(string model, RequestOptions options);
4092 public virtual ClientResult<ModelDeletionResult> DeleteModel(string model, CancellationToken cancellationToken = default);
4093 public virtual Task<ClientResult> DeleteModelAsync(string model, RequestOptions options);
4094 public virtual Task<ClientResult<ModelDeletionResult>> DeleteModelAsync(string model, CancellationToken cancellationToken = default);
4095 public virtual ClientResult GetModel(string model, RequestOptions options);
4096 public virtual ClientResult<OpenAIModel> GetModel(string model, CancellationToken cancellationToken = default);
4097 public virtual Task<ClientResult> GetModelAsync(string model, RequestOptions options);
4098 public virtual Task<ClientResult<OpenAIModel>> GetModelAsync(string model, CancellationToken cancellationToken = default);
4099 public virtual ClientResult GetModels(RequestOptions options);
4100 public virtual ClientResult<OpenAIModelCollection> GetModels(CancellationToken cancellationToken = default);
4101 public virtual Task<ClientResult> GetModelsAsync(RequestOptions options);
4102 public virtual Task<ClientResult<OpenAIModelCollection>> GetModelsAsync(CancellationToken cancellationToken = default);
4103 }
4104 [Experimental("SCME0002")]
4105 public sealed class OpenAIModelClientSettings : ClientSettings {
4106 public OpenAIClientOptions Options { get; set; }
4107 protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
4108 }
4109 public class OpenAIModelCollection : ObjectModel.ReadOnlyCollection<OpenAIModel>, IJsonModel<OpenAIModelCollection>, IPersistableModel<OpenAIModelCollection> {
4110 [Experimental("OPENAI001")]
4111 protected virtual OpenAIModelCollection JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4112 [Experimental("OPENAI001")]
4113 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4114 [Experimental("OPENAI001")]
4115 public static explicit operator OpenAIModelCollection(ClientResult result);
4116 [Experimental("OPENAI001")]
4117 protected virtual OpenAIModelCollection PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4118 [Experimental("OPENAI001")]
4119 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4120 }
4121 public static class OpenAIModelsModelFactory {
4122 public static ModelDeletionResult ModelDeletionResult(string modelId = null, bool deleted = false);
4123 public static OpenAIModel OpenAIModel(string id = null, DateTimeOffset createdAt = default, string ownedBy = null);
4124 public static OpenAIModelCollection OpenAIModelCollection(IEnumerable<OpenAIModel> items = null);
4125 }
4126}
4127namespace OpenAI.Moderations {
4128 [Experimental("OPENAI001")]
4129 [Flags]
4130 public enum ModerationApplicableInputKinds {
4131 None = 0,
4132 Other = 1,
4133 Text = 2,
4134 Image = 4
4135 }
4136 public class ModerationCategory {
4137 [Experimental("OPENAI001")]
4138 public ModerationApplicableInputKinds ApplicableInputKinds { get; }
4139 public bool Flagged { get; }
4140 public float Score { get; }
4141 }
4142 public class ModerationClient {
4143 protected ModerationClient();
4144 [Experimental("SCME0002")]
4145 public ModerationClient(ModerationClientSettings settings);
4146 protected internal ModerationClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
4147 public ModerationClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
4148 public ModerationClient(string model, ApiKeyCredential credential);
4149 [Experimental("OPENAI001")]
4150 public ModerationClient(string model, AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
4151 [Experimental("OPENAI001")]
4152 public ModerationClient(string model, AuthenticationPolicy authenticationPolicy);
4153 public ModerationClient(string model, string apiKey);
4154 [Experimental("OPENAI001")]
4155 public Uri Endpoint { get; }
4156 [Experimental("OPENAI001")]
4157 public string Model { get; }
4158 public ClientPipeline Pipeline { get; }
4159 [Experimental("OPENAI001")]
4160 public virtual ClientResult ClassifyInputs(BinaryContent content, RequestOptions options = null);
4161 [Experimental("OPENAI001")]
4162 public virtual ClientResult<ModerationResult> ClassifyInputs(IEnumerable<ModerationInputPart> inputParts, CancellationToken cancellationToken = default);
4163 [Experimental("OPENAI001")]
4164 public virtual Task<ClientResult> ClassifyInputsAsync(BinaryContent content, RequestOptions options = null);
4165 [Experimental("OPENAI001")]
4166 public virtual Task<ClientResult<ModerationResult>> ClassifyInputsAsync(IEnumerable<ModerationInputPart> inputParts, CancellationToken cancellationToken = default);
4167 public virtual ClientResult ClassifyText(BinaryContent content, RequestOptions options = null);
4168 public virtual ClientResult<ModerationResultCollection> ClassifyText(IEnumerable<string> inputs, CancellationToken cancellationToken = default);
4169 public virtual ClientResult<ModerationResult> ClassifyText(string input, CancellationToken cancellationToken = default);
4170 public virtual Task<ClientResult> ClassifyTextAsync(BinaryContent content, RequestOptions options = null);
4171 public virtual Task<ClientResult<ModerationResultCollection>> ClassifyTextAsync(IEnumerable<string> inputs, CancellationToken cancellationToken = default);
4172 public virtual Task<ClientResult<ModerationResult>> ClassifyTextAsync(string input, CancellationToken cancellationToken = default);
4173 }
4174 [Experimental("SCME0002")]
4175 public sealed class ModerationClientSettings : ClientSettings {
4176 public string Model { get; set; }
4177 public OpenAIClientOptions Options { get; set; }
4178 protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
4179 }
4180 [Experimental("OPENAI001")]
4181 public class ModerationInputPart : IJsonModel<ModerationInputPart>, IPersistableModel<ModerationInputPart> {
4182 public Uri ImageUri { get; }
4183 public ModerationInputPartKind Kind { get; }
4184 public string Text { get; }
4185 public static ModerationInputPart CreateImagePart(Uri imageUri);
4186 public static ModerationInputPart CreateTextPart(string text);
4187 protected virtual ModerationInputPart JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4188 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4189 protected virtual ModerationInputPart PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4190 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4191 }
4192 [Experimental("OPENAI001")]
4193 public enum ModerationInputPartKind {
4194 Text = 0,
4195 Image = 1
4196 }
4197 public class ModerationResult : IJsonModel<ModerationResult>, IPersistableModel<ModerationResult> {
4198 public bool Flagged { get; }
4199 public ModerationCategory Harassment { get; }
4200 public ModerationCategory HarassmentThreatening { get; }
4201 public ModerationCategory Hate { get; }
4202 public ModerationCategory HateThreatening { get; }
4203 public ModerationCategory Illicit { get; }
4204 public ModerationCategory IllicitViolent { get; }
4205 public ModerationCategory SelfHarm { get; }
4206 public ModerationCategory SelfHarmInstructions { get; }
4207 public ModerationCategory SelfHarmIntent { get; }
4208 public ModerationCategory Sexual { get; }
4209 public ModerationCategory SexualMinors { get; }
4210 public ModerationCategory Violence { get; }
4211 public ModerationCategory ViolenceGraphic { get; }
4212 [Experimental("OPENAI001")]
4213 protected virtual ModerationResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4214 [Experimental("OPENAI001")]
4215 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4216 [Experimental("OPENAI001")]
4217 protected virtual ModerationResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4218 [Experimental("OPENAI001")]
4219 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4220 }
4221 public class ModerationResultCollection : ObjectModel.ReadOnlyCollection<ModerationResult>, IJsonModel<ModerationResultCollection>, IPersistableModel<ModerationResultCollection> {
4222 public string Id { get; }
4223 public string Model { get; }
4224 [Experimental("OPENAI001")]
4225 protected virtual ModerationResultCollection JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4226 [Experimental("OPENAI001")]
4227 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4228 [Experimental("OPENAI001")]
4229 public static explicit operator ModerationResultCollection(ClientResult result);
4230 [Experimental("OPENAI001")]
4231 protected virtual ModerationResultCollection PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4232 [Experimental("OPENAI001")]
4233 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4234 }
4235 public static class OpenAIModerationsModelFactory {
4236 public static ModerationCategory ModerationCategory(bool flagged = false, float score = 0);
4237 [Experimental("OPENAI001")]
4238 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);
4239 [EditorBrowsable(EditorBrowsableState.Never)]
4240 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);
4241 public static ModerationResultCollection ModerationResultCollection(string id = null, string model = null, IEnumerable<ModerationResult> items = null);
4242 }
4243}
4244namespace OpenAI.Realtime {
4245 [Experimental("OPENAI002")]
4246 public class CreateClientSecretOptions : IJsonModel<CreateClientSecretOptions>, IPersistableModel<CreateClientSecretOptions> {
4247 public RealtimeClientSecretExpirationPolicy ExpirationPolicy { get; set; }
4248 [Serialization.JsonIgnore]
4249 [EditorBrowsable(EditorBrowsableState.Never)]
4250 [Experimental("SCME0001")]
4251 public ref JsonPatch Patch { get; }
4252 public RealtimeSessionOptions SessionOptions { get; set; }
4253 protected virtual CreateClientSecretOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4254 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4255 public static implicit operator BinaryContent(CreateClientSecretOptions createClientSecretOptions);
4256 protected virtual CreateClientSecretOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4257 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4258 }
4259 [Experimental("OPENAI002")]
4260 public class CreateClientSecretResult : IJsonModel<CreateClientSecretResult>, IPersistableModel<CreateClientSecretResult> {
4261 public DateTimeOffset ExpiresAt { get; }
4262 [Serialization.JsonIgnore]
4263 [EditorBrowsable(EditorBrowsableState.Never)]
4264 [Experimental("SCME0001")]
4265 public ref JsonPatch Patch { get; }
4266 public RealtimeSession Session { get; }
4267 public string Value { get; }
4268 protected virtual CreateClientSecretResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4269 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4270 public static explicit operator CreateClientSecretResult(ClientResult result);
4271 protected virtual CreateClientSecretResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4272 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4273 }
4274 [Experimental("OPENAI002")]
4275 public class RealtimeAudioFormat : IJsonModel<RealtimeAudioFormat>, IPersistableModel<RealtimeAudioFormat> {
4276 [Serialization.JsonIgnore]
4277 [EditorBrowsable(EditorBrowsableState.Never)]
4278 [Experimental("SCME0001")]
4279 public ref JsonPatch Patch { get; }
4280 protected virtual RealtimeAudioFormat JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4281 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4282 protected virtual RealtimeAudioFormat PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4283 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4284 }
4285 [Experimental("OPENAI002")]
4286 public class RealtimeAudioTranscriptionOptions : IJsonModel<RealtimeAudioTranscriptionOptions>, IPersistableModel<RealtimeAudioTranscriptionOptions> {
4287 public string Language { get; set; }
4288 public string Model { get; set; }
4289 [Serialization.JsonIgnore]
4290 [EditorBrowsable(EditorBrowsableState.Never)]
4291 [Experimental("SCME0001")]
4292 public ref JsonPatch Patch { get; }
4293 public string Prompt { get; set; }
4294 protected virtual RealtimeAudioTranscriptionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4295 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4296 protected virtual RealtimeAudioTranscriptionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4297 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4298 }
4299 [Experimental("OPENAI002")]
4300 public class RealtimeClient {
4301 protected RealtimeClient();
4302 [Experimental("SCME0002")]
4303 public RealtimeClient(RealtimeClientSettings settings);
4304 public RealtimeClient(ApiKeyCredential credential, RealtimeClientOptions options);
4305 public RealtimeClient(ApiKeyCredential credential);
4306 [Experimental("OPENAI001")]
4307 public RealtimeClient(AuthenticationPolicy authenticationPolicy, RealtimeClientOptions options);
4308 [Experimental("OPENAI001")]
4309 public RealtimeClient(AuthenticationPolicy authenticationPolicy);
4310 protected internal RealtimeClient(ClientPipeline pipeline, RealtimeClientOptions options);
4311 public RealtimeClient(string apiKey);
4312 [Experimental("OPENAI001")]
4313 public Uri Endpoint { get; }
4314 public ClientPipeline Pipeline { get; }
4315 public event EventHandler<BinaryData> OnReceivingCommand {
4316 add;
4317 remove;
4318 }
4319 public event EventHandler<BinaryData> OnSendingCommand {
4320 add;
4321 remove;
4322 }
4323 public virtual ClientResult<CreateClientSecretResult> CreateRealtimeClientSecret(CreateClientSecretOptions options, CancellationToken cancellationToken = default);
4324 public virtual ClientResult CreateRealtimeClientSecret(BinaryContent content, RequestOptions options = null);
4325 public virtual Task<ClientResult<CreateClientSecretResult>> CreateRealtimeClientSecretAsync(CreateClientSecretOptions options, CancellationToken cancellationToken = default);
4326 public virtual Task<ClientResult> CreateRealtimeClientSecretAsync(BinaryContent content, RequestOptions options = null);
4327 public virtual RealtimeSessionClient StartConversationSession(string model, RealtimeSessionClientOptions options = null, CancellationToken cancellationToken = default);
4328 public virtual Task<RealtimeSessionClient> StartConversationSessionAsync(string model, RealtimeSessionClientOptions options = null, CancellationToken cancellationToken = default);
4329 public virtual RealtimeSessionClient StartSession(string model, string intent, RealtimeSessionClientOptions options = null, CancellationToken cancellationToken = default);
4330 public virtual Task<RealtimeSessionClient> StartSessionAsync(string model, string intent, RealtimeSessionClientOptions options = null, CancellationToken cancellationToken = default);
4331 public virtual RealtimeSessionClient StartTranscriptionSession(RealtimeSessionClientOptions options = null, CancellationToken cancellationToken = default);
4332 public virtual Task<RealtimeSessionClient> StartTranscriptionSessionAsync(RealtimeSessionClientOptions options = null, CancellationToken cancellationToken = default);
4333 }
4334 [Experimental("OPENAI002")]
4335 public class RealtimeClientCommand : IJsonModel<RealtimeClientCommand>, IPersistableModel<RealtimeClientCommand> {
4336 [Serialization.JsonIgnore]
4337 [EditorBrowsable(EditorBrowsableState.Never)]
4338 [Experimental("SCME0001")]
4339 public ref JsonPatch Patch { get; }
4340 protected virtual RealtimeClientCommand JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4341 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4342 protected virtual RealtimeClientCommand PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4343 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4344 }
4345 [Experimental("OPENAI002")]
4346 public class RealtimeClientCommandConversationItemCreate : RealtimeClientCommand, IJsonModel<RealtimeClientCommandConversationItemCreate>, IPersistableModel<RealtimeClientCommandConversationItemCreate> {
4347 public RealtimeClientCommandConversationItemCreate(RealtimeItem item);
4348 public string EventId { get; set; }
4349 public RealtimeItem Item { get; }
4350 public string PreviousItemId { get; set; }
4351 protected override RealtimeClientCommand JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4352 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4353 protected override RealtimeClientCommand PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4354 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4355 }
4356 [Experimental("OPENAI002")]
4357 public class RealtimeClientCommandConversationItemDelete : RealtimeClientCommand, IJsonModel<RealtimeClientCommandConversationItemDelete>, IPersistableModel<RealtimeClientCommandConversationItemDelete> {
4358 public RealtimeClientCommandConversationItemDelete(string itemId);
4359 public string EventId { get; set; }
4360 public string ItemId { get; }
4361 protected override RealtimeClientCommand JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4362 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4363 protected override RealtimeClientCommand PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4364 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4365 }
4366 [Experimental("OPENAI002")]
4367 public class RealtimeClientCommandConversationItemRetrieve : RealtimeClientCommand, IJsonModel<RealtimeClientCommandConversationItemRetrieve>, IPersistableModel<RealtimeClientCommandConversationItemRetrieve> {
4368 public RealtimeClientCommandConversationItemRetrieve(string itemId);
4369 public string EventId { get; set; }
4370 public string ItemId { get; }
4371 protected override RealtimeClientCommand JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4372 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4373 protected override RealtimeClientCommand PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4374 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4375 }
4376 [Experimental("OPENAI002")]
4377 public class RealtimeClientCommandConversationItemTruncate : RealtimeClientCommand, IJsonModel<RealtimeClientCommandConversationItemTruncate>, IPersistableModel<RealtimeClientCommandConversationItemTruncate> {
4378 public RealtimeClientCommandConversationItemTruncate(string itemId, int contentIndex, TimeSpan audioEndTime);
4379 public TimeSpan AudioEndTime { get; }
4380 public int ContentIndex { get; }
4381 public string EventId { get; set; }
4382 public string ItemId { get; }
4383 protected override RealtimeClientCommand JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4384 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4385 protected override RealtimeClientCommand PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4386 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4387 }
4388 [Experimental("OPENAI002")]
4389 public class RealtimeClientCommandInputAudioBufferAppend : RealtimeClientCommand, IJsonModel<RealtimeClientCommandInputAudioBufferAppend>, IPersistableModel<RealtimeClientCommandInputAudioBufferAppend> {
4390 public RealtimeClientCommandInputAudioBufferAppend(BinaryData audioBytes);
4391 public BinaryData AudioBytes { get; }
4392 public string EventId { get; set; }
4393 protected override RealtimeClientCommand JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4394 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4395 protected override RealtimeClientCommand PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4396 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4397 }
4398 [Experimental("OPENAI002")]
4399 public class RealtimeClientCommandInputAudioBufferClear : RealtimeClientCommand, IJsonModel<RealtimeClientCommandInputAudioBufferClear>, IPersistableModel<RealtimeClientCommandInputAudioBufferClear> {
4400 public RealtimeClientCommandInputAudioBufferClear();
4401 public string EventId { get; set; }
4402 protected override RealtimeClientCommand JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4403 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4404 protected override RealtimeClientCommand PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4405 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4406 }
4407 [Experimental("OPENAI002")]
4408 public class RealtimeClientCommandInputAudioBufferCommit : RealtimeClientCommand, IJsonModel<RealtimeClientCommandInputAudioBufferCommit>, IPersistableModel<RealtimeClientCommandInputAudioBufferCommit> {
4409 public RealtimeClientCommandInputAudioBufferCommit();
4410 public string EventId { get; set; }
4411 protected override RealtimeClientCommand JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4412 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4413 protected override RealtimeClientCommand PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4414 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4415 }
4416 [Experimental("OPENAI002")]
4417 public class RealtimeClientCommandOutputAudioBufferClear : RealtimeClientCommand, IJsonModel<RealtimeClientCommandOutputAudioBufferClear>, IPersistableModel<RealtimeClientCommandOutputAudioBufferClear> {
4418 public RealtimeClientCommandOutputAudioBufferClear();
4419 public string EventId { get; set; }
4420 protected override RealtimeClientCommand JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4421 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4422 protected override RealtimeClientCommand PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4423 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4424 }
4425 [Experimental("OPENAI002")]
4426 public class RealtimeClientCommandResponseCancel : RealtimeClientCommand, IJsonModel<RealtimeClientCommandResponseCancel>, IPersistableModel<RealtimeClientCommandResponseCancel> {
4427 public RealtimeClientCommandResponseCancel();
4428 public string EventId { get; set; }
4429 public string ResponseId { get; set; }
4430 protected override RealtimeClientCommand JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4431 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4432 protected override RealtimeClientCommand PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4433 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4434 }
4435 [Experimental("OPENAI002")]
4436 public class RealtimeClientCommandResponseCreate : RealtimeClientCommand, IJsonModel<RealtimeClientCommandResponseCreate>, IPersistableModel<RealtimeClientCommandResponseCreate> {
4437 public RealtimeClientCommandResponseCreate();
4438 public string EventId { get; set; }
4439 public RealtimeResponseOptions ResponseOptions { get; set; }
4440 protected override RealtimeClientCommand JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4441 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4442 protected override RealtimeClientCommand PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4443 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4444 }
4445 [Experimental("OPENAI002")]
4446 public class RealtimeClientCommandSessionUpdate : RealtimeClientCommand, IJsonModel<RealtimeClientCommandSessionUpdate>, IPersistableModel<RealtimeClientCommandSessionUpdate> {
4447 public RealtimeClientCommandSessionUpdate(RealtimeSessionOptions sessionOptions);
4448 public string EventId { get; set; }
4449 public RealtimeSessionOptions SessionOptions { get; }
4450 protected override RealtimeClientCommand JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4451 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4452 protected override RealtimeClientCommand PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4453 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4454 }
4455 public class RealtimeClientOptions : ClientPipelineOptions {
4456 public Uri Endpoint { get; set; }
4457 public string OrganizationId { get; set; }
4458 public string ProjectId { get; set; }
4459 public string UserAgentApplicationId { get; set; }
4460 }
4461 [Experimental("OPENAI002")]
4462 public class RealtimeClientSecret : IJsonModel<RealtimeClientSecret>, IPersistableModel<RealtimeClientSecret> {
4463 public DateTimeOffset ExpiresAt { get; }
4464 [Serialization.JsonIgnore]
4465 [EditorBrowsable(EditorBrowsableState.Never)]
4466 [Experimental("SCME0001")]
4467 public ref JsonPatch Patch { get; }
4468 public string Value { get; }
4469 protected virtual RealtimeClientSecret JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4470 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4471 protected virtual RealtimeClientSecret PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4472 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4473 }
4474 [Experimental("OPENAI002")]
4475 public readonly partial struct RealtimeClientSecretExpirationAnchor : IEquatable<RealtimeClientSecretExpirationAnchor> {
4476 public RealtimeClientSecretExpirationAnchor(string value);
4477 public static RealtimeClientSecretExpirationAnchor CreatedAt { get; }
4478 public readonly bool Equals(RealtimeClientSecretExpirationAnchor other);
4479 [EditorBrowsable(EditorBrowsableState.Never)]
4480 public override readonly bool Equals(object obj);
4481 [EditorBrowsable(EditorBrowsableState.Never)]
4482 public override readonly int GetHashCode();
4483 public static bool operator ==(RealtimeClientSecretExpirationAnchor left, RealtimeClientSecretExpirationAnchor right);
4484 public static implicit operator RealtimeClientSecretExpirationAnchor(string value);
4485 public static implicit operator RealtimeClientSecretExpirationAnchor?(string value);
4486 public static bool operator !=(RealtimeClientSecretExpirationAnchor left, RealtimeClientSecretExpirationAnchor right);
4487 public override readonly string ToString();
4488 }
4489 [Experimental("OPENAI002")]
4490 public class RealtimeClientSecretExpirationPolicy : IJsonModel<RealtimeClientSecretExpirationPolicy>, IPersistableModel<RealtimeClientSecretExpirationPolicy> {
4491 public RealtimeClientSecretExpirationAnchor? Anchor { get; set; }
4492 [Serialization.JsonIgnore]
4493 [EditorBrowsable(EditorBrowsableState.Never)]
4494 [Experimental("SCME0001")]
4495 public ref JsonPatch Patch { get; }
4496 public int? Seconds { get; set; }
4497 protected virtual RealtimeClientSecretExpirationPolicy JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4498 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4499 protected virtual RealtimeClientSecretExpirationPolicy PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4500 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4501 }
4502 [Experimental("SCME0002")]
4503 public sealed class RealtimeClientSettings : ClientSettings {
4504 public OpenAIClientOptions Options { get; set; }
4505 protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
4506 }
4507 [Experimental("OPENAI002")]
4508 public class RealtimeConversation : IJsonModel<RealtimeConversation>, IPersistableModel<RealtimeConversation> {
4509 public string Id { get; }
4510 [Serialization.JsonIgnore]
4511 [EditorBrowsable(EditorBrowsableState.Never)]
4512 [Experimental("SCME0001")]
4513 public ref JsonPatch Patch { get; }
4514 protected virtual RealtimeConversation JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4515 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4516 protected virtual RealtimeConversation PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4517 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4518 }
4519 [Experimental("OPENAI002")]
4520 public class RealtimeConversationSession : RealtimeSession, IJsonModel<RealtimeConversationSession>, IPersistableModel<RealtimeConversationSession> {
4521 public RealtimeConversationSessionAudioOptions AudioOptions { get; set; }
4522 public RealtimeClientSecret ClientSecret { get; }
4523 public IList<RealtimeIncludedProperty> IncludedProperties { get; }
4524 public string Instructions { get; }
4525 public RealtimeMaxOutputTokenCount MaxOutputTokenCount { get; set; }
4526 public string Model { get; set; }
4527 public IList<RealtimeOutputModality> OutputModalities { get; }
4528 public RealtimeToolChoice ToolChoice { get; set; }
4529 public IList<RealtimeTool> Tools { get; }
4530 public RealtimeTracing Tracing { get; set; }
4531 public RealtimeTruncation Truncation { get; set; }
4532 protected override RealtimeSession JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4533 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4534 protected override RealtimeSession PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4535 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4536 }
4537 [Experimental("OPENAI002")]
4538 public class RealtimeConversationSessionAudioOptions : IJsonModel<RealtimeConversationSessionAudioOptions>, IPersistableModel<RealtimeConversationSessionAudioOptions> {
4539 public RealtimeConversationSessionInputAudioOptions InputAudioOptions { get; set; }
4540 public RealtimeConversationSessionOutputAudioOptions OutputAudioOptions { get; set; }
4541 [Serialization.JsonIgnore]
4542 [EditorBrowsable(EditorBrowsableState.Never)]
4543 [Experimental("SCME0001")]
4544 public ref JsonPatch Patch { get; }
4545 protected virtual RealtimeConversationSessionAudioOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4546 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4547 protected virtual RealtimeConversationSessionAudioOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4548 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4549 }
4550 [Experimental("OPENAI002")]
4551 public class RealtimeConversationSessionInputAudioOptions : IJsonModel<RealtimeConversationSessionInputAudioOptions>, IPersistableModel<RealtimeConversationSessionInputAudioOptions> {
4552 public RealtimeAudioFormat AudioFormat { get; set; }
4553 public RealtimeAudioTranscriptionOptions AudioTranscriptionOptions { get; set; }
4554 public RealtimeNoiseReduction NoiseReduction { get; set; }
4555 [Serialization.JsonIgnore]
4556 [EditorBrowsable(EditorBrowsableState.Never)]
4557 [Experimental("SCME0001")]
4558 public ref JsonPatch Patch { get; }
4559 public RealtimeTurnDetection TurnDetection { get; set; }
4560 public void DisableTurnDetection();
4561 protected virtual RealtimeConversationSessionInputAudioOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4562 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4563 protected virtual RealtimeConversationSessionInputAudioOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4564 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4565 }
4566 [Experimental("OPENAI002")]
4567 public class RealtimeConversationSessionOptions : RealtimeSessionOptions, IJsonModel<RealtimeConversationSessionOptions>, IPersistableModel<RealtimeConversationSessionOptions> {
4568 public RealtimeConversationSessionOptions();
4569 public RealtimeConversationSessionAudioOptions AudioOptions { get; set; }
4570 public IList<RealtimeIncludedProperty> IncludedProperties { get; }
4571 public string Instructions { get; set; }
4572 public RealtimeMaxOutputTokenCount MaxOutputTokenCount { get; set; }
4573 public string Model { get; set; }
4574 public IList<RealtimeOutputModality> OutputModalities { get; }
4575 public RealtimeToolChoice ToolChoice { get; set; }
4576 public IList<RealtimeTool> Tools { get; }
4577 public RealtimeTracing Tracing { get; set; }
4578 public RealtimeTruncation Truncation { get; set; }
4579 protected override RealtimeSessionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4580 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4581 protected override RealtimeSessionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4582 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4583 }
4584 [Experimental("OPENAI002")]
4585 public class RealtimeConversationSessionOutputAudioOptions : IJsonModel<RealtimeConversationSessionOutputAudioOptions>, IPersistableModel<RealtimeConversationSessionOutputAudioOptions> {
4586 public RealtimeAudioFormat AudioFormat { get; set; }
4587 [Serialization.JsonIgnore]
4588 [EditorBrowsable(EditorBrowsableState.Never)]
4589 [Experimental("SCME0001")]
4590 public ref JsonPatch Patch { get; }
4591 public float? Speed { get; set; }
4592 public RealtimeVoice? Voice { get; set; }
4593 protected virtual RealtimeConversationSessionOutputAudioOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4594 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4595 protected virtual RealtimeConversationSessionOutputAudioOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4596 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4597 }
4598 [Experimental("OPENAI002")]
4599 public class RealtimeCustomFunctionToolChoice : RealtimeCustomToolChoice, IJsonModel<RealtimeCustomFunctionToolChoice>, IPersistableModel<RealtimeCustomFunctionToolChoice> {
4600 public RealtimeCustomFunctionToolChoice(string functionName);
4601 public string FunctionName { get; set; }
4602 protected override RealtimeCustomToolChoice JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4603 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4604 protected override RealtimeCustomToolChoice PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4605 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4606 }
4607 [Experimental("OPENAI002")]
4608 public class RealtimeCustomMcpToolCallApprovalPolicy : IJsonModel<RealtimeCustomMcpToolCallApprovalPolicy>, IPersistableModel<RealtimeCustomMcpToolCallApprovalPolicy> {
4609 [Serialization.JsonIgnore]
4610 [EditorBrowsable(EditorBrowsableState.Never)]
4611 [Experimental("SCME0001")]
4612 public ref JsonPatch Patch { get; }
4613 public RealtimeMcpToolFilter ToolsAlwaysRequiringApproval { get; set; }
4614 public RealtimeMcpToolFilter ToolsNeverRequiringApproval { get; set; }
4615 protected virtual RealtimeCustomMcpToolCallApprovalPolicy JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4616 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4617 protected virtual RealtimeCustomMcpToolCallApprovalPolicy PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4618 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4619 }
4620 [Experimental("OPENAI002")]
4621 public class RealtimeCustomMcpToolChoice : RealtimeCustomToolChoice, IJsonModel<RealtimeCustomMcpToolChoice>, IPersistableModel<RealtimeCustomMcpToolChoice> {
4622 public RealtimeCustomMcpToolChoice(string serverLabel);
4623 public string McpToolName { get; set; }
4624 public string ServerLabel { get; set; }
4625 protected override RealtimeCustomToolChoice JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4626 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4627 protected override RealtimeCustomToolChoice PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4628 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4629 }
4630 [Experimental("OPENAI002")]
4631 public class RealtimeCustomRetentionRatioTruncation : RealtimeCustomTruncation, IJsonModel<RealtimeCustomRetentionRatioTruncation>, IPersistableModel<RealtimeCustomRetentionRatioTruncation> {
4632 public RealtimeCustomRetentionRatioTruncation(float retentionRatio);
4633 public float RetentionRatio { get; set; }
4634 public RealtimeRetentionRatioTokenLimitDetails TokenLimitDetails { get; set; }
4635 protected override RealtimeCustomTruncation JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4636 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4637 protected override RealtimeCustomTruncation PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4638 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4639 }
4640 [Experimental("OPENAI002")]
4641 public class RealtimeCustomToolChoice : IJsonModel<RealtimeCustomToolChoice>, IPersistableModel<RealtimeCustomToolChoice> {
4642 [Serialization.JsonIgnore]
4643 [EditorBrowsable(EditorBrowsableState.Never)]
4644 [Experimental("SCME0001")]
4645 public ref JsonPatch Patch { get; }
4646 protected virtual RealtimeCustomToolChoice JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4647 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4648 protected virtual RealtimeCustomToolChoice PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4649 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4650 }
4651 [Experimental("OPENAI002")]
4652 public class RealtimeCustomTracing : IJsonModel<RealtimeCustomTracing>, IPersistableModel<RealtimeCustomTracing> {
4653 public string GroupId { get; set; }
4654 public IDictionary<string, BinaryData> Metadata { get; }
4655 [Serialization.JsonIgnore]
4656 [EditorBrowsable(EditorBrowsableState.Never)]
4657 [Experimental("SCME0001")]
4658 public ref JsonPatch Patch { get; }
4659 public string WorkflowName { get; set; }
4660 protected virtual RealtimeCustomTracing JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4661 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4662 protected virtual RealtimeCustomTracing PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4663 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4664 }
4665 [Experimental("OPENAI002")]
4666 public class RealtimeCustomTruncation : IJsonModel<RealtimeCustomTruncation>, IPersistableModel<RealtimeCustomTruncation> {
4667 [Serialization.JsonIgnore]
4668 [EditorBrowsable(EditorBrowsableState.Never)]
4669 [Experimental("SCME0001")]
4670 public ref JsonPatch Patch { get; }
4671 protected virtual RealtimeCustomTruncation JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4672 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4673 protected virtual RealtimeCustomTruncation PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4674 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4675 }
4676 [Experimental("OPENAI002")]
4677 public readonly partial struct RealtimeDefaultMaxOutputTokenCount : IEquatable<RealtimeDefaultMaxOutputTokenCount> {
4678 public RealtimeDefaultMaxOutputTokenCount(string value);
4679 public static RealtimeDefaultMaxOutputTokenCount Infinity { get; }
4680 public readonly bool Equals(RealtimeDefaultMaxOutputTokenCount other);
4681 [EditorBrowsable(EditorBrowsableState.Never)]
4682 public override readonly bool Equals(object obj);
4683 [EditorBrowsable(EditorBrowsableState.Never)]
4684 public override readonly int GetHashCode();
4685 public static bool operator ==(RealtimeDefaultMaxOutputTokenCount left, RealtimeDefaultMaxOutputTokenCount right);
4686 public static implicit operator RealtimeDefaultMaxOutputTokenCount(string value);
4687 public static implicit operator RealtimeDefaultMaxOutputTokenCount?(string value);
4688 public static bool operator !=(RealtimeDefaultMaxOutputTokenCount left, RealtimeDefaultMaxOutputTokenCount right);
4689 public override readonly string ToString();
4690 }
4691 [Experimental("OPENAI002")]
4692 public readonly partial struct RealtimeDefaultMcpToolCallApprovalPolicy : IEquatable<RealtimeDefaultMcpToolCallApprovalPolicy> {
4693 public RealtimeDefaultMcpToolCallApprovalPolicy(string value);
4694 public static RealtimeDefaultMcpToolCallApprovalPolicy AlwaysRequireApproval { get; }
4695 public static RealtimeDefaultMcpToolCallApprovalPolicy NeverRequireApproval { get; }
4696 public readonly bool Equals(RealtimeDefaultMcpToolCallApprovalPolicy other);
4697 [EditorBrowsable(EditorBrowsableState.Never)]
4698 public override readonly bool Equals(object obj);
4699 [EditorBrowsable(EditorBrowsableState.Never)]
4700 public override readonly int GetHashCode();
4701 public static bool operator ==(RealtimeDefaultMcpToolCallApprovalPolicy left, RealtimeDefaultMcpToolCallApprovalPolicy right);
4702 public static implicit operator RealtimeDefaultMcpToolCallApprovalPolicy(string value);
4703 public static implicit operator RealtimeDefaultMcpToolCallApprovalPolicy?(string value);
4704 public static bool operator !=(RealtimeDefaultMcpToolCallApprovalPolicy left, RealtimeDefaultMcpToolCallApprovalPolicy right);
4705 public override readonly string ToString();
4706 }
4707 [Experimental("OPENAI002")]
4708 public readonly partial struct RealtimeDefaultToolChoice : IEquatable<RealtimeDefaultToolChoice> {
4709 public RealtimeDefaultToolChoice(string value);
4710 public static RealtimeDefaultToolChoice Auto { get; }
4711 public static RealtimeDefaultToolChoice None { get; }
4712 public static RealtimeDefaultToolChoice Required { get; }
4713 public readonly bool Equals(RealtimeDefaultToolChoice other);
4714 [EditorBrowsable(EditorBrowsableState.Never)]
4715 public override readonly bool Equals(object obj);
4716 [EditorBrowsable(EditorBrowsableState.Never)]
4717 public override readonly int GetHashCode();
4718 public static bool operator ==(RealtimeDefaultToolChoice left, RealtimeDefaultToolChoice right);
4719 public static implicit operator RealtimeDefaultToolChoice(string value);
4720 public static implicit operator RealtimeDefaultToolChoice?(string value);
4721 public static bool operator !=(RealtimeDefaultToolChoice left, RealtimeDefaultToolChoice right);
4722 public override readonly string ToString();
4723 }
4724 [Experimental("OPENAI002")]
4725 public readonly partial struct RealtimeDefaultTracing : IEquatable<RealtimeDefaultTracing> {
4726 public RealtimeDefaultTracing(string value);
4727 public static RealtimeDefaultTracing Auto { get; }
4728 public readonly bool Equals(RealtimeDefaultTracing other);
4729 [EditorBrowsable(EditorBrowsableState.Never)]
4730 public override readonly bool Equals(object obj);
4731 [EditorBrowsable(EditorBrowsableState.Never)]
4732 public override readonly int GetHashCode();
4733 public static bool operator ==(RealtimeDefaultTracing left, RealtimeDefaultTracing right);
4734 public static implicit operator RealtimeDefaultTracing(string value);
4735 public static implicit operator RealtimeDefaultTracing?(string value);
4736 public static bool operator !=(RealtimeDefaultTracing left, RealtimeDefaultTracing right);
4737 public override readonly string ToString();
4738 }
4739 [Experimental("OPENAI002")]
4740 public readonly partial struct RealtimeDefaultTruncation : IEquatable<RealtimeDefaultTruncation> {
4741 public RealtimeDefaultTruncation(string value);
4742 public static RealtimeDefaultTruncation Auto { get; }
4743 public static RealtimeDefaultTruncation Disabled { get; }
4744 public readonly bool Equals(RealtimeDefaultTruncation other);
4745 [EditorBrowsable(EditorBrowsableState.Never)]
4746 public override readonly bool Equals(object obj);
4747 [EditorBrowsable(EditorBrowsableState.Never)]
4748 public override readonly int GetHashCode();
4749 public static bool operator ==(RealtimeDefaultTruncation left, RealtimeDefaultTruncation right);
4750 public static implicit operator RealtimeDefaultTruncation(string value);
4751 public static implicit operator RealtimeDefaultTruncation?(string value);
4752 public static bool operator !=(RealtimeDefaultTruncation left, RealtimeDefaultTruncation right);
4753 public override readonly string ToString();
4754 }
4755 [Experimental("OPENAI002")]
4756 public class RealtimeError : IJsonModel<RealtimeError>, IPersistableModel<RealtimeError> {
4757 public string Code { get; set; }
4758 public string EventId { get; set; }
4759 public string Kind { get; set; }
4760 public string Message { get; set; }
4761 public string ParameterName { get; }
4762 [Serialization.JsonIgnore]
4763 [EditorBrowsable(EditorBrowsableState.Never)]
4764 [Experimental("SCME0001")]
4765 public ref JsonPatch Patch { get; }
4766 protected virtual RealtimeError JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4767 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4768 protected virtual RealtimeError PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4769 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4770 }
4771 [Experimental("OPENAI002")]
4772 public class RealtimeFunctionCallItem : RealtimeItem, IJsonModel<RealtimeFunctionCallItem>, IPersistableModel<RealtimeFunctionCallItem> {
4773 public RealtimeFunctionCallItem(string callId, string functionName, BinaryData functionArguments);
4774 public string CallId { get; set; }
4775 public BinaryData FunctionArguments { get; set; }
4776 public string FunctionName { get; set; }
4777 public string Id { get; set; }
4778 public RealtimeFunctionCallStatus? Status { get; set; }
4779 protected override RealtimeItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4780 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4781 protected override RealtimeItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4782 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4783 }
4784 [Experimental("OPENAI002")]
4785 public class RealtimeFunctionCallOutputItem : RealtimeItem, IJsonModel<RealtimeFunctionCallOutputItem>, IPersistableModel<RealtimeFunctionCallOutputItem> {
4786 public RealtimeFunctionCallOutputItem(string callId, string functionOutput);
4787 public string CallId { get; set; }
4788 public string FunctionOutput { get; set; }
4789 public string Id { get; set; }
4790 public RealtimeFunctionCallOutputStatus? Status { get; set; }
4791 protected override RealtimeItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4792 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4793 protected override RealtimeItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4794 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4795 }
4796 [Experimental("OPENAI002")]
4797 public readonly partial struct RealtimeFunctionCallOutputStatus : IEquatable<RealtimeFunctionCallOutputStatus> {
4798 public RealtimeFunctionCallOutputStatus(string value);
4799 public static RealtimeFunctionCallOutputStatus Completed { get; }
4800 public static RealtimeFunctionCallOutputStatus Incomplete { get; }
4801 public static RealtimeFunctionCallOutputStatus InProgress { get; }
4802 public readonly bool Equals(RealtimeFunctionCallOutputStatus other);
4803 [EditorBrowsable(EditorBrowsableState.Never)]
4804 public override readonly bool Equals(object obj);
4805 [EditorBrowsable(EditorBrowsableState.Never)]
4806 public override readonly int GetHashCode();
4807 public static bool operator ==(RealtimeFunctionCallOutputStatus left, RealtimeFunctionCallOutputStatus right);
4808 public static implicit operator RealtimeFunctionCallOutputStatus(string value);
4809 public static implicit operator RealtimeFunctionCallOutputStatus?(string value);
4810 public static bool operator !=(RealtimeFunctionCallOutputStatus left, RealtimeFunctionCallOutputStatus right);
4811 public override readonly string ToString();
4812 }
4813 [Experimental("OPENAI002")]
4814 public readonly partial struct RealtimeFunctionCallStatus : IEquatable<RealtimeFunctionCallStatus> {
4815 public RealtimeFunctionCallStatus(string value);
4816 public static RealtimeFunctionCallStatus Completed { get; }
4817 public static RealtimeFunctionCallStatus Incomplete { get; }
4818 public static RealtimeFunctionCallStatus InProgress { get; }
4819 public readonly bool Equals(RealtimeFunctionCallStatus other);
4820 [EditorBrowsable(EditorBrowsableState.Never)]
4821 public override readonly bool Equals(object obj);
4822 [EditorBrowsable(EditorBrowsableState.Never)]
4823 public override readonly int GetHashCode();
4824 public static bool operator ==(RealtimeFunctionCallStatus left, RealtimeFunctionCallStatus right);
4825 public static implicit operator RealtimeFunctionCallStatus(string value);
4826 public static implicit operator RealtimeFunctionCallStatus?(string value);
4827 public static bool operator !=(RealtimeFunctionCallStatus left, RealtimeFunctionCallStatus right);
4828 public override readonly string ToString();
4829 }
4830 [Experimental("OPENAI002")]
4831 public class RealtimeFunctionTool : RealtimeTool, IJsonModel<RealtimeFunctionTool>, IPersistableModel<RealtimeFunctionTool> {
4832 public RealtimeFunctionTool(string functionName);
4833 public string FunctionDescription { get; set; }
4834 public string FunctionName { get; }
4835 public BinaryData FunctionParameters { get; set; }
4836 protected override RealtimeTool JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4837 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4838 protected override RealtimeTool PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4839 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4840 }
4841 [Experimental("OPENAI002")]
4842 public readonly partial struct RealtimeImageDetailLevel : IEquatable<RealtimeImageDetailLevel> {
4843 public RealtimeImageDetailLevel(string value);
4844 public static RealtimeImageDetailLevel Auto { get; }
4845 public static RealtimeImageDetailLevel High { get; }
4846 public static RealtimeImageDetailLevel Low { get; }
4847 public readonly bool Equals(RealtimeImageDetailLevel other);
4848 [EditorBrowsable(EditorBrowsableState.Never)]
4849 public override readonly bool Equals(object obj);
4850 [EditorBrowsable(EditorBrowsableState.Never)]
4851 public override readonly int GetHashCode();
4852 public static bool operator ==(RealtimeImageDetailLevel left, RealtimeImageDetailLevel right);
4853 public static implicit operator RealtimeImageDetailLevel(string value);
4854 public static implicit operator RealtimeImageDetailLevel?(string value);
4855 public static bool operator !=(RealtimeImageDetailLevel left, RealtimeImageDetailLevel right);
4856 public override readonly string ToString();
4857 }
4858 [Experimental("OPENAI002")]
4859 public readonly partial struct RealtimeIncludedProperty : IEquatable<RealtimeIncludedProperty> {
4860 public RealtimeIncludedProperty(string value);
4861 public static RealtimeIncludedProperty ItemInputAudioTranscriptionLogProbabilities { get; }
4862 public readonly bool Equals(RealtimeIncludedProperty other);
4863 [EditorBrowsable(EditorBrowsableState.Never)]
4864 public override readonly bool Equals(object obj);
4865 [EditorBrowsable(EditorBrowsableState.Never)]
4866 public override readonly int GetHashCode();
4867 public static bool operator ==(RealtimeIncludedProperty left, RealtimeIncludedProperty right);
4868 public static implicit operator RealtimeIncludedProperty(string value);
4869 public static implicit operator RealtimeIncludedProperty?(string value);
4870 public static bool operator !=(RealtimeIncludedProperty left, RealtimeIncludedProperty right);
4871 public override readonly string ToString();
4872 }
4873 [Experimental("OPENAI002")]
4874 public class RealtimeInputAudioMessageContentPart : RealtimeMessageContentPart, IJsonModel<RealtimeInputAudioMessageContentPart>, IPersistableModel<RealtimeInputAudioMessageContentPart> {
4875 public RealtimeInputAudioMessageContentPart(BinaryData audioBytes);
4876 public BinaryData AudioBytes { get; set; }
4877 public string Transcript { get; set; }
4878 protected override RealtimeMessageContentPart JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4879 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4880 protected override RealtimeMessageContentPart PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4881 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4882 }
4883 [Experimental("OPENAI002")]
4884 public class RealtimeInputImageMessageContentPart : RealtimeMessageContentPart, IJsonModel<RealtimeInputImageMessageContentPart>, IPersistableModel<RealtimeInputImageMessageContentPart> {
4885 public RealtimeInputImageMessageContentPart(Uri imageUri);
4886 public RealtimeImageDetailLevel? Detail { get; set; }
4887 public Uri ImageUri { get; set; }
4888 protected override RealtimeMessageContentPart JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4889 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4890 protected override RealtimeMessageContentPart PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4891 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4892 }
4893 [Experimental("OPENAI002")]
4894 public class RealtimeInputTextMessageContentPart : RealtimeMessageContentPart, IJsonModel<RealtimeInputTextMessageContentPart>, IPersistableModel<RealtimeInputTextMessageContentPart> {
4895 public RealtimeInputTextMessageContentPart(string text);
4896 public string Text { get; set; }
4897 protected override RealtimeMessageContentPart JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4898 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4899 protected override RealtimeMessageContentPart PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4900 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4901 }
4902 [Experimental("OPENAI002")]
4903 public class RealtimeItem : IJsonModel<RealtimeItem>, IPersistableModel<RealtimeItem> {
4904 [Serialization.JsonIgnore]
4905 [EditorBrowsable(EditorBrowsableState.Never)]
4906 [Experimental("SCME0001")]
4907 public ref JsonPatch Patch { get; }
4908 public static RealtimeMessageItem CreateAssistantMessageItem(IEnumerable<RealtimeMessageContentPart> contentParts);
4909 public static RealtimeMessageItem CreateAssistantMessageItem(string outputTextContent);
4910 public static RealtimeFunctionCallItem CreateFunctionCallItem(string callId, string functionName, BinaryData functionArguments);
4911 public static RealtimeFunctionCallOutputItem CreateFunctionCallOutputItem(string callId, string functionOutput);
4912 public static RealtimeMcpToolCallApprovalRequestItem CreateMcpApprovalRequestItem(string id, string serverLabel, string name, BinaryData arguments);
4913 public static RealtimeMcpToolCallApprovalResponseItem CreateMcpApprovalResponseItem(string approvalRequestId, bool approved);
4914 public static RealtimeMcpToolCallItem CreateMcpToolCallItem(string serverLabel, string name, BinaryData arguments);
4915 public static RealtimeMcpToolDefinitionListItem CreateMcpToolDefinitionListItem(string serverLabel, IEnumerable<RealtimeMcpToolDefinition> toolDefinitions);
4916 public static RealtimeMessageItem CreateSystemMessageItem(IEnumerable<RealtimeMessageContentPart> contentParts);
4917 public static RealtimeMessageItem CreateSystemMessageItem(string inputTextContent);
4918 public static RealtimeMessageItem CreateUserMessageItem(IEnumerable<RealtimeMessageContentPart> contentParts);
4919 public static RealtimeMessageItem CreateUserMessageItem(string inputTextContent);
4920 protected virtual RealtimeItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4921 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4922 protected virtual RealtimeItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4923 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4924 }
4925 [Experimental("OPENAI002")]
4926 public class RealtimeLogProbabilityDetails : IJsonModel<RealtimeLogProbabilityDetails>, IPersistableModel<RealtimeLogProbabilityDetails> {
4927 public float LogProbability { get; }
4928 [Serialization.JsonIgnore]
4929 [EditorBrowsable(EditorBrowsableState.Never)]
4930 [Experimental("SCME0001")]
4931 public ref JsonPatch Patch { get; }
4932 public string Token { get; }
4933 public ReadOnlyMemory<byte> Utf8Bytes { get; }
4934 protected virtual RealtimeLogProbabilityDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4935 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4936 protected virtual RealtimeLogProbabilityDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4937 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4938 }
4939 [Experimental("OPENAI002")]
4940 public class RealtimeMaxOutputTokenCount : IJsonModel<RealtimeMaxOutputTokenCount>, IPersistableModel<RealtimeMaxOutputTokenCount> {
4941 public RealtimeMaxOutputTokenCount(RealtimeDefaultMaxOutputTokenCount defaultMaxOutputTokenCount);
4942 public RealtimeMaxOutputTokenCount(int customMaxOutputTokenCount);
4943 public int? CustomMaxOutputTokenCount { get; }
4944 public RealtimeDefaultMaxOutputTokenCount? DefaultMaxOutputTokenCount { get; }
4945 [Serialization.JsonIgnore]
4946 [EditorBrowsable(EditorBrowsableState.Never)]
4947 [Experimental("SCME0001")]
4948 public ref JsonPatch Patch { get; }
4949 protected virtual RealtimeMaxOutputTokenCount JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4950 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4951 public static implicit operator RealtimeMaxOutputTokenCount(RealtimeDefaultMaxOutputTokenCount defaultMaxOutputTokenCount);
4952 public static implicit operator RealtimeMaxOutputTokenCount(int customMaxOutputTokenCount);
4953 protected virtual RealtimeMaxOutputTokenCount PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4954 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4955 }
4956 [Experimental("OPENAI002")]
4957 public class RealtimeMcpTool : RealtimeTool, IJsonModel<RealtimeMcpTool>, IPersistableModel<RealtimeMcpTool> {
4958 public RealtimeMcpTool(string serverLabel, RealtimeMcpToolConnectorId connectorId);
4959 public RealtimeMcpTool(string serverLabel, Uri serverUri);
4960 public RealtimeMcpToolFilter AllowedTools { get; set; }
4961 public string AuthorizationToken { get; set; }
4962 public RealtimeMcpToolConnectorId? ConnectorId { get; set; }
4963 public IDictionary<string, string> Headers { get; set; }
4964 public string ServerDescription { get; set; }
4965 public string ServerLabel { get; set; }
4966 public Uri ServerUri { get; set; }
4967 public RealtimeMcpToolCallApprovalPolicy ToolCallApprovalPolicy { get; set; }
4968 protected override RealtimeTool JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4969 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4970 protected override RealtimeTool PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4971 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4972 }
4973 [Experimental("OPENAI002")]
4974 public class RealtimeMcpToolCallApprovalPolicy : IJsonModel<RealtimeMcpToolCallApprovalPolicy>, IPersistableModel<RealtimeMcpToolCallApprovalPolicy> {
4975 public RealtimeMcpToolCallApprovalPolicy(RealtimeCustomMcpToolCallApprovalPolicy customPolicy);
4976 public RealtimeMcpToolCallApprovalPolicy(RealtimeDefaultMcpToolCallApprovalPolicy defaultPolicy);
4977 public RealtimeCustomMcpToolCallApprovalPolicy CustomPolicy { get; }
4978 public RealtimeDefaultMcpToolCallApprovalPolicy? DefaultPolicy { get; }
4979 [Serialization.JsonIgnore]
4980 [EditorBrowsable(EditorBrowsableState.Never)]
4981 [Experimental("SCME0001")]
4982 public ref JsonPatch Patch { get; }
4983 protected virtual RealtimeMcpToolCallApprovalPolicy JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4984 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4985 public static implicit operator RealtimeMcpToolCallApprovalPolicy(RealtimeCustomMcpToolCallApprovalPolicy customPolicy);
4986 public static implicit operator RealtimeMcpToolCallApprovalPolicy(RealtimeDefaultMcpToolCallApprovalPolicy defaultPolicy);
4987 protected virtual RealtimeMcpToolCallApprovalPolicy PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4988 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4989 }
4990 [Experimental("OPENAI002")]
4991 public class RealtimeMcpToolCallApprovalRequestItem : RealtimeItem, IJsonModel<RealtimeMcpToolCallApprovalRequestItem>, IPersistableModel<RealtimeMcpToolCallApprovalRequestItem> {
4992 public RealtimeMcpToolCallApprovalRequestItem(string id, string serverLabel, string toolName, BinaryData toolArguments);
4993 public string Id { get; set; }
4994 public string ServerLabel { get; set; }
4995 public BinaryData ToolArguments { get; set; }
4996 public string ToolName { get; set; }
4997 protected override RealtimeItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4998 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4999 protected override RealtimeItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5000 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5001 }
5002 [Experimental("OPENAI002")]
5003 public class RealtimeMcpToolCallApprovalResponseItem : RealtimeItem, IJsonModel<RealtimeMcpToolCallApprovalResponseItem>, IPersistableModel<RealtimeMcpToolCallApprovalResponseItem> {
5004 public RealtimeMcpToolCallApprovalResponseItem(string approvalRequestId, bool approved);
5005 public string ApprovalRequestId { get; set; }
5006 public bool Approved { get; set; }
5007 public string Id { get; set; }
5008 public string Reason { get; set; }
5009 protected override RealtimeItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5010 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5011 protected override RealtimeItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5012 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5013 }
5014 [Experimental("OPENAI002")]
5015 public class RealtimeMcpToolCallItem : RealtimeItem, IJsonModel<RealtimeMcpToolCallItem>, IPersistableModel<RealtimeMcpToolCallItem> {
5016 public RealtimeMcpToolCallItem(string serverLabel, string toolName, BinaryData toolArguments);
5017 public string ApprovalRequestId { get; set; }
5018 public RealtimeError Error { get; set; }
5019 public string Id { get; set; }
5020 public string ServerLabel { get; set; }
5021 public BinaryData ToolArguments { get; set; }
5022 public string ToolName { get; set; }
5023 public string ToolOutput { get; set; }
5024 protected override RealtimeItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5025 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5026 protected override RealtimeItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5027 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5028 }
5029 [Experimental("OPENAI002")]
5030 public readonly partial struct RealtimeMcpToolConnectorId : IEquatable<RealtimeMcpToolConnectorId> {
5031 public RealtimeMcpToolConnectorId(string value);
5032 public static RealtimeMcpToolConnectorId Dropbox { get; }
5033 public static RealtimeMcpToolConnectorId Gmail { get; }
5034 public static RealtimeMcpToolConnectorId GoogleCalendar { get; }
5035 public static RealtimeMcpToolConnectorId GoogleDrive { get; }
5036 public static RealtimeMcpToolConnectorId MicrosoftTeams { get; }
5037 public static RealtimeMcpToolConnectorId OutlookCalendar { get; }
5038 public static RealtimeMcpToolConnectorId OutlookEmail { get; }
5039 public static RealtimeMcpToolConnectorId SharePoint { get; }
5040 public readonly bool Equals(RealtimeMcpToolConnectorId other);
5041 [EditorBrowsable(EditorBrowsableState.Never)]
5042 public override readonly bool Equals(object obj);
5043 [EditorBrowsable(EditorBrowsableState.Never)]
5044 public override readonly int GetHashCode();
5045 public static bool operator ==(RealtimeMcpToolConnectorId left, RealtimeMcpToolConnectorId right);
5046 public static implicit operator RealtimeMcpToolConnectorId(string value);
5047 public static implicit operator RealtimeMcpToolConnectorId?(string value);
5048 public static bool operator !=(RealtimeMcpToolConnectorId left, RealtimeMcpToolConnectorId right);
5049 public override readonly string ToString();
5050 }
5051 [Experimental("OPENAI002")]
5052 public class RealtimeMcpToolDefinition : IJsonModel<RealtimeMcpToolDefinition>, IPersistableModel<RealtimeMcpToolDefinition> {
5053 public RealtimeMcpToolDefinition(string name, BinaryData inputSchema);
5054 public BinaryData Annotations { get; set; }
5055 public string Description { get; set; }
5056 public BinaryData InputSchema { get; set; }
5057 public string Name { get; set; }
5058 [Serialization.JsonIgnore]
5059 [EditorBrowsable(EditorBrowsableState.Never)]
5060 [Experimental("SCME0001")]
5061 public ref JsonPatch Patch { get; }
5062 protected virtual RealtimeMcpToolDefinition JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5063 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5064 protected virtual RealtimeMcpToolDefinition PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5065 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5066 }
5067 [Experimental("OPENAI002")]
5068 public class RealtimeMcpToolDefinitionListItem : RealtimeItem, IJsonModel<RealtimeMcpToolDefinitionListItem>, IPersistableModel<RealtimeMcpToolDefinitionListItem> {
5069 public RealtimeMcpToolDefinitionListItem(string serverLabel, IEnumerable<RealtimeMcpToolDefinition> toolDefinitions);
5070 public string Id { get; set; }
5071 public string ServerLabel { get; set; }
5072 public IList<RealtimeMcpToolDefinition> ToolDefinitions { get; }
5073 protected override RealtimeItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5074 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5075 protected override RealtimeItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5076 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5077 }
5078 [Experimental("OPENAI002")]
5079 public class RealtimeMcpToolFilter : IJsonModel<RealtimeMcpToolFilter>, IPersistableModel<RealtimeMcpToolFilter> {
5080 public bool? IsReadOnly { get; set; }
5081 [Serialization.JsonIgnore]
5082 [EditorBrowsable(EditorBrowsableState.Never)]
5083 [Experimental("SCME0001")]
5084 public ref JsonPatch Patch { get; }
5085 public IList<string> ToolNames { get; }
5086 protected virtual RealtimeMcpToolFilter JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5087 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5088 protected virtual RealtimeMcpToolFilter PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5089 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5090 }
5091 [Experimental("OPENAI002")]
5092 public class RealtimeMessageContentPart : IJsonModel<RealtimeMessageContentPart>, IPersistableModel<RealtimeMessageContentPart> {
5093 [Serialization.JsonIgnore]
5094 [EditorBrowsable(EditorBrowsableState.Never)]
5095 [Experimental("SCME0001")]
5096 public ref JsonPatch Patch { get; }
5097 protected virtual RealtimeMessageContentPart JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5098 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5099 protected virtual RealtimeMessageContentPart PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5100 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5101 }
5102 [Experimental("OPENAI002")]
5103 public class RealtimeMessageItem : RealtimeItem, IJsonModel<RealtimeMessageItem>, IPersistableModel<RealtimeMessageItem> {
5104 public RealtimeMessageItem(RealtimeMessageRole role, IEnumerable<RealtimeMessageContentPart> content);
5105 public IList<RealtimeMessageContentPart> Content { get; }
5106 public string Id { get; set; }
5107 public RealtimeMessageRole Role { get; set; }
5108 public RealtimeMessageStatus? Status { get; set; }
5109 protected override RealtimeItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5110 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5111 protected override RealtimeItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5112 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5113 }
5114 [Experimental("OPENAI002")]
5115 public readonly partial struct RealtimeMessageRole : IEquatable<RealtimeMessageRole> {
5116 public RealtimeMessageRole(string value);
5117 public static RealtimeMessageRole Assistant { get; }
5118 public static RealtimeMessageRole System { get; }
5119 public static RealtimeMessageRole User { get; }
5120 public readonly bool Equals(RealtimeMessageRole other);
5121 [EditorBrowsable(global::EditorBrowsableState.Never)]
5122 public override readonly bool Equals(object obj);
5123 [EditorBrowsable(global::EditorBrowsableState.Never)]
5124 public override readonly int GetHashCode();
5125 public static bool operator ==(RealtimeMessageRole left, RealtimeMessageRole right);
5126 public static implicit operator RealtimeMessageRole(string value);
5127 public static implicit operator RealtimeMessageRole?(string value);
5128 public static bool operator !=(RealtimeMessageRole left, RealtimeMessageRole right);
5129 public override readonly string ToString();
5130 }
5131 [Experimental("OPENAI002")]
5132 public readonly partial struct RealtimeMessageStatus : IEquatable<RealtimeMessageStatus> {
5133 public RealtimeMessageStatus(string value);
5134 public static RealtimeMessageStatus Completed { get; }
5135 public static RealtimeMessageStatus Incomplete { get; }
5136 public static RealtimeMessageStatus InProgress { get; }
5137 public readonly bool Equals(RealtimeMessageStatus other);
5138 [EditorBrowsable(EditorBrowsableState.Never)]
5139 public override readonly bool Equals(object obj);
5140 [EditorBrowsable(EditorBrowsableState.Never)]
5141 public override readonly int GetHashCode();
5142 public static bool operator ==(RealtimeMessageStatus left, RealtimeMessageStatus right);
5143 public static implicit operator RealtimeMessageStatus(string value);
5144 public static implicit operator RealtimeMessageStatus?(string value);
5145 public static bool operator !=(RealtimeMessageStatus left, RealtimeMessageStatus right);
5146 public override readonly string ToString();
5147 }
5148 [Experimental("OPENAI002")]
5149 public class RealtimeNoiseReduction : IJsonModel<RealtimeNoiseReduction>, IPersistableModel<RealtimeNoiseReduction> {
5150 public RealtimeNoiseReduction(RealtimeNoiseReductionKind kind);
5151 public RealtimeNoiseReductionKind Kind { get; set; }
5152 [Serialization.JsonIgnore]
5153 [EditorBrowsable(EditorBrowsableState.Never)]
5154 [Experimental("SCME0001")]
5155 public ref JsonPatch Patch { get; }
5156 protected virtual RealtimeNoiseReduction JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5157 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5158 protected virtual RealtimeNoiseReduction PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5159 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5160 }
5161 [Experimental("OPENAI002")]
5162 public readonly partial struct RealtimeNoiseReductionKind : IEquatable<RealtimeNoiseReductionKind> {
5163 public RealtimeNoiseReductionKind(string value);
5164 public static RealtimeNoiseReductionKind FarField { get; }
5165 public static RealtimeNoiseReductionKind NearField { get; }
5166 public readonly bool Equals(RealtimeNoiseReductionKind other);
5167 [EditorBrowsable(EditorBrowsableState.Never)]
5168 public override readonly bool Equals(object obj);
5169 [EditorBrowsable(EditorBrowsableState.Never)]
5170 public override readonly int GetHashCode();
5171 public static bool operator ==(RealtimeNoiseReductionKind left, RealtimeNoiseReductionKind right);
5172 public static implicit operator RealtimeNoiseReductionKind(string value);
5173 public static implicit operator RealtimeNoiseReductionKind?(string value);
5174 public static bool operator !=(RealtimeNoiseReductionKind left, RealtimeNoiseReductionKind right);
5175 public override readonly string ToString();
5176 }
5177 [Experimental("OPENAI002")]
5178 public class RealtimeOutputAudioMessageContentPart : RealtimeMessageContentPart, IJsonModel<RealtimeOutputAudioMessageContentPart>, IPersistableModel<RealtimeOutputAudioMessageContentPart> {
5179 public RealtimeOutputAudioMessageContentPart(BinaryData audioBytes, string transcript);
5180 public BinaryData AudioBytes { get; set; }
5181 public string Transcript { get; set; }
5182 protected override RealtimeMessageContentPart JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5183 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5184 protected override RealtimeMessageContentPart PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5185 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5186 }
5187 [Experimental("OPENAI002")]
5188 public readonly partial struct RealtimeOutputModality : IEquatable<RealtimeOutputModality> {
5189 public RealtimeOutputModality(string value);
5190 public static RealtimeOutputModality Audio { get; }
5191 public static RealtimeOutputModality Text { get; }
5192 public readonly bool Equals(RealtimeOutputModality other);
5193 [EditorBrowsable(EditorBrowsableState.Never)]
5194 public override readonly bool Equals(object obj);
5195 [EditorBrowsable(EditorBrowsableState.Never)]
5196 public override readonly int GetHashCode();
5197 public static bool operator ==(RealtimeOutputModality left, RealtimeOutputModality right);
5198 public static implicit operator RealtimeOutputModality(string value);
5199 public static implicit operator RealtimeOutputModality?(string value);
5200 public static bool operator !=(RealtimeOutputModality left, RealtimeOutputModality right);
5201 public override readonly string ToString();
5202 }
5203 [Experimental("OPENAI002")]
5204 public class RealtimeOutputTextMessageContentPart : RealtimeMessageContentPart, IJsonModel<RealtimeOutputTextMessageContentPart>, IPersistableModel<RealtimeOutputTextMessageContentPart> {
5205 public RealtimeOutputTextMessageContentPart(string text);
5206 public string Text { get; set; }
5207 protected override RealtimeMessageContentPart JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5208 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5209 protected override RealtimeMessageContentPart PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5210 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5211 }
5212 [Experimental("OPENAI002")]
5213 public class RealtimePcmaAudioFormat : RealtimeAudioFormat, IJsonModel<RealtimePcmaAudioFormat>, IPersistableModel<RealtimePcmaAudioFormat> {
5214 public RealtimePcmaAudioFormat();
5215 protected override RealtimeAudioFormat JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5216 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5217 protected override RealtimeAudioFormat PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5218 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5219 }
5220 [Experimental("OPENAI002")]
5221 public class RealtimePcmAudioFormat : RealtimeAudioFormat, IJsonModel<RealtimePcmAudioFormat>, IPersistableModel<RealtimePcmAudioFormat> {
5222 public RealtimePcmAudioFormat();
5223 public int Rate { get; }
5224 protected override RealtimeAudioFormat JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5225 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5226 protected override RealtimeAudioFormat PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5227 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5228 }
5229 [Experimental("OPENAI002")]
5230 public class RealtimePcmuAudioFormat : RealtimeAudioFormat, IJsonModel<RealtimePcmuAudioFormat>, IPersistableModel<RealtimePcmuAudioFormat> {
5231 public RealtimePcmuAudioFormat();
5232 protected override RealtimeAudioFormat JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5233 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5234 protected override RealtimeAudioFormat PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5235 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5236 }
5237 [Experimental("OPENAI002")]
5238 public class RealtimeRateLimitDetails : IJsonModel<RealtimeRateLimitDetails>, IPersistableModel<RealtimeRateLimitDetails> {
5239 public int? Limit { get; }
5240 public RealtimeRateLimitName? Name { get; }
5241 [Serialization.JsonIgnore]
5242 [EditorBrowsable(EditorBrowsableState.Never)]
5243 [Experimental("SCME0001")]
5244 public ref JsonPatch Patch { get; }
5245 public int? RemainingCount { get; }
5246 public TimeSpan? TimeUntilReset { get; }
5247 protected virtual RealtimeRateLimitDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5248 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5249 protected virtual RealtimeRateLimitDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5250 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5251 }
5252 [Experimental("OPENAI002")]
5253 public readonly partial struct RealtimeRateLimitName : IEquatable<RealtimeRateLimitName> {
5254 public RealtimeRateLimitName(string value);
5255 public static RealtimeRateLimitName Requests { get; }
5256 public static RealtimeRateLimitName Tokens { get; }
5257 public readonly bool Equals(RealtimeRateLimitName other);
5258 [EditorBrowsable(EditorBrowsableState.Never)]
5259 public override readonly bool Equals(object obj);
5260 [EditorBrowsable(EditorBrowsableState.Never)]
5261 public override readonly int GetHashCode();
5262 public static bool operator ==(RealtimeRateLimitName left, RealtimeRateLimitName right);
5263 public static implicit operator RealtimeRateLimitName(string value);
5264 public static implicit operator RealtimeRateLimitName?(string value);
5265 public static bool operator !=(RealtimeRateLimitName left, RealtimeRateLimitName right);
5266 public override readonly string ToString();
5267 }
5268 [Experimental("OPENAI002")]
5269 public class RealtimeResponse : IJsonModel<RealtimeResponse>, IPersistableModel<RealtimeResponse> {
5270 public RealtimeResponseAudioOptions AudioOptions { get; }
5271 public string ConversationId { get; }
5272 public string Id { get; }
5273 public RealtimeMaxOutputTokenCount MaxOutputTokenCount { get; }
5274 public IDictionary<string, BinaryData> Metadata { get; }
5275 public IList<RealtimeItem> OutputItems { get; }
5276 public IList<RealtimeOutputModality> OutputModalities { get; }
5277 [Serialization.JsonIgnore]
5278 [EditorBrowsable(EditorBrowsableState.Never)]
5279 [Experimental("SCME0001")]
5280 public ref JsonPatch Patch { get; }
5281 public RealtimeResponseStatus? Status { get; }
5282 public RealtimeResponseStatusDetails StatusDetails { get; }
5283 public RealtimeResponseUsage Usage { get; }
5284 protected virtual RealtimeResponse JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5285 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5286 protected virtual RealtimeResponse PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5287 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5288 }
5289 [Experimental("OPENAI002")]
5290 public class RealtimeResponseAudioOptions : IJsonModel<RealtimeResponseAudioOptions>, IPersistableModel<RealtimeResponseAudioOptions> {
5291 public RealtimeResponseOutputAudioOptions OutputAudioOptions { get; }
5292 [Serialization.JsonIgnore]
5293 [EditorBrowsable(EditorBrowsableState.Never)]
5294 [Experimental("SCME0001")]
5295 public ref JsonPatch Patch { get; }
5296 protected virtual RealtimeResponseAudioOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5297 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5298 protected virtual RealtimeResponseAudioOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5299 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5300 }
5301 [Experimental("OPENAI002")]
5302 public class RealtimeResponseContentPart : IJsonModel<RealtimeResponseContentPart>, IPersistableModel<RealtimeResponseContentPart> {
5303 public BinaryData Audio { get; }
5304 public RealtimeResponseContentPartKind? Kind { get; }
5305 [Serialization.JsonIgnore]
5306 [EditorBrowsable(EditorBrowsableState.Never)]
5307 [Experimental("SCME0001")]
5308 public ref JsonPatch Patch { get; }
5309 public string Text { get; }
5310 public string Transcript { get; }
5311 protected virtual RealtimeResponseContentPart JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5312 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5313 protected virtual RealtimeResponseContentPart PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5314 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5315 }
5316 [Experimental("OPENAI002")]
5317 public readonly partial struct RealtimeResponseContentPartKind : IEquatable<RealtimeResponseContentPartKind> {
5318 public RealtimeResponseContentPartKind(string value);
5319 public static RealtimeResponseContentPartKind Audio { get; }
5320 public static RealtimeResponseContentPartKind Text { get; }
5321 public readonly bool Equals(RealtimeResponseContentPartKind other);
5322 [EditorBrowsable(EditorBrowsableState.Never)]
5323 public override readonly bool Equals(object obj);
5324 [EditorBrowsable(EditorBrowsableState.Never)]
5325 public override readonly int GetHashCode();
5326 public static bool operator ==(RealtimeResponseContentPartKind left, RealtimeResponseContentPartKind right);
5327 public static implicit operator RealtimeResponseContentPartKind(string value);
5328 public static implicit operator RealtimeResponseContentPartKind?(string value);
5329 public static bool operator !=(RealtimeResponseContentPartKind left, RealtimeResponseContentPartKind right);
5330 public override readonly string ToString();
5331 }
5332 [Experimental("OPENAI002")]
5333 public readonly partial struct RealtimeResponseDefaultConversationConfiguration : IEquatable<RealtimeResponseDefaultConversationConfiguration> {
5334 public RealtimeResponseDefaultConversationConfiguration(string value);
5335 public static RealtimeResponseDefaultConversationConfiguration Auto { get; }
5336 public static RealtimeResponseDefaultConversationConfiguration None { get; }
5337 public readonly bool Equals(RealtimeResponseDefaultConversationConfiguration other);
5338 [EditorBrowsable(EditorBrowsableState.Never)]
5339 public override readonly bool Equals(object obj);
5340 [EditorBrowsable(EditorBrowsableState.Never)]
5341 public override readonly int GetHashCode();
5342 public static bool operator ==(RealtimeResponseDefaultConversationConfiguration left, RealtimeResponseDefaultConversationConfiguration right);
5343 public static implicit operator RealtimeResponseDefaultConversationConfiguration(string value);
5344 public static implicit operator RealtimeResponseDefaultConversationConfiguration?(string value);
5345 public static bool operator !=(RealtimeResponseDefaultConversationConfiguration left, RealtimeResponseDefaultConversationConfiguration right);
5346 public override readonly string ToString();
5347 }
5348 [Experimental("OPENAI002")]
5349 public class RealtimeResponseInputCachedTokenUsageDetails : IJsonModel<RealtimeResponseInputCachedTokenUsageDetails>, IPersistableModel<RealtimeResponseInputCachedTokenUsageDetails> {
5350 public int? AudioTokenCount { get; }
5351 public int? ImageTokenCount { get; }
5352 [Serialization.JsonIgnore]
5353 [EditorBrowsable(EditorBrowsableState.Never)]
5354 [Experimental("SCME0001")]
5355 public ref JsonPatch Patch { get; }
5356 public int? TextTokenCount { get; }
5357 protected virtual RealtimeResponseInputCachedTokenUsageDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5358 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5359 protected virtual RealtimeResponseInputCachedTokenUsageDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5360 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5361 }
5362 [Experimental("OPENAI002")]
5363 public class RealtimeResponseInputTokenUsageDetails : IJsonModel<RealtimeResponseInputTokenUsageDetails>, IPersistableModel<RealtimeResponseInputTokenUsageDetails> {
5364 public int? AudioTokenCount { get; }
5365 public int? CachedTokenCount { get; }
5366 public RealtimeResponseInputCachedTokenUsageDetails CachedTokenDetails { get; }
5367 public int? ImageTokenCount { get; }
5368 [Serialization.JsonIgnore]
5369 [EditorBrowsable(EditorBrowsableState.Never)]
5370 [Experimental("SCME0001")]
5371 public ref JsonPatch Patch { get; }
5372 public int? TextTokenCount { get; }
5373 protected virtual RealtimeResponseInputTokenUsageDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5374 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5375 protected virtual RealtimeResponseInputTokenUsageDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5376 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5377 }
5378 [Experimental("OPENAI002")]
5379 public class RealtimeResponseOptions : IJsonModel<RealtimeResponseOptions>, IPersistableModel<RealtimeResponseOptions> {
5380 public RealtimeResponseAudioOptions AudioOptions { get; set; }
5381 public RealtimeResponseDefaultConversationConfiguration? DefaultConversationConfiguration { get; set; }
5382 public IList<RealtimeItem> InputItems { get; }
5383 public string Instructions { get; set; }
5384 public RealtimeMaxOutputTokenCount MaxOutputTokenCount { get; set; }
5385 public IDictionary<string, BinaryData> Metadata { get; set; }
5386 public IList<RealtimeOutputModality> OutputModalities { get; }
5387 [Serialization.JsonIgnore]
5388 [EditorBrowsable(EditorBrowsableState.Never)]
5389 [Experimental("SCME0001")]
5390 public ref JsonPatch Patch { get; }
5391 public RealtimeToolChoice ToolChoice { get; set; }
5392 public IList<RealtimeTool> Tools { get; }
5393 protected virtual RealtimeResponseOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5394 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5395 protected virtual RealtimeResponseOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5396 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5397 }
5398 [Experimental("OPENAI002")]
5399 public class RealtimeResponseOutputAudioOptions : IJsonModel<RealtimeResponseOutputAudioOptions>, IPersistableModel<RealtimeResponseOutputAudioOptions> {
5400 public RealtimeAudioFormat AudioFormat { get; set; }
5401 [Serialization.JsonIgnore]
5402 [EditorBrowsable(EditorBrowsableState.Never)]
5403 [Experimental("SCME0001")]
5404 public ref JsonPatch Patch { get; }
5405 public RealtimeVoice? Voice { get; set; }
5406 protected virtual RealtimeResponseOutputAudioOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5407 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5408 protected virtual RealtimeResponseOutputAudioOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5409 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5410 }
5411 [Experimental("OPENAI002")]
5412 public class RealtimeResponseOutputTokenUsageDetails : IJsonModel<RealtimeResponseOutputTokenUsageDetails>, IPersistableModel<RealtimeResponseOutputTokenUsageDetails> {
5413 public int? AudioTokenCount { get; }
5414 [Serialization.JsonIgnore]
5415 [EditorBrowsable(EditorBrowsableState.Never)]
5416 [Experimental("SCME0001")]
5417 public ref JsonPatch Patch { get; }
5418 public int? TextTokenCount { get; }
5419 protected virtual RealtimeResponseOutputTokenUsageDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5420 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5421 protected virtual RealtimeResponseOutputTokenUsageDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5422 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5423 }
5424 [Experimental("OPENAI002")]
5425 public readonly partial struct RealtimeResponseStatus : IEquatable<RealtimeResponseStatus> {
5426 public RealtimeResponseStatus(string value);
5427 public static RealtimeResponseStatus Cancelled { get; }
5428 public static RealtimeResponseStatus Completed { get; }
5429 public static RealtimeResponseStatus Failed { get; }
5430 public static RealtimeResponseStatus Incomplete { get; }
5431 public static RealtimeResponseStatus InProgress { get; }
5432 public readonly bool Equals(RealtimeResponseStatus other);
5433 [EditorBrowsable(EditorBrowsableState.Never)]
5434 public override readonly bool Equals(object obj);
5435 [EditorBrowsable(EditorBrowsableState.Never)]
5436 public override readonly int GetHashCode();
5437 public static bool operator ==(RealtimeResponseStatus left, RealtimeResponseStatus right);
5438 public static implicit operator RealtimeResponseStatus(string value);
5439 public static implicit operator RealtimeResponseStatus?(string value);
5440 public static bool operator !=(RealtimeResponseStatus left, RealtimeResponseStatus right);
5441 public override readonly string ToString();
5442 }
5443 [Experimental("OPENAI002")]
5444 public class RealtimeResponseStatusDetails : IJsonModel<RealtimeResponseStatusDetails>, IPersistableModel<RealtimeResponseStatusDetails> {
5445 public RealtimeError Error { get; }
5446 public RealtimeResponseStatusErrorKind? Kind { get; }
5447 [Serialization.JsonIgnore]
5448 [EditorBrowsable(EditorBrowsableState.Never)]
5449 [Experimental("SCME0001")]
5450 public ref JsonPatch Patch { get; }
5451 public RealtimeResponseStatusReason? Reason { get; }
5452 protected virtual RealtimeResponseStatusDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5453 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5454 protected virtual RealtimeResponseStatusDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5455 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5456 }
5457 [Experimental("OPENAI002")]
5458 public readonly partial struct RealtimeResponseStatusErrorKind : IEquatable<RealtimeResponseStatusErrorKind> {
5459 public RealtimeResponseStatusErrorKind(string value);
5460 public static RealtimeResponseStatusErrorKind Cancelled { get; }
5461 public static RealtimeResponseStatusErrorKind Completed { get; }
5462 public static RealtimeResponseStatusErrorKind Failed { get; }
5463 public static RealtimeResponseStatusErrorKind Incomplete { get; }
5464 public readonly bool Equals(RealtimeResponseStatusErrorKind other);
5465 [EditorBrowsable(EditorBrowsableState.Never)]
5466 public override readonly bool Equals(object obj);
5467 [EditorBrowsable(EditorBrowsableState.Never)]
5468 public override readonly int GetHashCode();
5469 public static bool operator ==(RealtimeResponseStatusErrorKind left, RealtimeResponseStatusErrorKind right);
5470 public static implicit operator RealtimeResponseStatusErrorKind(string value);
5471 public static implicit operator RealtimeResponseStatusErrorKind?(string value);
5472 public static bool operator !=(RealtimeResponseStatusErrorKind left, RealtimeResponseStatusErrorKind right);
5473 public override readonly string ToString();
5474 }
5475 [Experimental("OPENAI002")]
5476 public readonly partial struct RealtimeResponseStatusReason : IEquatable<RealtimeResponseStatusReason> {
5477 public RealtimeResponseStatusReason(string value);
5478 public static RealtimeResponseStatusReason ClientCancelled { get; }
5479 public static RealtimeResponseStatusReason ContentFilter { get; }
5480 public static RealtimeResponseStatusReason MaxOutputTokens { get; }
5481 public static RealtimeResponseStatusReason TurnDetected { get; }
5482 public readonly bool Equals(RealtimeResponseStatusReason other);
5483 [EditorBrowsable(EditorBrowsableState.Never)]
5484 public override readonly bool Equals(object obj);
5485 [EditorBrowsable(EditorBrowsableState.Never)]
5486 public override readonly int GetHashCode();
5487 public static bool operator ==(RealtimeResponseStatusReason left, RealtimeResponseStatusReason right);
5488 public static implicit operator RealtimeResponseStatusReason(string value);
5489 public static implicit operator RealtimeResponseStatusReason?(string value);
5490 public static bool operator !=(RealtimeResponseStatusReason left, RealtimeResponseStatusReason right);
5491 public override readonly string ToString();
5492 }
5493 [Experimental("OPENAI002")]
5494 public class RealtimeResponseUsage : IJsonModel<RealtimeResponseUsage>, IPersistableModel<RealtimeResponseUsage> {
5495 public int? InputTokenCount { get; }
5496 public RealtimeResponseInputTokenUsageDetails InputTokenDetails { get; }
5497 public int? OutputTokenCount { get; }
5498 public RealtimeResponseOutputTokenUsageDetails OutputTokenDetails { get; }
5499 [Serialization.JsonIgnore]
5500 [EditorBrowsable(EditorBrowsableState.Never)]
5501 [Experimental("SCME0001")]
5502 public ref JsonPatch Patch { get; }
5503 public int? TotalTokenCount { get; }
5504 protected virtual RealtimeResponseUsage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5505 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5506 protected virtual RealtimeResponseUsage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5507 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5508 }
5509 [Experimental("OPENAI002")]
5510 public class RealtimeRetentionRatioTokenLimitDetails : IJsonModel<RealtimeRetentionRatioTokenLimitDetails>, IPersistableModel<RealtimeRetentionRatioTokenLimitDetails> {
5511 public int? MaxPostInstructionsTokenCount { get; set; }
5512 [Serialization.JsonIgnore]
5513 [EditorBrowsable(EditorBrowsableState.Never)]
5514 [Experimental("SCME0001")]
5515 public ref JsonPatch Patch { get; }
5516 protected virtual RealtimeRetentionRatioTokenLimitDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5517 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5518 protected virtual RealtimeRetentionRatioTokenLimitDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5519 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5520 }
5521 [Experimental("OPENAI002")]
5522 public readonly partial struct RealtimeSemanticVadEagernessLevel : IEquatable<RealtimeSemanticVadEagernessLevel> {
5523 public RealtimeSemanticVadEagernessLevel(string value);
5524 public static RealtimeSemanticVadEagernessLevel Auto { get; }
5525 public static RealtimeSemanticVadEagernessLevel High { get; }
5526 public static RealtimeSemanticVadEagernessLevel Low { get; }
5527 public static RealtimeSemanticVadEagernessLevel Medium { get; }
5528 public readonly bool Equals(RealtimeSemanticVadEagernessLevel other);
5529 [EditorBrowsable(EditorBrowsableState.Never)]
5530 public override readonly bool Equals(object obj);
5531 [EditorBrowsable(EditorBrowsableState.Never)]
5532 public override readonly int GetHashCode();
5533 public static bool operator ==(RealtimeSemanticVadEagernessLevel left, RealtimeSemanticVadEagernessLevel right);
5534 public static implicit operator RealtimeSemanticVadEagernessLevel(string value);
5535 public static implicit operator RealtimeSemanticVadEagernessLevel?(string value);
5536 public static bool operator !=(RealtimeSemanticVadEagernessLevel left, RealtimeSemanticVadEagernessLevel right);
5537 public override readonly string ToString();
5538 }
5539 [Experimental("OPENAI002")]
5540 public class RealtimeSemanticVadTurnDetection : RealtimeTurnDetection, IJsonModel<RealtimeSemanticVadTurnDetection>, IPersistableModel<RealtimeSemanticVadTurnDetection> {
5541 public RealtimeSemanticVadTurnDetection();
5542 public bool? CreateResponseEnabled { get; set; }
5543 public RealtimeSemanticVadEagernessLevel? EagernessLevel { get; set; }
5544 public bool? InterruptResponseEnabled { get; set; }
5545 protected override RealtimeTurnDetection JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5546 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5547 protected override RealtimeTurnDetection PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5548 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5549 }
5550 [Experimental("OPENAI002")]
5551 public class RealtimeServerUpdate : IJsonModel<RealtimeServerUpdate>, IPersistableModel<RealtimeServerUpdate> {
5552 [Serialization.JsonIgnore]
5553 [EditorBrowsable(EditorBrowsableState.Never)]
5554 [Experimental("SCME0001")]
5555 public ref JsonPatch Patch { get; }
5556 protected virtual RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5557 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5558 protected virtual RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5559 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5560 }
5561 [Experimental("OPENAI002")]
5562 public class RealtimeServerUpdateConversationCreated : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationCreated>, IPersistableModel<RealtimeServerUpdateConversationCreated> {
5563 public RealtimeConversation Conversation { get; }
5564 public string EventId { get; }
5565 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5566 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5567 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5568 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5569 }
5570 [Experimental("OPENAI002")]
5571 public class RealtimeServerUpdateConversationItemAdded : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemAdded>, IPersistableModel<RealtimeServerUpdateConversationItemAdded> {
5572 public string EventId { get; }
5573 public RealtimeItem Item { get; }
5574 public string PreviousItemId { get; }
5575 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5576 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5577 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5578 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5579 }
5580 [Experimental("OPENAI002")]
5581 public class RealtimeServerUpdateConversationItemCreated : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemCreated>, IPersistableModel<RealtimeServerUpdateConversationItemCreated> {
5582 public string EventId { get; }
5583 public RealtimeItem Item { get; }
5584 public string PreviousItemId { get; }
5585 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5586 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5587 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5588 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5589 }
5590 [Experimental("OPENAI002")]
5591 public class RealtimeServerUpdateConversationItemDeleted : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemDeleted>, IPersistableModel<RealtimeServerUpdateConversationItemDeleted> {
5592 public string EventId { get; }
5593 public string ItemId { get; }
5594 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5595 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5596 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5597 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5598 }
5599 [Experimental("OPENAI002")]
5600 public class RealtimeServerUpdateConversationItemDone : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemDone>, IPersistableModel<RealtimeServerUpdateConversationItemDone> {
5601 public string EventId { get; }
5602 public RealtimeItem Item { get; }
5603 public string PreviousItemId { get; }
5604 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5605 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5606 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5607 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5608 }
5609 [Experimental("OPENAI002")]
5610 public class RealtimeServerUpdateConversationItemInputAudioTranscriptionCompleted : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemInputAudioTranscriptionCompleted>, IPersistableModel<RealtimeServerUpdateConversationItemInputAudioTranscriptionCompleted> {
5611 public int ContentIndex { get; }
5612 public string EventId { get; }
5613 public string ItemId { get; }
5614 public IList<RealtimeLogProbabilityDetails> Logprobs { get; }
5615 public string Transcript { get; }
5616 public RealtimeTranscriptionUsage Usage { get; }
5617 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5618 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5619 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5620 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5621 }
5622 [Experimental("OPENAI002")]
5623 public class RealtimeServerUpdateConversationItemInputAudioTranscriptionDelta : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemInputAudioTranscriptionDelta>, IPersistableModel<RealtimeServerUpdateConversationItemInputAudioTranscriptionDelta> {
5624 public int? ContentIndex { get; }
5625 public string Delta { get; }
5626 public string EventId { get; }
5627 public string ItemId { get; }
5628 public IList<RealtimeLogProbabilityDetails> Logprobs { get; }
5629 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5630 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5631 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5632 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5633 }
5634 [Experimental("OPENAI002")]
5635 public class RealtimeServerUpdateConversationItemInputAudioTranscriptionFailed : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemInputAudioTranscriptionFailed>, IPersistableModel<RealtimeServerUpdateConversationItemInputAudioTranscriptionFailed> {
5636 public int ContentIndex { get; }
5637 public RealtimeError Error { get; }
5638 public string EventId { get; }
5639 public string ItemId { get; }
5640 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5641 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5642 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5643 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5644 }
5645 [Experimental("OPENAI002")]
5646 public class RealtimeServerUpdateConversationItemInputAudioTranscriptionSegment : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemInputAudioTranscriptionSegment>, IPersistableModel<RealtimeServerUpdateConversationItemInputAudioTranscriptionSegment> {
5647 public int ContentIndex { get; }
5648 public float End { get; }
5649 public string EventId { get; }
5650 public string Id { get; }
5651 public string ItemId { get; }
5652 public string Speaker { get; }
5653 public float Start { get; }
5654 public string Text { get; }
5655 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5656 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5657 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5658 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5659 }
5660 [Experimental("OPENAI002")]
5661 public class RealtimeServerUpdateConversationItemRetrieved : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemRetrieved>, IPersistableModel<RealtimeServerUpdateConversationItemRetrieved> {
5662 public string EventId { get; }
5663 public RealtimeItem Item { get; }
5664 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5665 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5666 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5667 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5668 }
5669 [Experimental("OPENAI002")]
5670 public class RealtimeServerUpdateConversationItemTruncated : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateConversationItemTruncated>, IPersistableModel<RealtimeServerUpdateConversationItemTruncated> {
5671 public TimeSpan AudioEndTime { get; }
5672 public int ContentIndex { get; }
5673 public string EventId { get; }
5674 public string ItemId { get; }
5675 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5676 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5677 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5678 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5679 }
5680 [Experimental("OPENAI002")]
5681 public class RealtimeServerUpdateError : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateError>, IPersistableModel<RealtimeServerUpdateError> {
5682 public RealtimeError Error { get; }
5683 public string EventId { get; }
5684 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5685 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5686 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5687 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5688 }
5689 [Experimental("OPENAI002")]
5690 public class RealtimeServerUpdateInputAudioBufferCleared : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateInputAudioBufferCleared>, IPersistableModel<RealtimeServerUpdateInputAudioBufferCleared> {
5691 public string EventId { get; }
5692 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5693 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5694 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5695 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5696 }
5697 [Experimental("OPENAI002")]
5698 public class RealtimeServerUpdateInputAudioBufferCommitted : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateInputAudioBufferCommitted>, IPersistableModel<RealtimeServerUpdateInputAudioBufferCommitted> {
5699 public string EventId { get; }
5700 public string ItemId { get; }
5701 public string PreviousItemId { get; }
5702 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5703 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5704 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5705 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5706 }
5707 [Experimental("OPENAI002")]
5708 public class RealtimeServerUpdateInputAudioBufferDtmfEventReceived : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateInputAudioBufferDtmfEventReceived>, IPersistableModel<RealtimeServerUpdateInputAudioBufferDtmfEventReceived> {
5709 public string Event { get; }
5710 public DateTimeOffset ReceivedAt { get; }
5711 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5712 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5713 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5714 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5715 }
5716 [Experimental("OPENAI002")]
5717 public class RealtimeServerUpdateInputAudioBufferSpeechStarted : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateInputAudioBufferSpeechStarted>, IPersistableModel<RealtimeServerUpdateInputAudioBufferSpeechStarted> {
5718 public TimeSpan AudioStartTime { get; }
5719 public string EventId { get; }
5720 public string ItemId { get; }
5721 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5722 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5723 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5724 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5725 }
5726 [Experimental("OPENAI002")]
5727 public class RealtimeServerUpdateInputAudioBufferSpeechStopped : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateInputAudioBufferSpeechStopped>, IPersistableModel<RealtimeServerUpdateInputAudioBufferSpeechStopped> {
5728 public TimeSpan AudioEndTime { get; }
5729 public string EventId { get; }
5730 public string ItemId { get; }
5731 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5732 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5733 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5734 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5735 }
5736 [Experimental("OPENAI002")]
5737 public class RealtimeServerUpdateInputAudioBufferTimeoutTriggered : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateInputAudioBufferTimeoutTriggered>, IPersistableModel<RealtimeServerUpdateInputAudioBufferTimeoutTriggered> {
5738 public TimeSpan AudioEndTime { get; }
5739 public TimeSpan AudioStartTime { get; }
5740 public string EventId { get; }
5741 public string ItemId { get; }
5742 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5743 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5744 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5745 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5746 }
5747 [Experimental("OPENAI002")]
5748 public class RealtimeServerUpdateMcpListToolsCompleted : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateMcpListToolsCompleted>, IPersistableModel<RealtimeServerUpdateMcpListToolsCompleted> {
5749 public string EventId { get; }
5750 public string ItemId { get; }
5751 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5752 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5753 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5754 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5755 }
5756 [Experimental("OPENAI002")]
5757 public class RealtimeServerUpdateMcpListToolsFailed : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateMcpListToolsFailed>, IPersistableModel<RealtimeServerUpdateMcpListToolsFailed> {
5758 public string EventId { get; }
5759 public string ItemId { get; }
5760 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5761 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5762 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5763 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5764 }
5765 [Experimental("OPENAI002")]
5766 public class RealtimeServerUpdateMcpListToolsInProgress : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateMcpListToolsInProgress>, IPersistableModel<RealtimeServerUpdateMcpListToolsInProgress> {
5767 public string EventId { get; }
5768 public string ItemId { get; }
5769 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5770 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5771 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5772 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5773 }
5774 [Experimental("OPENAI002")]
5775 public class RealtimeServerUpdateOutputAudioBufferCleared : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateOutputAudioBufferCleared>, IPersistableModel<RealtimeServerUpdateOutputAudioBufferCleared> {
5776 public string EventId { get; }
5777 public string ResponseId { get; }
5778 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5779 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5780 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5781 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5782 }
5783 [Experimental("OPENAI002")]
5784 public class RealtimeServerUpdateOutputAudioBufferStarted : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateOutputAudioBufferStarted>, IPersistableModel<RealtimeServerUpdateOutputAudioBufferStarted> {
5785 public string EventId { get; }
5786 public string ResponseId { get; }
5787 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5788 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5789 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5790 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5791 }
5792 [Experimental("OPENAI002")]
5793 public class RealtimeServerUpdateOutputAudioBufferStopped : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateOutputAudioBufferStopped>, IPersistableModel<RealtimeServerUpdateOutputAudioBufferStopped> {
5794 public string EventId { get; }
5795 public string ResponseId { get; }
5796 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5797 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5798 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5799 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5800 }
5801 [Experimental("OPENAI002")]
5802 public class RealtimeServerUpdateRateLimitsUpdated : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateRateLimitsUpdated>, IPersistableModel<RealtimeServerUpdateRateLimitsUpdated> {
5803 public string EventId { get; }
5804 public IList<RealtimeRateLimitDetails> RateLimitDetails { get; }
5805 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5806 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5807 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5808 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5809 }
5810 [Experimental("OPENAI002")]
5811 public class RealtimeServerUpdateResponseContentPartAdded : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseContentPartAdded>, IPersistableModel<RealtimeServerUpdateResponseContentPartAdded> {
5812 public int ContentIndex { get; }
5813 public string EventId { get; }
5814 public string ItemId { get; }
5815 public int OutputIndex { get; }
5816 public RealtimeResponseContentPart Part { get; }
5817 public string ResponseId { get; }
5818 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5819 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5820 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5821 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5822 }
5823 [Experimental("OPENAI002")]
5824 public class RealtimeServerUpdateResponseContentPartDone : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseContentPartDone>, IPersistableModel<RealtimeServerUpdateResponseContentPartDone> {
5825 public int ContentIndex { get; }
5826 public string EventId { get; }
5827 public string ItemId { get; }
5828 public int OutputIndex { get; }
5829 public RealtimeResponseContentPart Part { get; }
5830 public string ResponseId { get; }
5831 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5832 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5833 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5834 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5835 }
5836 [Experimental("OPENAI002")]
5837 public class RealtimeServerUpdateResponseCreated : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseCreated>, IPersistableModel<RealtimeServerUpdateResponseCreated> {
5838 public string EventId { get; }
5839 public RealtimeResponse Response { get; }
5840 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5841 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5842 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5843 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5844 }
5845 [Experimental("OPENAI002")]
5846 public class RealtimeServerUpdateResponseDone : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseDone>, IPersistableModel<RealtimeServerUpdateResponseDone> {
5847 public string EventId { get; }
5848 public RealtimeResponse Response { get; }
5849 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5850 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5851 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5852 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5853 }
5854 [Experimental("OPENAI002")]
5855 public class RealtimeServerUpdateResponseFunctionCallArgumentsDelta : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseFunctionCallArgumentsDelta>, IPersistableModel<RealtimeServerUpdateResponseFunctionCallArgumentsDelta> {
5856 public string CallId { get; }
5857 public BinaryData Delta { get; }
5858 public string EventId { get; }
5859 public string ItemId { get; }
5860 public int OutputIndex { get; }
5861 public string ResponseId { get; }
5862 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5863 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5864 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5865 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5866 }
5867 [Experimental("OPENAI002")]
5868 public class RealtimeServerUpdateResponseFunctionCallArgumentsDone : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseFunctionCallArgumentsDone>, IPersistableModel<RealtimeServerUpdateResponseFunctionCallArgumentsDone> {
5869 public string CallId { get; }
5870 public string EventId { get; }
5871 public BinaryData FunctionArguments { get; }
5872 public string FunctionName { get; }
5873 public string ItemId { get; }
5874 public int OutputIndex { get; }
5875 public string ResponseId { get; }
5876 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5877 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5878 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5879 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5880 }
5881 [Experimental("OPENAI002")]
5882 public class RealtimeServerUpdateResponseMcpCallArgumentsDelta : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseMcpCallArgumentsDelta>, IPersistableModel<RealtimeServerUpdateResponseMcpCallArgumentsDelta> {
5883 public BinaryData Delta { get; }
5884 public string EventId { get; }
5885 public string ItemId { get; }
5886 public string Obfuscation { get; }
5887 public int OutputIndex { get; }
5888 public string ResponseId { get; }
5889 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5890 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5891 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5892 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5893 }
5894 [Experimental("OPENAI002")]
5895 public class RealtimeServerUpdateResponseMcpCallArgumentsDone : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseMcpCallArgumentsDone>, IPersistableModel<RealtimeServerUpdateResponseMcpCallArgumentsDone> {
5896 public string EventId { get; }
5897 public string ItemId { get; }
5898 public int OutputIndex { get; }
5899 public string ResponseId { get; }
5900 public BinaryData ToolArguments { get; }
5901 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5902 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5903 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5904 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5905 }
5906 [Experimental("OPENAI002")]
5907 public class RealtimeServerUpdateResponseMcpCallCompleted : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseMcpCallCompleted>, IPersistableModel<RealtimeServerUpdateResponseMcpCallCompleted> {
5908 public string EventId { get; }
5909 public string ItemId { get; }
5910 public int OutputIndex { get; }
5911 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5912 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5913 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5914 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5915 }
5916 [Experimental("OPENAI002")]
5917 public class RealtimeServerUpdateResponseMcpCallFailed : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseMcpCallFailed>, IPersistableModel<RealtimeServerUpdateResponseMcpCallFailed> {
5918 public string EventId { get; }
5919 public string ItemId { get; }
5920 public int OutputIndex { get; }
5921 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5922 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5923 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5924 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5925 }
5926 [Experimental("OPENAI002")]
5927 public class RealtimeServerUpdateResponseMcpCallInProgress : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseMcpCallInProgress>, IPersistableModel<RealtimeServerUpdateResponseMcpCallInProgress> {
5928 public string EventId { get; }
5929 public string ItemId { get; }
5930 public int OutputIndex { get; }
5931 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5932 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5933 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5934 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5935 }
5936 [Experimental("OPENAI002")]
5937 public class RealtimeServerUpdateResponseOutputAudioDelta : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseOutputAudioDelta>, IPersistableModel<RealtimeServerUpdateResponseOutputAudioDelta> {
5938 public int ContentIndex { get; }
5939 public BinaryData Delta { get; }
5940 public string EventId { get; }
5941 public string ItemId { get; }
5942 public int OutputIndex { get; }
5943 public string ResponseId { get; }
5944 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5945 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5946 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5947 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5948 }
5949 [Experimental("OPENAI002")]
5950 public class RealtimeServerUpdateResponseOutputAudioDone : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseOutputAudioDone>, IPersistableModel<RealtimeServerUpdateResponseOutputAudioDone> {
5951 public int ContentIndex { get; }
5952 public string EventId { get; }
5953 public string ItemId { get; }
5954 public int OutputIndex { get; }
5955 public string ResponseId { get; }
5956 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5957 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5958 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5959 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5960 }
5961 [Experimental("OPENAI002")]
5962 public class RealtimeServerUpdateResponseOutputAudioTranscriptDelta : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseOutputAudioTranscriptDelta>, IPersistableModel<RealtimeServerUpdateResponseOutputAudioTranscriptDelta> {
5963 public int ContentIndex { get; }
5964 public string Delta { get; }
5965 public string EventId { get; }
5966 public string ItemId { get; }
5967 public int OutputIndex { get; }
5968 public string ResponseId { get; }
5969 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5970 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5971 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5972 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5973 }
5974 [Experimental("OPENAI002")]
5975 public class RealtimeServerUpdateResponseOutputAudioTranscriptDone : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseOutputAudioTranscriptDone>, IPersistableModel<RealtimeServerUpdateResponseOutputAudioTranscriptDone> {
5976 public int ContentIndex { get; }
5977 public string EventId { get; }
5978 public string ItemId { get; }
5979 public int OutputIndex { get; }
5980 public string ResponseId { get; }
5981 public string Transcript { get; }
5982 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5983 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5984 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5985 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5986 }
5987 [Experimental("OPENAI002")]
5988 public class RealtimeServerUpdateResponseOutputItemAdded : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseOutputItemAdded>, IPersistableModel<RealtimeServerUpdateResponseOutputItemAdded> {
5989 public string EventId { get; }
5990 public RealtimeItem Item { get; }
5991 public int OutputIndex { get; }
5992 public string ResponseId { get; }
5993 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
5994 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
5995 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
5996 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
5997 }
5998 [Experimental("OPENAI002")]
5999 public class RealtimeServerUpdateResponseOutputItemDone : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseOutputItemDone>, IPersistableModel<RealtimeServerUpdateResponseOutputItemDone> {
6000 public string EventId { get; }
6001 public RealtimeItem Item { get; }
6002 public int OutputIndex { get; }
6003 public string ResponseId { get; }
6004 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6005 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6006 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6007 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6008 }
6009 [Experimental("OPENAI002")]
6010 public class RealtimeServerUpdateResponseOutputTextDelta : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseOutputTextDelta>, IPersistableModel<RealtimeServerUpdateResponseOutputTextDelta> {
6011 public int ContentIndex { get; }
6012 public string Delta { get; }
6013 public string EventId { get; }
6014 public string ItemId { get; }
6015 public int OutputIndex { get; }
6016 public string ResponseId { get; }
6017 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6018 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6019 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6020 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6021 }
6022 [Experimental("OPENAI002")]
6023 public class RealtimeServerUpdateResponseOutputTextDone : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateResponseOutputTextDone>, IPersistableModel<RealtimeServerUpdateResponseOutputTextDone> {
6024 public int ContentIndex { get; }
6025 public string EventId { get; }
6026 public string ItemId { get; }
6027 public int OutputIndex { get; }
6028 public string ResponseId { get; }
6029 public string Text { get; }
6030 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6031 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6032 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6033 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6034 }
6035 [Experimental("OPENAI002")]
6036 public class RealtimeServerUpdateSessionCreated : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateSessionCreated>, IPersistableModel<RealtimeServerUpdateSessionCreated> {
6037 public string EventId { get; }
6038 public RealtimeSession Session { get; }
6039 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6040 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6041 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6042 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6043 }
6044 [Experimental("OPENAI002")]
6045 public class RealtimeServerUpdateSessionUpdated : RealtimeServerUpdate, IJsonModel<RealtimeServerUpdateSessionUpdated>, IPersistableModel<RealtimeServerUpdateSessionUpdated> {
6046 public string EventId { get; }
6047 public RealtimeSession Session { get; }
6048 protected override RealtimeServerUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6049 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6050 protected override RealtimeServerUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6051 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6052 }
6053 [Experimental("OPENAI002")]
6054 public class RealtimeServerVadTurnDetection : RealtimeTurnDetection, IJsonModel<RealtimeServerVadTurnDetection>, IPersistableModel<RealtimeServerVadTurnDetection> {
6055 public RealtimeServerVadTurnDetection();
6056 public bool? CreateResponseEnabled { get; set; }
6057 public float? DetectionThreshold { get; set; }
6058 public TimeSpan? IdleTimeout { get; set; }
6059 public bool? InterruptResponseEnabled { get; set; }
6060 public TimeSpan? PrefixPadding { get; set; }
6061 public TimeSpan? SilenceDuration { get; set; }
6062 protected override RealtimeTurnDetection JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6063 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6064 protected override RealtimeTurnDetection PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6065 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6066 }
6067 [Experimental("OPENAI002")]
6068 public class RealtimeSession : IJsonModel<RealtimeSession>, IPersistableModel<RealtimeSession> {
6069 [Serialization.JsonIgnore]
6070 [EditorBrowsable(EditorBrowsableState.Never)]
6071 [Experimental("SCME0001")]
6072 public ref JsonPatch Patch { get; }
6073 protected virtual RealtimeSession JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6074 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6075 protected virtual RealtimeSession PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6076 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6077 }
6078 [Experimental("OPENAI002")]
6079 public class RealtimeSessionClient : IDisposable {
6080 protected internal RealtimeSessionClient(ApiKeyCredential credential, Uri endpoint, string model, string intent, RealtimeClient parentClient);
6081 public Net.WebSockets.WebSocket WebSocket { get; protected set; }
6082 public virtual void AddItem(RealtimeItem item, string previousItemId, CancellationToken cancellationToken = default);
6083 public virtual void AddItem(RealtimeItem item, CancellationToken cancellationToken = default);
6084 public virtual Task AddItemAsync(RealtimeItem item, string previousItemId, CancellationToken cancellationToken = default);
6085 public virtual Task AddItemAsync(RealtimeItem item, CancellationToken cancellationToken = default);
6086 public virtual void CancelResponse(CancellationToken cancellationToken = default);
6087 public virtual Task CancelResponseAsync(CancellationToken cancellationToken = default);
6088 public virtual void ClearInputAudio(CancellationToken cancellationToken = default);
6089 public virtual Task ClearInputAudioAsync(CancellationToken cancellationToken = default);
6090 public virtual void CommitPendingAudio(CancellationToken cancellationToken = default);
6091 public virtual Task CommitPendingAudioAsync(CancellationToken cancellationToken = default);
6092 public virtual void ConfigureConversationSession(RealtimeConversationSessionOptions sessionOptions, CancellationToken cancellationToken = default);
6093 public virtual Task ConfigureConversationSessionAsync(RealtimeConversationSessionOptions sessionOptions, CancellationToken cancellationToken = default);
6094 public virtual void ConfigureTranscriptionSession(RealtimeTranscriptionSessionOptions sessionOptions, CancellationToken cancellationToken = default);
6095 public virtual Task ConfigureTranscriptionSessionAsync(RealtimeTranscriptionSessionOptions sessionOptions, CancellationToken cancellationToken = default);
6096 protected internal virtual void Connect(string queryString = null, IDictionary<string, string> headers = null, CancellationToken cancellationToken = default);
6097 protected internal virtual Task ConnectAsync(string queryString = null, IDictionary<string, string> headers = null, CancellationToken cancellationToken = default);
6098 public virtual void DeleteItem(string itemId, CancellationToken cancellationToken = default);
6099 public virtual Task DeleteItemAsync(string itemId, CancellationToken cancellationToken = default);
6100 public void Dispose();
6101 public virtual IEnumerable<ClientResult> ReceiveUpdates(RequestOptions options);
6102 public virtual IEnumerable<RealtimeServerUpdate> ReceiveUpdates(CancellationToken cancellationToken = default);
6103 public virtual IAsyncEnumerable<ClientResult> ReceiveUpdatesAsync(RequestOptions options);
6104 public virtual IAsyncEnumerable<RealtimeServerUpdate> ReceiveUpdatesAsync(CancellationToken cancellationToken = default);
6105 public virtual void RequestItemRetrieval(string itemId, CancellationToken cancellationToken = default);
6106 public virtual Task RequestItemRetrievalAsync(string itemId, CancellationToken cancellationToken = default);
6107 public virtual void SendCommand(RealtimeClientCommand command, CancellationToken cancellationToken = default);
6108 public virtual void SendCommand(BinaryData data, RequestOptions options);
6109 public virtual Task SendCommandAsync(RealtimeClientCommand command, CancellationToken cancellationToken = default);
6110 public virtual Task SendCommandAsync(BinaryData data, RequestOptions options);
6111 public virtual void SendInputAudio(BinaryData audio, CancellationToken cancellationToken = default);
6112 public virtual void SendInputAudio(Stream audio, CancellationToken cancellationToken = default);
6113 public virtual Task SendInputAudioAsync(BinaryData audio, CancellationToken cancellationToken = default);
6114 public virtual Task SendInputAudioAsync(Stream audio, CancellationToken cancellationToken = default);
6115 public virtual void StartResponse(RealtimeResponseOptions responseOptions, CancellationToken cancellationToken = default);
6116 public virtual void StartResponse(CancellationToken cancellationToken = default);
6117 public virtual Task StartResponseAsync(RealtimeResponseOptions responseOptions, CancellationToken cancellationToken = default);
6118 public virtual Task StartResponseAsync(CancellationToken cancellationToken = default);
6119 public virtual void TruncateItem(string itemId, int contentPartIndex, TimeSpan audioDuration, CancellationToken cancellationToken = default);
6120 public virtual Task TruncateItemAsync(string itemId, int contentPartIndex, TimeSpan audioDuration, CancellationToken cancellationToken = default);
6121 }
6122 [Experimental("OPENAI002")]
6123 public class RealtimeSessionClientOptions {
6124 public string ClientSecret { get; set; }
6125 public IDictionary<string, string> Headers { get; }
6126 public string QueryString { get; set; }
6127 }
6128 [Experimental("OPENAI002")]
6129 public class RealtimeSessionOptions : IJsonModel<RealtimeSessionOptions>, IPersistableModel<RealtimeSessionOptions> {
6130 [Serialization.JsonIgnore]
6131 [EditorBrowsable(EditorBrowsableState.Never)]
6132 [Experimental("SCME0001")]
6133 public ref JsonPatch Patch { get; }
6134 protected virtual RealtimeSessionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6135 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6136 protected virtual RealtimeSessionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6137 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6138 }
6139 [Experimental("OPENAI002")]
6140 public class RealtimeTool : IJsonModel<RealtimeTool>, IPersistableModel<RealtimeTool> {
6141 [Serialization.JsonIgnore]
6142 [EditorBrowsable(EditorBrowsableState.Never)]
6143 [Experimental("SCME0001")]
6144 public ref JsonPatch Patch { get; }
6145 protected virtual RealtimeTool JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6146 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6147 protected virtual RealtimeTool PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6148 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6149 }
6150 [Experimental("OPENAI002")]
6151 public class RealtimeToolChoice : IJsonModel<RealtimeToolChoice>, IPersistableModel<RealtimeToolChoice> {
6152 public RealtimeToolChoice(RealtimeCustomToolChoice customToolChoice);
6153 public RealtimeToolChoice(RealtimeDefaultToolChoice defaultToolChoice);
6154 public RealtimeCustomToolChoice CustomToolChoice { get; }
6155 public RealtimeDefaultToolChoice? DefaultToolChoice { get; }
6156 [Serialization.JsonIgnore]
6157 [EditorBrowsable(EditorBrowsableState.Never)]
6158 [Experimental("SCME0001")]
6159 public ref JsonPatch Patch { get; }
6160 protected virtual RealtimeToolChoice JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6161 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6162 public static implicit operator RealtimeToolChoice(RealtimeCustomToolChoice customToolChoice);
6163 public static implicit operator RealtimeToolChoice(RealtimeDefaultToolChoice defaultToolChoice);
6164 protected virtual RealtimeToolChoice PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6165 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6166 }
6167 [Experimental("OPENAI002")]
6168 public class RealtimeTracing : IJsonModel<RealtimeTracing>, IPersistableModel<RealtimeTracing> {
6169 public RealtimeTracing(RealtimeCustomTracing customTracing);
6170 public RealtimeTracing(RealtimeDefaultTracing defaultTracing);
6171 public RealtimeCustomTracing CustomTracing { get; }
6172 public RealtimeDefaultTracing? DefaultTracing { get; }
6173 [Serialization.JsonIgnore]
6174 [EditorBrowsable(EditorBrowsableState.Never)]
6175 [Experimental("SCME0001")]
6176 public ref JsonPatch Patch { get; }
6177 protected virtual RealtimeTracing JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6178 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6179 public static implicit operator RealtimeTracing(RealtimeCustomTracing customTracing);
6180 public static implicit operator RealtimeTracing(RealtimeDefaultTracing defaultTracing);
6181 protected virtual RealtimeTracing PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6182 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6183 }
6184 [Experimental("OPENAI002")]
6185 public class RealtimeTranscriptionDurationUsage : RealtimeTranscriptionUsage, IJsonModel<RealtimeTranscriptionDurationUsage>, IPersistableModel<RealtimeTranscriptionDurationUsage> {
6186 public TimeSpan Duration { get; }
6187 protected override RealtimeTranscriptionUsage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6188 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6189 protected override RealtimeTranscriptionUsage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6190 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6191 }
6192 [Experimental("OPENAI002")]
6193 public class RealtimeTranscriptionInputTokenUsageDetails : IJsonModel<RealtimeTranscriptionInputTokenUsageDetails>, IPersistableModel<RealtimeTranscriptionInputTokenUsageDetails> {
6194 public int? AudioTokenCount { get; }
6195 [Serialization.JsonIgnore]
6196 [EditorBrowsable(EditorBrowsableState.Never)]
6197 [Experimental("SCME0001")]
6198 public ref JsonPatch Patch { get; }
6199 public int? TextTokenCount { get; }
6200 protected virtual RealtimeTranscriptionInputTokenUsageDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6201 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6202 protected virtual RealtimeTranscriptionInputTokenUsageDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6203 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6204 }
6205 [Experimental("OPENAI002")]
6206 public class RealtimeTranscriptionSession : RealtimeSession, IJsonModel<RealtimeTranscriptionSession>, IPersistableModel<RealtimeTranscriptionSession> {
6207 public RealtimeTranscriptionSessionAudioOptions AudioOptions { get; set; }
6208 public DateTimeOffset? ExpiresAt { get; }
6209 public string Id { get; }
6210 public IList<RealtimeIncludedProperty> IncludedProperties { get; }
6211 public string Object { get; }
6212 protected override RealtimeSession JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6213 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6214 protected override RealtimeSession PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6215 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6216 }
6217 [Experimental("OPENAI002")]
6218 public class RealtimeTranscriptionSessionAudioOptions : IJsonModel<RealtimeTranscriptionSessionAudioOptions>, IPersistableModel<RealtimeTranscriptionSessionAudioOptions> {
6219 public RealtimeTranscriptionSessionInputAudioOptions InputAudioOptions { get; set; }
6220 [Serialization.JsonIgnore]
6221 [EditorBrowsable(EditorBrowsableState.Never)]
6222 [Experimental("SCME0001")]
6223 public ref JsonPatch Patch { get; }
6224 protected virtual RealtimeTranscriptionSessionAudioOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6225 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6226 protected virtual RealtimeTranscriptionSessionAudioOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6227 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6228 }
6229 [Experimental("OPENAI002")]
6230 public class RealtimeTranscriptionSessionInputAudioOptions : IJsonModel<RealtimeTranscriptionSessionInputAudioOptions>, IPersistableModel<RealtimeTranscriptionSessionInputAudioOptions> {
6231 public RealtimeAudioFormat AudioFormat { get; set; }
6232 public RealtimeAudioTranscriptionOptions AudioTranscriptionOptions { get; set; }
6233 public RealtimeNoiseReduction NoiseReduction { get; set; }
6234 [Serialization.JsonIgnore]
6235 [EditorBrowsable(EditorBrowsableState.Never)]
6236 [Experimental("SCME0001")]
6237 public ref JsonPatch Patch { get; }
6238 public RealtimeTurnDetection TurnDetection { get; set; }
6239 public void DisableTurnDetection();
6240 protected virtual RealtimeTranscriptionSessionInputAudioOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6241 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6242 protected virtual RealtimeTranscriptionSessionInputAudioOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6243 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6244 }
6245 [Experimental("OPENAI002")]
6246 public class RealtimeTranscriptionSessionOptions : RealtimeSessionOptions, IJsonModel<RealtimeTranscriptionSessionOptions>, IPersistableModel<RealtimeTranscriptionSessionOptions> {
6247 public RealtimeTranscriptionSessionOptions();
6248 public RealtimeTranscriptionSessionAudioOptions AudioOptions { get; set; }
6249 public IList<RealtimeIncludedProperty> IncludedProperties { get; }
6250 protected override RealtimeSessionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6251 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6252 protected override RealtimeSessionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6253 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6254 }
6255 [Experimental("OPENAI002")]
6256 public class RealtimeTranscriptionTokenUsage : RealtimeTranscriptionUsage, IJsonModel<RealtimeTranscriptionTokenUsage>, IPersistableModel<RealtimeTranscriptionTokenUsage> {
6257 public int InputTokenCount { get; }
6258 public RealtimeTranscriptionInputTokenUsageDetails InputTokenDetails { get; }
6259 public int OutputTokenCount { get; }
6260 public int TotalTokenCount { get; }
6261 protected override RealtimeTranscriptionUsage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6262 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6263 protected override RealtimeTranscriptionUsage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6264 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6265 }
6266 [Experimental("OPENAI002")]
6267 public class RealtimeTranscriptionUsage : IJsonModel<RealtimeTranscriptionUsage>, IPersistableModel<RealtimeTranscriptionUsage> {
6268 [Serialization.JsonIgnore]
6269 [EditorBrowsable(EditorBrowsableState.Never)]
6270 [Experimental("SCME0001")]
6271 public ref JsonPatch Patch { get; }
6272 protected virtual RealtimeTranscriptionUsage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6273 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6274 protected virtual RealtimeTranscriptionUsage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6275 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6276 }
6277 [Experimental("OPENAI002")]
6278 public class RealtimeTruncation : IJsonModel<RealtimeTruncation>, IPersistableModel<RealtimeTruncation> {
6279 public RealtimeTruncation(RealtimeCustomTruncation customTruncation);
6280 public RealtimeTruncation(RealtimeDefaultTruncation defaultTruncation);
6281 public RealtimeCustomTruncation CustomTruncation { get; }
6282 public RealtimeDefaultTruncation? DefaultTruncation { get; }
6283 [Serialization.JsonIgnore]
6284 [EditorBrowsable(EditorBrowsableState.Never)]
6285 [Experimental("SCME0001")]
6286 public ref JsonPatch Patch { get; }
6287 protected virtual RealtimeTruncation JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6288 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6289 public static implicit operator RealtimeTruncation(RealtimeCustomTruncation customTruncation);
6290 public static implicit operator RealtimeTruncation(RealtimeDefaultTruncation defaultTruncation);
6291 protected virtual RealtimeTruncation PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6292 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6293 }
6294 [Experimental("OPENAI002")]
6295 public class RealtimeTurnDetection : IJsonModel<RealtimeTurnDetection>, IPersistableModel<RealtimeTurnDetection> {
6296 [Serialization.JsonIgnore]
6297 [EditorBrowsable(EditorBrowsableState.Never)]
6298 [Experimental("SCME0001")]
6299 public ref JsonPatch Patch { get; }
6300 protected virtual RealtimeTurnDetection JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6301 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6302 protected virtual RealtimeTurnDetection PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6303 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6304 }
6305 [Experimental("OPENAI002")]
6306 public readonly partial struct RealtimeVoice : IEquatable<RealtimeVoice> {
6307 public RealtimeVoice(string value);
6308 public static RealtimeVoice Alloy { get; }
6309 public static RealtimeVoice Ash { get; }
6310 public static RealtimeVoice Ballad { get; }
6311 public static RealtimeVoice Cedar { get; }
6312 public static RealtimeVoice Coral { get; }
6313 public static RealtimeVoice Echo { get; }
6314 public static RealtimeVoice Marin { get; }
6315 public static RealtimeVoice Sage { get; }
6316 public static RealtimeVoice Shimmer { get; }
6317 public static RealtimeVoice Verse { get; }
6318 public readonly bool Equals(RealtimeVoice other);
6319 [EditorBrowsable(EditorBrowsableState.Never)]
6320 public override readonly bool Equals(object obj);
6321 [EditorBrowsable(EditorBrowsableState.Never)]
6322 public override readonly int GetHashCode();
6323 public static bool operator ==(RealtimeVoice left, RealtimeVoice right);
6324 public static implicit operator RealtimeVoice(string value);
6325 public static implicit operator RealtimeVoice?(string value);
6326 public static bool operator !=(RealtimeVoice left, RealtimeVoice right);
6327 public override readonly string ToString();
6328 }
6329}
6330namespace OpenAI.Responses {
6331 [Experimental("OPENAI001")]
6332 public class AutomaticCodeInterpreterToolContainerConfiguration : CodeInterpreterToolContainerConfiguration, IJsonModel<AutomaticCodeInterpreterToolContainerConfiguration>, IPersistableModel<AutomaticCodeInterpreterToolContainerConfiguration> {
6333 public AutomaticCodeInterpreterToolContainerConfiguration();
6334 public IList<string> FileIds { get; }
6335 protected override CodeInterpreterToolContainerConfiguration JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6336 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6337 protected override CodeInterpreterToolContainerConfiguration PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6338 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6339 }
6340 [Experimental("OPENAI001")]
6341 public class CodeInterpreterCallImageOutput : CodeInterpreterCallOutput, IJsonModel<CodeInterpreterCallImageOutput>, IPersistableModel<CodeInterpreterCallImageOutput> {
6342 public CodeInterpreterCallImageOutput(Uri imageUri);
6343 public Uri ImageUri { get; set; }
6344 protected override CodeInterpreterCallOutput JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6345 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6346 protected override CodeInterpreterCallOutput PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6347 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6348 }
6349 [Experimental("OPENAI001")]
6350 public class CodeInterpreterCallLogsOutput : CodeInterpreterCallOutput, IJsonModel<CodeInterpreterCallLogsOutput>, IPersistableModel<CodeInterpreterCallLogsOutput> {
6351 public CodeInterpreterCallLogsOutput(string logs);
6352 public string Logs { get; set; }
6353 protected override CodeInterpreterCallOutput JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6354 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6355 protected override CodeInterpreterCallOutput PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6356 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6357 }
6358 [Experimental("OPENAI001")]
6359 public class CodeInterpreterCallOutput : IJsonModel<CodeInterpreterCallOutput>, IPersistableModel<CodeInterpreterCallOutput> {
6360 [Serialization.JsonIgnore]
6361 [EditorBrowsable(EditorBrowsableState.Never)]
6362 [Experimental("SCME0001")]
6363 public ref JsonPatch Patch { get; }
6364 protected virtual CodeInterpreterCallOutput JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6365 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6366 protected virtual CodeInterpreterCallOutput PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6367 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6368 }
6369 [Experimental("OPENAI001")]
6370 public class CodeInterpreterCallResponseItem : ResponseItem, IJsonModel<CodeInterpreterCallResponseItem>, IPersistableModel<CodeInterpreterCallResponseItem> {
6371 public CodeInterpreterCallResponseItem(string code);
6372 public string Code { get; set; }
6373 public string ContainerId { get; set; }
6374 public IList<CodeInterpreterCallOutput> Outputs { get; }
6375 public CodeInterpreterCallStatus? Status { get; set; }
6376 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6377 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6378 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6379 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6380 }
6381 [Experimental("OPENAI001")]
6382 public enum CodeInterpreterCallStatus {
6383 InProgress = 0,
6384 Interpreting = 1,
6385 Completed = 2,
6386 Incomplete = 3,
6387 Failed = 4
6388 }
6389 [Experimental("OPENAI001")]
6390 public class CodeInterpreterTool : ResponseTool, IJsonModel<CodeInterpreterTool>, IPersistableModel<CodeInterpreterTool> {
6391 public CodeInterpreterTool(CodeInterpreterToolContainer container);
6392 public CodeInterpreterToolContainer Container { get; }
6393 protected override ResponseTool JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6394 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6395 protected override ResponseTool PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6396 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6397 }
6398 [Experimental("OPENAI001")]
6399 public class CodeInterpreterToolContainer : IJsonModel<CodeInterpreterToolContainer>, IPersistableModel<CodeInterpreterToolContainer> {
6400 public CodeInterpreterToolContainer(CodeInterpreterToolContainerConfiguration containerConfiguration);
6401 public CodeInterpreterToolContainer(string containerId);
6402 public CodeInterpreterToolContainerConfiguration ContainerConfiguration { get; }
6403 public string ContainerId { get; }
6404 [Serialization.JsonIgnore]
6405 [EditorBrowsable(EditorBrowsableState.Never)]
6406 [Experimental("SCME0001")]
6407 public ref JsonPatch Patch { get; }
6408 protected virtual CodeInterpreterToolContainer JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6409 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6410 protected virtual CodeInterpreterToolContainer PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6411 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6412 }
6413 [Experimental("OPENAI001")]
6414 public class CodeInterpreterToolContainerConfiguration : IJsonModel<CodeInterpreterToolContainerConfiguration>, IPersistableModel<CodeInterpreterToolContainerConfiguration> {
6415 [Serialization.JsonIgnore]
6416 [EditorBrowsable(EditorBrowsableState.Never)]
6417 [Experimental("SCME0001")]
6418 public ref JsonPatch Patch { get; }
6419 public static AutomaticCodeInterpreterToolContainerConfiguration CreateAutomaticContainerConfiguration(IEnumerable<string> fileIds = null);
6420 protected virtual CodeInterpreterToolContainerConfiguration JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6421 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6422 protected virtual CodeInterpreterToolContainerConfiguration PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6423 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6424 }
6425 [Experimental("OPENAICUA001")]
6426 public class ComputerCallAction : IJsonModel<ComputerCallAction>, IPersistableModel<ComputerCallAction> {
6427 public Drawing.Point? ClickCoordinates { get; }
6428 public ComputerCallActionMouseButton? ClickMouseButton { get; }
6429 public Drawing.Point? DoubleClickCoordinates { get; }
6430 public IList<Drawing.Point> DragPath { get; }
6431 public IList<string> KeyPressKeyCodes { get; }
6432 public ComputerCallActionKind Kind { get; }
6433 public Drawing.Point? MoveCoordinates { get; }
6434 [Serialization.JsonIgnore]
6435 [EditorBrowsable(EditorBrowsableState.Never)]
6436 [Experimental("SCME0001")]
6437 public ref JsonPatch Patch { get; }
6438 public Drawing.Point? ScrollCoordinates { get; }
6439 public int? ScrollHorizontalOffset { get; }
6440 public int? ScrollVerticalOffset { get; }
6441 public string TypeText { get; }
6442 public static ComputerCallAction CreateClickAction(Drawing.Point clickCoordinates, ComputerCallActionMouseButton clickMouseButton);
6443 public static ComputerCallAction CreateDoubleClickAction(Drawing.Point doubleClickCoordinates, ComputerCallActionMouseButton doubleClickMouseButton);
6444 public static ComputerCallAction CreateDragAction(IList<Drawing.Point> dragPath);
6445 public static ComputerCallAction CreateKeyPressAction(IList<string> keyCodes);
6446 public static ComputerCallAction CreateMoveAction(Drawing.Point moveCoordinates);
6447 public static ComputerCallAction CreateScreenshotAction();
6448 public static ComputerCallAction CreateScrollAction(Drawing.Point scrollCoordinates, int horizontalOffset, int verticalOffset);
6449 public static ComputerCallAction CreateTypeAction(string typeText);
6450 public static ComputerCallAction CreateWaitAction();
6451 protected virtual ComputerCallAction JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6452 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6453 protected virtual ComputerCallAction PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6454 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6455 }
6456 [Experimental("OPENAICUA001")]
6457 public enum ComputerCallActionKind {
6458 Click = 0,
6459 DoubleClick = 1,
6460 Drag = 2,
6461 KeyPress = 3,
6462 Move = 4,
6463 Screenshot = 5,
6464 Scroll = 6,
6465 Type = 7,
6466 Wait = 8
6467 }
6468 [Experimental("OPENAICUA001")]
6469 public enum ComputerCallActionMouseButton {
6470 Left = 0,
6471 Right = 1,
6472 Wheel = 2,
6473 Back = 3,
6474 Forward = 4
6475 }
6476 [Experimental("OPENAICUA001")]
6477 public class ComputerCallOutput : IJsonModel<ComputerCallOutput>, IPersistableModel<ComputerCallOutput> {
6478 [Serialization.JsonIgnore]
6479 [EditorBrowsable(EditorBrowsableState.Never)]
6480 [Experimental("SCME0001")]
6481 public ref JsonPatch Patch { get; }
6482 public static ComputerCallOutput CreateScreenshotOutput(BinaryData screenshotImageBytes, string screenshotImageBytesMediaType);
6483 public static ComputerCallOutput CreateScreenshotOutput(string screenshotImageFileId);
6484 public static ComputerCallOutput CreateScreenshotOutput(Uri screenshotImageUri);
6485 protected virtual ComputerCallOutput JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6486 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6487 protected virtual ComputerCallOutput PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6488 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6489 }
6490 [Experimental("OPENAICUA001")]
6491 public class ComputerCallOutputResponseItem : ResponseItem, IJsonModel<ComputerCallOutputResponseItem>, IPersistableModel<ComputerCallOutputResponseItem> {
6492 public ComputerCallOutputResponseItem(string callId, ComputerCallOutput output);
6493 public IList<ComputerCallSafetyCheck> AcknowledgedSafetyChecks { get; }
6494 public string CallId { get; set; }
6495 public ComputerCallOutput Output { get; set; }
6496 public ComputerCallOutputStatus? Status { get; set; }
6497 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6498 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6499 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6500 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6501 }
6502 [Experimental("OPENAICUA001")]
6503 public enum ComputerCallOutputStatus {
6504 InProgress = 0,
6505 Completed = 1,
6506 Incomplete = 2
6507 }
6508 [Experimental("OPENAICUA001")]
6509 public class ComputerCallResponseItem : ResponseItem, IJsonModel<ComputerCallResponseItem>, IPersistableModel<ComputerCallResponseItem> {
6510 public ComputerCallResponseItem(string callId, ComputerCallAction action, IEnumerable<ComputerCallSafetyCheck> pendingSafetyChecks);
6511 public ComputerCallAction Action { get; set; }
6512 public string CallId { get; set; }
6513 public IList<ComputerCallSafetyCheck> PendingSafetyChecks { get; }
6514 public ComputerCallStatus? Status { get; set; }
6515 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6516 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6517 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6518 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6519 }
6520 [Experimental("OPENAICUA001")]
6521 public class ComputerCallSafetyCheck : IJsonModel<ComputerCallSafetyCheck>, IPersistableModel<ComputerCallSafetyCheck> {
6522 public ComputerCallSafetyCheck(string id, string code, string message);
6523 public string Code { get; set; }
6524 public string Id { get; set; }
6525 public string Message { get; set; }
6526 [Serialization.JsonIgnore]
6527 [EditorBrowsable(EditorBrowsableState.Never)]
6528 [Experimental("SCME0001")]
6529 public ref JsonPatch Patch { get; }
6530 protected virtual ComputerCallSafetyCheck JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6531 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6532 protected virtual ComputerCallSafetyCheck PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6533 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6534 }
6535 [Experimental("OPENAICUA001")]
6536 public enum ComputerCallStatus {
6537 InProgress = 0,
6538 Completed = 1,
6539 Incomplete = 2
6540 }
6541 [Experimental("OPENAI001")]
6542 public class ComputerTool : ResponseTool, IJsonModel<ComputerTool>, IPersistableModel<ComputerTool> {
6543 public ComputerTool(ComputerToolEnvironment environment, int displayWidth, int displayHeight);
6544 public int DisplayHeight { get; set; }
6545 public int DisplayWidth { get; set; }
6546 public ComputerToolEnvironment Environment { get; set; }
6547 protected override ResponseTool JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6548 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6549 protected override ResponseTool PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6550 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6551 }
6552 [Experimental("OPENAICUA001")]
6553 public readonly partial struct ComputerToolEnvironment : IEquatable<ComputerToolEnvironment> {
6554 public ComputerToolEnvironment(string value);
6555 public static ComputerToolEnvironment Browser { get; }
6556 public static ComputerToolEnvironment Linux { get; }
6557 public static ComputerToolEnvironment Mac { get; }
6558 public static ComputerToolEnvironment Ubuntu { get; }
6559 public static ComputerToolEnvironment Windows { get; }
6560 public readonly bool Equals(ComputerToolEnvironment other);
6561 [EditorBrowsable(EditorBrowsableState.Never)]
6562 public override readonly bool Equals(object obj);
6563 [EditorBrowsable(EditorBrowsableState.Never)]
6564 public override readonly int GetHashCode();
6565 public static bool operator ==(ComputerToolEnvironment left, ComputerToolEnvironment right);
6566 public static implicit operator ComputerToolEnvironment(string value);
6567 public static implicit operator ComputerToolEnvironment?(string value);
6568 public static bool operator !=(ComputerToolEnvironment left, ComputerToolEnvironment right);
6569 public override readonly string ToString();
6570 }
6571 [Experimental("OPENAI001")]
6572 public class ContainerFileCitationMessageAnnotation : ResponseMessageAnnotation, IJsonModel<ContainerFileCitationMessageAnnotation>, IPersistableModel<ContainerFileCitationMessageAnnotation> {
6573 public ContainerFileCitationMessageAnnotation(string containerId, string fileId, int startIndex, int endIndex, string filename);
6574 public string ContainerId { get; set; }
6575 public int EndIndex { get; set; }
6576 public string FileId { get; set; }
6577 public string Filename { get; set; }
6578 public int StartIndex { get; set; }
6579 protected override ResponseMessageAnnotation JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6580 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6581 protected override ResponseMessageAnnotation PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6582 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6583 }
6584 [Experimental("OPENAI001")]
6585 public class CreateResponseOptions : IJsonModel<CreateResponseOptions>, IPersistableModel<CreateResponseOptions> {
6586 public CreateResponseOptions();
6587 public CreateResponseOptions(string model, IEnumerable<ResponseItem> inputItems);
6588 public bool? BackgroundModeEnabled { get; set; }
6589 public ResponseConversationOptions ConversationOptions { get; set; }
6590 public string EndUserId { get; set; }
6591 public IList<IncludedResponseProperty> IncludedProperties { get; }
6592 public IList<ResponseItem> InputItems { get; }
6593 public string Instructions { get; set; }
6594 public int? MaxOutputTokenCount { get; set; }
6595 public int? MaxToolCallCount { get; set; }
6596 public IDictionary<string, string> Metadata { get; }
6597 public string Model { get; set; }
6598 public bool? ParallelToolCallsEnabled { get; set; }
6599 [Serialization.JsonIgnore]
6600 [EditorBrowsable(EditorBrowsableState.Never)]
6601 [Experimental("SCME0001")]
6602 public ref JsonPatch Patch { get; }
6603 public string PreviousResponseId { get; set; }
6604 public ResponseReasoningOptions ReasoningOptions { get; set; }
6605 public string SafetyIdentifier { get; set; }
6606 public ResponseServiceTier? ServiceTier { get; set; }
6607 public bool? StoredOutputEnabled { get; set; }
6608 public bool? StreamingEnabled { get; set; }
6609 public float? Temperature { get; set; }
6610 public ResponseTextOptions TextOptions { get; set; }
6611 public ResponseToolChoice ToolChoice { get; set; }
6612 public IList<ResponseTool> Tools { get; }
6613 public int? TopLogProbabilityCount { get; set; }
6614 public float? TopP { get; set; }
6615 public ResponseTruncationMode? TruncationMode { get; set; }
6616 protected virtual CreateResponseOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6617 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6618 public static implicit operator BinaryContent(CreateResponseOptions createResponseOptions);
6619 protected virtual CreateResponseOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6620 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6621 }
6622 [Experimental("OPENAI001")]
6623 public class CustomMcpToolCallApprovalPolicy : IJsonModel<CustomMcpToolCallApprovalPolicy>, IPersistableModel<CustomMcpToolCallApprovalPolicy> {
6624 [Serialization.JsonIgnore]
6625 [EditorBrowsable(EditorBrowsableState.Never)]
6626 [Experimental("SCME0001")]
6627 public ref JsonPatch Patch { get; }
6628 public McpToolFilter ToolsAlwaysRequiringApproval { get; set; }
6629 public McpToolFilter ToolsNeverRequiringApproval { get; set; }
6630 protected virtual CustomMcpToolCallApprovalPolicy JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6631 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6632 protected virtual CustomMcpToolCallApprovalPolicy PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6633 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6634 }
6635 [Experimental("OPENAI001")]
6636 public class FileCitationMessageAnnotation : ResponseMessageAnnotation, IJsonModel<FileCitationMessageAnnotation>, IPersistableModel<FileCitationMessageAnnotation> {
6637 public FileCitationMessageAnnotation(string fileId, int index, string filename);
6638 public string FileId { get; set; }
6639 public string Filename { get; set; }
6640 public int Index { get; set; }
6641 protected override ResponseMessageAnnotation JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6642 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6643 protected override ResponseMessageAnnotation PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6644 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6645 }
6646 [Experimental("OPENAI001")]
6647 public class FilePathMessageAnnotation : ResponseMessageAnnotation, IJsonModel<FilePathMessageAnnotation>, IPersistableModel<FilePathMessageAnnotation> {
6648 public FilePathMessageAnnotation(string fileId, int index);
6649 public string FileId { get; set; }
6650 public int Index { get; set; }
6651 protected override ResponseMessageAnnotation JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6652 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6653 protected override ResponseMessageAnnotation PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6654 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6655 }
6656 [Experimental("OPENAI001")]
6657 public class FileSearchCallResponseItem : ResponseItem, IJsonModel<FileSearchCallResponseItem>, IPersistableModel<FileSearchCallResponseItem> {
6658 public FileSearchCallResponseItem(IEnumerable<string> queries);
6659 public IList<string> Queries { get; }
6660 public IList<FileSearchCallResult> Results { get; set; }
6661 public FileSearchCallStatus? Status { get; set; }
6662 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6663 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6664 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6665 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6666 }
6667 [Experimental("OPENAI001")]
6668 public class FileSearchCallResult : IJsonModel<FileSearchCallResult>, IPersistableModel<FileSearchCallResult> {
6669 public IDictionary<string, BinaryData> Attributes { get; }
6670 public string FileId { get; set; }
6671 public string Filename { get; set; }
6672 [Serialization.JsonIgnore]
6673 [EditorBrowsable(EditorBrowsableState.Never)]
6674 [Experimental("SCME0001")]
6675 public ref JsonPatch Patch { get; }
6676 public float? Score { get; set; }
6677 public string Text { get; set; }
6678 protected virtual FileSearchCallResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6679 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6680 protected virtual FileSearchCallResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6681 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6682 }
6683 [Experimental("OPENAI001")]
6684 public enum FileSearchCallStatus {
6685 InProgress = 0,
6686 Searching = 1,
6687 Completed = 2,
6688 Incomplete = 3,
6689 Failed = 4
6690 }
6691 [Experimental("OPENAI001")]
6692 public class FileSearchTool : ResponseTool, IJsonModel<FileSearchTool>, IPersistableModel<FileSearchTool> {
6693 public FileSearchTool(IEnumerable<string> vectorStoreIds);
6694 public BinaryData Filters { get; set; }
6695 public int? MaxResultCount { get; set; }
6696 public FileSearchToolRankingOptions RankingOptions { get; set; }
6697 public IList<string> VectorStoreIds { get; }
6698 protected override ResponseTool JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6699 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6700 protected override ResponseTool PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6701 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6702 }
6703 [Experimental("OPENAI001")]
6704 public readonly partial struct FileSearchToolRanker : IEquatable<FileSearchToolRanker> {
6705 public FileSearchToolRanker(string value);
6706 public static FileSearchToolRanker Auto { get; }
6707 public static FileSearchToolRanker Default20241115 { get; }
6708 public readonly bool Equals(FileSearchToolRanker other);
6709 [EditorBrowsable(EditorBrowsableState.Never)]
6710 public override readonly bool Equals(object obj);
6711 [EditorBrowsable(EditorBrowsableState.Never)]
6712 public override readonly int GetHashCode();
6713 public static bool operator ==(FileSearchToolRanker left, FileSearchToolRanker right);
6714 public static implicit operator FileSearchToolRanker(string value);
6715 public static implicit operator FileSearchToolRanker?(string value);
6716 public static bool operator !=(FileSearchToolRanker left, FileSearchToolRanker right);
6717 public override readonly string ToString();
6718 }
6719 [Experimental("OPENAI001")]
6720 public class FileSearchToolRankingOptions : IJsonModel<FileSearchToolRankingOptions>, IPersistableModel<FileSearchToolRankingOptions> {
6721 [Serialization.JsonIgnore]
6722 [EditorBrowsable(EditorBrowsableState.Never)]
6723 [Experimental("SCME0001")]
6724 public ref JsonPatch Patch { get; }
6725 public FileSearchToolRanker? Ranker { get; set; }
6726 public float? ScoreThreshold { get; set; }
6727 protected virtual FileSearchToolRankingOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6728 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6729 protected virtual FileSearchToolRankingOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6730 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6731 }
6732 [Experimental("OPENAI001")]
6733 public class FunctionCallOutputResponseItem : ResponseItem, IJsonModel<FunctionCallOutputResponseItem>, IPersistableModel<FunctionCallOutputResponseItem> {
6734 public FunctionCallOutputResponseItem(string callId, string functionOutput);
6735 public string CallId { get; set; }
6736 public string FunctionOutput { get; set; }
6737 public FunctionCallOutputStatus? Status { get; set; }
6738 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6739 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6740 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6741 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6742 }
6743 [Experimental("OPENAI001")]
6744 public enum FunctionCallOutputStatus {
6745 InProgress = 0,
6746 Completed = 1,
6747 Incomplete = 2
6748 }
6749 [Experimental("OPENAI001")]
6750 public class FunctionCallResponseItem : ResponseItem, IJsonModel<FunctionCallResponseItem>, IPersistableModel<FunctionCallResponseItem> {
6751 public FunctionCallResponseItem(string callId, string functionName, BinaryData functionArguments);
6752 public string CallId { get; set; }
6753 public BinaryData FunctionArguments { get; set; }
6754 public string FunctionName { get; set; }
6755 public FunctionCallStatus? Status { get; set; }
6756 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6757 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6758 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6759 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6760 }
6761 [Experimental("OPENAI001")]
6762 public enum FunctionCallStatus {
6763 InProgress = 0,
6764 Completed = 1,
6765 Incomplete = 2
6766 }
6767 [Experimental("OPENAI001")]
6768 public class FunctionTool : ResponseTool, IJsonModel<FunctionTool>, IPersistableModel<FunctionTool> {
6769 public FunctionTool(string functionName, BinaryData functionParameters, bool? strictModeEnabled);
6770 public string FunctionDescription { get; set; }
6771 public string FunctionName { get; set; }
6772 public BinaryData FunctionParameters { get; set; }
6773 public bool? StrictModeEnabled { get; set; }
6774 protected override ResponseTool JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6775 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6776 protected override ResponseTool PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6777 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6778 }
6779 [Experimental("OPENAI001")]
6780 public class GetResponseOptions : IJsonModel<GetResponseOptions>, IPersistableModel<GetResponseOptions> {
6781 public GetResponseOptions(string responseId);
6782 public IList<IncludedResponseProperty> IncludedProperties { get; set; }
6783 public bool? IncludeObfuscation { get; set; }
6784 [Serialization.JsonIgnore]
6785 [EditorBrowsable(EditorBrowsableState.Never)]
6786 [Experimental("SCME0001")]
6787 public ref JsonPatch Patch { get; }
6788 public string ResponseId { get; }
6789 public int? StartingAfter { get; set; }
6790 public bool? StreamingEnabled { get; set; }
6791 protected virtual GetResponseOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6792 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6793 protected virtual GetResponseOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6794 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6795 }
6796 [Experimental("OPENAI001")]
6797 public readonly partial struct GlobalMcpToolCallApprovalPolicy : IEquatable<GlobalMcpToolCallApprovalPolicy> {
6798 public GlobalMcpToolCallApprovalPolicy(string value);
6799 public static GlobalMcpToolCallApprovalPolicy AlwaysRequireApproval { get; }
6800 public static GlobalMcpToolCallApprovalPolicy NeverRequireApproval { get; }
6801 public readonly bool Equals(GlobalMcpToolCallApprovalPolicy other);
6802 [EditorBrowsable(EditorBrowsableState.Never)]
6803 public override readonly bool Equals(object obj);
6804 [EditorBrowsable(EditorBrowsableState.Never)]
6805 public override readonly int GetHashCode();
6806 public static bool operator ==(GlobalMcpToolCallApprovalPolicy left, GlobalMcpToolCallApprovalPolicy right);
6807 public static implicit operator GlobalMcpToolCallApprovalPolicy(string value);
6808 public static implicit operator GlobalMcpToolCallApprovalPolicy?(string value);
6809 public static bool operator !=(GlobalMcpToolCallApprovalPolicy left, GlobalMcpToolCallApprovalPolicy right);
6810 public override readonly string ToString();
6811 }
6812 [Experimental("OPENAI001")]
6813 public class ImageGenerationCallResponseItem : ResponseItem, IJsonModel<ImageGenerationCallResponseItem>, IPersistableModel<ImageGenerationCallResponseItem> {
6814 public ImageGenerationCallResponseItem(BinaryData imageResultBytes);
6815 public BinaryData ImageResultBytes { get; set; }
6816 public ImageGenerationCallStatus? Status { get; set; }
6817 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6818 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6819 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6820 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6821 }
6822 [Experimental("OPENAI001")]
6823 public enum ImageGenerationCallStatus {
6824 InProgress = 0,
6825 Completed = 1,
6826 Generating = 2,
6827 Failed = 3
6828 }
6829 [Experimental("OPENAI001")]
6830 public class ImageGenerationTool : ResponseTool, IJsonModel<ImageGenerationTool>, IPersistableModel<ImageGenerationTool> {
6831 public ImageGenerationTool();
6832 public ImageGenerationToolBackground? Background { get; set; }
6833 public ImageGenerationToolInputFidelity? InputFidelity { get; set; }
6834 public ImageGenerationToolInputImageMask InputImageMask { get; set; }
6835 public string Model { get; set; }
6836 public ImageGenerationToolModerationLevel? ModerationLevel { get; set; }
6837 public int? OutputCompressionFactor { get; set; }
6838 public ImageGenerationToolOutputFileFormat? OutputFileFormat { get; set; }
6839 public int? PartialImageCount { get; set; }
6840 public ImageGenerationToolQuality? Quality { get; set; }
6841 public ImageGenerationToolSize? Size { get; set; }
6842 protected override ResponseTool JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6843 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6844 protected override ResponseTool PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6845 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6846 }
6847 [Experimental("OPENAI001")]
6848 public readonly partial struct ImageGenerationToolBackground : IEquatable<ImageGenerationToolBackground> {
6849 public ImageGenerationToolBackground(string value);
6850 public static ImageGenerationToolBackground Auto { get; }
6851 public static ImageGenerationToolBackground Opaque { get; }
6852 public static ImageGenerationToolBackground Transparent { get; }
6853 public readonly bool Equals(ImageGenerationToolBackground other);
6854 [EditorBrowsable(EditorBrowsableState.Never)]
6855 public override readonly bool Equals(object obj);
6856 [EditorBrowsable(EditorBrowsableState.Never)]
6857 public override readonly int GetHashCode();
6858 public static bool operator ==(ImageGenerationToolBackground left, ImageGenerationToolBackground right);
6859 public static implicit operator ImageGenerationToolBackground(string value);
6860 public static implicit operator ImageGenerationToolBackground?(string value);
6861 public static bool operator !=(ImageGenerationToolBackground left, ImageGenerationToolBackground right);
6862 public override readonly string ToString();
6863 }
6864 [Experimental("OPENAI001")]
6865 public readonly partial struct ImageGenerationToolInputFidelity : IEquatable<ImageGenerationToolInputFidelity> {
6866 public ImageGenerationToolInputFidelity(string value);
6867 public static ImageGenerationToolInputFidelity High { get; }
6868 public static ImageGenerationToolInputFidelity Low { get; }
6869 public readonly bool Equals(ImageGenerationToolInputFidelity other);
6870 [EditorBrowsable(EditorBrowsableState.Never)]
6871 public override readonly bool Equals(object obj);
6872 [EditorBrowsable(EditorBrowsableState.Never)]
6873 public override readonly int GetHashCode();
6874 public static bool operator ==(ImageGenerationToolInputFidelity left, ImageGenerationToolInputFidelity right);
6875 public static implicit operator ImageGenerationToolInputFidelity(string value);
6876 public static implicit operator ImageGenerationToolInputFidelity?(string value);
6877 public static bool operator !=(ImageGenerationToolInputFidelity left, ImageGenerationToolInputFidelity right);
6878 public override readonly string ToString();
6879 }
6880 [Experimental("OPENAI001")]
6881 public class ImageGenerationToolInputImageMask : IJsonModel<ImageGenerationToolInputImageMask>, IPersistableModel<ImageGenerationToolInputImageMask> {
6882 public ImageGenerationToolInputImageMask(string fileId);
6883 public ImageGenerationToolInputImageMask(Uri imageUri);
6884 public string FileId { get; }
6885 public Uri ImageUri { get; }
6886 [Serialization.JsonIgnore]
6887 [EditorBrowsable(EditorBrowsableState.Never)]
6888 [Experimental("SCME0001")]
6889 public ref JsonPatch Patch { get; }
6890 protected virtual ImageGenerationToolInputImageMask JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6891 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6892 protected virtual ImageGenerationToolInputImageMask PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6893 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6894 }
6895 [Experimental("OPENAI001")]
6896 public readonly partial struct ImageGenerationToolModerationLevel : IEquatable<ImageGenerationToolModerationLevel> {
6897 public ImageGenerationToolModerationLevel(string value);
6898 public static ImageGenerationToolModerationLevel Auto { get; }
6899 public static ImageGenerationToolModerationLevel Low { get; }
6900 public readonly bool Equals(ImageGenerationToolModerationLevel other);
6901 [EditorBrowsable(EditorBrowsableState.Never)]
6902 public override readonly bool Equals(object obj);
6903 [EditorBrowsable(EditorBrowsableState.Never)]
6904 public override readonly int GetHashCode();
6905 public static bool operator ==(ImageGenerationToolModerationLevel left, ImageGenerationToolModerationLevel right);
6906 public static implicit operator ImageGenerationToolModerationLevel(string value);
6907 public static implicit operator ImageGenerationToolModerationLevel?(string value);
6908 public static bool operator !=(ImageGenerationToolModerationLevel left, ImageGenerationToolModerationLevel right);
6909 public override readonly string ToString();
6910 }
6911 [Experimental("OPENAI001")]
6912 public readonly partial struct ImageGenerationToolOutputFileFormat : IEquatable<ImageGenerationToolOutputFileFormat> {
6913 public ImageGenerationToolOutputFileFormat(string value);
6914 public static ImageGenerationToolOutputFileFormat Jpeg { get; }
6915 public static ImageGenerationToolOutputFileFormat Png { get; }
6916 public static ImageGenerationToolOutputFileFormat Webp { get; }
6917 public readonly bool Equals(ImageGenerationToolOutputFileFormat other);
6918 [EditorBrowsable(EditorBrowsableState.Never)]
6919 public override readonly bool Equals(object obj);
6920 [EditorBrowsable(EditorBrowsableState.Never)]
6921 public override readonly int GetHashCode();
6922 public static bool operator ==(ImageGenerationToolOutputFileFormat left, ImageGenerationToolOutputFileFormat right);
6923 public static implicit operator ImageGenerationToolOutputFileFormat(string value);
6924 public static implicit operator ImageGenerationToolOutputFileFormat?(string value);
6925 public static bool operator !=(ImageGenerationToolOutputFileFormat left, ImageGenerationToolOutputFileFormat right);
6926 public override readonly string ToString();
6927 }
6928 [Experimental("OPENAI001")]
6929 public readonly partial struct ImageGenerationToolQuality : IEquatable<ImageGenerationToolQuality> {
6930 public ImageGenerationToolQuality(string value);
6931 public static ImageGenerationToolQuality Auto { get; }
6932 public static ImageGenerationToolQuality High { get; }
6933 public static ImageGenerationToolQuality Low { get; }
6934 public static ImageGenerationToolQuality Medium { get; }
6935 public readonly bool Equals(ImageGenerationToolQuality other);
6936 [EditorBrowsable(EditorBrowsableState.Never)]
6937 public override readonly bool Equals(object obj);
6938 [EditorBrowsable(EditorBrowsableState.Never)]
6939 public override readonly int GetHashCode();
6940 public static bool operator ==(ImageGenerationToolQuality left, ImageGenerationToolQuality right);
6941 public static implicit operator ImageGenerationToolQuality(string value);
6942 public static implicit operator ImageGenerationToolQuality?(string value);
6943 public static bool operator !=(ImageGenerationToolQuality left, ImageGenerationToolQuality right);
6944 public override readonly string ToString();
6945 }
6946 [Experimental("OPENAI001")]
6947 public readonly partial struct ImageGenerationToolSize : IEquatable<ImageGenerationToolSize> {
6948 public static readonly ImageGenerationToolSize W1024xH1024;
6949 public static readonly ImageGenerationToolSize W1024xH1536;
6950 public static readonly ImageGenerationToolSize W1536xH1024;
6951 public ImageGenerationToolSize(int width, int height);
6952 public static ImageGenerationToolSize Auto { get; }
6953 public readonly bool Equals(ImageGenerationToolSize other);
6954 [EditorBrowsable(EditorBrowsableState.Never)]
6955 public override readonly bool Equals(object obj);
6956 [EditorBrowsable(EditorBrowsableState.Never)]
6957 public override readonly int GetHashCode();
6958 public static bool operator ==(ImageGenerationToolSize left, ImageGenerationToolSize right);
6959 public static bool operator !=(ImageGenerationToolSize left, ImageGenerationToolSize right);
6960 public override readonly string ToString();
6961 }
6962 [Experimental("OPENAI001")]
6963 public readonly partial struct IncludedResponseProperty : IEquatable<IncludedResponseProperty> {
6964 public IncludedResponseProperty(string value);
6965 public static IncludedResponseProperty CodeInterpreterCallOutputs { get; }
6966 public static IncludedResponseProperty ComputerCallOutputImageUri { get; }
6967 public static IncludedResponseProperty FileSearchCallResults { get; }
6968 public static IncludedResponseProperty MessageInputImageUri { get; }
6969 public static IncludedResponseProperty ReasoningEncryptedContent { get; }
6970 public readonly bool Equals(IncludedResponseProperty other);
6971 [EditorBrowsable(EditorBrowsableState.Never)]
6972 public override readonly bool Equals(object obj);
6973 [EditorBrowsable(EditorBrowsableState.Never)]
6974 public override readonly int GetHashCode();
6975 public static bool operator ==(IncludedResponseProperty left, IncludedResponseProperty right);
6976 public static implicit operator IncludedResponseProperty(string value);
6977 public static implicit operator IncludedResponseProperty?(string value);
6978 public static bool operator !=(IncludedResponseProperty left, IncludedResponseProperty right);
6979 public override readonly string ToString();
6980 }
6981 [Experimental("OPENAI001")]
6982 public class McpTool : ResponseTool, IJsonModel<McpTool>, IPersistableModel<McpTool> {
6983 public McpTool(string serverLabel, McpToolConnectorId connectorId);
6984 public McpTool(string serverLabel, Uri serverUri);
6985 public McpToolFilter AllowedTools { get; set; }
6986 public string AuthorizationToken { get; set; }
6987 public McpToolConnectorId? ConnectorId { get; set; }
6988 public IDictionary<string, string> Headers { get; set; }
6989 public string ServerDescription { get; set; }
6990 public string ServerLabel { get; set; }
6991 public Uri ServerUri { get; set; }
6992 public McpToolCallApprovalPolicy ToolCallApprovalPolicy { get; set; }
6993 protected override ResponseTool JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
6994 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
6995 protected override ResponseTool PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
6996 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
6997 }
6998 [Experimental("OPENAI001")]
6999 public class McpToolCallApprovalPolicy : IJsonModel<McpToolCallApprovalPolicy>, IPersistableModel<McpToolCallApprovalPolicy> {
7000 public McpToolCallApprovalPolicy(CustomMcpToolCallApprovalPolicy customPolicy);
7001 public McpToolCallApprovalPolicy(GlobalMcpToolCallApprovalPolicy globalPolicy);
7002 public CustomMcpToolCallApprovalPolicy CustomPolicy { get; }
7003 public GlobalMcpToolCallApprovalPolicy? GlobalPolicy { get; }
7004 [Serialization.JsonIgnore]
7005 [EditorBrowsable(EditorBrowsableState.Never)]
7006 [Experimental("SCME0001")]
7007 public ref JsonPatch Patch { get; }
7008 protected virtual McpToolCallApprovalPolicy JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
7009 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
7010 public static implicit operator McpToolCallApprovalPolicy(CustomMcpToolCallApprovalPolicy customPolicy);
7011 public static implicit operator McpToolCallApprovalPolicy(GlobalMcpToolCallApprovalPolicy globalPolicy);
7012 protected virtual McpToolCallApprovalPolicy PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
7013 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
7014 }
7015 [Experimental("OPENAI001")]
7016 public class McpToolCallApprovalRequestItem : ResponseItem, IJsonModel<McpToolCallApprovalRequestItem>, IPersistableModel<McpToolCallApprovalRequestItem> {
7017 public McpToolCallApprovalRequestItem(string id, string serverLabel, string toolName, BinaryData toolArguments);
7018 public string ServerLabel { get; set; }
7019 public BinaryData ToolArguments { get; set; }
7020 public string ToolName { get; set; }
7021 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
7022 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
7023 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
7024 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
7025 }
7026 [Experimental("OPENAI001")]
7027 public class McpToolCallApprovalResponseItem : ResponseItem, IJsonModel<McpToolCallApprovalResponseItem>, IPersistableModel<McpToolCallApprovalResponseItem> {
7028 public McpToolCallApprovalResponseItem(string approvalRequestId, bool approved);
7029 public string ApprovalRequestId { get; set; }
7030 public bool Approved { get; set; }
7031 public string Reason { get; set; }
7032 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
7033 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
7034 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
7035 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
7036 }
7037 [Experimental("OPENAI001")]
7038 public class McpToolCallItem : ResponseItem, IJsonModel<McpToolCallItem>, IPersistableModel<McpToolCallItem> {
7039 public McpToolCallItem(string serverLabel, string toolName, BinaryData toolArguments);
7040 public BinaryData Error { get; set; }
7041 public string ServerLabel { get; set; }
7042 public BinaryData ToolArguments { get; set; }
7043 public string ToolName { get; set; }
7044 public string ToolOutput { get; set; }
7045 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
7046 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
7047 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
7048 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
7049 }
7050 [Experimental("OPENAI001")]
7051 public readonly partial struct McpToolConnectorId : IEquatable<McpToolConnectorId> {
7052 public McpToolConnectorId(string value);
7053 public static McpToolConnectorId Dropbox { get; }
7054 public static McpToolConnectorId Gmail { get; }
7055 public static McpToolConnectorId GoogleCalendar { get; }
7056 public static McpToolConnectorId GoogleDrive { get; }
7057 public static McpToolConnectorId MicrosoftTeams { get; }
7058 public static McpToolConnectorId OutlookCalendar { get; }
7059 public static McpToolConnectorId OutlookEmail { get; }
7060 public static McpToolConnectorId SharePoint { get; }
7061 public readonly bool Equals(McpToolConnectorId other);
7062 [EditorBrowsable(EditorBrowsableState.Never)]
7063 public override readonly bool Equals(object obj);
7064 [EditorBrowsable(EditorBrowsableState.Never)]
7065 public override readonly int GetHashCode();
7066 public static bool operator ==(McpToolConnectorId left, McpToolConnectorId right);
7067 public static implicit operator McpToolConnectorId(string value);
7068 public static implicit operator McpToolConnectorId?(string value);
7069 public static bool operator !=(McpToolConnectorId left, McpToolConnectorId right);
7070 public override readonly string ToString();
7071 }
7072 [Experimental("OPENAI001")]
7073 public class McpToolDefinition : IJsonModel<McpToolDefinition>, IPersistableModel<McpToolDefinition> {
7074 public McpToolDefinition(string name, BinaryData inputSchema);
7075 public BinaryData Annotations { get; set; }
7076 public string Description { get; set; }
7077 public BinaryData InputSchema { get; set; }
7078 public string Name { get; set; }
7079 [Serialization.JsonIgnore]
7080 [EditorBrowsable(EditorBrowsableState.Never)]
7081 [Experimental("SCME0001")]
7082 public ref JsonPatch Patch { get; }
7083 protected virtual McpToolDefinition JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
7084 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
7085 protected virtual McpToolDefinition PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
7086 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
7087 }
7088 [Experimental("OPENAI001")]
7089 public class McpToolDefinitionListItem : ResponseItem, IJsonModel<McpToolDefinitionListItem>, IPersistableModel<McpToolDefinitionListItem> {
7090 public McpToolDefinitionListItem(string serverLabel, IEnumerable<McpToolDefinition> toolDefinitions);
7091 public BinaryData Error { get; set; }
7092 public string ServerLabel { get; set; }
7093 public IList<McpToolDefinition> ToolDefinitions { get; }
7094 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
7095 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
7096 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
7097 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
7098 }
7099 [Experimental("OPENAI001")]
7100 public class McpToolFilter : IJsonModel<McpToolFilter>, IPersistableModel<McpToolFilter> {
7101 public bool? IsReadOnly { get; set; }
7102 [Serialization.JsonIgnore]
7103 [EditorBrowsable(EditorBrowsableState.Never)]
7104 [Experimental("SCME0001")]
7105 public ref JsonPatch Patch { get; }
7106 public IList<string> ToolNames { get; }
7107 protected virtual McpToolFilter JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
7108 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
7109 protected virtual McpToolFilter PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
7110 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
7111 }
7112 [Experimental("OPENAI001")]
7113 public class MessageResponseItem : ResponseItem, IJsonModel<MessageResponseItem>, IPersistableModel<MessageResponseItem> {
7114 public IList<ResponseContentPart> Content { get; }
7115 public MessageRole Role { get; }
7116 public MessageStatus? Status { get; set; }
7117 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
7118 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
7119 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
7120 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
7121 }
7122 [Experimental("OPENAI001")]
7123 public enum MessageRole {
7124 Unknown = 0,
7125 Assistant = 1,
7126 Developer = 2,
7127 System = 3,
7128 User = 4
7129 }
7130 [Experimental("OPENAI001")]
7131 public enum MessageStatus {
7132 InProgress = 0,
7133 Completed = 1,
7134 Incomplete = 2
7135 }
7136 [Experimental("OPENAI001")]
7137 public class ReasoningResponseItem : ResponseItem, IJsonModel<ReasoningResponseItem>, IPersistableModel<ReasoningResponseItem> {
7138 public ReasoningResponseItem(IEnumerable<ReasoningSummaryPart> summaryParts);
7139 public ReasoningResponseItem(string summaryText);
7140 public string EncryptedContent { get; set; }
7141 public ReasoningStatus? Status { get; set; }
7142 public IL