openai/openai-dotnet

Public

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

CodeCommitsIssuesPull requestsActionsInsightsSecurity
copilot/update-properties-to-string

Branches

Tags

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

Clone

HTTPS

Download ZIP

api/OpenAI.netstandard2.0.cs

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