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
copilot/fix-mcptoolfilter-issue

Branches

Tags

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

Clone

HTTPS

Download ZIP

openai-dotnet/api

api/OpenAI.net10.0.cs

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