openai/openai-dotnet

Public

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

CodeCommitsIssuesPull requestsActionsInsightsSecurity
main

Branches

Tags

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

Clone

HTTPS

Download ZIP

api/OpenAI.netstandard2.0.cs

6510lines · modecode

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