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
typespec/update-http-client-csharp-1.0.0-alpha.20260612.4

Branches

Tags

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

Clone

HTTPS

Download ZIP

openai-dotnet/api

api/OpenAI.net10.0.cs

7457lines · modecode

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