openai/openai-dotnet

Public

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

CodeCommitsIssuesPull requestsActionsInsightsSecurity
copilot/create-responses-client-options-type

Branches

Tags

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

Clone

HTTPS

Download ZIP

api/OpenAI.netstandard2.0.cs

6337lines · modecode

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