GitVita
New repositoryImport repositoryNew issue
Your repositories Your dashboard Sign in

openai/openai-dotnet

Public

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

Watch0Fork0Star0
CodeCommitsIssuesPull requestsActionsInsightsSecurity
OpenAI_2.2.0

Branches

Tags

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

Clone

HTTPS

Download ZIP

openai-dotnet/api

api/OpenAI.netstandard2.0.cs

4776lines · modecode

RawDownload
Latest commit unavailable.
1namespace OpenAI {
2 public class OpenAIClient {
3 protected OpenAIClient();
4 public OpenAIClient(ApiKeyCredential credential, OpenAIClientOptions options);
5 public OpenAIClient(ApiKeyCredential credential);
6 protected internal OpenAIClient(ClientPipeline pipeline, OpenAIClientOptions options);
7 public OpenAIClient(string apiKey);
8 public ClientPipeline Pipeline { get; }
9 public virtual AssistantClient GetAssistantClient();
10 public virtual AudioClient GetAudioClient(string model);
11 public virtual BatchClient GetBatchClient();
12 public virtual ChatClient GetChatClient(string model);
13 public virtual EmbeddingClient GetEmbeddingClient(string model);
14 public virtual EvaluationClient GetEvaluationClient();
15 public virtual FineTuningClient GetFineTuningClient();
16 public virtual ImageClient GetImageClient(string model);
17 public virtual ModerationClient GetModerationClient(string model);
18 public virtual OpenAIFileClient GetOpenAIFileClient();
19 public virtual OpenAIModelClient GetOpenAIModelClient();
20 public virtual OpenAIResponseClient GetOpenAIResponseClient(string model);
21 public virtual RealtimeClient GetRealtimeClient();
22 public virtual VectorStoreClient GetVectorStoreClient();
23 }
24 public class OpenAIClientOptions : ClientPipelineOptions {
25 public Uri Endpoint { get; set; }
26 public string OrganizationId { get; set; }
27 public string ProjectId { get; set; }
28 public string UserAgentApplicationId { get; set; }
29 }
30 public class OpenAIContext : ModelReaderWriterContext {
31 public static OpenAIContext Default { get; }
32 protected override bool TryGetTypeBuilderCore(Type type, out ModelReaderWriterTypeBuilder builder);
33 }
34}
35namespace OpenAI.Assistants {
36 public class Assistant : IJsonModel<Assistant>, IPersistableModel<Assistant> {
37 public DateTimeOffset CreatedAt { get; }
38 public string Description { get; }
39 public string Id { get; }
40 public string Instructions { get; }
41 public IReadOnlyDictionary<string, string> Metadata { get; }
42 public string Model { get; }
43 public string Name { get; }
44 public float? NucleusSamplingFactor { get; }
45 public AssistantResponseFormat ResponseFormat { get; }
46 public float? Temperature { get; }
47 public ToolResources ToolResources { get; }
48 public IReadOnlyList<ToolDefinition> Tools { get; }
49 protected virtual Assistant JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
50 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
51 protected virtual Assistant PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
52 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
53 }
54 public class AssistantClient {
55 protected AssistantClient();
56 public AssistantClient(ApiKeyCredential credential, OpenAIClientOptions options);
57 public AssistantClient(ApiKeyCredential credential);
58 protected internal AssistantClient(ClientPipeline pipeline, OpenAIClientOptions options);
59 public AssistantClient(string apiKey);
60 public ClientPipeline Pipeline { get; }
61 [EditorBrowsable(EditorBrowsableState.Never)]
62 public virtual ClientResult CancelRun(string threadId, string runId, RequestOptions options);
63 public virtual ClientResult<ThreadRun> CancelRun(string threadId, string runId, CancellationToken cancellationToken = default);
64 [EditorBrowsable(EditorBrowsableState.Never)]
65 public virtual Task<ClientResult> CancelRunAsync(string threadId, string runId, RequestOptions options);
66 public virtual Task<ClientResult<ThreadRun>> CancelRunAsync(string threadId, string runId, CancellationToken cancellationToken = default);
67 [EditorBrowsable(EditorBrowsableState.Never)]
68 public virtual ClientResult CreateAssistant(BinaryContent content, RequestOptions options = null);
69 public virtual ClientResult<Assistant> CreateAssistant(string model, AssistantCreationOptions options = null, CancellationToken cancellationToken = default);
70 [EditorBrowsable(EditorBrowsableState.Never)]
71 public virtual Task<ClientResult> CreateAssistantAsync(BinaryContent content, RequestOptions options = null);
72 public virtual Task<ClientResult<Assistant>> CreateAssistantAsync(string model, AssistantCreationOptions options = null, CancellationToken cancellationToken = default);
73 public virtual ClientResult<ThreadMessage> CreateMessage(string threadId, MessageRole role, IEnumerable<MessageContent> content, MessageCreationOptions options = null, CancellationToken cancellationToken = default);
74 [EditorBrowsable(EditorBrowsableState.Never)]
75 public virtual ClientResult CreateMessage(string threadId, BinaryContent content, RequestOptions options = null);
76 public virtual Task<ClientResult<ThreadMessage>> CreateMessageAsync(string threadId, MessageRole role, IEnumerable<MessageContent> content, MessageCreationOptions options = null, CancellationToken cancellationToken = default);
77 [EditorBrowsable(EditorBrowsableState.Never)]
78 public virtual Task<ClientResult> CreateMessageAsync(string threadId, BinaryContent content, RequestOptions options = null);
79 [EditorBrowsable(EditorBrowsableState.Never)]
80 public virtual ClientResult CreateRun(string threadId, BinaryContent content, RequestOptions options = null);
81 public virtual ClientResult<ThreadRun> CreateRun(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
82 [EditorBrowsable(EditorBrowsableState.Never)]
83 public virtual Task<ClientResult> CreateRunAsync(string threadId, BinaryContent content, RequestOptions options = null);
84 public virtual Task<ClientResult<ThreadRun>> CreateRunAsync(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
85 public virtual CollectionResult<StreamingUpdate> CreateRunStreaming(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
86 public virtual AsyncCollectionResult<StreamingUpdate> CreateRunStreamingAsync(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
87 public virtual ClientResult<AssistantThread> CreateThread(ThreadCreationOptions options = null, CancellationToken cancellationToken = default);
88 [EditorBrowsable(EditorBrowsableState.Never)]
89 public virtual ClientResult CreateThread(BinaryContent content, RequestOptions options = null);
90 [EditorBrowsable(EditorBrowsableState.Never)]
91 public virtual ClientResult CreateThreadAndRun(BinaryContent content, RequestOptions options = null);
92 public virtual ClientResult<ThreadRun> CreateThreadAndRun(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
93 [EditorBrowsable(EditorBrowsableState.Never)]
94 public virtual Task<ClientResult> CreateThreadAndRunAsync(BinaryContent content, RequestOptions options = null);
95 public virtual Task<ClientResult<ThreadRun>> CreateThreadAndRunAsync(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
96 public virtual CollectionResult<StreamingUpdate> CreateThreadAndRunStreaming(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
97 public virtual AsyncCollectionResult<StreamingUpdate> CreateThreadAndRunStreamingAsync(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
98 public virtual Task<ClientResult<AssistantThread>> CreateThreadAsync(ThreadCreationOptions options = null, CancellationToken cancellationToken = default);
99 [EditorBrowsable(EditorBrowsableState.Never)]
100 public virtual Task<ClientResult> CreateThreadAsync(BinaryContent content, RequestOptions options = null);
101 [EditorBrowsable(EditorBrowsableState.Never)]
102 public virtual ClientResult DeleteAssistant(string assistantId, RequestOptions options);
103 public virtual ClientResult<AssistantDeletionResult> DeleteAssistant(string assistantId, CancellationToken cancellationToken = default);
104 [EditorBrowsable(EditorBrowsableState.Never)]
105 public virtual Task<ClientResult> DeleteAssistantAsync(string assistantId, RequestOptions options);
106 public virtual Task<ClientResult<AssistantDeletionResult>> DeleteAssistantAsync(string assistantId, CancellationToken cancellationToken = default);
107 [EditorBrowsable(EditorBrowsableState.Never)]
108 public virtual ClientResult DeleteMessage(string threadId, string messageId, RequestOptions options);
109 public virtual ClientResult<MessageDeletionResult> DeleteMessage(string threadId, string messageId, CancellationToken cancellationToken = default);
110 [EditorBrowsable(EditorBrowsableState.Never)]
111 public virtual Task<ClientResult> DeleteMessageAsync(string threadId, string messageId, RequestOptions options);
112 public virtual Task<ClientResult<MessageDeletionResult>> DeleteMessageAsync(string threadId, string messageId, CancellationToken cancellationToken = default);
113 [EditorBrowsable(EditorBrowsableState.Never)]
114 public virtual ClientResult DeleteThread(string threadId, RequestOptions options);
115 public virtual ClientResult<ThreadDeletionResult> DeleteThread(string threadId, CancellationToken cancellationToken = default);
116 [EditorBrowsable(EditorBrowsableState.Never)]
117 public virtual Task<ClientResult> DeleteThreadAsync(string threadId, RequestOptions options);
118 public virtual Task<ClientResult<ThreadDeletionResult>> DeleteThreadAsync(string threadId, CancellationToken cancellationToken = default);
119 [EditorBrowsable(EditorBrowsableState.Never)]
120 public virtual ClientResult GetAssistant(string assistantId, RequestOptions options);
121 public virtual ClientResult<Assistant> GetAssistant(string assistantId, CancellationToken cancellationToken = default);
122 [EditorBrowsable(EditorBrowsableState.Never)]
123 public virtual Task<ClientResult> GetAssistantAsync(string assistantId, RequestOptions options);
124 public virtual Task<ClientResult<Assistant>> GetAssistantAsync(string assistantId, CancellationToken cancellationToken = default);
125 public virtual CollectionResult<Assistant> GetAssistants(AssistantCollectionOptions options = null, CancellationToken cancellationToken = default);
126 public virtual CollectionResult<Assistant> GetAssistants(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
127 [EditorBrowsable(EditorBrowsableState.Never)]
128 public virtual CollectionResult GetAssistants(int? limit, string order, string after, string before, RequestOptions options);
129 public virtual AsyncCollectionResult<Assistant> GetAssistantsAsync(AssistantCollectionOptions options = null, CancellationToken cancellationToken = default);
130 public virtual AsyncCollectionResult<Assistant> GetAssistantsAsync(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
131 [EditorBrowsable(EditorBrowsableState.Never)]
132 public virtual AsyncCollectionResult GetAssistantsAsync(int? limit, string order, string after, string before, RequestOptions options);
133 [EditorBrowsable(EditorBrowsableState.Never)]
134 public virtual ClientResult GetMessage(string threadId, string messageId, RequestOptions options);
135 public virtual ClientResult<ThreadMessage> GetMessage(string threadId, string messageId, CancellationToken cancellationToken = default);
136 [EditorBrowsable(EditorBrowsableState.Never)]
137 public virtual Task<ClientResult> GetMessageAsync(string threadId, string messageId, RequestOptions options);
138 public virtual Task<ClientResult<ThreadMessage>> GetMessageAsync(string threadId, string messageId, CancellationToken cancellationToken = default);
139 public virtual CollectionResult<ThreadMessage> GetMessages(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
140 public virtual CollectionResult<ThreadMessage> GetMessages(string threadId, MessageCollectionOptions options = null, CancellationToken cancellationToken = default);
141 [EditorBrowsable(EditorBrowsableState.Never)]
142 public virtual CollectionResult GetMessages(string threadId, int? limit, string order, string after, string before, RequestOptions options);
143 public virtual AsyncCollectionResult<ThreadMessage> GetMessagesAsync(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
144 public virtual AsyncCollectionResult<ThreadMessage> GetMessagesAsync(string threadId, MessageCollectionOptions options = null, CancellationToken cancellationToken = default);
145 [EditorBrowsable(EditorBrowsableState.Never)]
146 public virtual AsyncCollectionResult GetMessagesAsync(string threadId, int? limit, string order, string after, string before, RequestOptions options);
147 [EditorBrowsable(EditorBrowsableState.Never)]
148 public virtual ClientResult GetRun(string threadId, string runId, RequestOptions options);
149 public virtual ClientResult<ThreadRun> GetRun(string threadId, string runId, CancellationToken cancellationToken = default);
150 [EditorBrowsable(EditorBrowsableState.Never)]
151 public virtual Task<ClientResult> GetRunAsync(string threadId, string runId, RequestOptions options);
152 public virtual Task<ClientResult<ThreadRun>> GetRunAsync(string threadId, string runId, CancellationToken cancellationToken = default);
153 public virtual CollectionResult<ThreadRun> GetRuns(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
154 public virtual CollectionResult<ThreadRun> GetRuns(string threadId, RunCollectionOptions options = null, CancellationToken cancellationToken = default);
155 [EditorBrowsable(EditorBrowsableState.Never)]
156 public virtual CollectionResult GetRuns(string threadId, int? limit, string order, string after, string before, RequestOptions options);
157 public virtual AsyncCollectionResult<ThreadRun> GetRunsAsync(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
158 public virtual AsyncCollectionResult<ThreadRun> GetRunsAsync(string threadId, RunCollectionOptions options = null, CancellationToken cancellationToken = default);
159 [EditorBrowsable(EditorBrowsableState.Never)]
160 public virtual AsyncCollectionResult GetRunsAsync(string threadId, int? limit, string order, string after, string before, RequestOptions options);
161 [EditorBrowsable(EditorBrowsableState.Never)]
162 public virtual ClientResult GetRunStep(string threadId, string runId, string stepId, RequestOptions options);
163 public virtual ClientResult<RunStep> GetRunStep(string threadId, string runId, string stepId, CancellationToken cancellationToken = default);
164 [EditorBrowsable(EditorBrowsableState.Never)]
165 public virtual Task<ClientResult> GetRunStepAsync(string threadId, string runId, string stepId, RequestOptions options);
166 public virtual Task<ClientResult<RunStep>> GetRunStepAsync(string threadId, string runId, string stepId, CancellationToken cancellationToken = default);
167 public virtual CollectionResult<RunStep> GetRunSteps(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
168 public virtual CollectionResult<RunStep> GetRunSteps(string threadId, string runId, RunStepCollectionOptions options = null, CancellationToken cancellationToken = default);
169 [EditorBrowsable(EditorBrowsableState.Never)]
170 public virtual CollectionResult GetRunSteps(string threadId, string runId, int? limit, string order, string after, string before, RequestOptions options);
171 public virtual AsyncCollectionResult<RunStep> GetRunStepsAsync(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
172 public virtual AsyncCollectionResult<RunStep> GetRunStepsAsync(string threadId, string runId, RunStepCollectionOptions options = null, CancellationToken cancellationToken = default);
173 [EditorBrowsable(EditorBrowsableState.Never)]
174 public virtual AsyncCollectionResult GetRunStepsAsync(string threadId, string runId, int? limit, string order, string after, string before, RequestOptions options);
175 [EditorBrowsable(EditorBrowsableState.Never)]
176 public virtual ClientResult GetThread(string threadId, RequestOptions options);
177 public virtual ClientResult<AssistantThread> GetThread(string threadId, CancellationToken cancellationToken = default);
178 [EditorBrowsable(EditorBrowsableState.Never)]
179 public virtual Task<ClientResult> GetThreadAsync(string threadId, RequestOptions options);
180 public virtual Task<ClientResult<AssistantThread>> GetThreadAsync(string threadId, CancellationToken cancellationToken = default);
181 public virtual ClientResult<Assistant> ModifyAssistant(string assistantId, AssistantModificationOptions options, CancellationToken cancellationToken = default);
182 [EditorBrowsable(EditorBrowsableState.Never)]
183 public virtual ClientResult ModifyAssistant(string assistantId, BinaryContent content, RequestOptions options = null);
184 public virtual Task<ClientResult<Assistant>> ModifyAssistantAsync(string assistantId, AssistantModificationOptions options, CancellationToken cancellationToken = default);
185 [EditorBrowsable(EditorBrowsableState.Never)]
186 public virtual Task<ClientResult> ModifyAssistantAsync(string assistantId, BinaryContent content, RequestOptions options = null);
187 public virtual ClientResult<ThreadMessage> ModifyMessage(string threadId, string messageId, MessageModificationOptions options, CancellationToken cancellationToken = default);
188 [EditorBrowsable(EditorBrowsableState.Never)]
189 public virtual ClientResult ModifyMessage(string threadId, string messageId, BinaryContent content, RequestOptions options = null);
190 public virtual Task<ClientResult<ThreadMessage>> ModifyMessageAsync(string threadId, string messageId, MessageModificationOptions options, CancellationToken cancellationToken = default);
191 [EditorBrowsable(EditorBrowsableState.Never)]
192 public virtual Task<ClientResult> ModifyMessageAsync(string threadId, string messageId, BinaryContent content, RequestOptions options = null);
193 [EditorBrowsable(EditorBrowsableState.Never)]
194 public virtual ClientResult ModifyRun(string threadId, string runId, BinaryContent content, RequestOptions options = null);
195 [EditorBrowsable(EditorBrowsableState.Never)]
196 public virtual Task<ClientResult> ModifyRunAsync(string threadId, string runId, BinaryContent content, RequestOptions options = null);
197 public virtual ClientResult<AssistantThread> ModifyThread(string threadId, ThreadModificationOptions options, CancellationToken cancellationToken = default);
198 [EditorBrowsable(EditorBrowsableState.Never)]
199 public virtual ClientResult ModifyThread(string threadId, BinaryContent content, RequestOptions options = null);
200 public virtual Task<ClientResult<AssistantThread>> ModifyThreadAsync(string threadId, ThreadModificationOptions options, CancellationToken cancellationToken = default);
201 [EditorBrowsable(EditorBrowsableState.Never)]
202 public virtual Task<ClientResult> ModifyThreadAsync(string threadId, BinaryContent content, RequestOptions options = null);
203 [EditorBrowsable(EditorBrowsableState.Never)]
204 public virtual ClientResult SubmitToolOutputsToRun(string threadId, string runId, BinaryContent content, RequestOptions options = null);
205 public virtual ClientResult<ThreadRun> SubmitToolOutputsToRun(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
206 [EditorBrowsable(EditorBrowsableState.Never)]
207 public virtual Task<ClientResult> SubmitToolOutputsToRunAsync(string threadId, string runId, BinaryContent content, RequestOptions options = null);
208 public virtual Task<ClientResult<ThreadRun>> SubmitToolOutputsToRunAsync(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
209 public virtual CollectionResult<StreamingUpdate> SubmitToolOutputsToRunStreaming(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
210 public virtual AsyncCollectionResult<StreamingUpdate> SubmitToolOutputsToRunStreamingAsync(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
211 }
212 public class AssistantCollectionOptions {
213 public string AfterId { get; set; }
214 public string BeforeId { get; set; }
215 public AssistantCollectionOrder? Order { get; set; }
216 public int? PageSizeLimit { get; set; }
217 }
218 public readonly partial struct AssistantCollectionOrder : IEquatable<AssistantCollectionOrder> {
219 public AssistantCollectionOrder(string value);
220 public static AssistantCollectionOrder Ascending { get; }
221 public static AssistantCollectionOrder Descending { get; }
222 public readonly bool Equals(AssistantCollectionOrder other);
223 [EditorBrowsable(EditorBrowsableState.Never)]
224 public override readonly bool Equals(object obj);
225 [EditorBrowsable(EditorBrowsableState.Never)]
226 public override readonly int GetHashCode();
227 public static bool operator ==(AssistantCollectionOrder left, AssistantCollectionOrder right);
228 public static implicit operator AssistantCollectionOrder(string value);
229 public static bool operator !=(AssistantCollectionOrder left, AssistantCollectionOrder right);
230 public override readonly string ToString();
231 }
232 public class AssistantCreationOptions : IJsonModel<AssistantCreationOptions>, IPersistableModel<AssistantCreationOptions> {
233 public string Description { get; set; }
234 public string Instructions { get; set; }
235 public IDictionary<string, string> Metadata { get; }
236 public string Name { get; set; }
237 public float? NucleusSamplingFactor { get; set; }
238 public AssistantResponseFormat ResponseFormat { get; set; }
239 public float? Temperature { get; set; }
240 public ToolResources ToolResources { get; set; }
241 public IList<ToolDefinition> Tools { get; }
242 protected virtual AssistantCreationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
243 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
244 protected virtual AssistantCreationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
245 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
246 }
247 public class AssistantDeletionResult : IJsonModel<AssistantDeletionResult>, IPersistableModel<AssistantDeletionResult> {
248 public string AssistantId { get; }
249 public bool Deleted { get; }
250 protected virtual AssistantDeletionResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
251 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
252 protected virtual AssistantDeletionResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
253 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
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 protected virtual AssistantModificationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
267 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
268 protected virtual AssistantModificationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
269 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
270 }
271 public class AssistantResponseFormat : IEquatable<AssistantResponseFormat>, IEquatable<string>, IJsonModel<AssistantResponseFormat>, IPersistableModel<AssistantResponseFormat> {
272 public static AssistantResponseFormat Auto { get; }
273 public static AssistantResponseFormat JsonObject { get; }
274 public static AssistantResponseFormat Text { get; }
275 public static AssistantResponseFormat CreateAutoFormat();
276 public static AssistantResponseFormat CreateJsonObjectFormat();
277 public static AssistantResponseFormat CreateJsonSchemaFormat(string name, BinaryData jsonSchema, string description = null, bool? strictSchemaEnabled = null);
278 public static AssistantResponseFormat CreateTextFormat();
279 [EditorBrowsable(EditorBrowsableState.Never)]
280 public override bool Equals(object obj);
281 [EditorBrowsable(EditorBrowsableState.Never)]
282 public override int GetHashCode();
283 protected virtual AssistantResponseFormat JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
284 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
285 [EditorBrowsable(EditorBrowsableState.Never)]
286 public static bool operator ==(AssistantResponseFormat first, AssistantResponseFormat second);
287 [EditorBrowsable(EditorBrowsableState.Never)]
288 public static implicit operator AssistantResponseFormat(string plainTextFormat);
289 [EditorBrowsable(EditorBrowsableState.Never)]
290 public static bool operator !=(AssistantResponseFormat first, AssistantResponseFormat second);
291 protected virtual AssistantResponseFormat PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
292 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
293 [EditorBrowsable(EditorBrowsableState.Never)]
294 bool IEquatable<AssistantResponseFormat>.Equals(AssistantResponseFormat other);
295 [EditorBrowsable(EditorBrowsableState.Never)]
296 bool IEquatable<string>.Equals(string other);
297 public override string ToString();
298 }
299 public class AssistantThread : IJsonModel<AssistantThread>, IPersistableModel<AssistantThread> {
300 public DateTimeOffset CreatedAt { get; }
301 public string Id { get; }
302 public IReadOnlyDictionary<string, string> Metadata { get; }
303 public ToolResources ToolResources { get; }
304 protected virtual AssistantThread JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
305 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
306 protected virtual AssistantThread PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
307 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
308 }
309 public class CodeInterpreterToolDefinition : ToolDefinition, IJsonModel<CodeInterpreterToolDefinition>, IPersistableModel<CodeInterpreterToolDefinition> {
310 public CodeInterpreterToolDefinition();
311 protected override ToolDefinition JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
312 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
313 protected override ToolDefinition PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
314 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
315 }
316 public class CodeInterpreterToolResources : IJsonModel<CodeInterpreterToolResources>, IPersistableModel<CodeInterpreterToolResources> {
317 public IList<string> FileIds { get; }
318 protected virtual CodeInterpreterToolResources JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
319 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
320 protected virtual CodeInterpreterToolResources PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
321 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
322 }
323 public readonly partial struct FileSearchRanker : IEquatable<FileSearchRanker> {
324 public FileSearchRanker(string value);
325 public static FileSearchRanker Auto { get; }
326 public static FileSearchRanker Default20240821 { get; }
327 public readonly bool Equals(FileSearchRanker other);
328 [EditorBrowsable(EditorBrowsableState.Never)]
329 public override readonly bool Equals(object obj);
330 [EditorBrowsable(EditorBrowsableState.Never)]
331 public override readonly int GetHashCode();
332 public static bool operator ==(FileSearchRanker left, FileSearchRanker right);
333 public static implicit operator FileSearchRanker(string value);
334 public static bool operator !=(FileSearchRanker left, FileSearchRanker right);
335 public override readonly string ToString();
336 }
337 public class FileSearchRankingOptions : IJsonModel<FileSearchRankingOptions>, IPersistableModel<FileSearchRankingOptions> {
338 public FileSearchRankingOptions(float scoreThreshold);
339 public FileSearchRanker? Ranker { get; set; }
340 public float ScoreThreshold { get; set; }
341 protected virtual FileSearchRankingOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
342 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
343 protected virtual FileSearchRankingOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
344 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
345 }
346 public class FileSearchToolDefinition : ToolDefinition, IJsonModel<FileSearchToolDefinition>, IPersistableModel<FileSearchToolDefinition> {
347 public FileSearchToolDefinition();
348 public int? MaxResults { get; set; }
349 public FileSearchRankingOptions RankingOptions { get; set; }
350 protected override ToolDefinition JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
351 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
352 protected override ToolDefinition PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
353 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
354 }
355 public class FileSearchToolResources : IJsonModel<FileSearchToolResources>, IPersistableModel<FileSearchToolResources> {
356 public IList<VectorStoreCreationHelper> NewVectorStores { get; }
357 public IList<string> VectorStoreIds { get; }
358 protected virtual FileSearchToolResources JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
359 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
360 protected virtual FileSearchToolResources PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
361 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
362 }
363 public class FunctionToolDefinition : ToolDefinition, IJsonModel<FunctionToolDefinition>, IPersistableModel<FunctionToolDefinition> {
364 public FunctionToolDefinition();
365 public FunctionToolDefinition(string name);
366 public string Description { get; set; }
367 public string FunctionName { get; set; }
368 public BinaryData Parameters { get; set; }
369 public bool? StrictParameterSchemaEnabled { get; set; }
370 protected override ToolDefinition JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
371 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
372 protected override ToolDefinition PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
373 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
374 }
375 public class MessageCollectionOptions {
376 public string AfterId { get; set; }
377 public string BeforeId { get; set; }
378 public MessageCollectionOrder? Order { get; set; }
379 public int? PageSizeLimit { get; set; }
380 }
381 public readonly partial struct MessageCollectionOrder : IEquatable<MessageCollectionOrder> {
382 public MessageCollectionOrder(string value);
383 public static MessageCollectionOrder Ascending { get; }
384 public static MessageCollectionOrder Descending { get; }
385 public readonly bool Equals(MessageCollectionOrder other);
386 [EditorBrowsable(EditorBrowsableState.Never)]
387 public override readonly bool Equals(object obj);
388 [EditorBrowsable(EditorBrowsableState.Never)]
389 public override readonly int GetHashCode();
390 public static bool operator ==(MessageCollectionOrder left, MessageCollectionOrder right);
391 public static implicit operator MessageCollectionOrder(string value);
392 public static bool operator !=(MessageCollectionOrder left, MessageCollectionOrder right);
393 public override readonly string ToString();
394 }
395 public abstract class MessageContent : IJsonModel<MessageContent>, IPersistableModel<MessageContent> {
396 public MessageImageDetail? ImageDetail { get; }
397 public string ImageFileId { get; }
398 public Uri ImageUri { get; }
399 public string Refusal { get; }
400 public string Text { get; }
401 public IReadOnlyList<TextAnnotation> TextAnnotations { get; }
402 public static MessageContent FromImageFileId(string imageFileId, MessageImageDetail? detail = null);
403 public static MessageContent FromImageUri(Uri imageUri, MessageImageDetail? detail = null);
404 public static MessageContent FromText(string text);
405 protected virtual MessageContent JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
406 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
407 public static implicit operator MessageContent(string value);
408 protected virtual MessageContent PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
409 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
410 }
411 public class MessageContentUpdate : StreamingUpdate {
412 public MessageImageDetail? ImageDetail { get; }
413 public string ImageFileId { get; }
414 public string MessageId { get; }
415 public int MessageIndex { get; }
416 public string RefusalUpdate { get; }
417 public MessageRole? Role { get; }
418 public string Text { get; }
419 public TextAnnotationUpdate TextAnnotation { get; }
420 }
421 public class MessageCreationAttachment : IJsonModel<MessageCreationAttachment>, IPersistableModel<MessageCreationAttachment> {
422 public MessageCreationAttachment(string fileId, IEnumerable<ToolDefinition> tools);
423 public string FileId { get; }
424 public IReadOnlyList<ToolDefinition> Tools { get; }
425 protected virtual MessageCreationAttachment JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
426 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
427 protected virtual MessageCreationAttachment PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
428 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
429 }
430 public class MessageCreationOptions : IJsonModel<MessageCreationOptions>, IPersistableModel<MessageCreationOptions> {
431 public IList<MessageCreationAttachment> Attachments { get; set; }
432 public IDictionary<string, string> Metadata { get; }
433 protected virtual MessageCreationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
434 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
435 protected virtual MessageCreationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
436 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
437 }
438 public class MessageDeletionResult : IJsonModel<MessageDeletionResult>, IPersistableModel<MessageDeletionResult> {
439 public bool Deleted { get; }
440 public string MessageId { get; }
441 protected virtual MessageDeletionResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
442 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
443 protected virtual MessageDeletionResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
444 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
445 }
446 public class MessageFailureDetails : IJsonModel<MessageFailureDetails>, IPersistableModel<MessageFailureDetails> {
447 public MessageFailureReason Reason { get; }
448 protected virtual MessageFailureDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
449 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
450 protected virtual MessageFailureDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
451 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
452 }
453 public readonly partial struct MessageFailureReason : IEquatable<MessageFailureReason> {
454 public MessageFailureReason(string value);
455 public static MessageFailureReason ContentFilter { get; }
456 public static MessageFailureReason MaxTokens { get; }
457 public static MessageFailureReason RunCancelled { get; }
458 public static MessageFailureReason RunExpired { get; }
459 public static MessageFailureReason RunFailed { get; }
460 public readonly bool Equals(MessageFailureReason other);
461 [EditorBrowsable(EditorBrowsableState.Never)]
462 public override readonly bool Equals(object obj);
463 [EditorBrowsable(EditorBrowsableState.Never)]
464 public override readonly int GetHashCode();
465 public static bool operator ==(MessageFailureReason left, MessageFailureReason right);
466 public static implicit operator MessageFailureReason(string value);
467 public static bool operator !=(MessageFailureReason left, MessageFailureReason right);
468 public override readonly string ToString();
469 }
470 public enum MessageImageDetail {
471 Auto = 0,
472 Low = 1,
473 High = 2
474 }
475 public class MessageModificationOptions : IJsonModel<MessageModificationOptions>, IPersistableModel<MessageModificationOptions> {
476 public IDictionary<string, string> Metadata { get; }
477 protected virtual MessageModificationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
478 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
479 protected virtual MessageModificationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
480 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
481 }
482 public enum MessageRole {
483 User = 0,
484 Assistant = 1
485 }
486 public readonly partial struct MessageStatus : IEquatable<MessageStatus> {
487 public MessageStatus(string value);
488 public static MessageStatus Completed { get; }
489 public static MessageStatus Incomplete { get; }
490 public static MessageStatus InProgress { get; }
491 public readonly bool Equals(MessageStatus other);
492 [EditorBrowsable(EditorBrowsableState.Never)]
493 public override readonly bool Equals(object obj);
494 [EditorBrowsable(EditorBrowsableState.Never)]
495 public override readonly int GetHashCode();
496 public static bool operator ==(MessageStatus left, MessageStatus right);
497 public static implicit operator MessageStatus(string value);
498 public static bool operator !=(MessageStatus left, MessageStatus right);
499 public override readonly string ToString();
500 }
501 public class MessageStatusUpdate : StreamingUpdate<ThreadMessage> {
502 }
503 public abstract class RequiredAction {
504 public string FunctionArguments { get; }
505 public string FunctionName { get; }
506 public string ToolCallId { get; }
507 }
508 public class RequiredActionUpdate : RunUpdate {
509 public string FunctionArguments { get; }
510 public string FunctionName { get; }
511 public string ToolCallId { get; }
512 public ThreadRun GetThreadRun();
513 }
514 public class RunCollectionOptions {
515 public string AfterId { get; set; }
516 public string BeforeId { get; set; }
517 public RunCollectionOrder? Order { get; set; }
518 public int? PageSizeLimit { get; set; }
519 }
520 public readonly partial struct RunCollectionOrder : IEquatable<RunCollectionOrder> {
521 public RunCollectionOrder(string value);
522 public static RunCollectionOrder Ascending { get; }
523 public static RunCollectionOrder Descending { get; }
524 public readonly bool Equals(RunCollectionOrder other);
525 [EditorBrowsable(EditorBrowsableState.Never)]
526 public override readonly bool Equals(object obj);
527 [EditorBrowsable(EditorBrowsableState.Never)]
528 public override readonly int GetHashCode();
529 public static bool operator ==(RunCollectionOrder left, RunCollectionOrder right);
530 public static implicit operator RunCollectionOrder(string value);
531 public static bool operator !=(RunCollectionOrder left, RunCollectionOrder right);
532 public override readonly string ToString();
533 }
534 public class RunCreationOptions : IJsonModel<RunCreationOptions>, IPersistableModel<RunCreationOptions> {
535 public string AdditionalInstructions { get; set; }
536 public IList<ThreadInitializationMessage> AdditionalMessages { get; }
537 public bool? AllowParallelToolCalls { get; set; }
538 public string InstructionsOverride { get; set; }
539 public int? MaxInputTokenCount { get; set; }
540 public int? MaxOutputTokenCount { get; set; }
541 public IDictionary<string, string> Metadata { get; }
542 public string ModelOverride { get; set; }
543 public float? NucleusSamplingFactor { get; set; }
544 public AssistantResponseFormat ResponseFormat { get; set; }
545 public float? Temperature { get; set; }
546 public ToolConstraint ToolConstraint { get; set; }
547 public IList<ToolDefinition> ToolsOverride { get; }
548 public RunTruncationStrategy TruncationStrategy { get; set; }
549 protected virtual RunCreationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
550 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
551 protected virtual RunCreationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
552 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
553 }
554 public class RunError : IJsonModel<RunError>, IPersistableModel<RunError> {
555 public RunErrorCode Code { get; }
556 public string Message { get; }
557 protected virtual RunError JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
558 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
559 protected virtual RunError PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
560 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
561 }
562 public readonly partial struct RunErrorCode : IEquatable<RunErrorCode> {
563 public RunErrorCode(string value);
564 public static RunErrorCode InvalidPrompt { get; }
565 public static RunErrorCode RateLimitExceeded { get; }
566 public static RunErrorCode ServerError { get; }
567 public readonly bool Equals(RunErrorCode other);
568 [EditorBrowsable(EditorBrowsableState.Never)]
569 public override readonly bool Equals(object obj);
570 [EditorBrowsable(EditorBrowsableState.Never)]
571 public override readonly int GetHashCode();
572 public static bool operator ==(RunErrorCode left, RunErrorCode right);
573 public static implicit operator RunErrorCode(string value);
574 public static bool operator !=(RunErrorCode left, RunErrorCode right);
575 public override readonly string ToString();
576 }
577 public class RunIncompleteDetails : IJsonModel<RunIncompleteDetails>, IPersistableModel<RunIncompleteDetails> {
578 public RunIncompleteReason? Reason { get; }
579 protected virtual RunIncompleteDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
580 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
581 protected virtual RunIncompleteDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
582 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
583 }
584 public readonly partial struct RunIncompleteReason : IEquatable<RunIncompleteReason> {
585 public RunIncompleteReason(string value);
586 public static RunIncompleteReason MaxInputTokenCount { get; }
587 public static RunIncompleteReason MaxOutputTokenCount { get; }
588 public readonly bool Equals(RunIncompleteReason other);
589 [EditorBrowsable(EditorBrowsableState.Never)]
590 public override readonly bool Equals(object obj);
591 [EditorBrowsable(EditorBrowsableState.Never)]
592 public override readonly int GetHashCode();
593 public static bool operator ==(RunIncompleteReason left, RunIncompleteReason right);
594 public static implicit operator RunIncompleteReason(string value);
595 public static bool operator !=(RunIncompleteReason left, RunIncompleteReason right);
596 public override readonly string ToString();
597 }
598 public class RunModificationOptions : IJsonModel<RunModificationOptions>, IPersistableModel<RunModificationOptions> {
599 public IDictionary<string, string> Metadata { get; }
600 protected virtual RunModificationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
601 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
602 protected virtual RunModificationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
603 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
604 }
605 public readonly partial struct RunStatus : IEquatable<RunStatus> {
606 public RunStatus(string value);
607 public static RunStatus Cancelled { get; }
608 public static RunStatus Cancelling { get; }
609 public static RunStatus Completed { get; }
610 public static RunStatus Expired { get; }
611 public static RunStatus Failed { get; }
612 public static RunStatus Incomplete { get; }
613 public static RunStatus InProgress { get; }
614 public bool IsTerminal { get; }
615 public static RunStatus Queued { get; }
616 public static RunStatus RequiresAction { get; }
617 public readonly bool Equals(RunStatus other);
618 [EditorBrowsable(EditorBrowsableState.Never)]
619 public override readonly bool Equals(object obj);
620 [EditorBrowsable(EditorBrowsableState.Never)]
621 public override readonly int GetHashCode();
622 public static bool operator ==(RunStatus left, RunStatus right);
623 public static implicit operator RunStatus(string value);
624 public static bool operator !=(RunStatus left, RunStatus right);
625 public override readonly string ToString();
626 }
627 public class RunStep : IJsonModel<RunStep>, IPersistableModel<RunStep> {
628 public string AssistantId { get; }
629 public DateTimeOffset? CancelledAt { get; }
630 public DateTimeOffset? CompletedAt { get; }
631 public DateTimeOffset CreatedAt { get; }
632 public RunStepDetails Details { get; }
633 public DateTimeOffset? ExpiredAt { get; }
634 public DateTimeOffset? FailedAt { get; }
635 public string Id { get; }
636 public RunStepKind Kind { get; }
637 public RunStepError LastError { get; }
638 public IReadOnlyDictionary<string, string> Metadata { get; }
639 public string RunId { get; }
640 public RunStepStatus Status { get; }
641 public string ThreadId { get; }
642 public RunStepTokenUsage Usage { get; }
643 protected virtual RunStep JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
644 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
645 protected virtual RunStep PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
646 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
647 }
648 public abstract class RunStepCodeInterpreterOutput : IJsonModel<RunStepCodeInterpreterOutput>, IPersistableModel<RunStepCodeInterpreterOutput> {
649 public string ImageFileId { get; }
650 public string Logs { get; }
651 protected virtual RunStepCodeInterpreterOutput JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
652 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
653 protected virtual RunStepCodeInterpreterOutput PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
654 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
655 }
656 public class RunStepCollectionOptions {
657 public string AfterId { get; set; }
658 public string BeforeId { get; set; }
659 public RunStepCollectionOrder? Order { get; set; }
660 public int? PageSizeLimit { get; set; }
661 }
662 public readonly partial struct RunStepCollectionOrder : IEquatable<RunStepCollectionOrder> {
663 public RunStepCollectionOrder(string value);
664 public static RunStepCollectionOrder Ascending { get; }
665 public static RunStepCollectionOrder Descending { get; }
666 public readonly bool Equals(RunStepCollectionOrder other);
667 [EditorBrowsable(EditorBrowsableState.Never)]
668 public override readonly bool Equals(object obj);
669 [EditorBrowsable(EditorBrowsableState.Never)]
670 public override readonly int GetHashCode();
671 public static bool operator ==(RunStepCollectionOrder left, RunStepCollectionOrder right);
672 public static implicit operator RunStepCollectionOrder(string value);
673 public static bool operator !=(RunStepCollectionOrder left, RunStepCollectionOrder right);
674 public override readonly string ToString();
675 }
676 public abstract class RunStepDetails : IJsonModel<RunStepDetails>, IPersistableModel<RunStepDetails> {
677 public string CreatedMessageId { get; }
678 public IReadOnlyList<RunStepToolCall> ToolCalls { get; }
679 protected virtual RunStepDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
680 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
681 protected virtual RunStepDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
682 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
683 }
684 public class RunStepDetailsUpdate : StreamingUpdate {
685 public string CodeInterpreterInput { get; }
686 public IReadOnlyList<RunStepUpdateCodeInterpreterOutput> CodeInterpreterOutputs { get; }
687 public string CreatedMessageId { get; }
688 public FileSearchRankingOptions FileSearchRankingOptions { get; }
689 public IReadOnlyList<RunStepFileSearchResult> FileSearchResults { get; }
690 public string FunctionArguments { get; }
691 public string FunctionName { get; }
692 public string FunctionOutput { get; }
693 public string StepId { get; }
694 public string ToolCallId { get; }
695 public int? ToolCallIndex { get; }
696 }
697 public class RunStepError : IJsonModel<RunStepError>, IPersistableModel<RunStepError> {
698 public RunStepErrorCode Code { get; }
699 public string Message { get; }
700 protected virtual RunStepError JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
701 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
702 protected virtual RunStepError PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
703 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
704 }
705 public readonly partial struct RunStepErrorCode : IEquatable<RunStepErrorCode> {
706 public RunStepErrorCode(string value);
707 public static RunStepErrorCode RateLimitExceeded { get; }
708 public static RunStepErrorCode ServerError { get; }
709 public readonly bool Equals(RunStepErrorCode other);
710 [EditorBrowsable(EditorBrowsableState.Never)]
711 public override readonly bool Equals(object obj);
712 [EditorBrowsable(EditorBrowsableState.Never)]
713 public override readonly int GetHashCode();
714 public static bool operator ==(RunStepErrorCode left, RunStepErrorCode right);
715 public static implicit operator RunStepErrorCode(string value);
716 public static bool operator !=(RunStepErrorCode left, RunStepErrorCode right);
717 public override readonly string ToString();
718 }
719 public class RunStepFileSearchResult : IJsonModel<RunStepFileSearchResult>, IPersistableModel<RunStepFileSearchResult> {
720 public IReadOnlyList<RunStepFileSearchResultContent> Content { get; }
721 public string FileId { get; }
722 public string FileName { get; }
723 public float Score { get; }
724 protected virtual RunStepFileSearchResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
725 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
726 protected virtual RunStepFileSearchResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
727 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
728 }
729 public class RunStepFileSearchResultContent : IJsonModel<RunStepFileSearchResultContent>, IPersistableModel<RunStepFileSearchResultContent> {
730 public RunStepFileSearchResultContentKind Kind { get; }
731 public string Text { get; }
732 protected virtual RunStepFileSearchResultContent JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
733 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
734 protected virtual RunStepFileSearchResultContent PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
735 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
736 }
737 public enum RunStepFileSearchResultContentKind {
738 Text = 0
739 }
740 public enum RunStepKind {
741 CreatedMessage = 0,
742 ToolCall = 1
743 }
744 public readonly partial struct RunStepStatus : IEquatable<RunStepStatus> {
745 public RunStepStatus(string value);
746 public static RunStepStatus Cancelled { get; }
747 public static RunStepStatus Completed { get; }
748 public static RunStepStatus Expired { get; }
749 public static RunStepStatus Failed { get; }
750 public static RunStepStatus InProgress { get; }
751 public readonly bool Equals(RunStepStatus other);
752 [EditorBrowsable(EditorBrowsableState.Never)]
753 public override readonly bool Equals(object obj);
754 [EditorBrowsable(EditorBrowsableState.Never)]
755 public override readonly int GetHashCode();
756 public static bool operator ==(RunStepStatus left, RunStepStatus right);
757 public static implicit operator RunStepStatus(string value);
758 public static bool operator !=(RunStepStatus left, RunStepStatus right);
759 public override readonly string ToString();
760 }
761 public class RunStepTokenUsage : IJsonModel<RunStepTokenUsage>, IPersistableModel<RunStepTokenUsage> {
762 public int InputTokenCount { get; }
763 public int OutputTokenCount { get; }
764 public int TotalTokenCount { get; }
765 protected virtual RunStepTokenUsage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
766 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
767 protected virtual RunStepTokenUsage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
768 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
769 }
770 public class RunStepToolCall : IJsonModel<RunStepToolCall>, IPersistableModel<RunStepToolCall> {
771 public string CodeInterpreterInput { get; }
772 public IReadOnlyList<RunStepCodeInterpreterOutput> CodeInterpreterOutputs { get; }
773 public FileSearchRankingOptions FileSearchRankingOptions { get; }
774 public IReadOnlyList<RunStepFileSearchResult> FileSearchResults { get; }
775 public string FunctionArguments { get; }
776 public string FunctionName { get; }
777 public string FunctionOutput { get; }
778 public string Id { get; }
779 public RunStepToolCallKind Kind { get; }
780 protected virtual RunStepToolCall JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
781 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
782 protected virtual RunStepToolCall PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
783 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
784 }
785 public enum RunStepToolCallKind {
786 CodeInterpreter = 0,
787 FileSearch = 1,
788 Function = 2
789 }
790 public class RunStepUpdate : StreamingUpdate<RunStep> {
791 }
792 public class RunStepUpdateCodeInterpreterOutput : IJsonModel<RunStepUpdateCodeInterpreterOutput>, IPersistableModel<RunStepUpdateCodeInterpreterOutput> {
793 public string ImageFileId { get; }
794 public string Logs { get; }
795 public int OutputIndex { get; }
796 protected virtual RunStepUpdateCodeInterpreterOutput JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
797 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
798 protected virtual RunStepUpdateCodeInterpreterOutput PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
799 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
800 }
801 public class RunTokenUsage : IJsonModel<RunTokenUsage>, IPersistableModel<RunTokenUsage> {
802 public int InputTokenCount { get; }
803 public int OutputTokenCount { get; }
804 public int TotalTokenCount { get; }
805 protected virtual RunTokenUsage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
806 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
807 protected virtual RunTokenUsage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
808 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
809 }
810 public class RunTruncationStrategy : IJsonModel<RunTruncationStrategy>, IPersistableModel<RunTruncationStrategy> {
811 public static RunTruncationStrategy Auto { get; }
812 public int? LastMessages { get; }
813 public static RunTruncationStrategy CreateLastMessagesStrategy(int lastMessageCount);
814 protected virtual RunTruncationStrategy JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
815 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
816 protected virtual RunTruncationStrategy PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
817 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
818 }
819 public class RunUpdate : StreamingUpdate<ThreadRun> {
820 }
821 public abstract class StreamingUpdate {
822 public StreamingUpdateReason UpdateKind { get; }
823 }
824 public enum StreamingUpdateReason {
825 Unknown = 0,
826 ThreadCreated = 1,
827 RunCreated = 2,
828 RunQueued = 3,
829 RunInProgress = 4,
830 RunRequiresAction = 5,
831 RunCompleted = 6,
832 RunIncomplete = 7,
833 RunFailed = 8,
834 RunCancelling = 9,
835 RunCancelled = 10,
836 RunExpired = 11,
837 RunStepCreated = 12,
838 RunStepInProgress = 13,
839 RunStepUpdated = 14,
840 RunStepCompleted = 15,
841 RunStepFailed = 16,
842 RunStepCancelled = 17,
843 RunStepExpired = 18,
844 MessageCreated = 19,
845 MessageInProgress = 20,
846 MessageUpdated = 21,
847 MessageCompleted = 22,
848 MessageFailed = 23,
849 Error = 24,
850 Done = 25
851 }
852 public class StreamingUpdate<T> : StreamingUpdate where T : class {
853 public T Value { get; }
854 public static implicit operator T(StreamingUpdate<T> update);
855 }
856 public class TextAnnotation {
857 public int EndIndex { get; }
858 public string InputFileId { get; }
859 public string OutputFileId { get; }
860 public int StartIndex { get; }
861 public string TextToReplace { get; }
862 }
863 public class TextAnnotationUpdate {
864 public int ContentIndex { get; }
865 public int? EndIndex { get; }
866 public string InputFileId { get; }
867 public string OutputFileId { get; }
868 public int? StartIndex { get; }
869 public string TextToReplace { get; }
870 }
871 public class ThreadCreationOptions : IJsonModel<ThreadCreationOptions>, IPersistableModel<ThreadCreationOptions> {
872 public IList<ThreadInitializationMessage> InitialMessages { get; }
873 public IDictionary<string, string> Metadata { get; }
874 public ToolResources ToolResources { get; set; }
875 protected virtual ThreadCreationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
876 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
877 protected virtual ThreadCreationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
878 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
879 }
880 public class ThreadDeletionResult : IJsonModel<ThreadDeletionResult>, IPersistableModel<ThreadDeletionResult> {
881 public bool Deleted { get; }
882 public string ThreadId { get; }
883 protected virtual ThreadDeletionResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
884 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
885 protected virtual ThreadDeletionResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
886 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
887 }
888 public class ThreadInitializationMessage : MessageCreationOptions {
889 public ThreadInitializationMessage(MessageRole role, IEnumerable<MessageContent> content);
890 public static implicit operator ThreadInitializationMessage(string initializationMessage);
891 }
892 public class ThreadMessage : IJsonModel<ThreadMessage>, IPersistableModel<ThreadMessage> {
893 public string AssistantId { get; }
894 public IReadOnlyList<MessageCreationAttachment> Attachments { get; }
895 public DateTimeOffset? CompletedAt { get; }
896 public IReadOnlyList<MessageContent> Content { get; }
897 public DateTimeOffset CreatedAt { get; }
898 public string Id { get; }
899 public DateTimeOffset? IncompleteAt { get; }
900 public MessageFailureDetails IncompleteDetails { get; }
901 public IReadOnlyDictionary<string, string> Metadata { get; }
902 public MessageRole Role { get; }
903 public string RunId { get; }
904 public MessageStatus Status { get; }
905 public string ThreadId { get; }
906 protected virtual ThreadMessage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
907 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
908 protected virtual ThreadMessage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
909 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
910 }
911 public class ThreadModificationOptions : IJsonModel<ThreadModificationOptions>, IPersistableModel<ThreadModificationOptions> {
912 public IDictionary<string, string> Metadata { get; }
913 public ToolResources ToolResources { get; set; }
914 protected virtual ThreadModificationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
915 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
916 protected virtual ThreadModificationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
917 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
918 }
919 public class ThreadRun : IJsonModel<ThreadRun>, IPersistableModel<ThreadRun> {
920 public bool? AllowParallelToolCalls { get; }
921 public string AssistantId { get; }
922 public DateTimeOffset? CancelledAt { get; }
923 public DateTimeOffset? CompletedAt { get; }
924 public DateTimeOffset CreatedAt { get; }
925 public DateTimeOffset? ExpiresAt { get; }
926 public DateTimeOffset? FailedAt { get; }
927 public string Id { get; }
928 public RunIncompleteDetails IncompleteDetails { get; }
929 public string Instructions { get; }
930 public RunError LastError { get; }
931 public int? MaxInputTokenCount { get; }
932 public int? MaxOutputTokenCount { get; }
933 public IReadOnlyDictionary<string, string> Metadata { get; }
934 public string Model { get; }
935 public float? NucleusSamplingFactor { get; }
936 public IReadOnlyList<RequiredAction> RequiredActions { get; }
937 public AssistantResponseFormat ResponseFormat { get; }
938 public DateTimeOffset? StartedAt { get; }
939 public RunStatus Status { get; }
940 public float? Temperature { get; }
941 public string ThreadId { get; }
942 public ToolConstraint ToolConstraint { get; }
943 public IReadOnlyList<ToolDefinition> Tools { get; }
944 public RunTruncationStrategy TruncationStrategy { get; }
945 public RunTokenUsage Usage { get; }
946 protected virtual ThreadRun JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
947 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
948 protected virtual ThreadRun PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
949 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
950 }
951 public class ThreadUpdate : StreamingUpdate<AssistantThread> {
952 public DateTimeOffset CreatedAt { get; }
953 public string Id { get; }
954 public IReadOnlyDictionary<string, string> Metadata { get; }
955 public ToolResources ToolResources { get; }
956 }
957 public class ToolConstraint : IJsonModel<ToolConstraint>, IPersistableModel<ToolConstraint> {
958 public ToolConstraint(ToolDefinition toolDefinition);
959 public static ToolConstraint Auto { get; }
960 public static ToolConstraint None { get; }
961 public static ToolConstraint Required { get; }
962 protected virtual ToolConstraint JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
963 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
964 protected virtual ToolConstraint PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
965 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
966 }
967 public class ToolDefinition : IJsonModel<ToolDefinition>, IPersistableModel<ToolDefinition> {
968 public static CodeInterpreterToolDefinition CreateCodeInterpreter();
969 public static FileSearchToolDefinition CreateFileSearch(int? maxResults = null);
970 public static FunctionToolDefinition CreateFunction(string name, string description = null, BinaryData parameters = null, bool? strictParameterSchemaEnabled = null);
971 protected virtual ToolDefinition JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
972 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
973 protected virtual ToolDefinition PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
974 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
975 }
976 public class ToolOutput : IJsonModel<ToolOutput>, IPersistableModel<ToolOutput> {
977 public ToolOutput();
978 public ToolOutput(string toolCallId, string output);
979 public string Output { get; set; }
980 public string ToolCallId { get; set; }
981 protected virtual ToolOutput JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
982 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
983 protected virtual ToolOutput PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
984 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
985 }
986 public class ToolResources : IJsonModel<ToolResources>, IPersistableModel<ToolResources> {
987 public CodeInterpreterToolResources CodeInterpreter { get; set; }
988 public FileSearchToolResources FileSearch { get; set; }
989 protected virtual ToolResources JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
990 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
991 protected virtual ToolResources PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
992 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
993 }
994 public class VectorStoreCreationHelper : IJsonModel<VectorStoreCreationHelper>, IPersistableModel<VectorStoreCreationHelper> {
995 public VectorStoreCreationHelper();
996 public VectorStoreCreationHelper(IEnumerable<OpenAIFile> files);
997 public VectorStoreCreationHelper(IEnumerable<string> fileIds);
998 public FileChunkingStrategy ChunkingStrategy { get; set; }
999 public IList<string> FileIds { get; }
1000 public IDictionary<string, string> Metadata { get; }
1001 protected virtual VectorStoreCreationHelper JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1002 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1003 protected virtual VectorStoreCreationHelper PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1004 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1005 }
1006}
1007namespace OpenAI.Audio {
1008 public class AudioClient {
1009 protected AudioClient();
1010 protected internal AudioClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
1011 public AudioClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
1012 public AudioClient(string model, ApiKeyCredential credential);
1013 public AudioClient(string model, string apiKey);
1014 public ClientPipeline Pipeline { get; }
1015 [EditorBrowsable(EditorBrowsableState.Never)]
1016 public virtual ClientResult GenerateSpeech(BinaryContent content, RequestOptions options = null);
1017 public virtual ClientResult<BinaryData> GenerateSpeech(string text, GeneratedSpeechVoice voice, SpeechGenerationOptions options = null, CancellationToken cancellationToken = default);
1018 [EditorBrowsable(EditorBrowsableState.Never)]
1019 public virtual Task<ClientResult> GenerateSpeechAsync(BinaryContent content, RequestOptions options = null);
1020 public virtual Task<ClientResult<BinaryData>> GenerateSpeechAsync(string text, GeneratedSpeechVoice voice, SpeechGenerationOptions options = null, CancellationToken cancellationToken = default);
1021 [EditorBrowsable(EditorBrowsableState.Never)]
1022 public virtual ClientResult TranscribeAudio(BinaryContent content, string contentType, RequestOptions options = null);
1023 public virtual ClientResult<AudioTranscription> TranscribeAudio(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
1024 public virtual ClientResult<AudioTranscription> TranscribeAudio(string audioFilePath, AudioTranscriptionOptions options = null);
1025 [EditorBrowsable(EditorBrowsableState.Never)]
1026 public virtual Task<ClientResult> TranscribeAudioAsync(BinaryContent content, string contentType, RequestOptions options = null);
1027 public virtual Task<ClientResult<AudioTranscription>> TranscribeAudioAsync(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
1028 public virtual Task<ClientResult<AudioTranscription>> TranscribeAudioAsync(string audioFilePath, AudioTranscriptionOptions options = null);
1029 public virtual CollectionResult<StreamingAudioTranscriptionUpdate> TranscribeAudioStreaming(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
1030 public virtual CollectionResult<StreamingAudioTranscriptionUpdate> TranscribeAudioStreaming(string audioFilePath, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
1031 public virtual AsyncCollectionResult<StreamingAudioTranscriptionUpdate> TranscribeAudioStreamingAsync(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
1032 public virtual AsyncCollectionResult<StreamingAudioTranscriptionUpdate> TranscribeAudioStreamingAsync(string audioFilePath, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
1033 public virtual ClientResult TranslateAudio(BinaryContent content, string contentType, RequestOptions options = null);
1034 public virtual ClientResult<AudioTranslation> TranslateAudio(Stream audio, string audioFilename, AudioTranslationOptions options = null, CancellationToken cancellationToken = default);
1035 public virtual ClientResult<AudioTranslation> TranslateAudio(string audioFilePath, AudioTranslationOptions options = null);
1036 public virtual Task<ClientResult> TranslateAudioAsync(BinaryContent content, string contentType, RequestOptions options = null);
1037 public virtual Task<ClientResult<AudioTranslation>> TranslateAudioAsync(Stream audio, string audioFilename, AudioTranslationOptions options = null, CancellationToken cancellationToken = default);
1038 public virtual Task<ClientResult<AudioTranslation>> TranslateAudioAsync(string audioFilePath, AudioTranslationOptions options = null);
1039 }
1040 [Flags]
1041 public enum AudioTimestampGranularities {
1042 Default = 0,
1043 Word = 1,
1044 Segment = 2
1045 }
1046 public class AudioTokenLogProbabilityDetails : IJsonModel<AudioTokenLogProbabilityDetails>, IPersistableModel<AudioTokenLogProbabilityDetails> {
1047 public float LogProbability { get; }
1048 public string Token { get; }
1049 public ReadOnlyMemory<byte> Utf8Bytes { get; }
1050 protected virtual AudioTokenLogProbabilityDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1051 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1052 protected virtual AudioTokenLogProbabilityDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1053 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1054 }
1055 public class AudioTranscription : IJsonModel<AudioTranscription>, IPersistableModel<AudioTranscription> {
1056 public TimeSpan? Duration { get; }
1057 public string Language { get; }
1058 public IReadOnlyList<TranscribedSegment> Segments { get; }
1059 public string Text { get; }
1060 public IReadOnlyList<AudioTokenLogProbabilityDetails> TranscriptionTokenLogProbabilities { get; }
1061 public IReadOnlyList<TranscribedWord> Words { get; }
1062 protected virtual AudioTranscription JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1063 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1064 protected virtual AudioTranscription PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1065 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1066 }
1067 public readonly partial struct AudioTranscriptionFormat : IEquatable<AudioTranscriptionFormat> {
1068 public AudioTranscriptionFormat(string value);
1069 public static AudioTranscriptionFormat Simple { get; }
1070 public static AudioTranscriptionFormat Srt { get; }
1071 [EditorBrowsable(EditorBrowsableState.Never)]
1072 public static AudioTranscriptionFormat Text { get; }
1073 public static AudioTranscriptionFormat Verbose { get; }
1074 public static AudioTranscriptionFormat Vtt { get; }
1075 public readonly bool Equals(AudioTranscriptionFormat 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 ==(AudioTranscriptionFormat left, AudioTranscriptionFormat right);
1081 public static implicit operator AudioTranscriptionFormat(string value);
1082 public static bool operator !=(AudioTranscriptionFormat left, AudioTranscriptionFormat right);
1083 public override readonly string ToString();
1084 }
1085 [Flags]
1086 public enum AudioTranscriptionIncludes {
1087 Default = 0,
1088 Logprobs = 1
1089 }
1090 public class AudioTranscriptionOptions : IJsonModel<AudioTranscriptionOptions>, IPersistableModel<AudioTranscriptionOptions> {
1091 public AudioTranscriptionIncludes Includes { get; set; }
1092 public string Language { get; set; }
1093 public string Prompt { get; set; }
1094 public AudioTranscriptionFormat? ResponseFormat { get; set; }
1095 public float? Temperature { get; set; }
1096 public AudioTimestampGranularities TimestampGranularities { get; set; }
1097 protected virtual AudioTranscriptionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1098 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1099 protected virtual AudioTranscriptionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1100 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1101 }
1102 public class AudioTranslation : IJsonModel<AudioTranslation>, IPersistableModel<AudioTranslation> {
1103 public TimeSpan? Duration { get; }
1104 public string Language { get; }
1105 public IReadOnlyList<TranscribedSegment> Segments { get; }
1106 public string Text { get; }
1107 protected virtual AudioTranslation JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1108 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1109 protected virtual AudioTranslation PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1110 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1111 }
1112 public readonly partial struct AudioTranslationFormat : IEquatable<AudioTranslationFormat> {
1113 public AudioTranslationFormat(string value);
1114 public static AudioTranslationFormat Simple { get; }
1115 public static AudioTranslationFormat Srt { get; }
1116 [EditorBrowsable(EditorBrowsableState.Never)]
1117 public static AudioTranslationFormat Text { get; }
1118 public static AudioTranslationFormat Verbose { get; }
1119 public static AudioTranslationFormat Vtt { get; }
1120 public readonly bool Equals(AudioTranslationFormat other);
1121 [EditorBrowsable(EditorBrowsableState.Never)]
1122 public override readonly bool Equals(object obj);
1123 [EditorBrowsable(EditorBrowsableState.Never)]
1124 public override readonly int GetHashCode();
1125 public static bool operator ==(AudioTranslationFormat left, AudioTranslationFormat right);
1126 public static implicit operator AudioTranslationFormat(string value);
1127 public static bool operator !=(AudioTranslationFormat left, AudioTranslationFormat right);
1128 public override readonly string ToString();
1129 }
1130 public class AudioTranslationOptions : IJsonModel<AudioTranslationOptions>, IPersistableModel<AudioTranslationOptions> {
1131 public string Prompt { get; set; }
1132 public AudioTranslationFormat? ResponseFormat { get; set; }
1133 public float? Temperature { get; set; }
1134 protected virtual AudioTranslationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1135 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1136 protected virtual AudioTranslationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1137 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1138 }
1139 public readonly partial struct GeneratedSpeechFormat : IEquatable<GeneratedSpeechFormat> {
1140 public GeneratedSpeechFormat(string value);
1141 public static GeneratedSpeechFormat Aac { get; }
1142 public static GeneratedSpeechFormat Flac { get; }
1143 public static GeneratedSpeechFormat Mp3 { get; }
1144 public static GeneratedSpeechFormat Opus { get; }
1145 public static GeneratedSpeechFormat Pcm { get; }
1146 public static GeneratedSpeechFormat Wav { get; }
1147 public readonly bool Equals(GeneratedSpeechFormat other);
1148 [EditorBrowsable(EditorBrowsableState.Never)]
1149 public override readonly bool Equals(object obj);
1150 [EditorBrowsable(EditorBrowsableState.Never)]
1151 public override readonly int GetHashCode();
1152 public static bool operator ==(GeneratedSpeechFormat left, GeneratedSpeechFormat right);
1153 public static implicit operator GeneratedSpeechFormat(string value);
1154 public static bool operator !=(GeneratedSpeechFormat left, GeneratedSpeechFormat right);
1155 public override readonly string ToString();
1156 }
1157 public readonly partial struct GeneratedSpeechVoice : IEquatable<GeneratedSpeechVoice> {
1158 public GeneratedSpeechVoice(string value);
1159 public static GeneratedSpeechVoice Alloy { get; }
1160 public static GeneratedSpeechVoice Ash { get; }
1161 public static GeneratedSpeechVoice Ballad { get; }
1162 public static GeneratedSpeechVoice Coral { get; }
1163 public static GeneratedSpeechVoice Echo { get; }
1164 public static GeneratedSpeechVoice Fable { get; }
1165 public static GeneratedSpeechVoice Nova { get; }
1166 public static GeneratedSpeechVoice Onyx { get; }
1167 public static GeneratedSpeechVoice Sage { get; }
1168 public static GeneratedSpeechVoice Shimmer { get; }
1169 public static GeneratedSpeechVoice Verse { get; }
1170 public readonly bool Equals(GeneratedSpeechVoice other);
1171 [EditorBrowsable(EditorBrowsableState.Never)]
1172 public override readonly bool Equals(object obj);
1173 [EditorBrowsable(EditorBrowsableState.Never)]
1174 public override readonly int GetHashCode();
1175 public static bool operator ==(GeneratedSpeechVoice left, GeneratedSpeechVoice right);
1176 public static implicit operator GeneratedSpeechVoice(string value);
1177 public static bool operator !=(GeneratedSpeechVoice left, GeneratedSpeechVoice right);
1178 public override readonly string ToString();
1179 }
1180 public static class OpenAIAudioModelFactory {
1181 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);
1182 [EditorBrowsable(EditorBrowsableState.Never)]
1183 public static AudioTranscription AudioTranscription(string language, TimeSpan? duration, string text, IEnumerable<TranscribedWord> words, IEnumerable<TranscribedSegment> segments);
1184 public static AudioTranslation AudioTranslation(string language = null, TimeSpan? duration = null, string text = null, IEnumerable<TranscribedSegment> segments = null);
1185 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);
1186 public static TranscribedWord TranscribedWord(string word = null, TimeSpan startTime = default, TimeSpan endTime = default);
1187 }
1188 public class SpeechGenerationOptions : IJsonModel<SpeechGenerationOptions>, IPersistableModel<SpeechGenerationOptions> {
1189 public string Instructions { get; set; }
1190 public GeneratedSpeechFormat? ResponseFormat { get; set; }
1191 public float? SpeedRatio { get; set; }
1192 protected virtual SpeechGenerationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1193 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1194 protected virtual SpeechGenerationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1195 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1196 }
1197 public class StreamingAudioTranscriptionTextDeltaUpdate : StreamingAudioTranscriptionUpdate, IJsonModel<StreamingAudioTranscriptionTextDeltaUpdate>, IPersistableModel<StreamingAudioTranscriptionTextDeltaUpdate> {
1198 public string Delta { get; }
1199 public IReadOnlyList<AudioTokenLogProbabilityDetails> TranscriptionTokenLogProbabilities { get; }
1200 protected override StreamingAudioTranscriptionUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1201 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1202 protected override StreamingAudioTranscriptionUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1203 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1204 }
1205 public class StreamingAudioTranscriptionTextDoneUpdate : StreamingAudioTranscriptionUpdate, IJsonModel<StreamingAudioTranscriptionTextDoneUpdate>, IPersistableModel<StreamingAudioTranscriptionTextDoneUpdate> {
1206 public string Text { get; }
1207 public IReadOnlyList<AudioTokenLogProbabilityDetails> TranscriptionTokenLogProbabilities { get; }
1208 protected override StreamingAudioTranscriptionUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1209 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1210 protected override StreamingAudioTranscriptionUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1211 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1212 }
1213 public class StreamingAudioTranscriptionUpdate : IJsonModel<StreamingAudioTranscriptionUpdate>, IPersistableModel<StreamingAudioTranscriptionUpdate> {
1214 protected virtual StreamingAudioTranscriptionUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1215 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1216 protected virtual StreamingAudioTranscriptionUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1217 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1218 }
1219 public readonly partial struct StreamingAudioTranscriptionUpdateKind : IEquatable<StreamingAudioTranscriptionUpdateKind> {
1220 public StreamingAudioTranscriptionUpdateKind(string value);
1221 public static StreamingAudioTranscriptionUpdateKind TranscriptTextDelta { get; }
1222 public static StreamingAudioTranscriptionUpdateKind TranscriptTextDone { get; }
1223 public readonly bool Equals(StreamingAudioTranscriptionUpdateKind other);
1224 [EditorBrowsable(EditorBrowsableState.Never)]
1225 public override readonly bool Equals(object obj);
1226 [EditorBrowsable(EditorBrowsableState.Never)]
1227 public override readonly int GetHashCode();
1228 public static bool operator ==(StreamingAudioTranscriptionUpdateKind left, StreamingAudioTranscriptionUpdateKind right);
1229 public static implicit operator StreamingAudioTranscriptionUpdateKind(string value);
1230 public static bool operator !=(StreamingAudioTranscriptionUpdateKind left, StreamingAudioTranscriptionUpdateKind right);
1231 public override readonly string ToString();
1232 }
1233 public readonly partial struct TranscribedSegment : IJsonModel<TranscribedSegment>, IPersistableModel<TranscribedSegment>, IJsonModel<object>, IPersistableModel<object> {
1234 public float AverageLogProbability { get; }
1235 public float CompressionRatio { get; }
1236 public TimeSpan EndTime { get; }
1237 public int Id { get; }
1238 public float NoSpeechProbability { get; }
1239 public int SeekOffset { get; }
1240 public TimeSpan StartTime { get; }
1241 public float Temperature { get; }
1242 public string Text { get; }
1243 public ReadOnlyMemory<int> TokenIds { get; }
1244 }
1245 public readonly partial struct TranscribedWord : IJsonModel<TranscribedWord>, IPersistableModel<TranscribedWord>, IJsonModel<object>, IPersistableModel<object> {
1246 public TimeSpan EndTime { get; }
1247 public TimeSpan StartTime { get; }
1248 public string Word { get; }
1249 }
1250}
1251namespace OpenAI.Batch {
1252 public class BatchClient {
1253 protected BatchClient();
1254 public BatchClient(ApiKeyCredential credential, OpenAIClientOptions options);
1255 public BatchClient(ApiKeyCredential credential);
1256 protected internal BatchClient(ClientPipeline pipeline, OpenAIClientOptions options);
1257 public BatchClient(string apiKey);
1258 public ClientPipeline Pipeline { get; }
1259 public virtual CreateBatchOperation CreateBatch(BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
1260 public virtual Task<CreateBatchOperation> CreateBatchAsync(BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
1261 public virtual CollectionResult GetBatches(string after, int? limit, RequestOptions options);
1262 public virtual AsyncCollectionResult GetBatchesAsync(string after, int? limit, RequestOptions options);
1263 }
1264 public class CreateBatchOperation : OperationResult {
1265 public string BatchId { get; }
1266 public override ContinuationToken? RehydrationToken { get; protected set; }
1267 public virtual ClientResult Cancel(RequestOptions? options);
1268 public virtual Task<ClientResult> CancelAsync(RequestOptions? options);
1269 public virtual ClientResult GetBatch(RequestOptions? options);
1270 public virtual Task<ClientResult> GetBatchAsync(RequestOptions? options);
1271 public static CreateBatchOperation Rehydrate(BatchClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
1272 public static CreateBatchOperation Rehydrate(BatchClient client, string batchId, CancellationToken cancellationToken = default);
1273 public static Task<CreateBatchOperation> RehydrateAsync(BatchClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
1274 public static Task<CreateBatchOperation> RehydrateAsync(BatchClient client, string batchId, CancellationToken cancellationToken = default);
1275 public override ClientResult UpdateStatus(RequestOptions? options = null);
1276 public override ValueTask<ClientResult> UpdateStatusAsync(RequestOptions? options = null);
1277 }
1278}
1279namespace OpenAI.Chat {
1280 public class AssistantChatMessage : ChatMessage, IJsonModel<AssistantChatMessage>, IPersistableModel<AssistantChatMessage> {
1281 public AssistantChatMessage(ChatCompletion chatCompletion);
1282 [Obsolete("This constructor is obsolete. Please use the constructor that takes an IEnumerable<ChatToolCall> parameter instead.")]
1283 public AssistantChatMessage(ChatFunctionCall functionCall);
1284 public AssistantChatMessage(params ChatMessageContentPart[] contentParts);
1285 public AssistantChatMessage(ChatOutputAudioReference outputAudioReference);
1286 public AssistantChatMessage(IEnumerable<ChatMessageContentPart> contentParts);
1287 public AssistantChatMessage(IEnumerable<ChatToolCall> toolCalls);
1288 public AssistantChatMessage(string content);
1289 [Obsolete("This property is obsolete. Please use ToolCalls instead.")]
1290 public ChatFunctionCall FunctionCall { get; set; }
1291 public ChatOutputAudioReference OutputAudioReference { get; set; }
1292 public string ParticipantName { get; set; }
1293 public string Refusal { get; set; }
1294 public IList<ChatToolCall> ToolCalls { get; }
1295 protected override ChatMessage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1296 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1297 protected override ChatMessage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1298 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1299 }
1300 public class ChatAudioOptions : IJsonModel<ChatAudioOptions>, IPersistableModel<ChatAudioOptions> {
1301 public ChatAudioOptions(ChatOutputAudioVoice outputAudioVoice, ChatOutputAudioFormat outputAudioFormat);
1302 public ChatOutputAudioFormat OutputAudioFormat { get; }
1303 public ChatOutputAudioVoice OutputAudioVoice { get; }
1304 protected virtual ChatAudioOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1305 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1306 protected virtual ChatAudioOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1307 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1308 }
1309 public class ChatClient {
1310 protected ChatClient();
1311 protected internal ChatClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
1312 public ChatClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
1313 public ChatClient(string model, ApiKeyCredential credential);
1314 public ChatClient(string model, string apiKey);
1315 public ClientPipeline Pipeline { get; }
1316 public virtual ClientResult<ChatCompletion> CompleteChat(params ChatMessage[] messages);
1317 [EditorBrowsable(EditorBrowsableState.Never)]
1318 public virtual ClientResult CompleteChat(BinaryContent content, RequestOptions options = null);
1319 public virtual ClientResult<ChatCompletion> CompleteChat(IEnumerable<ChatMessage> messages, ChatCompletionOptions options = null, CancellationToken cancellationToken = default);
1320 public virtual Task<ClientResult<ChatCompletion>> CompleteChatAsync(params ChatMessage[] messages);
1321 [EditorBrowsable(EditorBrowsableState.Never)]
1322 public virtual Task<ClientResult> CompleteChatAsync(BinaryContent content, RequestOptions options = null);
1323 public virtual Task<ClientResult<ChatCompletion>> CompleteChatAsync(IEnumerable<ChatMessage> messages, ChatCompletionOptions options = null, CancellationToken cancellationToken = default);
1324 public virtual CollectionResult<StreamingChatCompletionUpdate> CompleteChatStreaming(params ChatMessage[] messages);
1325 public virtual CollectionResult<StreamingChatCompletionUpdate> CompleteChatStreaming(IEnumerable<ChatMessage> messages, ChatCompletionOptions options = null, CancellationToken cancellationToken = default);
1326 public virtual AsyncCollectionResult<StreamingChatCompletionUpdate> CompleteChatStreamingAsync(params ChatMessage[] messages);
1327 public virtual AsyncCollectionResult<StreamingChatCompletionUpdate> CompleteChatStreamingAsync(IEnumerable<ChatMessage> messages, ChatCompletionOptions options = null, CancellationToken cancellationToken = default);
1328 public virtual ClientResult DeleteChatCompletion(string completionId, RequestOptions options);
1329 public virtual ClientResult<ChatCompletionDeletionResult> DeleteChatCompletion(string completionId, CancellationToken cancellationToken = default);
1330 public virtual Task<ClientResult> DeleteChatCompletionAsync(string completionId, RequestOptions options);
1331 public virtual Task<ClientResult<ChatCompletionDeletionResult>> DeleteChatCompletionAsync(string completionId, CancellationToken cancellationToken = default);
1332 public virtual ClientResult GetChatCompletion(string completionId, RequestOptions options);
1333 public virtual ClientResult<ChatCompletion> GetChatCompletion(string completionId, CancellationToken cancellationToken = default);
1334 public virtual Task<ClientResult> GetChatCompletionAsync(string completionId, RequestOptions options);
1335 public virtual Task<ClientResult<ChatCompletion>> GetChatCompletionAsync(string completionId, CancellationToken cancellationToken = default);
1336 }
1337 public class ChatCompletion : IJsonModel<ChatCompletion>, IPersistableModel<ChatCompletion> {
1338 public IReadOnlyList<ChatMessageAnnotation> Annotations { get; }
1339 public ChatMessageContent Content { get; }
1340 public IReadOnlyList<ChatTokenLogProbabilityDetails> ContentTokenLogProbabilities { get; }
1341 public DateTimeOffset CreatedAt { get; }
1342 public ChatFinishReason FinishReason { get; }
1343 [Obsolete("This property is obsolete. Please use ToolCalls instead.")]
1344 public ChatFunctionCall FunctionCall { get; }
1345 public string Id { get; }
1346 public string Model { get; }
1347 public ChatOutputAudio OutputAudio { get; }
1348 public string Refusal { get; }
1349 public IReadOnlyList<ChatTokenLogProbabilityDetails> RefusalTokenLogProbabilities { get; }
1350 public ChatMessageRole Role { get; }
1351 public string SystemFingerprint { get; }
1352 public IReadOnlyList<ChatToolCall> ToolCalls { get; }
1353 public ChatTokenUsage Usage { get; }
1354 protected virtual ChatCompletion JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1355 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1356 protected virtual ChatCompletion PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1357 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1358 }
1359 public class ChatCompletionDeletionResult : IJsonModel<ChatCompletionDeletionResult>, IPersistableModel<ChatCompletionDeletionResult> {
1360 public string ChatCompletionId { get; }
1361 public bool Deleted { get; }
1362 protected virtual ChatCompletionDeletionResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1363 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1364 protected virtual ChatCompletionDeletionResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1365 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1366 }
1367 public class ChatCompletionOptions : IJsonModel<ChatCompletionOptions>, IPersistableModel<ChatCompletionOptions> {
1368 public bool? AllowParallelToolCalls { get; set; }
1369 public ChatAudioOptions AudioOptions { get; set; }
1370 public string EndUserId { get; set; }
1371 public float? FrequencyPenalty { get; set; }
1372 [Obsolete("This property is obsolete. Please use ToolChoice instead.")]
1373 public ChatFunctionChoice FunctionChoice { get; set; }
1374 [Obsolete("This property is obsolete. Please use Tools instead.")]
1375 public IList<ChatFunction> Functions { get; }
1376 public bool? IncludeLogProbabilities { get; set; }
1377 public IDictionary<int, int> LogitBiases { get; }
1378 public int? MaxOutputTokenCount { get; set; }
1379 public IDictionary<string, string> Metadata { get; }
1380 public ChatOutputPrediction OutputPrediction { get; set; }
1381 public float? PresencePenalty { get; set; }
1382 public ChatReasoningEffortLevel? ReasoningEffortLevel { get; set; }
1383 public ChatResponseFormat ResponseFormat { get; set; }
1384 public ChatResponseModalities ResponseModalities { get; set; }
1385 public long? Seed { get; set; }
1386 public IList<string> StopSequences { get; }
1387 public bool? StoredOutputEnabled { get; set; }
1388 public float? Temperature { get; set; }
1389 public ChatToolChoice ToolChoice { get; set; }
1390 public IList<ChatTool> Tools { get; }
1391 public int? TopLogProbabilityCount { get; set; }
1392 public float? TopP { get; set; }
1393 public ChatWebSearchOptions WebSearchOptions { get; set; }
1394 protected virtual ChatCompletionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1395 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1396 protected virtual ChatCompletionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1397 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1398 }
1399 public enum ChatFinishReason {
1400 Stop = 0,
1401 Length = 1,
1402 ContentFilter = 2,
1403 ToolCalls = 3,
1404 FunctionCall = 4
1405 }
1406 [Obsolete("This class is obsolete. Please use ChatTool instead.")]
1407 public class ChatFunction : IJsonModel<ChatFunction>, IPersistableModel<ChatFunction> {
1408 public ChatFunction(string functionName);
1409 public string FunctionDescription { get; set; }
1410 public string FunctionName { get; }
1411 public BinaryData FunctionParameters { get; set; }
1412 protected virtual ChatFunction JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1413 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1414 protected virtual ChatFunction PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1415 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1416 }
1417 [Obsolete("This class is obsolete. Please use ChatToolCall instead.")]
1418 public class ChatFunctionCall : IJsonModel<ChatFunctionCall>, IPersistableModel<ChatFunctionCall> {
1419 public ChatFunctionCall(string functionName, BinaryData functionArguments);
1420 public BinaryData FunctionArguments { get; }
1421 public string FunctionName { get; }
1422 protected virtual ChatFunctionCall JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1423 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1424 protected virtual ChatFunctionCall PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1425 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1426 }
1427 [Obsolete("This class is obsolete. Please use ChatToolChoice instead.")]
1428 public class ChatFunctionChoice : IJsonModel<ChatFunctionChoice>, IPersistableModel<ChatFunctionChoice> {
1429 public static ChatFunctionChoice CreateAutoChoice();
1430 public static ChatFunctionChoice CreateNamedChoice(string functionName);
1431 public static ChatFunctionChoice CreateNoneChoice();
1432 protected virtual ChatFunctionChoice JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1433 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1434 protected virtual ChatFunctionChoice PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1435 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1436 }
1437 public readonly partial struct ChatImageDetailLevel : IEquatable<ChatImageDetailLevel> {
1438 public ChatImageDetailLevel(string value);
1439 public static ChatImageDetailLevel Auto { get; }
1440 public static ChatImageDetailLevel High { get; }
1441 public static ChatImageDetailLevel Low { get; }
1442 public readonly bool Equals(ChatImageDetailLevel other);
1443 [EditorBrowsable(EditorBrowsableState.Never)]
1444 public override readonly bool Equals(object obj);
1445 [EditorBrowsable(EditorBrowsableState.Never)]
1446 public override readonly int GetHashCode();
1447 public static bool operator ==(ChatImageDetailLevel left, ChatImageDetailLevel right);
1448 public static implicit operator ChatImageDetailLevel(string value);
1449 public static bool operator !=(ChatImageDetailLevel left, ChatImageDetailLevel right);
1450 public override readonly string ToString();
1451 }
1452 public readonly partial struct ChatInputAudioFormat : IEquatable<ChatInputAudioFormat> {
1453 public ChatInputAudioFormat(string value);
1454 public static ChatInputAudioFormat Mp3 { get; }
1455 public static ChatInputAudioFormat Wav { get; }
1456 public readonly bool Equals(ChatInputAudioFormat other);
1457 [EditorBrowsable(EditorBrowsableState.Never)]
1458 public override readonly bool Equals(object obj);
1459 [EditorBrowsable(EditorBrowsableState.Never)]
1460 public override readonly int GetHashCode();
1461 public static bool operator ==(ChatInputAudioFormat left, ChatInputAudioFormat right);
1462 public static implicit operator ChatInputAudioFormat(string value);
1463 public static bool operator !=(ChatInputAudioFormat left, ChatInputAudioFormat right);
1464 public override readonly string ToString();
1465 }
1466 public class ChatInputTokenUsageDetails : IJsonModel<ChatInputTokenUsageDetails>, IPersistableModel<ChatInputTokenUsageDetails> {
1467 public int AudioTokenCount { get; }
1468 public int CachedTokenCount { get; }
1469 protected virtual ChatInputTokenUsageDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1470 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1471 protected virtual ChatInputTokenUsageDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1472 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1473 }
1474 public class ChatMessage : IJsonModel<ChatMessage>, IPersistableModel<ChatMessage> {
1475 public ChatMessageContent Content { get; }
1476 public static AssistantChatMessage CreateAssistantMessage(ChatCompletion chatCompletion);
1477 public static AssistantChatMessage CreateAssistantMessage(ChatFunctionCall functionCall);
1478 public static AssistantChatMessage CreateAssistantMessage(params ChatMessageContentPart[] contentParts);
1479 public static AssistantChatMessage CreateAssistantMessage(ChatOutputAudioReference outputAudioReference);
1480 public static AssistantChatMessage CreateAssistantMessage(IEnumerable<ChatMessageContentPart> contentParts);
1481 public static AssistantChatMessage CreateAssistantMessage(IEnumerable<ChatToolCall> toolCalls);
1482 public static AssistantChatMessage CreateAssistantMessage(string content);
1483 public static DeveloperChatMessage CreateDeveloperMessage(params ChatMessageContentPart[] contentParts);
1484 public static DeveloperChatMessage CreateDeveloperMessage(IEnumerable<ChatMessageContentPart> contentParts);
1485 public static DeveloperChatMessage CreateDeveloperMessage(string content);
1486 [Obsolete("This method is obsolete. Please use CreateToolMessage instead.")]
1487 public static FunctionChatMessage CreateFunctionMessage(string functionName, string content);
1488 public static SystemChatMessage CreateSystemMessage(params ChatMessageContentPart[] contentParts);
1489 public static SystemChatMessage CreateSystemMessage(IEnumerable<ChatMessageContentPart> contentParts);
1490 public static SystemChatMessage CreateSystemMessage(string content);
1491 public static ToolChatMessage CreateToolMessage(string toolCallId, params ChatMessageContentPart[] contentParts);
1492 public static ToolChatMessage CreateToolMessage(string toolCallId, IEnumerable<ChatMessageContentPart> contentParts);
1493 public static ToolChatMessage CreateToolMessage(string toolCallId, string content);
1494 public static UserChatMessage CreateUserMessage(params ChatMessageContentPart[] contentParts);
1495 public static UserChatMessage CreateUserMessage(IEnumerable<ChatMessageContentPart> contentParts);
1496 public static UserChatMessage CreateUserMessage(string content);
1497 protected virtual ChatMessage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1498 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1499 public static implicit operator ChatMessage(string content);
1500 protected virtual ChatMessage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1501 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1502 }
1503 public class ChatMessageAnnotation : IJsonModel<ChatMessageAnnotation>, IPersistableModel<ChatMessageAnnotation> {
1504 public int EndIndex { get; }
1505 public int StartIndex { get; }
1506 public string WebResourceTitle { get; }
1507 public Uri WebResourceUri { get; }
1508 protected virtual ChatMessageAnnotation JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1509 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1510 protected virtual ChatMessageAnnotation PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1511 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1512 }
1513 public class ChatMessageContent : ObjectModel.Collection<ChatMessageContentPart> {
1514 public ChatMessageContent();
1515 public ChatMessageContent(params ChatMessageContentPart[] contentParts);
1516 public ChatMessageContent(IEnumerable<ChatMessageContentPart> contentParts);
1517 public ChatMessageContent(string content);
1518 }
1519 public class ChatMessageContentPart : IJsonModel<ChatMessageContentPart>, IPersistableModel<ChatMessageContentPart> {
1520 public BinaryData FileBytes { get; }
1521 public string FileBytesMediaType { get; }
1522 public string FileId { get; }
1523 public string Filename { get; }
1524 public BinaryData ImageBytes { get; }
1525 public string ImageBytesMediaType { get; }
1526 public ChatImageDetailLevel? ImageDetailLevel { get; }
1527 public Uri ImageUri { get; }
1528 public BinaryData InputAudioBytes { get; }
1529 public ChatInputAudioFormat? InputAudioFormat { get; }
1530 public ChatMessageContentPartKind Kind { get; }
1531 public string Refusal { get; }
1532 public string Text { get; }
1533 public static ChatMessageContentPart CreateFilePart(BinaryData fileBytes, string fileBytesMediaType, string filename);
1534 public static ChatMessageContentPart CreateFilePart(string fileId);
1535 public static ChatMessageContentPart CreateImagePart(BinaryData imageBytes, string imageBytesMediaType, ChatImageDetailLevel? imageDetailLevel = null);
1536 public static ChatMessageContentPart CreateImagePart(Uri imageUri, ChatImageDetailLevel? imageDetailLevel = null);
1537 public static ChatMessageContentPart CreateInputAudioPart(BinaryData inputAudioBytes, ChatInputAudioFormat inputAudioFormat);
1538 public static ChatMessageContentPart CreateRefusalPart(string refusal);
1539 public static ChatMessageContentPart CreateTextPart(string text);
1540 protected virtual ChatMessageContentPart JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1541 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1542 public static implicit operator ChatMessageContentPart(string text);
1543 protected virtual ChatMessageContentPart PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1544 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1545 }
1546 public enum ChatMessageContentPartKind {
1547 Text = 0,
1548 Refusal = 1,
1549 Image = 2,
1550 InputAudio = 3,
1551 File = 4
1552 }
1553 public enum ChatMessageRole {
1554 System = 0,
1555 User = 1,
1556 Assistant = 2,
1557 Tool = 3,
1558 Function = 4,
1559 Developer = 5
1560 }
1561 public class ChatOutputAudio : IJsonModel<ChatOutputAudio>, IPersistableModel<ChatOutputAudio> {
1562 public BinaryData AudioBytes { get; }
1563 public DateTimeOffset ExpiresAt { get; }
1564 public string Id { get; }
1565 public string Transcript { get; }
1566 protected virtual ChatOutputAudio JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1567 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1568 protected virtual ChatOutputAudio PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1569 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1570 }
1571 public readonly partial struct ChatOutputAudioFormat : IEquatable<ChatOutputAudioFormat> {
1572 public ChatOutputAudioFormat(string value);
1573 public static ChatOutputAudioFormat Aac { get; }
1574 public static ChatOutputAudioFormat Flac { get; }
1575 public static ChatOutputAudioFormat Mp3 { get; }
1576 public static ChatOutputAudioFormat Opus { get; }
1577 public static ChatOutputAudioFormat Pcm16 { get; }
1578 public static ChatOutputAudioFormat Wav { get; }
1579 public readonly bool Equals(ChatOutputAudioFormat other);
1580 [EditorBrowsable(EditorBrowsableState.Never)]
1581 public override readonly bool Equals(object obj);
1582 [EditorBrowsable(EditorBrowsableState.Never)]
1583 public override readonly int GetHashCode();
1584 public static bool operator ==(ChatOutputAudioFormat left, ChatOutputAudioFormat right);
1585 public static implicit operator ChatOutputAudioFormat(string value);
1586 public static bool operator !=(ChatOutputAudioFormat left, ChatOutputAudioFormat right);
1587 public override readonly string ToString();
1588 }
1589 public class ChatOutputAudioReference : IJsonModel<ChatOutputAudioReference>, IPersistableModel<ChatOutputAudioReference> {
1590 public ChatOutputAudioReference(string id);
1591 public string Id { get; }
1592 protected virtual ChatOutputAudioReference JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1593 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1594 protected virtual ChatOutputAudioReference PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1595 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1596 }
1597 public readonly partial struct ChatOutputAudioVoice : IEquatable<ChatOutputAudioVoice> {
1598 public ChatOutputAudioVoice(string value);
1599 public static ChatOutputAudioVoice Alloy { get; }
1600 public static ChatOutputAudioVoice Ash { get; }
1601 public static ChatOutputAudioVoice Ballad { get; }
1602 public static ChatOutputAudioVoice Coral { get; }
1603 public static ChatOutputAudioVoice Echo { get; }
1604 public static ChatOutputAudioVoice Fable { get; }
1605 public static ChatOutputAudioVoice Nova { get; }
1606 public static ChatOutputAudioVoice Onyx { get; }
1607 public static ChatOutputAudioVoice Sage { get; }
1608 public static ChatOutputAudioVoice Shimmer { get; }
1609 public static ChatOutputAudioVoice Verse { get; }
1610 public readonly bool Equals(ChatOutputAudioVoice other);
1611 [EditorBrowsable(EditorBrowsableState.Never)]
1612 public override readonly bool Equals(object obj);
1613 [EditorBrowsable(EditorBrowsableState.Never)]
1614 public override readonly int GetHashCode();
1615 public static bool operator ==(ChatOutputAudioVoice left, ChatOutputAudioVoice right);
1616 public static implicit operator ChatOutputAudioVoice(string value);
1617 public static bool operator !=(ChatOutputAudioVoice left, ChatOutputAudioVoice right);
1618 public override readonly string ToString();
1619 }
1620 public class ChatOutputPrediction : IJsonModel<ChatOutputPrediction>, IPersistableModel<ChatOutputPrediction> {
1621 public static ChatOutputPrediction CreateStaticContentPrediction(IEnumerable<ChatMessageContentPart> staticContentParts);
1622 public static ChatOutputPrediction CreateStaticContentPrediction(string staticContent);
1623 protected virtual ChatOutputPrediction JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1624 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1625 protected virtual ChatOutputPrediction PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1626 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1627 }
1628 public class ChatOutputTokenUsageDetails : IJsonModel<ChatOutputTokenUsageDetails>, IPersistableModel<ChatOutputTokenUsageDetails> {
1629 public int AcceptedPredictionTokenCount { get; }
1630 public int AudioTokenCount { get; }
1631 public int ReasoningTokenCount { get; }
1632 public int RejectedPredictionTokenCount { get; }
1633 protected virtual ChatOutputTokenUsageDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1634 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1635 protected virtual ChatOutputTokenUsageDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1636 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1637 }
1638 public readonly partial struct ChatReasoningEffortLevel : IEquatable<ChatReasoningEffortLevel> {
1639 public ChatReasoningEffortLevel(string value);
1640 public static ChatReasoningEffortLevel High { get; }
1641 public static ChatReasoningEffortLevel Low { get; }
1642 public static ChatReasoningEffortLevel Medium { get; }
1643 public readonly bool Equals(ChatReasoningEffortLevel other);
1644 [EditorBrowsable(EditorBrowsableState.Never)]
1645 public override readonly bool Equals(object obj);
1646 [EditorBrowsable(EditorBrowsableState.Never)]
1647 public override readonly int GetHashCode();
1648 public static bool operator ==(ChatReasoningEffortLevel left, ChatReasoningEffortLevel right);
1649 public static implicit operator ChatReasoningEffortLevel(string value);
1650 public static bool operator !=(ChatReasoningEffortLevel left, ChatReasoningEffortLevel right);
1651 public override readonly string ToString();
1652 }
1653 public class ChatResponseFormat : IJsonModel<ChatResponseFormat>, IPersistableModel<ChatResponseFormat> {
1654 public static ChatResponseFormat CreateJsonObjectFormat();
1655 public static ChatResponseFormat CreateJsonSchemaFormat(string jsonSchemaFormatName, BinaryData jsonSchema, string jsonSchemaFormatDescription = null, bool? jsonSchemaIsStrict = null);
1656 public static ChatResponseFormat CreateTextFormat();
1657 protected virtual ChatResponseFormat JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1658 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1659 protected virtual ChatResponseFormat PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1660 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1661 }
1662 [Flags]
1663 public enum ChatResponseModalities {
1664 Default = 0,
1665 Text = 1,
1666 Audio = 2
1667 }
1668 public class ChatTokenLogProbabilityDetails : IJsonModel<ChatTokenLogProbabilityDetails>, IPersistableModel<ChatTokenLogProbabilityDetails> {
1669 public float LogProbability { get; }
1670 public string Token { get; }
1671 public IReadOnlyList<ChatTokenTopLogProbabilityDetails> TopLogProbabilities { get; }
1672 public ReadOnlyMemory<byte>? Utf8Bytes { get; }
1673 protected virtual ChatTokenLogProbabilityDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1674 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1675 protected virtual ChatTokenLogProbabilityDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1676 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1677 }
1678 public class ChatTokenTopLogProbabilityDetails : IJsonModel<ChatTokenTopLogProbabilityDetails>, IPersistableModel<ChatTokenTopLogProbabilityDetails> {
1679 public float LogProbability { get; }
1680 public string Token { get; }
1681 public ReadOnlyMemory<byte>? Utf8Bytes { get; }
1682 protected virtual ChatTokenTopLogProbabilityDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1683 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1684 protected virtual ChatTokenTopLogProbabilityDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1685 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1686 }
1687 public class ChatTokenUsage : IJsonModel<ChatTokenUsage>, IPersistableModel<ChatTokenUsage> {
1688 public int InputTokenCount { get; }
1689 public ChatInputTokenUsageDetails InputTokenDetails { get; }
1690 public int OutputTokenCount { get; }
1691 public ChatOutputTokenUsageDetails OutputTokenDetails { get; }
1692 public int TotalTokenCount { get; }
1693 protected virtual ChatTokenUsage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1694 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1695 protected virtual ChatTokenUsage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1696 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1697 }
1698 public class ChatTool : IJsonModel<ChatTool>, IPersistableModel<ChatTool> {
1699 public string FunctionDescription { get; }
1700 public string FunctionName { get; }
1701 public BinaryData FunctionParameters { get; }
1702 public bool? FunctionSchemaIsStrict { get; }
1703 public ChatToolKind Kind { get; }
1704 public static ChatTool CreateFunctionTool(string functionName, string functionDescription = null, BinaryData functionParameters = null, bool? functionSchemaIsStrict = null);
1705 protected virtual ChatTool JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1706 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1707 protected virtual ChatTool PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1708 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1709 }
1710 public class ChatToolCall : IJsonModel<ChatToolCall>, IPersistableModel<ChatToolCall> {
1711 public BinaryData FunctionArguments { get; }
1712 public string FunctionName { get; }
1713 public string Id { get; set; }
1714 public ChatToolCallKind Kind { get; }
1715 public static ChatToolCall CreateFunctionToolCall(string id, string functionName, BinaryData functionArguments);
1716 protected virtual ChatToolCall JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1717 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1718 protected virtual ChatToolCall PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1719 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1720 }
1721 public enum ChatToolCallKind {
1722 Function = 0
1723 }
1724 public class ChatToolChoice : IJsonModel<ChatToolChoice>, IPersistableModel<ChatToolChoice> {
1725 public static ChatToolChoice CreateAutoChoice();
1726 public static ChatToolChoice CreateFunctionChoice(string functionName);
1727 public static ChatToolChoice CreateNoneChoice();
1728 public static ChatToolChoice CreateRequiredChoice();
1729 protected virtual ChatToolChoice JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1730 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1731 protected virtual ChatToolChoice PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1732 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1733 }
1734 public enum ChatToolKind {
1735 Function = 0
1736 }
1737 public class ChatWebSearchOptions : IJsonModel<ChatWebSearchOptions>, IPersistableModel<ChatWebSearchOptions> {
1738 protected virtual ChatWebSearchOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1739 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1740 protected virtual ChatWebSearchOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1741 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1742 }
1743 public class DeveloperChatMessage : ChatMessage, IJsonModel<DeveloperChatMessage>, IPersistableModel<DeveloperChatMessage> {
1744 public DeveloperChatMessage(params ChatMessageContentPart[] contentParts);
1745 public DeveloperChatMessage(IEnumerable<ChatMessageContentPart> contentParts);
1746 public DeveloperChatMessage(string content);
1747 public string ParticipantName { get; set; }
1748 protected override ChatMessage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1749 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1750 protected override ChatMessage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1751 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1752 }
1753 [Obsolete("This class is obsolete. Please use ToolChatMessage instead.")]
1754 public class FunctionChatMessage : ChatMessage, IJsonModel<FunctionChatMessage>, IPersistableModel<FunctionChatMessage> {
1755 public FunctionChatMessage(string functionName, string content);
1756 public string FunctionName { get; }
1757 protected override ChatMessage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1758 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1759 protected override ChatMessage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1760 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1761 }
1762 public static class OpenAIChatModelFactory {
1763 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, string systemFingerprint = null, ChatTokenUsage usage = null, ChatOutputAudio outputAudio = null, IEnumerable<ChatMessageAnnotation> messageAnnotations = null);
1764 [EditorBrowsable(EditorBrowsableState.Never)]
1765 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);
1766 public static ChatInputTokenUsageDetails ChatInputTokenUsageDetails(int audioTokenCount = 0, int cachedTokenCount = 0);
1767 public static ChatMessageAnnotation ChatMessageAnnotation(int startIndex = 0, int endIndex = 0, Uri webResourceUri = null, string webResourceTitle = null);
1768 public static ChatOutputAudio ChatOutputAudio(BinaryData audioBytes, string id = null, string transcript = null, DateTimeOffset expiresAt = default);
1769 public static ChatOutputTokenUsageDetails ChatOutputTokenUsageDetails(int reasoningTokenCount = 0, int audioTokenCount = 0, int acceptedPredictionTokenCount = 0, int rejectedPredictionTokenCount = 0);
1770 [EditorBrowsable(EditorBrowsableState.Never)]
1771 public static ChatOutputTokenUsageDetails ChatOutputTokenUsageDetails(int reasoningTokenCount, int audioTokenCount);
1772 [EditorBrowsable(EditorBrowsableState.Never)]
1773 public static ChatOutputTokenUsageDetails ChatOutputTokenUsageDetails(int reasoningTokenCount);
1774 public static ChatTokenLogProbabilityDetails ChatTokenLogProbabilityDetails(string token = null, float logProbability = 0, ReadOnlyMemory<byte>? utf8Bytes = null, IEnumerable<ChatTokenTopLogProbabilityDetails> topLogProbabilities = null);
1775 public static ChatTokenTopLogProbabilityDetails ChatTokenTopLogProbabilityDetails(string token = null, float logProbability = 0, ReadOnlyMemory<byte>? utf8Bytes = null);
1776 public static ChatTokenUsage ChatTokenUsage(int outputTokenCount = 0, int inputTokenCount = 0, int totalTokenCount = 0, ChatOutputTokenUsageDetails outputTokenDetails = null, ChatInputTokenUsageDetails inputTokenDetails = null);
1777 [EditorBrowsable(EditorBrowsableState.Never)]
1778 public static ChatTokenUsage ChatTokenUsage(int outputTokenCount, int inputTokenCount, int totalTokenCount, ChatOutputTokenUsageDetails outputTokenDetails);
1779 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, string systemFingerprint = null, ChatTokenUsage usage = null, StreamingChatOutputAudioUpdate outputAudioUpdate = null);
1780 [EditorBrowsable(EditorBrowsableState.Never)]
1781 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);
1782 [Obsolete("This class is obsolete. Please use StreamingChatToolCallUpdate instead.")]
1783 public static StreamingChatFunctionCallUpdate StreamingChatFunctionCallUpdate(string functionName = null, BinaryData functionArgumentsUpdate = null);
1784 public static StreamingChatOutputAudioUpdate StreamingChatOutputAudioUpdate(string id = null, DateTimeOffset? expiresAt = null, string transcriptUpdate = null, BinaryData audioBytesUpdate = null);
1785 public static StreamingChatToolCallUpdate StreamingChatToolCallUpdate(int index = 0, string toolCallId = null, ChatToolCallKind kind = ChatToolCallKind.Function, string functionName = null, BinaryData functionArgumentsUpdate = null);
1786 }
1787 public class StreamingChatCompletionUpdate : IJsonModel<StreamingChatCompletionUpdate>, IPersistableModel<StreamingChatCompletionUpdate> {
1788 public string CompletionId { get; }
1789 public IReadOnlyList<ChatTokenLogProbabilityDetails> ContentTokenLogProbabilities { get; }
1790 public ChatMessageContent ContentUpdate { get; }
1791 public DateTimeOffset CreatedAt { get; }
1792 public ChatFinishReason? FinishReason { get; }
1793 [Obsolete("This property is obsolete. Please use ToolCallUpdates instead.")]
1794 public StreamingChatFunctionCallUpdate FunctionCallUpdate { get; }
1795 public string Model { get; }
1796 public StreamingChatOutputAudioUpdate OutputAudioUpdate { get; }
1797 public IReadOnlyList<ChatTokenLogProbabilityDetails> RefusalTokenLogProbabilities { get; }
1798 public string RefusalUpdate { get; }
1799 public ChatMessageRole? Role { get; }
1800 public string SystemFingerprint { get; }
1801 public IReadOnlyList<StreamingChatToolCallUpdate> ToolCallUpdates { get; }
1802 public ChatTokenUsage Usage { get; }
1803 protected virtual StreamingChatCompletionUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1804 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1805 protected virtual StreamingChatCompletionUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1806 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1807 }
1808 [Obsolete("This class is obsolete. Please use StreamingChatToolCallUpdate instead.")]
1809 public class StreamingChatFunctionCallUpdate : IJsonModel<StreamingChatFunctionCallUpdate>, IPersistableModel<StreamingChatFunctionCallUpdate> {
1810 public BinaryData FunctionArgumentsUpdate { get; }
1811 public string FunctionName { get; }
1812 protected virtual StreamingChatFunctionCallUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1813 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1814 protected virtual StreamingChatFunctionCallUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1815 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1816 }
1817 public class StreamingChatOutputAudioUpdate : IJsonModel<StreamingChatOutputAudioUpdate>, IPersistableModel<StreamingChatOutputAudioUpdate> {
1818 public BinaryData AudioBytesUpdate { get; }
1819 public DateTimeOffset? ExpiresAt { get; }
1820 public string Id { get; }
1821 public string TranscriptUpdate { get; }
1822 protected virtual StreamingChatOutputAudioUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1823 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1824 protected virtual StreamingChatOutputAudioUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1825 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1826 }
1827 public class StreamingChatToolCallUpdate : IJsonModel<StreamingChatToolCallUpdate>, IPersistableModel<StreamingChatToolCallUpdate> {
1828 public BinaryData FunctionArgumentsUpdate { get; }
1829 public string FunctionName { get; }
1830 public int Index { get; }
1831 public ChatToolCallKind Kind { get; }
1832 public string ToolCallId { get; }
1833 protected virtual StreamingChatToolCallUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1834 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1835 protected virtual StreamingChatToolCallUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1836 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1837 }
1838 public class SystemChatMessage : ChatMessage, IJsonModel<SystemChatMessage>, IPersistableModel<SystemChatMessage> {
1839 public SystemChatMessage(params ChatMessageContentPart[] contentParts);
1840 public SystemChatMessage(IEnumerable<ChatMessageContentPart> contentParts);
1841 public SystemChatMessage(string content);
1842 public string ParticipantName { get; set; }
1843 protected override ChatMessage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1844 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1845 protected override ChatMessage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1846 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1847 }
1848 public class ToolChatMessage : ChatMessage, IJsonModel<ToolChatMessage>, IPersistableModel<ToolChatMessage> {
1849 public ToolChatMessage(string toolCallId, params ChatMessageContentPart[] contentParts);
1850 public ToolChatMessage(string toolCallId, IEnumerable<ChatMessageContentPart> contentParts);
1851 public ToolChatMessage(string toolCallId, string content);
1852 public string ToolCallId { get; }
1853 protected override ChatMessage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1854 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1855 protected override ChatMessage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1856 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1857 }
1858 public class UserChatMessage : ChatMessage, IJsonModel<UserChatMessage>, IPersistableModel<UserChatMessage> {
1859 public UserChatMessage(params ChatMessageContentPart[] contentParts);
1860 public UserChatMessage(IEnumerable<ChatMessageContentPart> contentParts);
1861 public UserChatMessage(string content);
1862 public string ParticipantName { get; set; }
1863 protected override ChatMessage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1864 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1865 protected override ChatMessage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1866 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1867 }
1868}
1869namespace OpenAI.Embeddings {
1870 public class EmbeddingClient {
1871 protected EmbeddingClient();
1872 protected internal EmbeddingClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
1873 public EmbeddingClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
1874 public EmbeddingClient(string model, ApiKeyCredential credential);
1875 public EmbeddingClient(string model, string apiKey);
1876 public ClientPipeline Pipeline { get; }
1877 public virtual ClientResult<OpenAIEmbedding> GenerateEmbedding(string input, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
1878 public virtual Task<ClientResult<OpenAIEmbedding>> GenerateEmbeddingAsync(string input, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
1879 [EditorBrowsable(EditorBrowsableState.Never)]
1880 public virtual ClientResult GenerateEmbeddings(BinaryContent content, RequestOptions options = null);
1881 public virtual ClientResult<OpenAIEmbeddingCollection> GenerateEmbeddings(IEnumerable<ReadOnlyMemory<int>> inputs, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
1882 public virtual ClientResult<OpenAIEmbeddingCollection> GenerateEmbeddings(IEnumerable<string> inputs, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
1883 [EditorBrowsable(EditorBrowsableState.Never)]
1884 public virtual Task<ClientResult> GenerateEmbeddingsAsync(BinaryContent content, RequestOptions options = null);
1885 public virtual Task<ClientResult<OpenAIEmbeddingCollection>> GenerateEmbeddingsAsync(IEnumerable<ReadOnlyMemory<int>> inputs, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
1886 public virtual Task<ClientResult<OpenAIEmbeddingCollection>> GenerateEmbeddingsAsync(IEnumerable<string> inputs, EmbeddingGenerationOptions options = null, CancellationToken cancellationToken = default);
1887 }
1888 public class EmbeddingGenerationOptions : IJsonModel<EmbeddingGenerationOptions>, IPersistableModel<EmbeddingGenerationOptions> {
1889 public int? Dimensions { get; set; }
1890 public string EndUserId { get; set; }
1891 protected virtual EmbeddingGenerationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1892 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1893 protected virtual EmbeddingGenerationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1894 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1895 }
1896 public class EmbeddingTokenUsage : IJsonModel<EmbeddingTokenUsage>, IPersistableModel<EmbeddingTokenUsage> {
1897 public int InputTokenCount { get; }
1898 public int TotalTokenCount { get; }
1899 protected virtual EmbeddingTokenUsage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1900 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1901 protected virtual EmbeddingTokenUsage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1902 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1903 }
1904 public class OpenAIEmbedding : IJsonModel<OpenAIEmbedding>, IPersistableModel<OpenAIEmbedding> {
1905 public int Index { get; }
1906 protected virtual OpenAIEmbedding JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1907 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1908 protected virtual OpenAIEmbedding PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1909 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1910 public ReadOnlyMemory<float> ToFloats();
1911 }
1912 public class OpenAIEmbeddingCollection : ObjectModel.ReadOnlyCollection<OpenAIEmbedding>, IJsonModel<OpenAIEmbeddingCollection>, IPersistableModel<OpenAIEmbeddingCollection> {
1913 public string Model { get; }
1914 public EmbeddingTokenUsage Usage { get; }
1915 protected virtual OpenAIEmbeddingCollection JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1916 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1917 protected virtual OpenAIEmbeddingCollection PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1918 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1919 }
1920 public static class OpenAIEmbeddingsModelFactory {
1921 public static EmbeddingTokenUsage EmbeddingTokenUsage(int inputTokenCount = 0, int totalTokenCount = 0);
1922 public static OpenAIEmbedding OpenAIEmbedding(int index = 0, IEnumerable<float> vector = null);
1923 public static OpenAIEmbeddingCollection OpenAIEmbeddingCollection(IEnumerable<OpenAIEmbedding> items = null, string model = null, EmbeddingTokenUsage usage = null);
1924 }
1925}
1926namespace OpenAI.Evals {
1927 public class EvaluationClient {
1928 protected EvaluationClient();
1929 public EvaluationClient(ApiKeyCredential credential, OpenAIClientOptions options);
1930 public EvaluationClient(ApiKeyCredential credential);
1931 protected internal EvaluationClient(ClientPipeline pipeline, OpenAIClientOptions options);
1932 public EvaluationClient(string apiKey);
1933 public ClientPipeline Pipeline { get; }
1934 public virtual ClientResult CancelEvaluationRun(string evaluationId, string evaluationRunId, RequestOptions options);
1935 public virtual Task<ClientResult> CancelEvaluationRunAsync(string evaluationId, string evaluationRunId, RequestOptions options);
1936 public virtual ClientResult CreateEvaluation(BinaryContent content, RequestOptions options = null);
1937 public virtual Task<ClientResult> CreateEvaluationAsync(BinaryContent content, RequestOptions options = null);
1938 public virtual ClientResult CreateEvaluationRun(string evaluationId, BinaryContent content, RequestOptions options = null);
1939 public virtual Task<ClientResult> CreateEvaluationRunAsync(string evaluationId, BinaryContent content, RequestOptions options = null);
1940 public virtual ClientResult DeleteEvaluation(string evaluationId, RequestOptions options);
1941 public virtual Task<ClientResult> DeleteEvaluationAsync(string evaluationId, RequestOptions options);
1942 public virtual ClientResult DeleteEvaluationRun(string evaluationId, string evaluationRunId, RequestOptions options);
1943 public virtual Task<ClientResult> DeleteEvaluationRunAsync(string evaluationId, string evaluationRunId, RequestOptions options);
1944 public virtual ClientResult GetEvaluation(string evaluationId, RequestOptions options);
1945 public virtual Task<ClientResult> GetEvaluationAsync(string evaluationId, RequestOptions options);
1946 public virtual ClientResult GetEvaluationRun(string evaluationId, string evaluationRunId, RequestOptions options);
1947 public virtual Task<ClientResult> GetEvaluationRunAsync(string evaluationId, string evaluationRunId, RequestOptions options);
1948 public virtual ClientResult GetEvaluationRunOutputItem(string evaluationId, string evaluationRunId, string outputItemId, RequestOptions options);
1949 public virtual Task<ClientResult> GetEvaluationRunOutputItemAsync(string evaluationId, string evaluationRunId, string outputItemId, RequestOptions options);
1950 public virtual ClientResult GetEvaluationRunOutputItems(string evaluationId, string evaluationRunId, int? limit, string order, string after, string outputItemStatus, RequestOptions options);
1951 public virtual Task<ClientResult> GetEvaluationRunOutputItemsAsync(string evaluationId, string evaluationRunId, int? limit, string order, string after, string outputItemStatus, RequestOptions options);
1952 public virtual ClientResult GetEvaluationRuns(string evaluationId, int? limit, string order, string after, string evaluationRunStatus, RequestOptions options);
1953 public virtual Task<ClientResult> GetEvaluationRunsAsync(string evaluationId, int? limit, string order, string after, string evaluationRunStatus, RequestOptions options);
1954 public virtual ClientResult GetEvaluations(int? limit, string orderBy, string order, string after, RequestOptions options);
1955 public virtual Task<ClientResult> GetEvaluationsAsync(int? limit, string orderBy, string order, string after, RequestOptions options);
1956 public virtual ClientResult UpdateEvaluation(string evaluationId, BinaryContent content, RequestOptions options = null);
1957 public virtual Task<ClientResult> UpdateEvaluationAsync(string evaluationId, BinaryContent content, RequestOptions options = null);
1958 }
1959}
1960namespace OpenAI.Files {
1961 public class FileDeletionResult : IJsonModel<FileDeletionResult>, IPersistableModel<FileDeletionResult> {
1962 public bool Deleted { get; }
1963 public string FileId { get; }
1964 protected virtual FileDeletionResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
1965 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
1966 protected virtual FileDeletionResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
1967 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
1968 }
1969 public enum FilePurpose {
1970 Assistants = 0,
1971 AssistantsOutput = 1,
1972 Batch = 2,
1973 BatchOutput = 3,
1974 FineTune = 4,
1975 FineTuneResults = 5,
1976 Vision = 6,
1977 UserData = 7,
1978 Evaluations = 8
1979 }
1980 [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.")]
1981 public enum FileStatus {
1982 Uploaded = 0,
1983 Processed = 1,
1984 Error = 2
1985 }
1986 public readonly partial struct FileUploadPurpose : IEquatable<FileUploadPurpose> {
1987 public FileUploadPurpose(string value);
1988 public static FileUploadPurpose Assistants { get; }
1989 public static FileUploadPurpose Batch { get; }
1990 public static FileUploadPurpose Evaluations { get; }
1991 public static FileUploadPurpose FineTune { get; }
1992 public static FileUploadPurpose UserData { get; }
1993 public static FileUploadPurpose Vision { get; }
1994 public readonly bool Equals(FileUploadPurpose other);
1995 [EditorBrowsable(EditorBrowsableState.Never)]
1996 public override readonly bool Equals(object obj);
1997 [EditorBrowsable(EditorBrowsableState.Never)]
1998 public override readonly int GetHashCode();
1999 public static bool operator ==(FileUploadPurpose left, FileUploadPurpose right);
2000 public static implicit operator FileUploadPurpose(string value);
2001 public static bool operator !=(FileUploadPurpose left, FileUploadPurpose right);
2002 public override readonly string ToString();
2003 }
2004 public class OpenAIFile : IJsonModel<OpenAIFile>, IPersistableModel<OpenAIFile> {
2005 public DateTimeOffset CreatedAt { get; }
2006 public DateTimeOffset? ExpiresAt { get; }
2007 public string Filename { get; }
2008 public string Id { get; }
2009 public FilePurpose Purpose { get; }
2010 [EditorBrowsable(EditorBrowsableState.Never)]
2011 public int? SizeInBytes { get; }
2012 public long? SizeInBytesLong { get; }
2013 [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.")]
2014 public FileStatus Status { get; }
2015 [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.")]
2016 public string StatusDetails { get; }
2017 protected virtual OpenAIFile JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2018 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2019 protected virtual OpenAIFile PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2020 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2021 }
2022 public class OpenAIFileClient {
2023 protected OpenAIFileClient();
2024 public OpenAIFileClient(ApiKeyCredential credential, OpenAIClientOptions options);
2025 public OpenAIFileClient(ApiKeyCredential credential);
2026 protected internal OpenAIFileClient(ClientPipeline pipeline, OpenAIClientOptions options);
2027 public OpenAIFileClient(string apiKey);
2028 public ClientPipeline Pipeline { get; }
2029 public virtual ClientResult AddUploadPart(string uploadId, BinaryContent content, string contentType, RequestOptions options = null);
2030 public virtual Task<ClientResult> AddUploadPartAsync(string uploadId, BinaryContent content, string contentType, RequestOptions options = null);
2031 public virtual ClientResult CancelUpload(string uploadId, RequestOptions options = null);
2032 public virtual Task<ClientResult> CancelUploadAsync(string uploadId, RequestOptions options = null);
2033 public virtual ClientResult CompleteUpload(string uploadId, BinaryContent content, RequestOptions options = null);
2034 public virtual Task<ClientResult> CompleteUploadAsync(string uploadId, BinaryContent content, RequestOptions options = null);
2035 public virtual ClientResult CreateUpload(BinaryContent content, RequestOptions options = null);
2036 public virtual Task<ClientResult> CreateUploadAsync(BinaryContent content, RequestOptions options = null);
2037 [EditorBrowsable(EditorBrowsableState.Never)]
2038 public virtual ClientResult DeleteFile(string fileId, RequestOptions options);
2039 public virtual ClientResult<FileDeletionResult> DeleteFile(string fileId, CancellationToken cancellationToken = default);
2040 [EditorBrowsable(EditorBrowsableState.Never)]
2041 public virtual Task<ClientResult> DeleteFileAsync(string fileId, RequestOptions options);
2042 public virtual Task<ClientResult<FileDeletionResult>> DeleteFileAsync(string fileId, CancellationToken cancellationToken = default);
2043 [EditorBrowsable(EditorBrowsableState.Never)]
2044 public virtual ClientResult DownloadFile(string fileId, RequestOptions options);
2045 public virtual ClientResult<BinaryData> DownloadFile(string fileId, CancellationToken cancellationToken = default);
2046 [EditorBrowsable(EditorBrowsableState.Never)]
2047 public virtual Task<ClientResult> DownloadFileAsync(string fileId, RequestOptions options);
2048 public virtual Task<ClientResult<BinaryData>> DownloadFileAsync(string fileId, CancellationToken cancellationToken = default);
2049 [EditorBrowsable(EditorBrowsableState.Never)]
2050 public virtual ClientResult GetFile(string fileId, RequestOptions options);
2051 public virtual ClientResult<OpenAIFile> GetFile(string fileId, CancellationToken cancellationToken = default);
2052 [EditorBrowsable(EditorBrowsableState.Never)]
2053 public virtual Task<ClientResult> GetFileAsync(string fileId, RequestOptions options);
2054 public virtual Task<ClientResult<OpenAIFile>> GetFileAsync(string fileId, CancellationToken cancellationToken = default);
2055 public virtual ClientResult<OpenAIFileCollection> GetFiles(FilePurpose purpose, CancellationToken cancellationToken = default);
2056 [EditorBrowsable(EditorBrowsableState.Never)]
2057 public virtual ClientResult GetFiles(string purpose, RequestOptions options);
2058 public virtual ClientResult<OpenAIFileCollection> GetFiles(CancellationToken cancellationToken = default);
2059 public virtual Task<ClientResult<OpenAIFileCollection>> GetFilesAsync(FilePurpose purpose, CancellationToken cancellationToken = default);
2060 [EditorBrowsable(EditorBrowsableState.Never)]
2061 public virtual Task<ClientResult> GetFilesAsync(string purpose, RequestOptions options);
2062 public virtual Task<ClientResult<OpenAIFileCollection>> GetFilesAsync(CancellationToken cancellationToken = default);
2063 public virtual ClientResult<OpenAIFile> UploadFile(BinaryData file, string filename, FileUploadPurpose purpose);
2064 [EditorBrowsable(EditorBrowsableState.Never)]
2065 public virtual ClientResult UploadFile(BinaryContent content, string contentType, RequestOptions options = null);
2066 public virtual ClientResult<OpenAIFile> UploadFile(Stream file, string filename, FileUploadPurpose purpose, CancellationToken cancellationToken = default);
2067 public virtual ClientResult<OpenAIFile> UploadFile(string filePath, FileUploadPurpose purpose);
2068 public virtual Task<ClientResult<OpenAIFile>> UploadFileAsync(BinaryData file, string filename, FileUploadPurpose purpose);
2069 [EditorBrowsable(EditorBrowsableState.Never)]
2070 public virtual Task<ClientResult> UploadFileAsync(BinaryContent content, string contentType, RequestOptions options = null);
2071 public virtual Task<ClientResult<OpenAIFile>> UploadFileAsync(Stream file, string filename, FileUploadPurpose purpose, CancellationToken cancellationToken = default);
2072 public virtual Task<ClientResult<OpenAIFile>> UploadFileAsync(string filePath, FileUploadPurpose purpose);
2073 }
2074 public class OpenAIFileCollection : ObjectModel.ReadOnlyCollection<OpenAIFile>, IJsonModel<OpenAIFileCollection>, IPersistableModel<OpenAIFileCollection> {
2075 protected virtual OpenAIFileCollection JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2076 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2077 protected virtual OpenAIFileCollection PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2078 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2079 }
2080 public static class OpenAIFilesModelFactory {
2081 public static FileDeletionResult FileDeletionResult(string fileId = null, bool deleted = false);
2082 public static OpenAIFileCollection OpenAIFileCollection(IEnumerable<OpenAIFile> items = null);
2083 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);
2084 [EditorBrowsable(EditorBrowsableState.Never)]
2085 public static OpenAIFile OpenAIFileInfo(string id, int? sizeInBytes, DateTimeOffset createdAt, string filename, FilePurpose purpose, FileStatus status, string statusDetails);
2086 }
2087}
2088namespace OpenAI.FineTuning {
2089 public class FineTuningCheckpoint : IJsonModel<FineTuningCheckpoint>, IPersistableModel<FineTuningCheckpoint> {
2090 public DateTimeOffset CreatedAt { get; }
2091 public string Id { get; }
2092 public string JobId { get; }
2093 public FineTuningCheckpointMetrics Metrics { get; }
2094 public string ModelId { get; }
2095 public int StepNumber { get; }
2096 protected virtual FineTuningCheckpoint JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2097 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2098 protected virtual FineTuningCheckpoint PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2099 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2100 public override string ToString();
2101 }
2102 public class FineTuningCheckpointMetrics : IJsonModel<FineTuningCheckpointMetrics>, IPersistableModel<FineTuningCheckpointMetrics> {
2103 public float? FullValidLoss { get; }
2104 public float? FullValidMeanTokenAccuracy { get; }
2105 public int StepNumber { get; }
2106 public float? TrainLoss { get; }
2107 public float? TrainMeanTokenAccuracy { get; }
2108 public float? ValidLoss { get; }
2109 public float? ValidMeanTokenAccuracy { get; }
2110 protected virtual FineTuningCheckpointMetrics JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2111 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2112 protected virtual FineTuningCheckpointMetrics PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2113 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2114 }
2115 public class FineTuningClient {
2116 protected FineTuningClient();
2117 public FineTuningClient(ApiKeyCredential credential, OpenAIClientOptions options);
2118 public FineTuningClient(ApiKeyCredential credential);
2119 protected internal FineTuningClient(ClientPipeline pipeline, OpenAIClientOptions options);
2120 protected internal FineTuningClient(ClientPipeline pipeline, Uri endpoint);
2121 public FineTuningClient(string apiKey);
2122 public ClientPipeline Pipeline { get; }
2123 public virtual ClientResult CreateFineTuningCheckpointPermission(string fineTunedModelCheckpoint, BinaryContent content, RequestOptions options = null);
2124 public virtual Task<ClientResult> CreateFineTuningCheckpointPermissionAsync(string fineTunedModelCheckpoint, BinaryContent content, RequestOptions options = null);
2125 public virtual ClientResult DeleteFineTuningCheckpointPermission(string fineTunedModelCheckpoint, string permissionId, RequestOptions options);
2126 public virtual Task<ClientResult> DeleteFineTuningCheckpointPermissionAsync(string fineTunedModelCheckpoint, string permissionId, RequestOptions options);
2127 public virtual FineTuningJob FineTune(BinaryContent content, bool waitUntilCompleted, RequestOptions options);
2128 public virtual FineTuningJob FineTune(string baseModel, string trainingFileId, bool waitUntilCompleted, FineTuningOptions options = null, CancellationToken cancellationToken = default);
2129 public virtual Task<FineTuningJob> FineTuneAsync(BinaryContent content, bool waitUntilCompleted, RequestOptions options);
2130 public virtual Task<FineTuningJob> FineTuneAsync(string baseModel, string trainingFileId, bool waitUntilCompleted, FineTuningOptions options = null, CancellationToken cancellationToken = default);
2131 public virtual ClientResult GetFineTuningCheckpointPermissions(string fineTunedModelCheckpoint, string after, int? limit, string order, string projectId, RequestOptions options);
2132 public virtual Task<ClientResult> GetFineTuningCheckpointPermissionsAsync(string fineTunedModelCheckpoint, string after, int? limit, string order, string projectId, RequestOptions options);
2133 public virtual FineTuningJob GetJob(string jobId, CancellationToken cancellationToken = default);
2134 public virtual Task<FineTuningJob> GetJobAsync(string jobId, CancellationToken cancellationToken = default);
2135 public virtual CollectionResult<FineTuningJob> GetJobs(FineTuningJobCollectionOptions options = null, CancellationToken cancellationToken = default);
2136 public virtual AsyncCollectionResult<FineTuningJob> GetJobsAsync(FineTuningJobCollectionOptions options = null, CancellationToken cancellationToken = default);
2137 public virtual ClientResult PauseFineTuningJob(string fineTuningJobId, RequestOptions options);
2138 public virtual Task<ClientResult> PauseFineTuningJobAsync(string fineTuningJobId, RequestOptions options);
2139 public virtual ClientResult ResumeFineTuningJob(string fineTuningJobId, RequestOptions options);
2140 public virtual Task<ClientResult> ResumeFineTuningJobAsync(string fineTuningJobId, RequestOptions options);
2141 }
2142 public class FineTuningError : IJsonModel<FineTuningError>, IPersistableModel<FineTuningError> {
2143 public string Code { get; }
2144 public string InvalidParameter { get; }
2145 public string Message { get; }
2146 protected virtual FineTuningError JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2147 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2148 protected virtual FineTuningError PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2149 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2150 }
2151 public class FineTuningEvent : IJsonModel<FineTuningEvent>, IPersistableModel<FineTuningEvent> {
2152 public string Level;
2153 public DateTimeOffset CreatedAt { get; }
2154 public BinaryData Data { get; }
2155 public string Id { get; }
2156 public FineTuningJobEventKind? Kind { get; }
2157 public string Message { get; }
2158 protected virtual FineTuningEvent JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2159 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2160 protected virtual FineTuningEvent PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2161 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2162 }
2163 public readonly partial struct FineTuningHyperparameters : IJsonModel<FineTuningHyperparameters>, IPersistableModel<FineTuningHyperparameters>, IJsonModel<object>, IPersistableModel<object> {
2164 public int BatchSize { get; }
2165 public int EpochCount { get; }
2166 public float LearningRateMultiplier { get; }
2167 }
2168 public class FineTuningIntegration : IJsonModel<FineTuningIntegration>, IPersistableModel<FineTuningIntegration> {
2169 protected virtual FineTuningIntegration JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2170 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2171 protected virtual FineTuningIntegration PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2172 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2173 }
2174 public class FineTuningJob : OperationResult {
2175 public string? Value;
2176 public string BaseModel { get; }
2177 public int BillableTrainedTokenCount { get; }
2178 public DateTimeOffset? EstimatedFinishAt { get; }
2179 [Obsolete("This property is deprecated. Use the MethodHyperparameters property instead.")]
2180 public FineTuningHyperparameters Hyperparameters { get; }
2181 public IReadOnlyList<FineTuningIntegration> Integrations { get; }
2182 public string JobId { get; }
2183 public IDictionary<string, string> Metadata { get; }
2184 public MethodHyperparameters? MethodHyperparameters { get; }
2185 public override ContinuationToken? RehydrationToken { get; protected set; }
2186 public IReadOnlyList<string> ResultFileIds { get; }
2187 public int? Seed { get; }
2188 public FineTuningStatus Status { get; }
2189 public string TrainingFileId { get; }
2190 public FineTuningTrainingMethod? TrainingMethod { get; }
2191 public string? UserProvidedSuffix { get; }
2192 public string ValidationFileId { get; }
2193 public virtual ClientResult Cancel(RequestOptions options);
2194 public virtual ClientResult CancelAndUpdate(CancellationToken cancellationToken = default);
2195 public virtual Task<ClientResult> CancelAndUpdateAsync(CancellationToken cancellationToken = default);
2196 public virtual Task<ClientResult> CancelAsync(RequestOptions options);
2197 public virtual CollectionResult<FineTuningCheckpoint> GetCheckpoints(GetCheckpointsOptions? options = null, CancellationToken cancellationToken = default);
2198 public virtual CollectionResult GetCheckpoints(string? after, int? limit, RequestOptions? options);
2199 public virtual AsyncCollectionResult<FineTuningCheckpoint> GetCheckpointsAsync(GetCheckpointsOptions? options = null, CancellationToken cancellationToken = default);
2200 public virtual AsyncCollectionResult GetCheckpointsAsync(string? after, int? limit, RequestOptions? options);
2201 public virtual CollectionResult<FineTuningEvent> GetEvents(GetEventsOptions options, CancellationToken cancellationToken = default);
2202 public virtual CollectionResult GetEvents(string? after, int? limit, RequestOptions options);
2203 public virtual AsyncCollectionResult<FineTuningEvent> GetEventsAsync(GetEventsOptions options, CancellationToken cancellationToken = default);
2204 public virtual AsyncCollectionResult GetEventsAsync(string? after, int? limit, RequestOptions options);
2205 public static FineTuningJob Rehydrate(FineTuningClient client, ContinuationToken rehydrationToken, RequestOptions options);
2206 public static FineTuningJob Rehydrate(FineTuningClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
2207 public static FineTuningJob Rehydrate(FineTuningClient client, string JobId, RequestOptions options);
2208 public static FineTuningJob Rehydrate(FineTuningClient client, string JobId, CancellationToken cancellationToken = default);
2209 public static Task<FineTuningJob> RehydrateAsync(FineTuningClient client, ContinuationToken rehydrationToken, RequestOptions options);
2210 public static Task<FineTuningJob> RehydrateAsync(FineTuningClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
2211 public static Task<FineTuningJob> RehydrateAsync(FineTuningClient client, string JobId, RequestOptions options);
2212 public static Task<FineTuningJob> RehydrateAsync(FineTuningClient client, string JobId, CancellationToken cancellationToken = default);
2213 public override ClientResult UpdateStatus(RequestOptions? options);
2214 public ClientResult UpdateStatus(CancellationToken cancellationToken = default);
2215 public override ValueTask<ClientResult> UpdateStatusAsync(RequestOptions? options);
2216 public ValueTask<ClientResult> UpdateStatusAsync(CancellationToken cancellationToken = default);
2217 public override void WaitForCompletion(CancellationToken cancellationToken = default);
2218 public override ValueTask WaitForCompletionAsync(CancellationToken cancellationToken = default);
2219 }
2220 public class FineTuningJobCollectionOptions {
2221 public string AfterJobId { get; set; }
2222 public int? PageSize { get; set; }
2223 }
2224 public readonly partial struct FineTuningJobEventKind : IEquatable<FineTuningJobEventKind> {
2225 public FineTuningJobEventKind(string value);
2226 public static FineTuningJobEventKind Message { get; }
2227 public static FineTuningJobEventKind Metrics { get; }
2228 public readonly bool Equals(FineTuningJobEventKind other);
2229 [EditorBrowsable(EditorBrowsableState.Never)]
2230 public override readonly bool Equals(object obj);
2231 [EditorBrowsable(EditorBrowsableState.Never)]
2232 public override readonly int GetHashCode();
2233 public static bool operator ==(FineTuningJobEventKind left, FineTuningJobEventKind right);
2234 public static implicit operator FineTuningJobEventKind(string value);
2235 public static bool operator !=(FineTuningJobEventKind left, FineTuningJobEventKind right);
2236 public override readonly string ToString();
2237 }
2238 public class FineTuningOptions : IJsonModel<FineTuningOptions>, IPersistableModel<FineTuningOptions> {
2239 public IList<FineTuningIntegration> Integrations { get; }
2240 public IDictionary<string, string> Metadata { get; }
2241 public int? Seed { get; set; }
2242 public string Suffix { get; set; }
2243 public FineTuningTrainingMethod TrainingMethod { get; set; }
2244 public string ValidationFile { get; set; }
2245 protected virtual FineTuningOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2246 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2247 protected virtual FineTuningOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2248 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2249 }
2250 public readonly partial struct FineTuningStatus : IEquatable<string>, IEquatable<FineTuningStatus> {
2251 public FineTuningStatus(string value);
2252 public static FineTuningStatus Cancelled { get; }
2253 public static FineTuningStatus Failed { get; }
2254 public bool InProgress { get; }
2255 public static FineTuningStatus Queued { get; }
2256 public static FineTuningStatus Running { get; }
2257 public static FineTuningStatus Succeeded { get; }
2258 public static FineTuningStatus ValidatingFiles { get; }
2259 public readonly bool Equals(FineTuningStatus other);
2260 [EditorBrowsable(EditorBrowsableState.Never)]
2261 public override readonly bool Equals(object obj);
2262 public readonly bool Equals(string other);
2263 [EditorBrowsable(EditorBrowsableState.Never)]
2264 public override readonly int GetHashCode();
2265 public static bool operator ==(FineTuningStatus left, FineTuningStatus right);
2266 public static implicit operator FineTuningStatus(string value);
2267 public static bool operator !=(FineTuningStatus left, FineTuningStatus right);
2268 public override readonly string ToString();
2269 }
2270 public class FineTuningTrainingMethod : IJsonModel<FineTuningTrainingMethod>, IPersistableModel<FineTuningTrainingMethod> {
2271 public static FineTuningTrainingMethod CreateDirectPreferenceOptimization(HyperparameterBatchSize batchSize = null, HyperparameterEpochCount epochCount = null, HyperparameterLearningRate learningRate = null, HyperparameterBetaFactor betaFactor = null);
2272 public static FineTuningTrainingMethod CreateSupervised(HyperparameterBatchSize batchSize = null, HyperparameterEpochCount epochCount = null, HyperparameterLearningRate learningRate = null);
2273 protected virtual FineTuningTrainingMethod JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2274 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2275 protected virtual FineTuningTrainingMethod PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2276 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2277 }
2278 public class GetCheckpointsOptions {
2279 public string AfterCheckpointId { get; set; }
2280 public int? PageSize { get; set; }
2281 }
2282 public class GetEventsOptions {
2283 public string AfterEventId { get; set; }
2284 public int? PageSize { get; set; }
2285 }
2286 public class HyperparameterBatchSize : IEquatable<int>, IEquatable<string>, IJsonModel<HyperparameterBatchSize>, IPersistableModel<HyperparameterBatchSize> {
2287 public HyperparameterBatchSize(int batchSize);
2288 public static HyperparameterBatchSize CreateAuto();
2289 public static HyperparameterBatchSize CreateSize(int batchSize);
2290 [EditorBrowsable(EditorBrowsableState.Never)]
2291 public bool Equals(int other);
2292 [EditorBrowsable(EditorBrowsableState.Never)]
2293 public override bool Equals(object other);
2294 [EditorBrowsable(EditorBrowsableState.Never)]
2295 public bool Equals(string other);
2296 [EditorBrowsable(EditorBrowsableState.Never)]
2297 public override int GetHashCode();
2298 [EditorBrowsable(EditorBrowsableState.Never)]
2299 public static bool operator ==(HyperparameterBatchSize first, HyperparameterBatchSize second);
2300 public static implicit operator HyperparameterBatchSize(int batchSize);
2301 [EditorBrowsable(EditorBrowsableState.Never)]
2302 public static bool operator !=(HyperparameterBatchSize first, HyperparameterBatchSize second);
2303 }
2304 public class HyperparameterBetaFactor : IEquatable<int>, IEquatable<string>, IJsonModel<HyperparameterBetaFactor>, IPersistableModel<HyperparameterBetaFactor> {
2305 public HyperparameterBetaFactor(int beta);
2306 public static HyperparameterBetaFactor CreateAuto();
2307 public static HyperparameterBetaFactor CreateBeta(int beta);
2308 [EditorBrowsable(EditorBrowsableState.Never)]
2309 public bool Equals(int other);
2310 [EditorBrowsable(EditorBrowsableState.Never)]
2311 public override bool Equals(object other);
2312 [EditorBrowsable(EditorBrowsableState.Never)]
2313 public bool Equals(string other);
2314 [EditorBrowsable(EditorBrowsableState.Never)]
2315 public override int GetHashCode();
2316 [EditorBrowsable(EditorBrowsableState.Never)]
2317 public static bool operator ==(HyperparameterBetaFactor first, HyperparameterBetaFactor second);
2318 public static implicit operator HyperparameterBetaFactor(int beta);
2319 [EditorBrowsable(EditorBrowsableState.Never)]
2320 public static bool operator !=(HyperparameterBetaFactor first, HyperparameterBetaFactor second);
2321 }
2322 public class HyperparameterEpochCount : IEquatable<int>, IEquatable<string>, IJsonModel<HyperparameterEpochCount>, IPersistableModel<HyperparameterEpochCount> {
2323 public HyperparameterEpochCount(int epochCount);
2324 public static HyperparameterEpochCount CreateAuto();
2325 public static HyperparameterEpochCount CreateEpochCount(int epochCount);
2326 [EditorBrowsable(EditorBrowsableState.Never)]
2327 public bool Equals(int other);
2328 [EditorBrowsable(EditorBrowsableState.Never)]
2329 public override bool Equals(object other);
2330 [EditorBrowsable(EditorBrowsableState.Never)]
2331 public bool Equals(string other);
2332 [EditorBrowsable(EditorBrowsableState.Never)]
2333 public override int GetHashCode();
2334 [EditorBrowsable(EditorBrowsableState.Never)]
2335 public static bool operator ==(HyperparameterEpochCount first, HyperparameterEpochCount second);
2336 public static implicit operator HyperparameterEpochCount(int epochCount);
2337 [EditorBrowsable(EditorBrowsableState.Never)]
2338 public static bool operator !=(HyperparameterEpochCount first, HyperparameterEpochCount second);
2339 }
2340 public class HyperparameterLearningRate : IEquatable<double>, IEquatable<int>, IEquatable<string>, IJsonModel<HyperparameterLearningRate>, IPersistableModel<HyperparameterLearningRate> {
2341 public HyperparameterLearningRate(double learningRateMultiplier);
2342 public static HyperparameterLearningRate CreateAuto();
2343 public static HyperparameterLearningRate CreateMultiplier(double learningRateMultiplier);
2344 [EditorBrowsable(EditorBrowsableState.Never)]
2345 public bool Equals(double other);
2346 [EditorBrowsable(EditorBrowsableState.Never)]
2347 public bool Equals(int other);
2348 [EditorBrowsable(EditorBrowsableState.Never)]
2349 public override bool Equals(object other);
2350 [EditorBrowsable(EditorBrowsableState.Never)]
2351 public bool Equals(string other);
2352 [EditorBrowsable(EditorBrowsableState.Never)]
2353 public override int GetHashCode();
2354 [EditorBrowsable(EditorBrowsableState.Never)]
2355 public static bool operator ==(HyperparameterLearningRate first, HyperparameterLearningRate second);
2356 public static implicit operator HyperparameterLearningRate(double learningRateMultiplier);
2357 [EditorBrowsable(EditorBrowsableState.Never)]
2358 public static bool operator !=(HyperparameterLearningRate first, HyperparameterLearningRate second);
2359 }
2360 public class HyperparametersForDPO : MethodHyperparameters, IJsonModel<HyperparametersForDPO>, IPersistableModel<HyperparametersForDPO> {
2361 public int BatchSize { get; }
2362 public float Beta { get; }
2363 public int EpochCount { get; }
2364 public float LearningRateMultiplier { get; }
2365 protected virtual HyperparametersForDPO JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2366 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2367 protected virtual HyperparametersForDPO PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2368 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2369 }
2370 public class HyperparametersForSupervised : MethodHyperparameters, IJsonModel<HyperparametersForSupervised>, IPersistableModel<HyperparametersForSupervised> {
2371 public int BatchSize { get; }
2372 public int EpochCount { get; }
2373 public float LearningRateMultiplier { get; }
2374 protected virtual HyperparametersForSupervised JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2375 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2376 protected virtual HyperparametersForSupervised PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2377 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2378 }
2379 public class MethodHyperparameters {
2380 }
2381 public class WeightsAndBiasesIntegration : FineTuningIntegration, IJsonModel<WeightsAndBiasesIntegration>, IPersistableModel<WeightsAndBiasesIntegration> {
2382 public WeightsAndBiasesIntegration(string projectName);
2383 public string DisplayName { get; set; }
2384 public string EntityName { get; set; }
2385 public string ProjectName { get; set; }
2386 public IList<string> Tags { get; }
2387 protected override FineTuningIntegration JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2388 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2389 protected override FineTuningIntegration PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2390 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2391 }
2392}
2393namespace OpenAI.Images {
2394 public class GeneratedImage : IJsonModel<GeneratedImage>, IPersistableModel<GeneratedImage> {
2395 public BinaryData ImageBytes { get; }
2396 public Uri ImageUri { get; }
2397 public string RevisedPrompt { get; }
2398 protected virtual GeneratedImage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2399 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2400 protected virtual GeneratedImage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2401 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2402 }
2403 public readonly partial struct GeneratedImageBackground : IEquatable<GeneratedImageBackground> {
2404 public GeneratedImageBackground(string value);
2405 public static GeneratedImageBackground Auto { get; }
2406 public static GeneratedImageBackground Opaque { get; }
2407 public static GeneratedImageBackground Transparent { get; }
2408 public readonly bool Equals(GeneratedImageBackground other);
2409 [EditorBrowsable(EditorBrowsableState.Never)]
2410 public override readonly bool Equals(object obj);
2411 [EditorBrowsable(EditorBrowsableState.Never)]
2412 public override readonly int GetHashCode();
2413 public static bool operator ==(GeneratedImageBackground left, GeneratedImageBackground right);
2414 public static implicit operator GeneratedImageBackground(string value);
2415 public static bool operator !=(GeneratedImageBackground left, GeneratedImageBackground right);
2416 public override readonly string ToString();
2417 }
2418 public class GeneratedImageCollection : ObjectModel.ReadOnlyCollection<GeneratedImage>, IJsonModel<GeneratedImageCollection>, IPersistableModel<GeneratedImageCollection> {
2419 public DateTimeOffset CreatedAt { get; }
2420 public ImageTokenUsage Usage { get; }
2421 protected virtual GeneratedImageCollection JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2422 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2423 protected virtual GeneratedImageCollection PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2424 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2425 }
2426 public readonly partial struct GeneratedImageFileFormat : IEquatable<GeneratedImageFileFormat> {
2427 public GeneratedImageFileFormat(string value);
2428 public static GeneratedImageFileFormat Jpeg { get; }
2429 public static GeneratedImageFileFormat Png { get; }
2430 public static GeneratedImageFileFormat Webp { get; }
2431 public readonly bool Equals(GeneratedImageFileFormat other);
2432 [EditorBrowsable(EditorBrowsableState.Never)]
2433 public override readonly bool Equals(object obj);
2434 [EditorBrowsable(EditorBrowsableState.Never)]
2435 public override readonly int GetHashCode();
2436 public static bool operator ==(GeneratedImageFileFormat left, GeneratedImageFileFormat right);
2437 public static implicit operator GeneratedImageFileFormat(string value);
2438 public static bool operator !=(GeneratedImageFileFormat left, GeneratedImageFileFormat right);
2439 public override readonly string ToString();
2440 }
2441 public readonly partial struct GeneratedImageFormat : IEquatable<GeneratedImageFormat> {
2442 public GeneratedImageFormat(string value);
2443 public static GeneratedImageFormat Bytes { get; }
2444 public static GeneratedImageFormat Uri { get; }
2445 public readonly bool Equals(GeneratedImageFormat other);
2446 [EditorBrowsable(EditorBrowsableState.Never)]
2447 public override readonly bool Equals(object obj);
2448 [EditorBrowsable(EditorBrowsableState.Never)]
2449 public override readonly int GetHashCode();
2450 public static bool operator ==(GeneratedImageFormat left, GeneratedImageFormat right);
2451 public static implicit operator GeneratedImageFormat(string value);
2452 public static bool operator !=(GeneratedImageFormat left, GeneratedImageFormat right);
2453 public override readonly string ToString();
2454 }
2455 public readonly partial struct GeneratedImageModerationLevel : IEquatable<GeneratedImageModerationLevel> {
2456 public GeneratedImageModerationLevel(string value);
2457 public static GeneratedImageModerationLevel Auto { get; }
2458 public static GeneratedImageModerationLevel Low { get; }
2459 public readonly bool Equals(GeneratedImageModerationLevel other);
2460 [EditorBrowsable(EditorBrowsableState.Never)]
2461 public override readonly bool Equals(object obj);
2462 [EditorBrowsable(EditorBrowsableState.Never)]
2463 public override readonly int GetHashCode();
2464 public static bool operator ==(GeneratedImageModerationLevel left, GeneratedImageModerationLevel right);
2465 public static implicit operator GeneratedImageModerationLevel(string value);
2466 public static bool operator !=(GeneratedImageModerationLevel left, GeneratedImageModerationLevel right);
2467 public override readonly string ToString();
2468 }
2469 public readonly partial struct GeneratedImageQuality : IEquatable<GeneratedImageQuality> {
2470 public GeneratedImageQuality(string value);
2471 public static GeneratedImageQuality Auto { get; }
2472 public static GeneratedImageQuality High { get; }
2473 public static GeneratedImageQuality Low { get; }
2474 public static GeneratedImageQuality Medium { get; }
2475 public static GeneratedImageQuality Standard { get; }
2476 public readonly bool Equals(GeneratedImageQuality other);
2477 [EditorBrowsable(EditorBrowsableState.Never)]
2478 public override readonly bool Equals(object obj);
2479 [EditorBrowsable(EditorBrowsableState.Never)]
2480 public override readonly int GetHashCode();
2481 public static bool operator ==(GeneratedImageQuality left, GeneratedImageQuality right);
2482 public static implicit operator GeneratedImageQuality(string value);
2483 public static bool operator !=(GeneratedImageQuality left, GeneratedImageQuality right);
2484 public override readonly string ToString();
2485 }
2486 public readonly partial struct GeneratedImageSize : IEquatable<GeneratedImageSize> {
2487 public static readonly GeneratedImageSize W1024xH1024;
2488 public static readonly GeneratedImageSize W1024xH1536;
2489 public static readonly GeneratedImageSize W1024xH1792;
2490 public static readonly GeneratedImageSize W1536xH1024;
2491 public static readonly GeneratedImageSize W1792xH1024;
2492 public static readonly GeneratedImageSize W256xH256;
2493 public static readonly GeneratedImageSize W512xH512;
2494 public GeneratedImageSize(int width, int height);
2495 public static GeneratedImageSize Auto { get; }
2496 public readonly bool Equals(GeneratedImageSize other);
2497 [EditorBrowsable(EditorBrowsableState.Never)]
2498 public override readonly bool Equals(object obj);
2499 [EditorBrowsable(EditorBrowsableState.Never)]
2500 public override readonly int GetHashCode();
2501 public static bool operator ==(GeneratedImageSize left, GeneratedImageSize right);
2502 public static bool operator !=(GeneratedImageSize left, GeneratedImageSize right);
2503 public override readonly string ToString();
2504 }
2505 public readonly partial struct GeneratedImageStyle : IEquatable<GeneratedImageStyle> {
2506 public GeneratedImageStyle(string value);
2507 public static GeneratedImageStyle Natural { get; }
2508 public static GeneratedImageStyle Vivid { get; }
2509 public readonly bool Equals(GeneratedImageStyle other);
2510 [EditorBrowsable(EditorBrowsableState.Never)]
2511 public override readonly bool Equals(object obj);
2512 [EditorBrowsable(EditorBrowsableState.Never)]
2513 public override readonly int GetHashCode();
2514 public static bool operator ==(GeneratedImageStyle left, GeneratedImageStyle right);
2515 public static implicit operator GeneratedImageStyle(string value);
2516 public static bool operator !=(GeneratedImageStyle left, GeneratedImageStyle right);
2517 public override readonly string ToString();
2518 }
2519 public class ImageClient {
2520 protected ImageClient();
2521 protected internal ImageClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
2522 public ImageClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
2523 public ImageClient(string model, ApiKeyCredential credential);
2524 public ImageClient(string model, string apiKey);
2525 public ClientPipeline Pipeline { get; }
2526 public virtual ClientResult<GeneratedImage> GenerateImage(string prompt, ImageGenerationOptions options = null, CancellationToken cancellationToken = default);
2527 public virtual Task<ClientResult<GeneratedImage>> GenerateImageAsync(string prompt, ImageGenerationOptions options = null, CancellationToken cancellationToken = default);
2528 public virtual ClientResult<GeneratedImage> GenerateImageEdit(Stream image, string imageFilename, string prompt, ImageEditOptions options = null, CancellationToken cancellationToken = default);
2529 public virtual ClientResult<GeneratedImage> GenerateImageEdit(Stream image, string imageFilename, string prompt, Stream mask, string maskFilename, ImageEditOptions options = null, CancellationToken cancellationToken = default);
2530 public virtual ClientResult<GeneratedImage> GenerateImageEdit(string imageFilePath, string prompt, ImageEditOptions options = null);
2531 public virtual ClientResult<GeneratedImage> GenerateImageEdit(string imageFilePath, string prompt, string maskFilePath, ImageEditOptions options = null);
2532 public virtual Task<ClientResult<GeneratedImage>> GenerateImageEditAsync(Stream image, string imageFilename, string prompt, ImageEditOptions options = null, CancellationToken cancellationToken = default);
2533 public virtual Task<ClientResult<GeneratedImage>> GenerateImageEditAsync(Stream image, string imageFilename, string prompt, Stream mask, string maskFilename, ImageEditOptions options = null, CancellationToken cancellationToken = default);
2534 public virtual Task<ClientResult<GeneratedImage>> GenerateImageEditAsync(string imageFilePath, string prompt, ImageEditOptions options = null);
2535 public virtual Task<ClientResult<GeneratedImage>> GenerateImageEditAsync(string imageFilePath, string prompt, string maskFilePath, ImageEditOptions options = null);
2536 [EditorBrowsable(EditorBrowsableState.Never)]
2537 public virtual ClientResult GenerateImageEdits(BinaryContent content, string contentType, RequestOptions options = null);
2538 public virtual ClientResult<GeneratedImageCollection> GenerateImageEdits(Stream image, string imageFilename, string prompt, int imageCount, ImageEditOptions options = null, CancellationToken cancellationToken = default);
2539 public virtual ClientResult<GeneratedImageCollection> GenerateImageEdits(Stream image, string imageFilename, string prompt, Stream mask, string maskFilename, int imageCount, ImageEditOptions options = null, CancellationToken cancellationToken = default);
2540 public virtual ClientResult<GeneratedImageCollection> GenerateImageEdits(string imageFilePath, string prompt, int imageCount, ImageEditOptions options = null);
2541 public virtual ClientResult<GeneratedImageCollection> GenerateImageEdits(string imageFilePath, string prompt, string maskFilePath, int imageCount, ImageEditOptions options = null);
2542 [EditorBrowsable(EditorBrowsableState.Never)]
2543 public virtual Task<ClientResult> GenerateImageEditsAsync(BinaryContent content, string contentType, RequestOptions options = null);
2544 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageEditsAsync(Stream image, string imageFilename, string prompt, int imageCount, ImageEditOptions options = null, CancellationToken cancellationToken = default);
2545 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageEditsAsync(Stream image, string imageFilename, string prompt, Stream mask, string maskFilename, int imageCount, ImageEditOptions options = null, CancellationToken cancellationToken = default);
2546 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageEditsAsync(string imageFilePath, string prompt, int imageCount, ImageEditOptions options = null);
2547 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageEditsAsync(string imageFilePath, string prompt, string maskFilePath, int imageCount, ImageEditOptions options = null);
2548 [EditorBrowsable(EditorBrowsableState.Never)]
2549 public virtual ClientResult GenerateImages(BinaryContent content, RequestOptions options = null);
2550 public virtual ClientResult<GeneratedImageCollection> GenerateImages(string prompt, int imageCount, ImageGenerationOptions options = null, CancellationToken cancellationToken = default);
2551 [EditorBrowsable(EditorBrowsableState.Never)]
2552 public virtual Task<ClientResult> GenerateImagesAsync(BinaryContent content, RequestOptions options = null);
2553 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImagesAsync(string prompt, int imageCount, ImageGenerationOptions options = null, CancellationToken cancellationToken = default);
2554 public virtual ClientResult<GeneratedImage> GenerateImageVariation(Stream image, string imageFilename, ImageVariationOptions options = null, CancellationToken cancellationToken = default);
2555 public virtual ClientResult<GeneratedImage> GenerateImageVariation(string imageFilePath, ImageVariationOptions options = null);
2556 public virtual Task<ClientResult<GeneratedImage>> GenerateImageVariationAsync(Stream image, string imageFilename, ImageVariationOptions options = null, CancellationToken cancellationToken = default);
2557 public virtual Task<ClientResult<GeneratedImage>> GenerateImageVariationAsync(string imageFilePath, ImageVariationOptions options = null);
2558 [EditorBrowsable(EditorBrowsableState.Never)]
2559 public virtual ClientResult GenerateImageVariations(BinaryContent content, string contentType, RequestOptions options = null);
2560 public virtual ClientResult<GeneratedImageCollection> GenerateImageVariations(Stream image, string imageFilename, int imageCount, ImageVariationOptions options = null, CancellationToken cancellationToken = default);
2561 public virtual ClientResult<GeneratedImageCollection> GenerateImageVariations(string imageFilePath, int imageCount, ImageVariationOptions options = null);
2562 [EditorBrowsable(EditorBrowsableState.Never)]
2563 public virtual Task<ClientResult> GenerateImageVariationsAsync(BinaryContent content, string contentType, RequestOptions options = null);
2564 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageVariationsAsync(Stream image, string imageFilename, int imageCount, ImageVariationOptions options = null, CancellationToken cancellationToken = default);
2565 public virtual Task<ClientResult<GeneratedImageCollection>> GenerateImageVariationsAsync(string imageFilePath, int imageCount, ImageVariationOptions options = null);
2566 }
2567 public class ImageEditOptions : IJsonModel<ImageEditOptions>, IPersistableModel<ImageEditOptions> {
2568 public string EndUserId { get; set; }
2569 public GeneratedImageFormat? ResponseFormat { get; set; }
2570 public GeneratedImageSize? Size { get; set; }
2571 protected virtual ImageEditOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2572 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2573 protected virtual ImageEditOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2574 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2575 }
2576 public class ImageGenerationOptions : IJsonModel<ImageGenerationOptions>, IPersistableModel<ImageGenerationOptions> {
2577 public GeneratedImageBackground? Background { get; set; }
2578 public string EndUserId { get; set; }
2579 public GeneratedImageModerationLevel? ModerationLevel { get; set; }
2580 public int? OutputCompressionFactor { get; set; }
2581 public GeneratedImageFileFormat? OutputFileFormat { get; set; }
2582 public GeneratedImageQuality? Quality { get; set; }
2583 public GeneratedImageFormat? ResponseFormat { get; set; }
2584 public GeneratedImageSize? Size { get; set; }
2585 public GeneratedImageStyle? Style { get; set; }
2586 protected virtual ImageGenerationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2587 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2588 protected virtual ImageGenerationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2589 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2590 }
2591 public class ImageInputTokenUsageDetails : IJsonModel<ImageInputTokenUsageDetails>, IPersistableModel<ImageInputTokenUsageDetails> {
2592 public int ImageTokenCount { get; }
2593 public int TextTokenCount { get; }
2594 protected virtual ImageInputTokenUsageDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2595 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2596 protected virtual ImageInputTokenUsageDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2597 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2598 }
2599 public class ImageTokenUsage : IJsonModel<ImageTokenUsage>, IPersistableModel<ImageTokenUsage> {
2600 public int InputTokenCount { get; }
2601 public ImageInputTokenUsageDetails InputTokenDetails { get; }
2602 public int OutputTokenCount { get; }
2603 public int TotalTokenCount { get; }
2604 protected virtual ImageTokenUsage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2605 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2606 protected virtual ImageTokenUsage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2607 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2608 }
2609 public class ImageVariationOptions : IJsonModel<ImageVariationOptions>, IPersistableModel<ImageVariationOptions> {
2610 public string EndUserId { get; set; }
2611 public GeneratedImageFormat? ResponseFormat { get; set; }
2612 public GeneratedImageSize? Size { get; set; }
2613 protected virtual ImageVariationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2614 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2615 protected virtual ImageVariationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2616 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2617 }
2618 public static class OpenAIImagesModelFactory {
2619 public static GeneratedImage GeneratedImage(BinaryData imageBytes = null, Uri imageUri = null, string revisedPrompt = null);
2620 public static GeneratedImageCollection GeneratedImageCollection(DateTimeOffset createdAt = default, IEnumerable<GeneratedImage> items = null, ImageTokenUsage usage = null);
2621 [EditorBrowsable(EditorBrowsableState.Never)]
2622 public static GeneratedImageCollection GeneratedImageCollection(DateTimeOffset createdAt, IEnumerable<GeneratedImage> items);
2623 }
2624}
2625namespace OpenAI.Models {
2626 public class ModelDeletionResult : IJsonModel<ModelDeletionResult>, IPersistableModel<ModelDeletionResult> {
2627 public bool Deleted { get; }
2628 public string ModelId { get; }
2629 protected virtual ModelDeletionResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2630 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2631 protected virtual ModelDeletionResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2632 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2633 }
2634 public class OpenAIModel : IJsonModel<OpenAIModel>, IPersistableModel<OpenAIModel> {
2635 public DateTimeOffset CreatedAt { get; }
2636 public string Id { get; }
2637 public string OwnedBy { get; }
2638 protected virtual OpenAIModel JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2639 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2640 protected virtual OpenAIModel PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2641 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2642 }
2643 public class OpenAIModelClient {
2644 protected OpenAIModelClient();
2645 public OpenAIModelClient(ApiKeyCredential credential, OpenAIClientOptions options);
2646 public OpenAIModelClient(ApiKeyCredential credential);
2647 protected internal OpenAIModelClient(ClientPipeline pipeline, OpenAIClientOptions options);
2648 public OpenAIModelClient(string apiKey);
2649 public ClientPipeline Pipeline { get; }
2650 [EditorBrowsable(EditorBrowsableState.Never)]
2651 public virtual ClientResult DeleteModel(string model, RequestOptions options);
2652 public virtual ClientResult<ModelDeletionResult> DeleteModel(string model, CancellationToken cancellationToken = default);
2653 [EditorBrowsable(EditorBrowsableState.Never)]
2654 public virtual Task<ClientResult> DeleteModelAsync(string model, RequestOptions options);
2655 public virtual Task<ClientResult<ModelDeletionResult>> DeleteModelAsync(string model, CancellationToken cancellationToken = default);
2656 [EditorBrowsable(EditorBrowsableState.Never)]
2657 public virtual ClientResult GetModel(string model, RequestOptions options);
2658 public virtual ClientResult<OpenAIModel> GetModel(string model, CancellationToken cancellationToken = default);
2659 [EditorBrowsable(EditorBrowsableState.Never)]
2660 public virtual Task<ClientResult> GetModelAsync(string model, RequestOptions options);
2661 public virtual Task<ClientResult<OpenAIModel>> GetModelAsync(string model, CancellationToken cancellationToken = default);
2662 [EditorBrowsable(EditorBrowsableState.Never)]
2663 public virtual ClientResult GetModels(RequestOptions options);
2664 public virtual ClientResult<OpenAIModelCollection> GetModels(CancellationToken cancellationToken = default);
2665 [EditorBrowsable(EditorBrowsableState.Never)]
2666 public virtual Task<ClientResult> GetModelsAsync(RequestOptions options);
2667 public virtual Task<ClientResult<OpenAIModelCollection>> GetModelsAsync(CancellationToken cancellationToken = default);
2668 }
2669 public class OpenAIModelCollection : ObjectModel.ReadOnlyCollection<OpenAIModel>, IJsonModel<OpenAIModelCollection>, IPersistableModel<OpenAIModelCollection> {
2670 protected virtual OpenAIModelCollection JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2671 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2672 protected virtual OpenAIModelCollection PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2673 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2674 }
2675 public static class OpenAIModelsModelFactory {
2676 public static ModelDeletionResult ModelDeletionResult(string modelId = null, bool deleted = false);
2677 public static OpenAIModel OpenAIModel(string id = null, DateTimeOffset createdAt = default, string ownedBy = null);
2678 public static OpenAIModelCollection OpenAIModelCollection(IEnumerable<OpenAIModel> items = null);
2679 }
2680}
2681namespace OpenAI.Moderations {
2682 public class ModerationCategory {
2683 public bool Flagged { get; }
2684 public float Score { get; }
2685 }
2686 public class ModerationClient {
2687 protected ModerationClient();
2688 protected internal ModerationClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
2689 public ModerationClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
2690 public ModerationClient(string model, ApiKeyCredential credential);
2691 public ModerationClient(string model, string apiKey);
2692 public ClientPipeline Pipeline { get; }
2693 [EditorBrowsable(EditorBrowsableState.Never)]
2694 public virtual ClientResult ClassifyText(BinaryContent content, RequestOptions options = null);
2695 public virtual ClientResult<ModerationResultCollection> ClassifyText(IEnumerable<string> inputs, CancellationToken cancellationToken = default);
2696 public virtual ClientResult<ModerationResult> ClassifyText(string input, CancellationToken cancellationToken = default);
2697 [EditorBrowsable(EditorBrowsableState.Never)]
2698 public virtual Task<ClientResult> ClassifyTextAsync(BinaryContent content, RequestOptions options = null);
2699 public virtual Task<ClientResult<ModerationResultCollection>> ClassifyTextAsync(IEnumerable<string> inputs, CancellationToken cancellationToken = default);
2700 public virtual Task<ClientResult<ModerationResult>> ClassifyTextAsync(string input, CancellationToken cancellationToken = default);
2701 }
2702 public class ModerationResult : IJsonModel<ModerationResult>, IPersistableModel<ModerationResult> {
2703 public bool Flagged { get; }
2704 public ModerationCategory Harassment { get; }
2705 public ModerationCategory HarassmentThreatening { get; }
2706 public ModerationCategory Hate { get; }
2707 public ModerationCategory HateThreatening { get; }
2708 public ModerationCategory Illicit { get; }
2709 public ModerationCategory IllicitViolent { get; }
2710 public ModerationCategory SelfHarm { get; }
2711 public ModerationCategory SelfHarmInstructions { get; }
2712 public ModerationCategory SelfHarmIntent { get; }
2713 public ModerationCategory Sexual { get; }
2714 public ModerationCategory SexualMinors { get; }
2715 public ModerationCategory Violence { get; }
2716 public ModerationCategory ViolenceGraphic { get; }
2717 protected virtual ModerationResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2718 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2719 protected virtual ModerationResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2720 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2721 }
2722 public class ModerationResultCollection : ObjectModel.ReadOnlyCollection<ModerationResult>, IJsonModel<ModerationResultCollection>, IPersistableModel<ModerationResultCollection> {
2723 public string Id { get; }
2724 public string Model { get; }
2725 protected virtual ModerationResultCollection JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2726 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2727 protected virtual ModerationResultCollection PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2728 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2729 }
2730 public static class OpenAIModerationsModelFactory {
2731 public static ModerationCategory ModerationCategory(bool flagged = false, float score = 0);
2732 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);
2733 [EditorBrowsable(EditorBrowsableState.Never)]
2734 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);
2735 public static ModerationResultCollection ModerationResultCollection(string id = null, string model = null, IEnumerable<ModerationResult> items = null);
2736 }
2737}
2738namespace OpenAI.Realtime {
2739 public class ConversationContentPart : IJsonModel<ConversationContentPart>, IPersistableModel<ConversationContentPart> {
2740 public string AudioTranscript { get; }
2741 public string Text { get; }
2742 public static ConversationContentPart CreateInputAudioTranscriptPart(string transcript = null);
2743 public static ConversationContentPart CreateInputTextPart(string text);
2744 public static ConversationContentPart CreateOutputAudioTranscriptPart(string transcript = null);
2745 public static ConversationContentPart CreateOutputTextPart(string text);
2746 protected virtual ConversationContentPart JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2747 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2748 public static implicit operator ConversationContentPart(string text);
2749 protected virtual ConversationContentPart PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2750 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2751 }
2752 public readonly partial struct ConversationContentPartKind : IEquatable<ConversationContentPartKind> {
2753 public ConversationContentPartKind(string value);
2754 public static ConversationContentPartKind InputAudio { get; }
2755 public static ConversationContentPartKind InputText { get; }
2756 public static ConversationContentPartKind OutputAudio { get; }
2757 public static ConversationContentPartKind OutputText { get; }
2758 public readonly bool Equals(ConversationContentPartKind other);
2759 [EditorBrowsable(EditorBrowsableState.Never)]
2760 public override readonly bool Equals(object obj);
2761 [EditorBrowsable(EditorBrowsableState.Never)]
2762 public override readonly int GetHashCode();
2763 public static bool operator ==(ConversationContentPartKind left, ConversationContentPartKind right);
2764 public static implicit operator ConversationContentPartKind(string value);
2765 public static bool operator !=(ConversationContentPartKind left, ConversationContentPartKind right);
2766 public override readonly string ToString();
2767 }
2768 public class ConversationFunctionTool : ConversationTool, IJsonModel<ConversationFunctionTool>, IPersistableModel<ConversationFunctionTool> {
2769 public ConversationFunctionTool(string name);
2770 public string Description { get; set; }
2771 public string Name { get; set; }
2772 public BinaryData Parameters { get; set; }
2773 protected override ConversationTool JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2774 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2775 protected override ConversationTool PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2776 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2777 }
2778 public readonly partial struct ConversationIncompleteReason : IEquatable<ConversationIncompleteReason> {
2779 public ConversationIncompleteReason(string value);
2780 public static ConversationIncompleteReason ClientCancelled { get; }
2781 public static ConversationIncompleteReason ContentFilter { get; }
2782 public static ConversationIncompleteReason MaxOutputTokens { get; }
2783 public static ConversationIncompleteReason TurnDetected { get; }
2784 public readonly bool Equals(ConversationIncompleteReason other);
2785 [EditorBrowsable(EditorBrowsableState.Never)]
2786 public override readonly bool Equals(object obj);
2787 [EditorBrowsable(EditorBrowsableState.Never)]
2788 public override readonly int GetHashCode();
2789 public static bool operator ==(ConversationIncompleteReason left, ConversationIncompleteReason right);
2790 public static implicit operator ConversationIncompleteReason(string value);
2791 public static bool operator !=(ConversationIncompleteReason left, ConversationIncompleteReason right);
2792 public override readonly string ToString();
2793 }
2794 public class ConversationInputTokenUsageDetails : IJsonModel<ConversationInputTokenUsageDetails>, IPersistableModel<ConversationInputTokenUsageDetails> {
2795 public int AudioTokenCount { get; }
2796 public int CachedTokenCount { get; }
2797 public int TextTokenCount { get; }
2798 protected virtual ConversationInputTokenUsageDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2799 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2800 protected virtual ConversationInputTokenUsageDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2801 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2802 }
2803 public readonly partial struct ConversationItemStatus : IEquatable<ConversationItemStatus> {
2804 public ConversationItemStatus(string value);
2805 public static ConversationItemStatus Completed { get; }
2806 public static ConversationItemStatus Incomplete { get; }
2807 public static ConversationItemStatus InProgress { get; }
2808 public readonly bool Equals(ConversationItemStatus other);
2809 [EditorBrowsable(EditorBrowsableState.Never)]
2810 public override readonly bool Equals(object obj);
2811 [EditorBrowsable(EditorBrowsableState.Never)]
2812 public override readonly int GetHashCode();
2813 public static bool operator ==(ConversationItemStatus left, ConversationItemStatus right);
2814 public static implicit operator ConversationItemStatus(string value);
2815 public static bool operator !=(ConversationItemStatus left, ConversationItemStatus right);
2816 public override readonly string ToString();
2817 }
2818 public class ConversationMaxTokensChoice : IJsonModel<ConversationMaxTokensChoice>, IPersistableModel<ConversationMaxTokensChoice> {
2819 public ConversationMaxTokensChoice(int numberValue);
2820 public int? NumericValue { get; }
2821 public static ConversationMaxTokensChoice CreateDefaultMaxTokensChoice();
2822 public static ConversationMaxTokensChoice CreateInfiniteMaxTokensChoice();
2823 public static ConversationMaxTokensChoice CreateNumericMaxTokensChoice(int maxTokens);
2824 public static implicit operator ConversationMaxTokensChoice(int maxTokens);
2825 }
2826 public readonly partial struct ConversationMessageRole : IEquatable<ConversationMessageRole> {
2827 public ConversationMessageRole(string value);
2828 public static ConversationMessageRole Assistant { get; }
2829 public static ConversationMessageRole System { get; }
2830 public static ConversationMessageRole User { get; }
2831 public readonly bool Equals(ConversationMessageRole other);
2832 [EditorBrowsable(global::EditorBrowsableState.Never)]
2833 public override readonly bool Equals(object obj);
2834 [EditorBrowsable(global::EditorBrowsableState.Never)]
2835 public override readonly int GetHashCode();
2836 public static bool operator ==(ConversationMessageRole left, ConversationMessageRole right);
2837 public static implicit operator ConversationMessageRole(string value);
2838 public static bool operator !=(ConversationMessageRole left, ConversationMessageRole right);
2839 public override readonly string ToString();
2840 }
2841 public class ConversationOutputTokenUsageDetails : IJsonModel<ConversationOutputTokenUsageDetails>, IPersistableModel<ConversationOutputTokenUsageDetails> {
2842 public int AudioTokenCount { get; }
2843 public int TextTokenCount { get; }
2844 protected virtual ConversationOutputTokenUsageDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2845 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2846 protected virtual ConversationOutputTokenUsageDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2847 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2848 }
2849 public class ConversationRateLimitDetailsItem : IJsonModel<ConversationRateLimitDetailsItem>, IPersistableModel<ConversationRateLimitDetailsItem> {
2850 public int MaximumCount { get; }
2851 public string Name { get; }
2852 public int RemainingCount { get; }
2853 public TimeSpan TimeUntilReset { get; }
2854 protected virtual ConversationRateLimitDetailsItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2855 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2856 protected virtual ConversationRateLimitDetailsItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2857 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2858 }
2859 public class ConversationResponseOptions : IJsonModel<ConversationResponseOptions>, IPersistableModel<ConversationResponseOptions> {
2860 public ConversationVoice? Voice;
2861 public RealtimeContentModalities ContentModalities { get; set; }
2862 public ResponseConversationSelection? ConversationSelection { get; set; }
2863 public string Instructions { get; set; }
2864 public ConversationMaxTokensChoice MaxOutputTokens { get; set; }
2865 public IDictionary<string, string> Metadata { get; }
2866 public RealtimeAudioFormat? OutputAudioFormat { get; set; }
2867 public IList<RealtimeItem> OverrideItems { get; }
2868 public float? Temperature { get; set; }
2869 public ConversationToolChoice ToolChoice { get; set; }
2870 public IList<ConversationTool> Tools { get; }
2871 protected virtual ConversationResponseOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2872 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2873 protected virtual ConversationResponseOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2874 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2875 }
2876 public class ConversationSessionConfiguredUpdate : RealtimeUpdate, IJsonModel<ConversationSessionConfiguredUpdate>, IPersistableModel<ConversationSessionConfiguredUpdate> {
2877 public RealtimeContentModalities ContentModalities { get; }
2878 public RealtimeAudioFormat InputAudioFormat { get; }
2879 public InputTranscriptionOptions InputTranscriptionOptions { get; }
2880 public string Instructions { get; }
2881 public ConversationMaxTokensChoice MaxOutputTokens { get; }
2882 public string Model { get; }
2883 public RealtimeAudioFormat OutputAudioFormat { get; }
2884 public string SessionId { get; }
2885 public float Temperature { get; }
2886 public ConversationToolChoice ToolChoice { get; }
2887 public IReadOnlyList<ConversationTool> Tools { get; }
2888 public TurnDetectionOptions TurnDetectionOptions { get; }
2889 public ConversationVoice Voice { get; }
2890 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2891 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2892 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2893 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2894 }
2895 public class ConversationSessionOptions : IJsonModel<ConversationSessionOptions>, IPersistableModel<ConversationSessionOptions> {
2896 public RealtimeContentModalities ContentModalities { get; set; }
2897 public RealtimeAudioFormat? InputAudioFormat { get; set; }
2898 public InputNoiseReductionOptions InputNoiseReductionOptions { get; set; }
2899 public InputTranscriptionOptions InputTranscriptionOptions { get; set; }
2900 public string Instructions { get; set; }
2901 public ConversationMaxTokensChoice MaxOutputTokens { get; set; }
2902 public RealtimeAudioFormat? OutputAudioFormat { get; set; }
2903 public float? Temperature { get; set; }
2904 public ConversationToolChoice ToolChoice { get; set; }
2905 public IList<ConversationTool> Tools { get; }
2906 public TurnDetectionOptions TurnDetectionOptions { get; set; }
2907 public ConversationVoice? Voice { get; set; }
2908 protected virtual ConversationSessionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2909 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2910 protected virtual ConversationSessionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2911 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2912 }
2913 public class ConversationSessionStartedUpdate : RealtimeUpdate, IJsonModel<ConversationSessionStartedUpdate>, IPersistableModel<ConversationSessionStartedUpdate> {
2914 public RealtimeContentModalities ContentModalities { get; }
2915 public RealtimeAudioFormat InputAudioFormat { get; }
2916 public InputTranscriptionOptions InputTranscriptionOptions { get; }
2917 public string Instructions { get; }
2918 public ConversationMaxTokensChoice MaxOutputTokens { get; }
2919 public string Model { get; }
2920 public RealtimeAudioFormat OutputAudioFormat { get; }
2921 public string SessionId { get; }
2922 public float Temperature { get; }
2923 public ConversationToolChoice ToolChoice { get; }
2924 public IReadOnlyList<ConversationTool> Tools { get; }
2925 public TurnDetectionOptions TurnDetectionOptions { get; }
2926 public ConversationVoice Voice { get; }
2927 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2928 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2929 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2930 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2931 }
2932 public readonly partial struct ConversationStatus : IEquatable<ConversationStatus> {
2933 public ConversationStatus(string value);
2934 public static ConversationStatus Cancelled { get; }
2935 public static ConversationStatus Completed { get; }
2936 public static ConversationStatus Failed { get; }
2937 public static ConversationStatus Incomplete { get; }
2938 public readonly bool Equals(ConversationStatus other);
2939 [EditorBrowsable(EditorBrowsableState.Never)]
2940 public override readonly bool Equals(object obj);
2941 [EditorBrowsable(EditorBrowsableState.Never)]
2942 public override readonly int GetHashCode();
2943 public static bool operator ==(ConversationStatus left, ConversationStatus right);
2944 public static implicit operator ConversationStatus(string value);
2945 public static bool operator !=(ConversationStatus left, ConversationStatus right);
2946 public override readonly string ToString();
2947 }
2948 public class ConversationStatusDetails : IJsonModel<ConversationStatusDetails>, IPersistableModel<ConversationStatusDetails> {
2949 public string ErrorCode { get; }
2950 public string ErrorKind { get; }
2951 public ConversationIncompleteReason? IncompleteReason { get; }
2952 public ConversationStatus StatusKind { get; }
2953 protected virtual ConversationStatusDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2954 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2955 protected virtual ConversationStatusDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2956 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2957 }
2958 public class ConversationTokenUsage : IJsonModel<ConversationTokenUsage>, IPersistableModel<ConversationTokenUsage> {
2959 public int InputTokenCount { get; }
2960 public ConversationInputTokenUsageDetails InputTokenDetails { get; }
2961 public int OutputTokenCount { get; }
2962 public ConversationOutputTokenUsageDetails OutputTokenDetails { get; }
2963 public int TotalTokenCount { get; }
2964 protected virtual ConversationTokenUsage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2965 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2966 protected virtual ConversationTokenUsage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2967 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2968 }
2969 public class ConversationTool : IJsonModel<ConversationTool>, IPersistableModel<ConversationTool> {
2970 public ConversationToolKind Kind { get; }
2971 public static ConversationTool CreateFunctionTool(string name, string description = null, BinaryData parameters = null);
2972 protected virtual ConversationTool JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
2973 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
2974 protected virtual ConversationTool PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
2975 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
2976 }
2977 public class ConversationToolChoice : IJsonModel<ConversationToolChoice>, IPersistableModel<ConversationToolChoice> {
2978 public string FunctionName { get; }
2979 public ConversationToolChoiceKind Kind { get; }
2980 public static ConversationToolChoice CreateAutoToolChoice();
2981 public static ConversationToolChoice CreateFunctionToolChoice(string functionName);
2982 public static ConversationToolChoice CreateNoneToolChoice();
2983 public static ConversationToolChoice CreateRequiredToolChoice();
2984 }
2985 public enum ConversationToolChoiceKind {
2986 Unknown = 0,
2987 Auto = 1,
2988 None = 2,
2989 Required = 3,
2990 Function = 4
2991 }
2992 public readonly partial struct ConversationToolKind : IEquatable<ConversationToolKind> {
2993 public ConversationToolKind(string value);
2994 public static ConversationToolKind Function { get; }
2995 public readonly bool Equals(ConversationToolKind other);
2996 [EditorBrowsable(EditorBrowsableState.Never)]
2997 public override readonly bool Equals(object obj);
2998 [EditorBrowsable(EditorBrowsableState.Never)]
2999 public override readonly int GetHashCode();
3000 public static bool operator ==(ConversationToolKind left, ConversationToolKind right);
3001 public static implicit operator ConversationToolKind(string value);
3002 public static bool operator !=(ConversationToolKind left, ConversationToolKind right);
3003 public override readonly string ToString();
3004 }
3005 public readonly partial struct ConversationVoice : IEquatable<ConversationVoice> {
3006 public ConversationVoice(string value);
3007 public static ConversationVoice Alloy { get; }
3008 public static ConversationVoice Ash { get; }
3009 public static ConversationVoice Ballad { get; }
3010 public static ConversationVoice Coral { get; }
3011 public static ConversationVoice Echo { get; }
3012 public static ConversationVoice Fable { get; }
3013 public static ConversationVoice Nova { get; }
3014 public static ConversationVoice Onyx { get; }
3015 public static ConversationVoice Sage { get; }
3016 public static ConversationVoice Shimmer { get; }
3017 public static ConversationVoice Verse { get; }
3018 public readonly bool Equals(ConversationVoice other);
3019 [EditorBrowsable(EditorBrowsableState.Never)]
3020 public override readonly bool Equals(object obj);
3021 [EditorBrowsable(EditorBrowsableState.Never)]
3022 public override readonly int GetHashCode();
3023 public static bool operator ==(ConversationVoice left, ConversationVoice right);
3024 public static implicit operator ConversationVoice(string value);
3025 public static bool operator !=(ConversationVoice left, ConversationVoice right);
3026 public override readonly string ToString();
3027 }
3028 public class InputAudioClearedUpdate : RealtimeUpdate, IJsonModel<InputAudioClearedUpdate>, IPersistableModel<InputAudioClearedUpdate> {
3029 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3030 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3031 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3032 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3033 }
3034 public class InputAudioCommittedUpdate : RealtimeUpdate, IJsonModel<InputAudioCommittedUpdate>, IPersistableModel<InputAudioCommittedUpdate> {
3035 public string ItemId { get; }
3036 public string PreviousItemId { get; }
3037 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3038 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3039 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3040 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3041 }
3042 public class InputAudioSpeechFinishedUpdate : RealtimeUpdate, IJsonModel<InputAudioSpeechFinishedUpdate>, IPersistableModel<InputAudioSpeechFinishedUpdate> {
3043 public TimeSpan AudioEndTime { get; }
3044 public string ItemId { get; }
3045 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3046 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3047 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3048 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3049 }
3050 public class InputAudioSpeechStartedUpdate : RealtimeUpdate, IJsonModel<InputAudioSpeechStartedUpdate>, IPersistableModel<InputAudioSpeechStartedUpdate> {
3051 public TimeSpan AudioStartTime { get; }
3052 public string ItemId { get; }
3053 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3054 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3055 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3056 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3057 }
3058 public class InputAudioTranscriptionDeltaUpdate : RealtimeUpdate, IJsonModel<InputAudioTranscriptionDeltaUpdate>, IPersistableModel<InputAudioTranscriptionDeltaUpdate> {
3059 public int? ContentIndex { get; }
3060 public string Delta { get; }
3061 public string ItemId { get; }
3062 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3063 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3064 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3065 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3066 }
3067 public class InputAudioTranscriptionFailedUpdate : RealtimeUpdate, IJsonModel<InputAudioTranscriptionFailedUpdate>, IPersistableModel<InputAudioTranscriptionFailedUpdate> {
3068 public int ContentIndex { get; }
3069 public string ErrorCode { get; }
3070 public string ErrorMessage { get; }
3071 public string ErrorParameterName { get; }
3072 public string ItemId { get; }
3073 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3074 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3075 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3076 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3077 }
3078 public class InputAudioTranscriptionFinishedUpdate : RealtimeUpdate, IJsonModel<InputAudioTranscriptionFinishedUpdate>, IPersistableModel<InputAudioTranscriptionFinishedUpdate> {
3079 public int ContentIndex { get; }
3080 public string ItemId { get; }
3081 public string Transcript { get; }
3082 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3083 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3084 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3085 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3086 }
3087 public enum InputNoiseReductionKind {
3088 Unknown = 0,
3089 NearField = 1,
3090 FarField = 2,
3091 Disabled = 3
3092 }
3093 public class InputNoiseReductionOptions : IJsonModel<InputNoiseReductionOptions>, IPersistableModel<InputNoiseReductionOptions> {
3094 public InputNoiseReductionKind Kind { get; set; }
3095 public static InputNoiseReductionOptions CreateDisabledOptions();
3096 public static InputNoiseReductionOptions CreateFarFieldOptions();
3097 public static InputNoiseReductionOptions CreateNearFieldOptions();
3098 protected virtual InputNoiseReductionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3099 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3100 protected virtual InputNoiseReductionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3101 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3102 }
3103 public readonly partial struct InputTranscriptionModel : IEquatable<InputTranscriptionModel> {
3104 public InputTranscriptionModel(string value);
3105 public static InputTranscriptionModel Whisper1 { get; }
3106 public readonly bool Equals(InputTranscriptionModel other);
3107 [EditorBrowsable(EditorBrowsableState.Never)]
3108 public override readonly bool Equals(object obj);
3109 [EditorBrowsable(EditorBrowsableState.Never)]
3110 public override readonly int GetHashCode();
3111 public static bool operator ==(InputTranscriptionModel left, InputTranscriptionModel right);
3112 public static implicit operator InputTranscriptionModel(string value);
3113 public static bool operator !=(InputTranscriptionModel left, InputTranscriptionModel right);
3114 public override readonly string ToString();
3115 }
3116 public class InputTranscriptionOptions : IJsonModel<InputTranscriptionOptions>, IPersistableModel<InputTranscriptionOptions> {
3117 public string Language { get; set; }
3118 public InputTranscriptionModel? Model { get; set; }
3119 public string Prompt { get; set; }
3120 protected virtual InputTranscriptionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3121 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3122 protected virtual InputTranscriptionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3123 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3124 }
3125 public class ItemCreatedUpdate : RealtimeUpdate, IJsonModel<ItemCreatedUpdate>, IPersistableModel<ItemCreatedUpdate> {
3126 public string FunctionCallArguments { get; }
3127 public string FunctionCallId { get; }
3128 public string FunctionCallOutput { get; }
3129 public string FunctionName { get; }
3130 public string ItemId { get; }
3131 public IReadOnlyList<ConversationContentPart> MessageContentParts { get; }
3132 public ConversationMessageRole? MessageRole { get; }
3133 public string PreviousItemId { get; }
3134 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3135 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3136 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3137 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3138 }
3139 public class ItemDeletedUpdate : RealtimeUpdate, IJsonModel<ItemDeletedUpdate>, IPersistableModel<ItemDeletedUpdate> {
3140 public string ItemId { get; }
3141 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3142 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3143 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3144 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3145 }
3146 public class ItemRetrievedUpdate : RealtimeUpdate, IJsonModel<ItemRetrievedUpdate>, IPersistableModel<ItemRetrievedUpdate> {
3147 public RealtimeItem Item { get; }
3148 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3149 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3150 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3151 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3152 }
3153 public class ItemTruncatedUpdate : RealtimeUpdate, IJsonModel<ItemTruncatedUpdate>, IPersistableModel<ItemTruncatedUpdate> {
3154 public int AudioEndMs { get; }
3155 public int ContentIndex { get; }
3156 public string ItemId { get; }
3157 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3158 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3159 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3160 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3161 }
3162 public class OutputAudioFinishedUpdate : RealtimeUpdate, IJsonModel<OutputAudioFinishedUpdate>, IPersistableModel<OutputAudioFinishedUpdate> {
3163 public int ContentIndex { get; }
3164 public string ItemId { get; }
3165 public int OutputIndex { get; }
3166 public string ResponseId { get; }
3167 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3168 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3169 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3170 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3171 }
3172 public class OutputAudioTranscriptionFinishedUpdate : RealtimeUpdate, IJsonModel<OutputAudioTranscriptionFinishedUpdate>, IPersistableModel<OutputAudioTranscriptionFinishedUpdate> {
3173 public int ContentIndex { get; }
3174 public string ItemId { get; }
3175 public int OutputIndex { get; }
3176 public string ResponseId { get; }
3177 public string Transcript { get; }
3178 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3179 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3180 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3181 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3182 }
3183 public class OutputDeltaUpdate : RealtimeUpdate, IJsonModel<OutputDeltaUpdate>, IPersistableModel<OutputDeltaUpdate> {
3184 public BinaryData AudioBytes { get; }
3185 public string AudioTranscript { get; }
3186 public int ContentPartIndex { get; }
3187 public string FunctionArguments { get; }
3188 public string FunctionCallId { get; }
3189 public string ItemId { get; }
3190 public int ItemIndex { get; }
3191 public string ResponseId { get; }
3192 public string Text { get; }
3193 }
3194 public class OutputPartFinishedUpdate : RealtimeUpdate, IJsonModel<OutputPartFinishedUpdate>, IPersistableModel<OutputPartFinishedUpdate> {
3195 public string AudioTranscript { get; }
3196 public int ContentPartIndex { get; }
3197 public string FunctionArguments { get; }
3198 public string FunctionCallId { get; }
3199 public string ItemId { get; }
3200 public int ItemIndex { get; }
3201 public string ResponseId { get; }
3202 public string Text { get; }
3203 }
3204 public class OutputStreamingFinishedUpdate : RealtimeUpdate, IJsonModel<OutputStreamingFinishedUpdate>, IPersistableModel<OutputStreamingFinishedUpdate> {
3205 public string FunctionCallArguments { get; }
3206 public string FunctionCallId { get; }
3207 public string FunctionCallOutput { get; }
3208 public string FunctionName { get; }
3209 public string ItemId { get; }
3210 public IReadOnlyList<ConversationContentPart> MessageContentParts { get; }
3211 public ConversationMessageRole? MessageRole { get; }
3212 public int OutputIndex { get; }
3213 public string ResponseId { get; }
3214 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3215 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3216 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3217 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3218 }
3219 public class OutputStreamingStartedUpdate : RealtimeUpdate, IJsonModel<OutputStreamingStartedUpdate>, IPersistableModel<OutputStreamingStartedUpdate> {
3220 public string FunctionCallArguments { get; }
3221 public string FunctionCallId { get; }
3222 public string FunctionCallOutput { get; }
3223 public string FunctionName { get; }
3224 public string ItemId { get; }
3225 public int ItemIndex { get; }
3226 public IReadOnlyList<ConversationContentPart> MessageContentParts { get; }
3227 public ConversationMessageRole? MessageRole { get; }
3228 public string ResponseId { get; }
3229 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3230 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3231 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3232 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3233 }
3234 public class OutputTextFinishedUpdate : RealtimeUpdate, IJsonModel<OutputTextFinishedUpdate>, IPersistableModel<OutputTextFinishedUpdate> {
3235 public int ContentIndex { get; }
3236 public string ItemId { get; }
3237 public int OutputIndex { get; }
3238 public string ResponseId { get; }
3239 public string Text { get; }
3240 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3241 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3242 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3243 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3244 }
3245 public class RateLimitsUpdate : RealtimeUpdate, IJsonModel<RateLimitsUpdate>, IPersistableModel<RateLimitsUpdate> {
3246 public IReadOnlyList<ConversationRateLimitDetailsItem> AllDetails { get; }
3247 public ConversationRateLimitDetailsItem RequestDetails { get; }
3248 public ConversationRateLimitDetailsItem TokenDetails { get; }
3249 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3250 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3251 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3252 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3253 }
3254 public readonly partial struct RealtimeAudioFormat : IEquatable<RealtimeAudioFormat> {
3255 public RealtimeAudioFormat(string value);
3256 public static RealtimeAudioFormat G711Alaw { get; }
3257 public static RealtimeAudioFormat G711Ulaw { get; }
3258 public static RealtimeAudioFormat Pcm16 { get; }
3259 public readonly bool Equals(RealtimeAudioFormat other);
3260 [EditorBrowsable(EditorBrowsableState.Never)]
3261 public override readonly bool Equals(object obj);
3262 [EditorBrowsable(EditorBrowsableState.Never)]
3263 public override readonly int GetHashCode();
3264 public static bool operator ==(RealtimeAudioFormat left, RealtimeAudioFormat right);
3265 public static implicit operator RealtimeAudioFormat(string value);
3266 public static bool operator !=(RealtimeAudioFormat left, RealtimeAudioFormat right);
3267 public override readonly string ToString();
3268 }
3269 public class RealtimeClient {
3270 protected RealtimeClient();
3271 public RealtimeClient(ApiKeyCredential credential, OpenAIClientOptions options);
3272 public RealtimeClient(ApiKeyCredential credential);
3273 protected internal RealtimeClient(ClientPipeline pipeline, OpenAIClientOptions options);
3274 public ClientPipeline Pipeline { get; }
3275 public event EventHandler<BinaryData> OnReceivingCommand { add; remove; }
3276 public event EventHandler<BinaryData> OnSendingCommand { add; remove; }
3277 public virtual ClientResult CreateEphemeralToken(BinaryContent content, RequestOptions options = null);
3278 public virtual Task<ClientResult> CreateEphemeralTokenAsync(BinaryContent content, RequestOptions options = null);
3279 public virtual ClientResult CreateEphemeralTranscriptionToken(BinaryContent content, RequestOptions options = null);
3280 public virtual Task<ClientResult> CreateEphemeralTranscriptionTokenAsync(BinaryContent content, RequestOptions options = null);
3281 public RealtimeSession StartConversationSession(string model, CancellationToken cancellationToken = default);
3282 [EditorBrowsable(EditorBrowsableState.Never)]
3283 public virtual Task<RealtimeSession> StartConversationSessionAsync(string model, RequestOptions options);
3284 public virtual Task<RealtimeSession> StartConversationSessionAsync(string model, CancellationToken cancellationToken = default);
3285 [EditorBrowsable(EditorBrowsableState.Never)]
3286 public virtual Task<RealtimeSession> StartSessionAsync(string model, string intent, RequestOptions options);
3287 public RealtimeSession StartTranscriptionSession(CancellationToken cancellationToken = default);
3288 [EditorBrowsable(EditorBrowsableState.Never)]
3289 public virtual Task<RealtimeSession> StartTranscriptionSessionAsync(RequestOptions options);
3290 public virtual Task<RealtimeSession> StartTranscriptionSessionAsync(CancellationToken cancellationToken = default);
3291 }
3292 [Flags]
3293 public enum RealtimeContentModalities {
3294 Default = 0,
3295 Text = 1,
3296 Audio = 2
3297 }
3298 public class RealtimeErrorUpdate : RealtimeUpdate, IJsonModel<RealtimeErrorUpdate>, IPersistableModel<RealtimeErrorUpdate> {
3299 public string ErrorCode { get; }
3300 public string ErrorEventId { get; }
3301 public string Message { get; }
3302 public string ParameterName { get; }
3303 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3304 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3305 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3306 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3307 }
3308 public class RealtimeItem : IJsonModel<RealtimeItem>, IPersistableModel<RealtimeItem> {
3309 public string FunctionArguments { get; }
3310 public string FunctionCallId { get; }
3311 public string FunctionName { get; }
3312 public string Id { get; set; }
3313 public IReadOnlyList<ConversationContentPart> MessageContentParts { get; }
3314 public ConversationMessageRole? MessageRole { get; }
3315 public static RealtimeItem CreateAssistantMessage(IEnumerable<ConversationContentPart> contentItems);
3316 public static RealtimeItem CreateFunctionCall(string name, string callId, string arguments);
3317 public static RealtimeItem CreateFunctionCallOutput(string callId, string output);
3318 public static RealtimeItem CreateSystemMessage(IEnumerable<ConversationContentPart> contentItems);
3319 public static RealtimeItem CreateUserMessage(IEnumerable<ConversationContentPart> contentItems);
3320 protected virtual RealtimeItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3321 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3322 protected virtual RealtimeItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3323 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3324 }
3325 public class RealtimeSession : IDisposable {
3326 protected internal RealtimeSession(RealtimeClient parentClient, Uri endpoint, ApiKeyCredential credential);
3327 public Net.WebSockets.WebSocket WebSocket { get; protected set; }
3328 public virtual void AddItem(RealtimeItem item, string previousItemId, CancellationToken cancellationToken = default);
3329 public virtual void AddItem(RealtimeItem item, CancellationToken cancellationToken = default);
3330 public virtual Task AddItemAsync(RealtimeItem item, string previousItemId, CancellationToken cancellationToken = default);
3331 public virtual Task AddItemAsync(RealtimeItem item, CancellationToken cancellationToken = default);
3332 public virtual void CancelResponse(CancellationToken cancellationToken = default);
3333 public virtual Task CancelResponseAsync(CancellationToken cancellationToken = default);
3334 public virtual void ClearInputAudio(CancellationToken cancellationToken = default);
3335 public virtual Task ClearInputAudioAsync(CancellationToken cancellationToken = default);
3336 public virtual void CommitPendingAudio(CancellationToken cancellationToken = default);
3337 public virtual Task CommitPendingAudioAsync(CancellationToken cancellationToken = default);
3338 public virtual Task ConfigureConversationSessionAsync(ConversationSessionOptions sessionOptions, CancellationToken cancellationToken = default);
3339 public virtual void ConfigureSession(ConversationSessionOptions sessionOptions, CancellationToken cancellationToken = default);
3340 public virtual void ConfigureTranscriptionSession(TranscriptionSessionOptions sessionOptions, CancellationToken cancellationToken = default);
3341 public virtual Task ConfigureTranscriptionSessionAsync(TranscriptionSessionOptions sessionOptions, CancellationToken cancellationToken = default);
3342 [EditorBrowsable(EditorBrowsableState.Never)]
3343 protected internal virtual void Connect(RequestOptions options);
3344 [EditorBrowsable(EditorBrowsableState.Never)]
3345 protected internal virtual Task ConnectAsync(RequestOptions options);
3346 public virtual void DeleteItem(string itemId, CancellationToken cancellationToken = default);
3347 public virtual Task DeleteItemAsync(string itemId, CancellationToken cancellationToken = default);
3348 public void Dispose();
3349 public virtual void InterruptResponse(CancellationToken cancellationToken = default);
3350 public virtual Task InterruptResponseAsync(CancellationToken cancellationToken = default);
3351 [EditorBrowsable(EditorBrowsableState.Never)]
3352 public virtual IEnumerable<ClientResult> ReceiveUpdates(RequestOptions options);
3353 public virtual IEnumerable<RealtimeUpdate> ReceiveUpdates(CancellationToken cancellationToken = default);
3354 [EditorBrowsable(EditorBrowsableState.Never)]
3355 public virtual IAsyncEnumerable<ClientResult> ReceiveUpdatesAsync(RequestOptions options);
3356 public virtual IAsyncEnumerable<RealtimeUpdate> ReceiveUpdatesAsync(CancellationToken cancellationToken = default);
3357 public virtual void RequestItemRetrieval(string itemId, CancellationToken cancellationToken = default);
3358 public virtual Task RequestItemRetrievalAsync(string itemId, CancellationToken cancellationToken = default);
3359 [EditorBrowsable(EditorBrowsableState.Never)]
3360 public virtual void SendCommand(BinaryData data, RequestOptions options);
3361 [EditorBrowsable(EditorBrowsableState.Never)]
3362 public virtual Task SendCommandAsync(BinaryData data, RequestOptions options);
3363 public virtual void SendInputAudio(BinaryData audio, CancellationToken cancellationToken = default);
3364 public virtual void SendInputAudio(Stream audio, CancellationToken cancellationToken = default);
3365 public virtual Task SendInputAudioAsync(BinaryData audio, CancellationToken cancellationToken = default);
3366 public virtual Task SendInputAudioAsync(Stream audio, CancellationToken cancellationToken = default);
3367 public virtual void StartResponse(ConversationResponseOptions options, CancellationToken cancellationToken = default);
3368 public void StartResponse(CancellationToken cancellationToken = default);
3369 public virtual Task StartResponseAsync(ConversationResponseOptions options, CancellationToken cancellationToken = default);
3370 public virtual Task StartResponseAsync(CancellationToken cancellationToken = default);
3371 public virtual void TruncateItem(string itemId, int contentPartIndex, TimeSpan audioDuration, CancellationToken cancellationToken = default);
3372 public virtual Task TruncateItemAsync(string itemId, int contentPartIndex, TimeSpan audioDuration, CancellationToken cancellationToken = default);
3373 }
3374 public class RealtimeUpdate : IJsonModel<RealtimeUpdate>, IPersistableModel<RealtimeUpdate> {
3375 public string EventId { get; }
3376 public RealtimeUpdateKind Kind { get; }
3377 public BinaryData GetRawContent();
3378 protected virtual RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3379 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3380 public static explicit operator RealtimeUpdate(ClientResult result);
3381 protected virtual RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3382 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3383 }
3384 public enum RealtimeUpdateKind {
3385 Unknown = 0,
3386 SessionStarted = 1,
3387 SessionConfigured = 2,
3388 ItemCreated = 3,
3389 ConversationCreated = 4,
3390 ItemRetrieved = 5,
3391 ItemDeleted = 6,
3392 ItemTruncated = 7,
3393 ResponseStarted = 8,
3394 ResponseFinished = 9,
3395 RateLimitsUpdated = 10,
3396 ItemStreamingStarted = 11,
3397 ItemStreamingFinished = 12,
3398 ItemContentPartStarted = 13,
3399 ItemContentPartFinished = 14,
3400 ItemStreamingPartAudioDelta = 15,
3401 ItemStreamingPartAudioFinished = 16,
3402 ItemStreamingPartAudioTranscriptionDelta = 17,
3403 ItemStreamingPartAudioTranscriptionFinished = 18,
3404 ItemStreamingPartTextDelta = 19,
3405 ItemStreamingPartTextFinished = 20,
3406 ItemStreamingFunctionCallArgumentsDelta = 21,
3407 ItemStreamingFunctionCallArgumentsFinished = 22,
3408 InputSpeechStarted = 23,
3409 InputSpeechStopped = 24,
3410 InputTranscriptionFinished = 25,
3411 InputTranscriptionDelta = 26,
3412 InputTranscriptionFailed = 27,
3413 InputAudioCommitted = 28,
3414 InputAudioCleared = 29,
3415 OutputAudioBufferCleared = 30,
3416 OutputAudioBufferStarted = 31,
3417 OutputAudioBufferStopped = 32,
3418 TranscriptionSessionStarted = 33,
3419 TranscriptionSessionConfigured = 34,
3420 Error = 35
3421 }
3422 public readonly partial struct ResponseConversationSelection : IEquatable<ResponseConversationSelection> {
3423 public ResponseConversationSelection(string value);
3424 public static ResponseConversationSelection Auto { get; }
3425 public static ResponseConversationSelection None { get; }
3426 public readonly bool Equals(ResponseConversationSelection other);
3427 [EditorBrowsable(EditorBrowsableState.Never)]
3428 public override readonly bool Equals(object obj);
3429 [EditorBrowsable(EditorBrowsableState.Never)]
3430 public override readonly int GetHashCode();
3431 public static bool operator ==(ResponseConversationSelection left, ResponseConversationSelection right);
3432 public static implicit operator ResponseConversationSelection(string value);
3433 public static bool operator !=(ResponseConversationSelection left, ResponseConversationSelection right);
3434 public override readonly string ToString();
3435 }
3436 public class ResponseFinishedUpdate : RealtimeUpdate, IJsonModel<ResponseFinishedUpdate>, IPersistableModel<ResponseFinishedUpdate> {
3437 public IReadOnlyList<RealtimeItem> CreatedItems { get; }
3438 public string ResponseId { get; }
3439 public ConversationStatus? Status { get; }
3440 public ConversationStatusDetails StatusDetails { get; }
3441 public ConversationTokenUsage Usage { get; }
3442 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3443 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3444 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3445 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3446 }
3447 public class ResponseStartedUpdate : RealtimeUpdate, IJsonModel<ResponseStartedUpdate>, IPersistableModel<ResponseStartedUpdate> {
3448 public IReadOnlyList<RealtimeItem> CreatedItems { get; }
3449 public string ResponseId { get; }
3450 public ConversationStatus Status { get; }
3451 public ConversationStatusDetails StatusDetails { get; }
3452 public ConversationTokenUsage Usage { get; }
3453 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3454 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3455 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3456 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3457 }
3458 public class TranscriptionSessionConfiguredUpdate : RealtimeUpdate, IJsonModel<TranscriptionSessionConfiguredUpdate>, IPersistableModel<TranscriptionSessionConfiguredUpdate> {
3459 public RealtimeContentModalities ContentModalities { get; }
3460 public RealtimeAudioFormat InputAudioFormat { get; }
3461 public InputTranscriptionOptions InputAudioTranscription { get; }
3462 public TurnDetectionOptions TurnDetection { get; }
3463 protected override RealtimeUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3464 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3465 protected override RealtimeUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3466 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3467 }
3468 public class TranscriptionSessionOptions : IJsonModel<TranscriptionSessionOptions>, IPersistableModel<TranscriptionSessionOptions> {
3469 public RealtimeContentModalities ContentModalities { get; set; }
3470 public IList<string> Include { get; }
3471 public RealtimeAudioFormat? InputAudioFormat { get; set; }
3472 public InputNoiseReductionOptions InputNoiseReductionOptions { get; set; }
3473 public InputTranscriptionOptions InputTranscriptionOptions { get; set; }
3474 public TurnDetectionOptions TurnDetectionOptions { get; set; }
3475 protected virtual TranscriptionSessionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3476 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3477 protected virtual TranscriptionSessionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3478 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3479 }
3480 public enum TurnDetectionKind {
3481 Unknown = 0,
3482 ServerVoiceActivityDetection = 1,
3483 SemanticVoiceActivityDetection = 2,
3484 Disabled = 3
3485 }
3486 public class TurnDetectionOptions : IJsonModel<TurnDetectionOptions>, IPersistableModel<TurnDetectionOptions> {
3487 public TurnDetectionKind Kind { get; }
3488 public static TurnDetectionOptions CreateDisabledTurnDetectionOptions();
3489 public static TurnDetectionOptions CreateServerVoiceActivityTurnDetectionOptions(float? detectionThreshold = null, TimeSpan? prefixPaddingDuration = null, TimeSpan? silenceDuration = null, bool? enableAutomaticResponseCreation = null, bool? enableResponseInterruption = null);
3490 protected virtual TurnDetectionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3491 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3492 protected virtual TurnDetectionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3493 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3494 }
3495}
3496namespace OpenAI.Responses {
3497 public class ComputerCallAction : IJsonModel<ComputerCallAction>, IPersistableModel<ComputerCallAction> {
3498 public Drawing.Point? ClickCoordinates { get; }
3499 public ComputerCallActionMouseButton? ClickMouseButton { get; }
3500 public Drawing.Point? DoubleClickCoordinates { get; }
3501 public IList<Drawing.Point> DragPath { get; }
3502 public IList<string> KeyPressKeyCodes { get; }
3503 public ComputerCallActionKind Kind { get; }
3504 public Drawing.Point? MoveCoordinates { get; }
3505 public Drawing.Point? ScrollCoordinates { get; }
3506 public int? ScrollHorizontalOffset { get; }
3507 public int? ScrollVerticalOffset { get; }
3508 public string TypeText { get; }
3509 public static ComputerCallAction CreateClickAction(Drawing.Point clickCoordinates, ComputerCallActionMouseButton clickMouseButton);
3510 public static ComputerCallAction CreateDoubleClickAction(Drawing.Point doubleClickCoordinates, ComputerCallActionMouseButton doubleClickMouseButton);
3511 public static ComputerCallAction CreateDragAction(IList<Drawing.Point> dragPath);
3512 public static ComputerCallAction CreateKeyPressAction(IList<string> keyCodes);
3513 public static ComputerCallAction CreateMoveAction(Drawing.Point moveCoordinates);
3514 public static ComputerCallAction CreateScreenshotAction();
3515 public static ComputerCallAction CreateScrollAction(Drawing.Point scrollCoordinates, int horizontalOffset, int verticalOffset);
3516 public static ComputerCallAction CreateTypeAction(string typeText);
3517 public static ComputerCallAction CreateWaitAction();
3518 protected virtual ComputerCallAction JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3519 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3520 protected virtual ComputerCallAction PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3521 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3522 }
3523 public enum ComputerCallActionKind {
3524 Click = 0,
3525 DoubleClick = 1,
3526 Drag = 2,
3527 KeyPress = 3,
3528 Move = 4,
3529 Screenshot = 5,
3530 Scroll = 6,
3531 Type = 7,
3532 Wait = 8
3533 }
3534 public enum ComputerCallActionMouseButton {
3535 Left = 0,
3536 Right = 1,
3537 Wheel = 2,
3538 Back = 3,
3539 Forward = 4
3540 }
3541 public class ComputerCallOutputResponseItem : ResponseItem, IJsonModel<ComputerCallOutputResponseItem>, IPersistableModel<ComputerCallOutputResponseItem> {
3542 public IList<ComputerCallSafetyCheck> AcknowledgedSafetyChecks { get; }
3543 public string CallId { get; }
3544 public ComputerOutput Output { get; }
3545 public ComputerCallOutputStatus? Status { get; }
3546 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3547 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3548 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3549 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3550 }
3551 public enum ComputerCallOutputStatus {
3552 InProgress = 0,
3553 Completed = 1,
3554 Incomplete = 2
3555 }
3556 public class ComputerCallResponseItem : ResponseItem, IJsonModel<ComputerCallResponseItem>, IPersistableModel<ComputerCallResponseItem> {
3557 public ComputerCallResponseItem(string callId, ComputerCallAction action, IEnumerable<ComputerCallSafetyCheck> pendingSafetyChecks);
3558 public ComputerCallAction Action { get; }
3559 public string CallId { get; }
3560 public IList<ComputerCallSafetyCheck> PendingSafetyChecks { get; }
3561 public ComputerCallStatus? Status { get; }
3562 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3563 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3564 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3565 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3566 }
3567 public class ComputerCallSafetyCheck : IJsonModel<ComputerCallSafetyCheck>, IPersistableModel<ComputerCallSafetyCheck> {
3568 public ComputerCallSafetyCheck(string id, string code, string message);
3569 public string Code { get; set; }
3570 public string Id { get; set; }
3571 public string Message { get; set; }
3572 protected virtual ComputerCallSafetyCheck JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3573 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3574 protected virtual ComputerCallSafetyCheck PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3575 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3576 }
3577 public enum ComputerCallStatus {
3578 InProgress = 0,
3579 Completed = 1,
3580 Incomplete = 2
3581 }
3582 public class ComputerOutput : IJsonModel<ComputerOutput>, IPersistableModel<ComputerOutput> {
3583 public static ComputerOutput CreateScreenshotOutput(BinaryData screenshotImageBytes, string screenshotImageBytesMediaType);
3584 public static ComputerOutput CreateScreenshotOutput(string screenshotImageFileId);
3585 public static ComputerOutput CreateScreenshotOutput(Uri screenshotImageUri);
3586 protected virtual ComputerOutput JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3587 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3588 protected virtual ComputerOutput PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3589 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3590 }
3591 public readonly partial struct ComputerToolEnvironment : IEquatable<ComputerToolEnvironment> {
3592 public ComputerToolEnvironment(string value);
3593 public static ComputerToolEnvironment Browser { get; }
3594 public static ComputerToolEnvironment Linux { get; }
3595 public static ComputerToolEnvironment Mac { get; }
3596 public static ComputerToolEnvironment Ubuntu { get; }
3597 public static ComputerToolEnvironment Windows { get; }
3598 public readonly bool Equals(ComputerToolEnvironment other);
3599 [EditorBrowsable(EditorBrowsableState.Never)]
3600 public override readonly bool Equals(object obj);
3601 [EditorBrowsable(EditorBrowsableState.Never)]
3602 public override readonly int GetHashCode();
3603 public static bool operator ==(ComputerToolEnvironment left, ComputerToolEnvironment right);
3604 public static implicit operator ComputerToolEnvironment(string value);
3605 public static bool operator !=(ComputerToolEnvironment left, ComputerToolEnvironment right);
3606 public override readonly string ToString();
3607 }
3608 public class FileSearchCallResponseItem : ResponseItem, IJsonModel<FileSearchCallResponseItem>, IPersistableModel<FileSearchCallResponseItem> {
3609 public IList<string> Queries { get; }
3610 public IList<FileSearchCallResult> Results { get; }
3611 public FileSearchCallStatus? Status { get; }
3612 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3613 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3614 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3615 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3616 }
3617 public class FileSearchCallResult : IJsonModel<FileSearchCallResult>, IPersistableModel<FileSearchCallResult> {
3618 public IReadOnlyDictionary<string, BinaryData> Attributes { get; }
3619 public string FileId { get; set; }
3620 public string Filename { get; set; }
3621 public float? Score { get; set; }
3622 public string Text { get; set; }
3623 protected virtual FileSearchCallResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3624 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3625 protected virtual FileSearchCallResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3626 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3627 }
3628 public enum FileSearchCallStatus {
3629 InProgress = 0,
3630 Searching = 1,
3631 Completed = 2,
3632 Incomplete = 3,
3633 Failed = 4
3634 }
3635 public readonly partial struct FileSearchToolRanker : IEquatable<FileSearchToolRanker> {
3636 public FileSearchToolRanker(string value);
3637 public static FileSearchToolRanker Auto { get; }
3638 public static FileSearchToolRanker Default20241115 { get; }
3639 public readonly bool Equals(FileSearchToolRanker other);
3640 [EditorBrowsable(EditorBrowsableState.Never)]
3641 public override readonly bool Equals(object obj);
3642 [EditorBrowsable(EditorBrowsableState.Never)]
3643 public override readonly int GetHashCode();
3644 public static bool operator ==(FileSearchToolRanker left, FileSearchToolRanker right);
3645 public static implicit operator FileSearchToolRanker(string value);
3646 public static bool operator !=(FileSearchToolRanker left, FileSearchToolRanker right);
3647 public override readonly string ToString();
3648 }
3649 public class FileSearchToolRankingOptions : IJsonModel<FileSearchToolRankingOptions>, IPersistableModel<FileSearchToolRankingOptions> {
3650 public FileSearchToolRanker? Ranker { get; set; }
3651 public float? ScoreThreshold { get; set; }
3652 protected virtual FileSearchToolRankingOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3653 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3654 protected virtual FileSearchToolRankingOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3655 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3656 }
3657 public class FunctionCallOutputResponseItem : ResponseItem, IJsonModel<FunctionCallOutputResponseItem>, IPersistableModel<FunctionCallOutputResponseItem> {
3658 public string CallId { get; }
3659 public string FunctionOutput { get; set; }
3660 public FunctionCallOutputStatus? Status { get; }
3661 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3662 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3663 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3664 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3665 }
3666 public enum FunctionCallOutputStatus {
3667 InProgress = 0,
3668 Completed = 1,
3669 Incomplete = 2
3670 }
3671 public class FunctionCallResponseItem : ResponseItem, IJsonModel<FunctionCallResponseItem>, IPersistableModel<FunctionCallResponseItem> {
3672 public string CallId { get; }
3673 public BinaryData FunctionArguments { get; set; }
3674 public string FunctionName { get; set; }
3675 public FunctionCallStatus? Status { get; }
3676 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3677 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3678 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3679 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3680 }
3681 public enum FunctionCallStatus {
3682 InProgress = 0,
3683 Completed = 1,
3684 Incomplete = 2
3685 }
3686 public class MessageResponseItem : ResponseItem, IJsonModel<MessageResponseItem>, IPersistableModel<MessageResponseItem> {
3687 public IList<ResponseContentPart> Content { get; }
3688 public MessageRole Role { get; }
3689 public MessageStatus? Status { get; }
3690 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3691 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3692 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3693 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3694 }
3695 public enum MessageRole {
3696 Unknown = 0,
3697 Assistant = 1,
3698 Developer = 2,
3699 System = 3,
3700 User = 4
3701 }
3702 public enum MessageStatus {
3703 InProgress = 0,
3704 Completed = 1,
3705 Incomplete = 2
3706 }
3707 public class OpenAIResponse : IJsonModel<OpenAIResponse>, IPersistableModel<OpenAIResponse> {
3708 public bool? Background { get; }
3709 public DateTimeOffset CreatedAt { get; }
3710 public string EndUserId { get; }
3711 public ResponseError Error { get; }
3712 public string Id { get; }
3713 public ResponseIncompleteStatusDetails IncompleteStatusDetails { get; }
3714 public string Instructions { get; }
3715 public int? MaxOutputTokenCount { get; }
3716 public IDictionary<string, string> Metadata { get; }
3717 public string Model { get; }
3718 public IList<ResponseItem> OutputItems { get; }
3719 public bool ParallelToolCallsEnabled { get; }
3720 public string PreviousResponseId { get; }
3721 public ResponseReasoningOptions ReasoningOptions { get; }
3722 public ResponseStatus? Status { get; }
3723 public float? Temperature { get; }
3724 public ResponseTextOptions TextOptions { get; }
3725 public ResponseToolChoice ToolChoice { get; }
3726 public IList<ResponseTool> Tools { get; }
3727 public float? TopP { get; }
3728 public ResponseTruncationMode? TruncationMode { get; }
3729 public ResponseTokenUsage Usage { get; }
3730 public string GetOutputText();
3731 protected virtual OpenAIResponse JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3732 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3733 protected virtual OpenAIResponse PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3734 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3735 }
3736 public class OpenAIResponseClient {
3737 protected OpenAIResponseClient();
3738 protected internal OpenAIResponseClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
3739 public OpenAIResponseClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
3740 public OpenAIResponseClient(string model, ApiKeyCredential credential);
3741 public OpenAIResponseClient(string model, string apiKey);
3742 public ClientPipeline Pipeline { get; }
3743 public virtual ClientResult CancelResponse(string responseId, RequestOptions options);
3744 public virtual ClientResult<OpenAIResponse> CancelResponse(string responseId, CancellationToken cancellationToken = default);
3745 public virtual Task<ClientResult> CancelResponseAsync(string responseId, RequestOptions options);
3746 public virtual Task<ClientResult<OpenAIResponse>> CancelResponseAsync(string responseId, CancellationToken cancellationToken = default);
3747 [EditorBrowsable(EditorBrowsableState.Never)]
3748 public virtual ClientResult CreateResponse(BinaryContent content, RequestOptions options = null);
3749 public virtual ClientResult<OpenAIResponse> CreateResponse(IEnumerable<ResponseItem> inputItems, ResponseCreationOptions options = null, CancellationToken cancellationToken = default);
3750 public virtual ClientResult<OpenAIResponse> CreateResponse(string userInputText, ResponseCreationOptions options = null, CancellationToken cancellationToken = default);
3751 [EditorBrowsable(EditorBrowsableState.Never)]
3752 public virtual Task<ClientResult> CreateResponseAsync(BinaryContent content, RequestOptions options = null);
3753 public virtual Task<ClientResult<OpenAIResponse>> CreateResponseAsync(IEnumerable<ResponseItem> inputItems, ResponseCreationOptions options = null, CancellationToken cancellationToken = default);
3754 public virtual Task<ClientResult<OpenAIResponse>> CreateResponseAsync(string userInputText, ResponseCreationOptions options = null, CancellationToken cancellationToken = default);
3755 public virtual CollectionResult<StreamingResponseUpdate> CreateResponseStreaming(IEnumerable<ResponseItem> inputItems, ResponseCreationOptions options = null, CancellationToken cancellationToken = default);
3756 public virtual CollectionResult<StreamingResponseUpdate> CreateResponseStreaming(string userInputText, ResponseCreationOptions options = null, CancellationToken cancellationToken = default);
3757 public virtual AsyncCollectionResult<StreamingResponseUpdate> CreateResponseStreamingAsync(IEnumerable<ResponseItem> inputItems, ResponseCreationOptions options = null, CancellationToken cancellationToken = default);
3758 public virtual AsyncCollectionResult<StreamingResponseUpdate> CreateResponseStreamingAsync(string userInputText, ResponseCreationOptions options = null, CancellationToken cancellationToken = default);
3759 [EditorBrowsable(EditorBrowsableState.Never)]
3760 public virtual ClientResult DeleteResponse(string responseId, RequestOptions options);
3761 public virtual ClientResult<ResponseDeletionResult> DeleteResponse(string responseId, CancellationToken cancellationToken = default);
3762 [EditorBrowsable(EditorBrowsableState.Never)]
3763 public virtual Task<ClientResult> DeleteResponseAsync(string responseId, RequestOptions options);
3764 public virtual Task<ClientResult<ResponseDeletionResult>> DeleteResponseAsync(string responseId, CancellationToken cancellationToken = default);
3765 [EditorBrowsable(EditorBrowsableState.Never)]
3766 public virtual ClientResult GetResponse(string responseId, bool? stream, int? startingAfter, RequestOptions options);
3767 public virtual ClientResult<OpenAIResponse> GetResponse(string responseId, CancellationToken cancellationToken = default);
3768 [EditorBrowsable(EditorBrowsableState.Never)]
3769 public virtual Task<ClientResult> GetResponseAsync(string responseId, bool? stream, int? startingAfter, RequestOptions options);
3770 public virtual Task<ClientResult<OpenAIResponse>> GetResponseAsync(string responseId, CancellationToken cancellationToken = default);
3771 public virtual CollectionResult<ResponseItem> GetResponseInputItems(string responseId, ResponseItemCollectionOptions options = null, CancellationToken cancellationToken = default);
3772 [EditorBrowsable(EditorBrowsableState.Never)]
3773 public virtual CollectionResult GetResponseInputItems(string responseId, int? limit, string order, string after, string before, RequestOptions options = null);
3774 public virtual AsyncCollectionResult<ResponseItem> GetResponseInputItemsAsync(string responseId, ResponseItemCollectionOptions options = null, CancellationToken cancellationToken = default);
3775 [EditorBrowsable(EditorBrowsableState.Never)]
3776 public virtual AsyncCollectionResult GetResponseInputItemsAsync(string responseId, int? limit, string order, string after, string before, RequestOptions options = null);
3777 public virtual CollectionResult<StreamingResponseUpdate> GetResponseStreaming(string responseId, int? startingAfter = null, CancellationToken cancellationToken = default);
3778 public virtual AsyncCollectionResult<StreamingResponseUpdate> GetResponseStreamingAsync(string responseId, int? startingAfter = null, CancellationToken cancellationToken = default);
3779 }
3780 public class ReasoningResponseItem : ResponseItem, IJsonModel<ReasoningResponseItem>, IPersistableModel<ReasoningResponseItem> {
3781 public ReasoningResponseItem(IEnumerable<ReasoningSummaryPart> summaryParts);
3782 public ReasoningResponseItem(string summaryText);
3783 public string EncryptedContent { get; }
3784 public ReasoningStatus? Status { get; }
3785 public IReadOnlyList<ReasoningSummaryPart> SummaryParts { get; }
3786 public string GetSummaryText();
3787 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3788 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3789 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3790 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3791 }
3792 public enum ReasoningStatus {
3793 InProgress = 0,
3794 Completed = 1,
3795 Incomplete = 2
3796 }
3797 public class ReasoningSummaryPart : IJsonModel<ReasoningSummaryPart>, IPersistableModel<ReasoningSummaryPart> {
3798 public static ReasoningSummaryPart CreateTextPart(string text);
3799 protected virtual ReasoningSummaryPart JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3800 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3801 protected virtual ReasoningSummaryPart PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3802 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3803 }
3804 public class ReasoningSummaryTextPart : ReasoningSummaryPart, IJsonModel<ReasoningSummaryTextPart>, IPersistableModel<ReasoningSummaryTextPart> {
3805 public ReasoningSummaryTextPart(string text);
3806 public string Text { get; set; }
3807 protected override ReasoningSummaryPart JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3808 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3809 protected override ReasoningSummaryPart PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3810 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3811 }
3812 public class ReferenceResponseItem : ResponseItem, IJsonModel<ReferenceResponseItem>, IPersistableModel<ReferenceResponseItem> {
3813 public ReferenceResponseItem(string id);
3814 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3815 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3816 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3817 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3818 }
3819 public class ResponseContentPart : IJsonModel<ResponseContentPart>, IPersistableModel<ResponseContentPart> {
3820 public BinaryData InputFileBytes { get; }
3821 public string InputFileBytesMediaType { get; }
3822 public string InputFileId { get; }
3823 public string InputFilename { get; }
3824 public ResponseImageDetailLevel? InputImageDetailLevel { get; }
3825 public string InputImageFileId { get; }
3826 public ResponseContentPartKind Kind { get; }
3827 public IReadOnlyList<ResponseMessageAnnotation> OutputTextAnnotations { get; }
3828 public string Refusal { get; }
3829 public string Text { get; }
3830 public static ResponseContentPart CreateInputFilePart(BinaryData fileBytes, string fileBytesMediaType, string filename);
3831 public static ResponseContentPart CreateInputFilePart(string fileId);
3832 public static ResponseContentPart CreateInputImagePart(BinaryData imageBytes, string imageBytesMediaType, ResponseImageDetailLevel? imageDetailLevel = null);
3833 public static ResponseContentPart CreateInputImagePart(string imageFileId, ResponseImageDetailLevel? imageDetailLevel = null);
3834 public static ResponseContentPart CreateInputImagePart(Uri imageUri, ResponseImageDetailLevel? imageDetailLevel = null);
3835 public static ResponseContentPart CreateInputTextPart(string text);
3836 public static ResponseContentPart CreateOutputTextPart(string text, IEnumerable<ResponseMessageAnnotation> annotations);
3837 public static ResponseContentPart CreateRefusalPart(string refusal);
3838 protected virtual ResponseContentPart JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3839 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3840 protected virtual ResponseContentPart PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3841 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3842 }
3843 public enum ResponseContentPartKind {
3844 Unknown = 0,
3845 InputText = 1,
3846 InputImage = 2,
3847 InputFile = 3,
3848 OutputText = 4,
3849 Refusal = 5
3850 }
3851 public class ResponseCreationOptions : IJsonModel<ResponseCreationOptions>, IPersistableModel<ResponseCreationOptions> {
3852 public bool? Background { get; set; }
3853 public string EndUserId { get; set; }
3854 public string Instructions { get; set; }
3855 public int? MaxOutputTokenCount { get; set; }
3856 public IDictionary<string, string> Metadata { get; }
3857 public bool? ParallelToolCallsEnabled { get; set; }
3858 public string PreviousResponseId { get; set; }
3859 public ResponseReasoningOptions ReasoningOptions { get; set; }
3860 public bool? StoredOutputEnabled { get; set; }
3861 public float? Temperature { get; set; }
3862 public ResponseTextOptions TextOptions { get; set; }
3863 public ResponseToolChoice ToolChoice { get; set; }
3864 public IList<ResponseTool> Tools { get; }
3865 public float? TopP { get; set; }
3866 public ResponseTruncationMode? TruncationMode { get; set; }
3867 protected virtual ResponseCreationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3868 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3869 protected virtual ResponseCreationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3870 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3871 }
3872 public class ResponseDeletionResult : IJsonModel<ResponseDeletionResult>, IPersistableModel<ResponseDeletionResult> {
3873 public bool Deleted { get; }
3874 public string Id { get; }
3875 protected virtual ResponseDeletionResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3876 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3877 protected virtual ResponseDeletionResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3878 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3879 }
3880 public class ResponseError : IJsonModel<ResponseError>, IPersistableModel<ResponseError> {
3881 public ResponseErrorCode Code { get; }
3882 public string Message { get; }
3883 protected virtual ResponseError JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3884 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3885 protected virtual ResponseError PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3886 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3887 }
3888 public readonly partial struct ResponseErrorCode : IEquatable<ResponseErrorCode> {
3889 public ResponseErrorCode(string value);
3890 public static ResponseErrorCode EmptyImageFile { get; }
3891 public static ResponseErrorCode FailedToDownloadImage { get; }
3892 public static ResponseErrorCode ImageContentPolicyViolation { get; }
3893 public static ResponseErrorCode ImageFileNotFound { get; }
3894 public static ResponseErrorCode ImageFileTooLarge { get; }
3895 public static ResponseErrorCode ImageParseError { get; }
3896 public static ResponseErrorCode ImageTooLarge { get; }
3897 public static ResponseErrorCode ImageTooSmall { get; }
3898 public static ResponseErrorCode InvalidBase64Image { get; }
3899 public static ResponseErrorCode InvalidImage { get; }
3900 public static ResponseErrorCode InvalidImageFormat { get; }
3901 public static ResponseErrorCode InvalidImageMode { get; }
3902 public static ResponseErrorCode InvalidImageUrl { get; }
3903 public static ResponseErrorCode InvalidPrompt { get; }
3904 public static ResponseErrorCode RateLimitExceeded { get; }
3905 public static ResponseErrorCode ServerError { get; }
3906 public static ResponseErrorCode UnsupportedImageMediaType { get; }
3907 public static ResponseErrorCode VectorStoreTimeout { get; }
3908 public readonly bool Equals(ResponseErrorCode other);
3909 [EditorBrowsable(EditorBrowsableState.Never)]
3910 public override readonly bool Equals(object obj);
3911 [EditorBrowsable(EditorBrowsableState.Never)]
3912 public override readonly int GetHashCode();
3913 public static bool operator ==(ResponseErrorCode left, ResponseErrorCode right);
3914 public static implicit operator ResponseErrorCode(string value);
3915 public static bool operator !=(ResponseErrorCode left, ResponseErrorCode right);
3916 public override readonly string ToString();
3917 }
3918 public readonly partial struct ResponseImageDetailLevel : IEquatable<ResponseImageDetailLevel> {
3919 public ResponseImageDetailLevel(string value);
3920 public static ResponseImageDetailLevel Auto { get; }
3921 public static ResponseImageDetailLevel High { get; }
3922 public static ResponseImageDetailLevel Low { get; }
3923 public readonly bool Equals(ResponseImageDetailLevel other);
3924 [EditorBrowsable(EditorBrowsableState.Never)]
3925 public override readonly bool Equals(object obj);
3926 [EditorBrowsable(EditorBrowsableState.Never)]
3927 public override readonly int GetHashCode();
3928 public static bool operator ==(ResponseImageDetailLevel left, ResponseImageDetailLevel right);
3929 public static implicit operator ResponseImageDetailLevel(string value);
3930 public static bool operator !=(ResponseImageDetailLevel left, ResponseImageDetailLevel right);
3931 public override readonly string ToString();
3932 }
3933 public class ResponseIncompleteStatusDetails : IJsonModel<ResponseIncompleteStatusDetails>, IPersistableModel<ResponseIncompleteStatusDetails> {
3934 public ResponseIncompleteStatusReason? Reason { get; }
3935 protected virtual ResponseIncompleteStatusDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3936 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3937 protected virtual ResponseIncompleteStatusDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3938 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3939 }
3940 public readonly partial struct ResponseIncompleteStatusReason : IEquatable<ResponseIncompleteStatusReason> {
3941 public ResponseIncompleteStatusReason(string value);
3942 public static ResponseIncompleteStatusReason ContentFilter { get; }
3943 public static ResponseIncompleteStatusReason MaxOutputTokens { get; }
3944 public readonly bool Equals(ResponseIncompleteStatusReason other);
3945 [EditorBrowsable(EditorBrowsableState.Never)]
3946 public override readonly bool Equals(object obj);
3947 [EditorBrowsable(EditorBrowsableState.Never)]
3948 public override readonly int GetHashCode();
3949 public static bool operator ==(ResponseIncompleteStatusReason left, ResponseIncompleteStatusReason right);
3950 public static implicit operator ResponseIncompleteStatusReason(string value);
3951 public static bool operator !=(ResponseIncompleteStatusReason left, ResponseIncompleteStatusReason right);
3952 public override readonly string ToString();
3953 }
3954 public class ResponseInputTokenUsageDetails : IJsonModel<ResponseInputTokenUsageDetails>, IPersistableModel<ResponseInputTokenUsageDetails> {
3955 public int CachedTokenCount { get; }
3956 protected virtual ResponseInputTokenUsageDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3957 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3958 protected virtual ResponseInputTokenUsageDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3959 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3960 }
3961 public class ResponseItem : IJsonModel<ResponseItem>, IPersistableModel<ResponseItem> {
3962 public string Id { get; }
3963 public static MessageResponseItem CreateAssistantMessageItem(IEnumerable<ResponseContentPart> contentParts);
3964 public static MessageResponseItem CreateAssistantMessageItem(string outputTextContent, IEnumerable<ResponseMessageAnnotation> annotations = null);
3965 public static ComputerCallResponseItem CreateComputerCallItem(string callId, ComputerCallAction action, IEnumerable<ComputerCallSafetyCheck> pendingSafetyChecks);
3966 public static ComputerCallOutputResponseItem CreateComputerCallOutputItem(string callId, IList<ComputerCallSafetyCheck> acknowledgedSafetyChecks, BinaryData screenshotImageBytes, string screenshotImageBytesMediaType);
3967 public static ComputerCallOutputResponseItem CreateComputerCallOutputItem(string callId, IList<ComputerCallSafetyCheck> acknowledgedSafetyChecks, string screenshotImageFileId);
3968 public static ComputerCallOutputResponseItem CreateComputerCallOutputItem(string callId, IList<ComputerCallSafetyCheck> acknowledgedSafetyChecks, Uri screenshotImageUri);
3969 public static MessageResponseItem CreateDeveloperMessageItem(IEnumerable<ResponseContentPart> contentParts);
3970 public static MessageResponseItem CreateDeveloperMessageItem(string inputTextContent);
3971 public static FileSearchCallResponseItem CreateFileSearchCallItem(IEnumerable<string> queries, IEnumerable<FileSearchCallResult> results);
3972 public static FunctionCallResponseItem CreateFunctionCallItem(string callId, string functionName, BinaryData functionArguments);
3973 public static FunctionCallOutputResponseItem CreateFunctionCallOutputItem(string callId, string functionOutput);
3974 public static ReasoningResponseItem CreateReasoningItem(IEnumerable<ReasoningSummaryPart> summaryParts);
3975 public static ReasoningResponseItem CreateReasoningItem(string summaryText);
3976 public static ReferenceResponseItem CreateReferenceItem(string id);
3977 public static MessageResponseItem CreateSystemMessageItem(IEnumerable<ResponseContentPart> contentParts);
3978 public static MessageResponseItem CreateSystemMessageItem(string inputTextContent);
3979 public static MessageResponseItem CreateUserMessageItem(IEnumerable<ResponseContentPart> contentParts);
3980 public static MessageResponseItem CreateUserMessageItem(string inputTextContent);
3981 public static WebSearchCallResponseItem CreateWebSearchCallItem();
3982 protected virtual ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
3983 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
3984 protected virtual ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
3985 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
3986 }
3987 public class ResponseItemCollectionOptions {
3988 public string AfterId { get; set; }
3989 public string BeforeId { get; set; }
3990 public ResponseItemCollectionOrder? Order { get; set; }
3991 public int? PageSizeLimit { get; set; }
3992 }
3993 public readonly partial struct ResponseItemCollectionOrder : IEquatable<ResponseItemCollectionOrder> {
3994 public ResponseItemCollectionOrder(string value);
3995 public static ResponseItemCollectionOrder Ascending { get; }
3996 public static ResponseItemCollectionOrder Descending { get; }
3997 public readonly bool Equals(ResponseItemCollectionOrder other);
3998 [EditorBrowsable(EditorBrowsableState.Never)]
3999 public override readonly bool Equals(object obj);
4000 [EditorBrowsable(EditorBrowsableState.Never)]
4001 public override readonly int GetHashCode();
4002 public static bool operator ==(ResponseItemCollectionOrder left, ResponseItemCollectionOrder right);
4003 public static implicit operator ResponseItemCollectionOrder(string value);
4004 public static bool operator !=(ResponseItemCollectionOrder left, ResponseItemCollectionOrder right);
4005 public override readonly string ToString();
4006 }
4007 public class ResponseMessageAnnotation : IJsonModel<ResponseMessageAnnotation>, IPersistableModel<ResponseMessageAnnotation> {
4008 public string FileCitationFileId { get; }
4009 public int? FileCitationIndex { get; }
4010 public string FilePathFileId { get; }
4011 public int? FilePathIndex { get; }
4012 public ResponseMessageAnnotationKind Kind { get; }
4013 public int? UriCitationEndIndex { get; }
4014 public int? UriCitationStartIndex { get; }
4015 public string UriCitationTitle { get; }
4016 public Uri UriCitationUri { get; }
4017 protected virtual ResponseMessageAnnotation JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4018 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4019 protected virtual ResponseMessageAnnotation PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4020 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4021 }
4022 public enum ResponseMessageAnnotationKind {
4023 FileCitation = 0,
4024 UriCitation = 1,
4025 FilePath = 2,
4026 ContainerFileCitation = 3
4027 }
4028 public class ResponseOutputTokenUsageDetails : IJsonModel<ResponseOutputTokenUsageDetails>, IPersistableModel<ResponseOutputTokenUsageDetails> {
4029 public int ReasoningTokenCount { get; }
4030 protected virtual ResponseOutputTokenUsageDetails JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4031 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4032 protected virtual ResponseOutputTokenUsageDetails PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4033 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4034 }
4035 public readonly partial struct ResponseReasoningEffortLevel : IEquatable<ResponseReasoningEffortLevel> {
4036 public ResponseReasoningEffortLevel(string value);
4037 public static ResponseReasoningEffortLevel High { get; }
4038 public static ResponseReasoningEffortLevel Low { get; }
4039 public static ResponseReasoningEffortLevel Medium { get; }
4040 public readonly bool Equals(ResponseReasoningEffortLevel other);
4041 [EditorBrowsable(EditorBrowsableState.Never)]
4042 public override readonly bool Equals(object obj);
4043 [EditorBrowsable(EditorBrowsableState.Never)]
4044 public override readonly int GetHashCode();
4045 public static bool operator ==(ResponseReasoningEffortLevel left, ResponseReasoningEffortLevel right);
4046 public static implicit operator ResponseReasoningEffortLevel(string value);
4047 public static bool operator !=(ResponseReasoningEffortLevel left, ResponseReasoningEffortLevel right);
4048 public override readonly string ToString();
4049 }
4050 public class ResponseReasoningOptions : IJsonModel<ResponseReasoningOptions>, IPersistableModel<ResponseReasoningOptions> {
4051 public ResponseReasoningEffortLevel? ReasoningEffortLevel { get; set; }
4052 public ResponseReasoningSummaryVerbosity? ReasoningSummaryVerbosity { get; set; }
4053 protected virtual ResponseReasoningOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4054 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4055 protected virtual ResponseReasoningOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4056 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4057 }
4058 public readonly partial struct ResponseReasoningSummaryVerbosity : IEquatable<ResponseReasoningSummaryVerbosity> {
4059 public ResponseReasoningSummaryVerbosity(string value);
4060 public static ResponseReasoningSummaryVerbosity Auto { get; }
4061 public static ResponseReasoningSummaryVerbosity Concise { get; }
4062 public static ResponseReasoningSummaryVerbosity Detailed { get; }
4063 public readonly bool Equals(ResponseReasoningSummaryVerbosity other);
4064 [EditorBrowsable(EditorBrowsableState.Never)]
4065 public override readonly bool Equals(object obj);
4066 [EditorBrowsable(EditorBrowsableState.Never)]
4067 public override readonly int GetHashCode();
4068 public static bool operator ==(ResponseReasoningSummaryVerbosity left, ResponseReasoningSummaryVerbosity right);
4069 public static implicit operator ResponseReasoningSummaryVerbosity(string value);
4070 public static bool operator !=(ResponseReasoningSummaryVerbosity left, ResponseReasoningSummaryVerbosity right);
4071 public override readonly string ToString();
4072 }
4073 public enum ResponseStatus {
4074 InProgress = 0,
4075 Completed = 1,
4076 Cancelled = 2,
4077 Queued = 3,
4078 Incomplete = 4,
4079 Failed = 5
4080 }
4081 public class ResponseTextFormat : IJsonModel<ResponseTextFormat>, IPersistableModel<ResponseTextFormat> {
4082 public ResponseTextFormatKind Kind { get; set; }
4083 public static ResponseTextFormat CreateJsonObjectFormat();
4084 public static ResponseTextFormat CreateJsonSchemaFormat(string jsonSchemaFormatName, BinaryData jsonSchema, string jsonSchemaFormatDescription = null, bool? jsonSchemaIsStrict = null);
4085 public static ResponseTextFormat CreateTextFormat();
4086 protected virtual ResponseTextFormat JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4087 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4088 protected virtual ResponseTextFormat PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4089 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4090 }
4091 public enum ResponseTextFormatKind {
4092 Unknown = 0,
4093 Text = 1,
4094 JsonObject = 2,
4095 JsonSchema = 3
4096 }
4097 public class ResponseTextOptions : IJsonModel<ResponseTextOptions>, IPersistableModel<ResponseTextOptions> {
4098 public ResponseTextFormat TextFormat { get; set; }
4099 protected virtual ResponseTextOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4100 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4101 protected virtual ResponseTextOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4102 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4103 }
4104 public class ResponseTokenUsage : IJsonModel<ResponseTokenUsage>, IPersistableModel<ResponseTokenUsage> {
4105 public int InputTokenCount { get; }
4106 public ResponseInputTokenUsageDetails InputTokenDetails { get; }
4107 public int OutputTokenCount { get; }
4108 public ResponseOutputTokenUsageDetails OutputTokenDetails { get; }
4109 public int TotalTokenCount { get; }
4110 protected virtual ResponseTokenUsage JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4111 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4112 protected virtual ResponseTokenUsage PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4113 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4114 }
4115 public class ResponseTool : IJsonModel<ResponseTool>, IPersistableModel<ResponseTool> {
4116 public static ResponseTool CreateComputerTool(ComputerToolEnvironment environment, int displayWidth, int displayHeight);
4117 public static ResponseTool CreateFileSearchTool(IEnumerable<string> vectorStoreIds, int? maxResultCount = null, FileSearchToolRankingOptions rankingOptions = null, BinaryData filters = null);
4118 public static ResponseTool CreateFunctionTool(string functionName, string functionDescription, BinaryData functionParameters, bool functionSchemaIsStrict = false);
4119 public static ResponseTool CreateWebSearchTool(WebSearchUserLocation userLocation = null, WebSearchContextSize? searchContextSize = null);
4120 protected virtual ResponseTool JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4121 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4122 protected virtual ResponseTool PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4123 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4124 }
4125 public class ResponseToolChoice : IJsonModel<ResponseToolChoice>, IPersistableModel<ResponseToolChoice> {
4126 public string FunctionName { get; }
4127 public ResponseToolChoiceKind Kind { get; }
4128 public static ResponseToolChoice CreateAutoChoice();
4129 public static ResponseToolChoice CreateComputerChoice();
4130 public static ResponseToolChoice CreateFileSearchChoice();
4131 public static ResponseToolChoice CreateFunctionChoice(string functionName);
4132 public static ResponseToolChoice CreateNoneChoice();
4133 public static ResponseToolChoice CreateRequiredChoice();
4134 public static ResponseToolChoice CreateWebSearchChoice();
4135 }
4136 public enum ResponseToolChoiceKind {
4137 Unknown = 0,
4138 Auto = 1,
4139 None = 2,
4140 Required = 3,
4141 Function = 4,
4142 FileSearch = 5,
4143 WebSearch = 6,
4144 Computer = 7
4145 }
4146 public readonly partial struct ResponseTruncationMode : IEquatable<ResponseTruncationMode> {
4147 public ResponseTruncationMode(string value);
4148 public static ResponseTruncationMode Auto { get; }
4149 public static ResponseTruncationMode Disabled { get; }
4150 public readonly bool Equals(ResponseTruncationMode other);
4151 [EditorBrowsable(EditorBrowsableState.Never)]
4152 public override readonly bool Equals(object obj);
4153 [EditorBrowsable(EditorBrowsableState.Never)]
4154 public override readonly int GetHashCode();
4155 public static bool operator ==(ResponseTruncationMode left, ResponseTruncationMode right);
4156 public static implicit operator ResponseTruncationMode(string value);
4157 public static bool operator !=(ResponseTruncationMode left, ResponseTruncationMode right);
4158 public override readonly string ToString();
4159 }
4160 public class StreamingResponseCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseCompletedUpdate>, IPersistableModel<StreamingResponseCompletedUpdate> {
4161 public OpenAIResponse Response { get; }
4162 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4163 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4164 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4165 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4166 }
4167 public class StreamingResponseContentPartAddedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseContentPartAddedUpdate>, IPersistableModel<StreamingResponseContentPartAddedUpdate> {
4168 public int ContentIndex { get; }
4169 public string ItemId { get; }
4170 public int OutputIndex { get; }
4171 public ResponseContentPart Part { get; }
4172 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4173 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4174 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4175 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4176 }
4177 public class StreamingResponseContentPartDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseContentPartDoneUpdate>, IPersistableModel<StreamingResponseContentPartDoneUpdate> {
4178 public int ContentIndex { get; }
4179 public string ItemId { get; }
4180 public int OutputIndex { get; }
4181 public ResponseContentPart Part { get; }
4182 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4183 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4184 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4185 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4186 }
4187 public class StreamingResponseCreatedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseCreatedUpdate>, IPersistableModel<StreamingResponseCreatedUpdate> {
4188 public OpenAIResponse Response { get; }
4189 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4190 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4191 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4192 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4193 }
4194 public class StreamingResponseErrorUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseErrorUpdate>, IPersistableModel<StreamingResponseErrorUpdate> {
4195 public string Code { get; }
4196 public string Message { get; }
4197 public string Param { get; }
4198 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4199 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4200 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4201 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4202 }
4203 public class StreamingResponseFailedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFailedUpdate>, IPersistableModel<StreamingResponseFailedUpdate> {
4204 public OpenAIResponse Response { get; }
4205 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4206 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4207 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4208 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4209 }
4210 public class StreamingResponseFileSearchCallCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFileSearchCallCompletedUpdate>, IPersistableModel<StreamingResponseFileSearchCallCompletedUpdate> {
4211 public string ItemId { get; }
4212 public int OutputIndex { get; }
4213 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4214 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4215 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4216 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4217 }
4218 public class StreamingResponseFileSearchCallInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFileSearchCallInProgressUpdate>, IPersistableModel<StreamingResponseFileSearchCallInProgressUpdate> {
4219 public string ItemId { get; }
4220 public int OutputIndex { get; }
4221 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4222 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4223 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4224 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4225 }
4226 public class StreamingResponseFileSearchCallSearchingUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFileSearchCallSearchingUpdate>, IPersistableModel<StreamingResponseFileSearchCallSearchingUpdate> {
4227 public string ItemId { get; }
4228 public int OutputIndex { get; }
4229 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4230 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4231 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4232 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4233 }
4234 public class StreamingResponseFunctionCallArgumentsDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFunctionCallArgumentsDeltaUpdate>, IPersistableModel<StreamingResponseFunctionCallArgumentsDeltaUpdate> {
4235 public string Delta { get; }
4236 public string ItemId { get; }
4237 public int OutputIndex { get; }
4238 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4239 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4240 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4241 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4242 }
4243 public class StreamingResponseFunctionCallArgumentsDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFunctionCallArgumentsDoneUpdate>, IPersistableModel<StreamingResponseFunctionCallArgumentsDoneUpdate> {
4244 public string Arguments { get; }
4245 public string ItemId { get; }
4246 public int OutputIndex { get; }
4247 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4248 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4249 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4250 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4251 }
4252 public class StreamingResponseIncompleteUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseIncompleteUpdate>, IPersistableModel<StreamingResponseIncompleteUpdate> {
4253 public OpenAIResponse Response { get; }
4254 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4255 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4256 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4257 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4258 }
4259 public class StreamingResponseInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseInProgressUpdate>, IPersistableModel<StreamingResponseInProgressUpdate> {
4260 public OpenAIResponse Response { get; }
4261 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4262 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4263 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4264 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4265 }
4266 public class StreamingResponseOutputItemAddedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseOutputItemAddedUpdate>, IPersistableModel<StreamingResponseOutputItemAddedUpdate> {
4267 public ResponseItem Item { get; }
4268 public int OutputIndex { get; }
4269 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4270 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4271 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4272 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4273 }
4274 public class StreamingResponseOutputItemDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseOutputItemDoneUpdate>, IPersistableModel<StreamingResponseOutputItemDoneUpdate> {
4275 public ResponseItem Item { get; }
4276 public int OutputIndex { get; }
4277 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4278 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4279 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4280 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4281 }
4282 public class StreamingResponseOutputTextDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseOutputTextDeltaUpdate>, IPersistableModel<StreamingResponseOutputTextDeltaUpdate> {
4283 public int ContentIndex { get; }
4284 public string Delta { get; }
4285 public string ItemId { get; }
4286 public int OutputIndex { get; }
4287 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4288 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4289 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4290 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4291 }
4292 public class StreamingResponseOutputTextDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseOutputTextDoneUpdate>, IPersistableModel<StreamingResponseOutputTextDoneUpdate> {
4293 public int ContentIndex { get; }
4294 public string ItemId { get; }
4295 public int OutputIndex { get; }
4296 public string Text { get; }
4297 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4298 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4299 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4300 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4301 }
4302 public class StreamingResponseQueuedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseQueuedUpdate>, IPersistableModel<StreamingResponseQueuedUpdate> {
4303 public OpenAIResponse Response { get; }
4304 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4305 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4306 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4307 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4308 }
4309 public class StreamingResponseRefusalDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseRefusalDeltaUpdate>, IPersistableModel<StreamingResponseRefusalDeltaUpdate> {
4310 public int ContentIndex { get; }
4311 public string Delta { get; }
4312 public string ItemId { get; }
4313 public int OutputIndex { get; }
4314 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4315 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4316 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4317 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4318 }
4319 public class StreamingResponseRefusalDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseRefusalDoneUpdate>, IPersistableModel<StreamingResponseRefusalDoneUpdate> {
4320 public int ContentIndex { get; }
4321 public string ItemId { get; }
4322 public int OutputIndex { get; }
4323 public string Refusal { get; }
4324 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4325 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4326 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4327 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4328 }
4329 public class StreamingResponseTextAnnotationAddedUpdate {
4330 }
4331 public class StreamingResponseUpdate : IJsonModel<StreamingResponseUpdate>, IPersistableModel<StreamingResponseUpdate> {
4332 public int SequenceNumber { get; }
4333 protected virtual StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4334 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4335 protected virtual StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4336 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4337 }
4338 public class StreamingResponseWebSearchCallCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseWebSearchCallCompletedUpdate>, IPersistableModel<StreamingResponseWebSearchCallCompletedUpdate> {
4339 public string ItemId { get; }
4340 public int OutputIndex { get; }
4341 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4342 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4343 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4344 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4345 }
4346 public class StreamingResponseWebSearchCallInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseWebSearchCallInProgressUpdate>, IPersistableModel<StreamingResponseWebSearchCallInProgressUpdate> {
4347 public string ItemId { get; }
4348 public int OutputIndex { get; }
4349 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4350 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4351 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4352 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4353 }
4354 public class StreamingResponseWebSearchCallSearchingUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseWebSearchCallSearchingUpdate>, IPersistableModel<StreamingResponseWebSearchCallSearchingUpdate> {
4355 public string ItemId { get; }
4356 public int OutputIndex { get; }
4357 protected override StreamingResponseUpdate JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4358 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4359 protected override StreamingResponseUpdate PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4360 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4361 }
4362 public class WebSearchCallResponseItem : ResponseItem, IJsonModel<WebSearchCallResponseItem>, IPersistableModel<WebSearchCallResponseItem> {
4363 public WebSearchCallStatus? Status { get; }
4364 protected override ResponseItem JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4365 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4366 protected override ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4367 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4368 }
4369 public enum WebSearchCallStatus {
4370 InProgress = 0,
4371 Searching = 1,
4372 Completed = 2,
4373 Failed = 3
4374 }
4375 public readonly partial struct WebSearchContextSize : IEquatable<WebSearchContextSize> {
4376 public WebSearchContextSize(string value);
4377 public static WebSearchContextSize High { get; }
4378 public static WebSearchContextSize Low { get; }
4379 public static WebSearchContextSize Medium { get; }
4380 public readonly bool Equals(WebSearchContextSize other);
4381 [EditorBrowsable(EditorBrowsableState.Never)]
4382 public override readonly bool Equals(object obj);
4383 [EditorBrowsable(EditorBrowsableState.Never)]
4384 public override readonly int GetHashCode();
4385 public static bool operator ==(WebSearchContextSize left, WebSearchContextSize right);
4386 public static implicit operator WebSearchContextSize(string value);
4387 public static bool operator !=(WebSearchContextSize left, WebSearchContextSize right);
4388 public override readonly string ToString();
4389 }
4390 public class WebSearchUserLocation : IJsonModel<WebSearchUserLocation>, IPersistableModel<WebSearchUserLocation> {
4391 public static WebSearchUserLocation CreateApproximateLocation(string country = null, string region = null, string city = null, string timezone = null);
4392 protected virtual WebSearchUserLocation JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4393 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4394 protected virtual WebSearchUserLocation PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4395 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4396 }
4397}
4398namespace OpenAI.VectorStores {
4399 public class AddFileToVectorStoreOperation : OperationResult {
4400 public string FileId { get; }
4401 public override ContinuationToken? RehydrationToken { get; protected set; }
4402 public VectorStoreFileAssociationStatus? Status { get; }
4403 public VectorStoreFileAssociation? Value { get; }
4404 public string VectorStoreId { get; }
4405 [EditorBrowsable(EditorBrowsableState.Never)]
4406 public virtual ClientResult GetFileAssociation(RequestOptions? options);
4407 public virtual ClientResult<VectorStoreFileAssociation> GetFileAssociation(CancellationToken cancellationToken = default);
4408 [EditorBrowsable(EditorBrowsableState.Never)]
4409 public virtual Task<ClientResult> GetFileAssociationAsync(RequestOptions? options);
4410 public virtual Task<ClientResult<VectorStoreFileAssociation>> GetFileAssociationAsync(CancellationToken cancellationToken = default);
4411 public static AddFileToVectorStoreOperation Rehydrate(VectorStoreClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
4412 public static Task<AddFileToVectorStoreOperation> RehydrateAsync(VectorStoreClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
4413 public override ClientResult UpdateStatus(RequestOptions? options = null);
4414 public override ValueTask<ClientResult> UpdateStatusAsync(RequestOptions? options = null);
4415 }
4416 public class CreateBatchFileJobOperation : OperationResult {
4417 public string BatchId { get; }
4418 public override ContinuationToken? RehydrationToken { get; protected set; }
4419 public VectorStoreBatchFileJobStatus? Status { get; }
4420 public VectorStoreBatchFileJob? Value { get; }
4421 public string VectorStoreId { get; }
4422 [EditorBrowsable(EditorBrowsableState.Never)]
4423 public virtual ClientResult Cancel(RequestOptions? options);
4424 public virtual ClientResult<VectorStoreBatchFileJob> Cancel(CancellationToken cancellationToken = default);
4425 [EditorBrowsable(EditorBrowsableState.Never)]
4426 public virtual Task<ClientResult> CancelAsync(RequestOptions? options);
4427 public virtual Task<ClientResult<VectorStoreBatchFileJob>> CancelAsync(CancellationToken cancellationToken = default);
4428 [EditorBrowsable(EditorBrowsableState.Never)]
4429 public virtual ClientResult GetFileBatch(RequestOptions? options);
4430 public virtual ClientResult<VectorStoreBatchFileJob> GetFileBatch(CancellationToken cancellationToken = default);
4431 [EditorBrowsable(EditorBrowsableState.Never)]
4432 public virtual Task<ClientResult> GetFileBatchAsync(RequestOptions? options);
4433 public virtual Task<ClientResult<VectorStoreBatchFileJob>> GetFileBatchAsync(CancellationToken cancellationToken = default);
4434 public static CreateBatchFileJobOperation Rehydrate(VectorStoreClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
4435 public static Task<CreateBatchFileJobOperation> RehydrateAsync(VectorStoreClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
4436 public override ClientResult UpdateStatus(RequestOptions? options = null);
4437 public override ValueTask<ClientResult> UpdateStatusAsync(RequestOptions? options = null);
4438 }
4439 public class CreateVectorStoreOperation : OperationResult {
4440 public override ContinuationToken? RehydrationToken { get; protected set; }
4441 public VectorStoreStatus? Status { get; }
4442 public VectorStore? Value { get; }
4443 public string VectorStoreId { get; }
4444 [EditorBrowsable(EditorBrowsableState.Never)]
4445 public virtual ClientResult GetVectorStore(RequestOptions? options);
4446 public virtual ClientResult<VectorStore> GetVectorStore(CancellationToken cancellationToken = default);
4447 [EditorBrowsable(EditorBrowsableState.Never)]
4448 public virtual Task<ClientResult> GetVectorStoreAsync(RequestOptions? options);
4449 public virtual Task<ClientResult<VectorStore>> GetVectorStoreAsync(CancellationToken cancellationToken = default);
4450 public static CreateVectorStoreOperation Rehydrate(VectorStoreClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
4451 public static Task<CreateVectorStoreOperation> RehydrateAsync(VectorStoreClient client, ContinuationToken rehydrationToken, CancellationToken cancellationToken = default);
4452 public override ClientResult UpdateStatus(RequestOptions? options = null);
4453 public override ValueTask<ClientResult> UpdateStatusAsync(RequestOptions? options = null);
4454 }
4455 public abstract class FileChunkingStrategy : IJsonModel<FileChunkingStrategy>, IPersistableModel<FileChunkingStrategy> {
4456 public static FileChunkingStrategy Auto { get; }
4457 public static FileChunkingStrategy Unknown { get; }
4458 public static FileChunkingStrategy CreateStaticStrategy(int maxTokensPerChunk, int overlappingTokenCount);
4459 protected virtual FileChunkingStrategy JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4460 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4461 protected virtual FileChunkingStrategy PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4462 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4463 }
4464 public class FileFromStoreRemovalResult : IJsonModel<FileFromStoreRemovalResult>, IPersistableModel<FileFromStoreRemovalResult> {
4465 public string FileId { get; }
4466 public bool Removed { get; }
4467 protected virtual FileFromStoreRemovalResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4468 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4469 protected virtual FileFromStoreRemovalResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4470 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4471 }
4472 public class StaticFileChunkingStrategy : FileChunkingStrategy, IJsonModel<StaticFileChunkingStrategy>, IPersistableModel<StaticFileChunkingStrategy> {
4473 public StaticFileChunkingStrategy(int maxTokensPerChunk, int overlappingTokenCount);
4474 public int MaxTokensPerChunk { get; }
4475 public int OverlappingTokenCount { get; }
4476 protected override FileChunkingStrategy JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4477 protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4478 protected override FileChunkingStrategy PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4479 protected override BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4480 }
4481 public class VectorStore : IJsonModel<VectorStore>, IPersistableModel<VectorStore> {
4482 public DateTimeOffset CreatedAt { get; }
4483 public VectorStoreExpirationPolicy ExpirationPolicy { get; }
4484 public DateTimeOffset? ExpiresAt { get; }
4485 public VectorStoreFileCounts FileCounts { get; }
4486 public string Id { get; }
4487 public DateTimeOffset? LastActiveAt { get; }
4488 public IReadOnlyDictionary<string, string> Metadata { get; }
4489 public string Name { get; }
4490 public VectorStoreStatus Status { get; }
4491 public int UsageBytes { get; }
4492 protected virtual VectorStore JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4493 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4494 protected virtual VectorStore PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4495 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4496 }
4497 public class VectorStoreBatchFileJob : IJsonModel<VectorStoreBatchFileJob>, IPersistableModel<VectorStoreBatchFileJob> {
4498 public string BatchId { get; }
4499 public DateTimeOffset CreatedAt { get; }
4500 public VectorStoreFileCounts FileCounts { get; }
4501 public VectorStoreBatchFileJobStatus Status { get; }
4502 public string VectorStoreId { get; }
4503 protected virtual VectorStoreBatchFileJob JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4504 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4505 protected virtual VectorStoreBatchFileJob PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4506 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4507 }
4508 public readonly partial struct VectorStoreBatchFileJobStatus : IEquatable<VectorStoreBatchFileJobStatus> {
4509 public VectorStoreBatchFileJobStatus(string value);
4510 public static VectorStoreBatchFileJobStatus Cancelled { get; }
4511 public static VectorStoreBatchFileJobStatus Completed { get; }
4512 public static VectorStoreBatchFileJobStatus Failed { get; }
4513 public static VectorStoreBatchFileJobStatus InProgress { get; }
4514 public readonly bool Equals(VectorStoreBatchFileJobStatus other);
4515 [EditorBrowsable(EditorBrowsableState.Never)]
4516 public override readonly bool Equals(object obj);
4517 [EditorBrowsable(EditorBrowsableState.Never)]
4518 public override readonly int GetHashCode();
4519 public static bool operator ==(VectorStoreBatchFileJobStatus left, VectorStoreBatchFileJobStatus right);
4520 public static implicit operator VectorStoreBatchFileJobStatus(string value);
4521 public static bool operator !=(VectorStoreBatchFileJobStatus left, VectorStoreBatchFileJobStatus right);
4522 public override readonly string ToString();
4523 }
4524 public class VectorStoreClient {
4525 protected VectorStoreClient();
4526 public VectorStoreClient(ApiKeyCredential credential, OpenAIClientOptions options);
4527 public VectorStoreClient(ApiKeyCredential credential);
4528 protected internal VectorStoreClient(ClientPipeline pipeline, OpenAIClientOptions options);
4529 public VectorStoreClient(string apiKey);
4530 public ClientPipeline Pipeline { get; }
4531 [EditorBrowsable(EditorBrowsableState.Never)]
4532 public virtual AddFileToVectorStoreOperation AddFileToVectorStore(string vectorStoreId, BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
4533 public virtual AddFileToVectorStoreOperation AddFileToVectorStore(string vectorStoreId, string fileId, bool waitUntilCompleted, CancellationToken cancellationToken = default);
4534 [EditorBrowsable(EditorBrowsableState.Never)]
4535 public virtual Task<AddFileToVectorStoreOperation> AddFileToVectorStoreAsync(string vectorStoreId, BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
4536 public virtual Task<AddFileToVectorStoreOperation> AddFileToVectorStoreAsync(string vectorStoreId, string fileId, bool waitUntilCompleted, CancellationToken cancellationToken = default);
4537 [EditorBrowsable(EditorBrowsableState.Never)]
4538 public virtual ClientResult CancelBatchFileJob(string vectorStoreId, string batchId, RequestOptions options);
4539 public virtual ClientResult<VectorStoreBatchFileJob> CancelBatchFileJob(string vectorStoreId, string batchJobId, CancellationToken cancellationToken = default);
4540 [EditorBrowsable(EditorBrowsableState.Never)]
4541 public virtual Task<ClientResult> CancelBatchFileJobAsync(string vectorStoreId, string batchId, RequestOptions options);
4542 public virtual Task<ClientResult<VectorStoreBatchFileJob>> CancelBatchFileJobAsync(string vectorStoreId, string batchJobId, CancellationToken cancellationToken = default);
4543 [EditorBrowsable(EditorBrowsableState.Never)]
4544 public virtual CreateBatchFileJobOperation CreateBatchFileJob(string vectorStoreId, BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
4545 public virtual CreateBatchFileJobOperation CreateBatchFileJob(string vectorStoreId, IEnumerable<string> fileIds, bool waitUntilCompleted, CancellationToken cancellationToken = default);
4546 [EditorBrowsable(EditorBrowsableState.Never)]
4547 public virtual Task<CreateBatchFileJobOperation> CreateBatchFileJobAsync(string vectorStoreId, BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
4548 public virtual Task<CreateBatchFileJobOperation> CreateBatchFileJobAsync(string vectorStoreId, IEnumerable<string> fileIds, bool waitUntilCompleted, CancellationToken cancellationToken = default);
4549 public virtual CreateVectorStoreOperation CreateVectorStore(bool waitUntilCompleted, VectorStoreCreationOptions options = null, CancellationToken cancellationToken = default);
4550 [EditorBrowsable(EditorBrowsableState.Never)]
4551 public virtual CreateVectorStoreOperation CreateVectorStore(BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
4552 public virtual ClientResult CreateVectorStore(BinaryContent content, RequestOptions options = null);
4553 public virtual Task<CreateVectorStoreOperation> CreateVectorStoreAsync(bool waitUntilCompleted, VectorStoreCreationOptions options = null, CancellationToken cancellationToken = default);
4554 [EditorBrowsable(EditorBrowsableState.Never)]
4555 public virtual Task<CreateVectorStoreOperation> CreateVectorStoreAsync(BinaryContent content, bool waitUntilCompleted, RequestOptions options = null);
4556 public virtual Task<ClientResult> CreateVectorStoreAsync(BinaryContent content, RequestOptions options = null);
4557 [EditorBrowsable(EditorBrowsableState.Never)]
4558 public virtual ClientResult DeleteVectorStore(string vectorStoreId, RequestOptions options);
4559 public virtual ClientResult<VectorStoreDeletionResult> DeleteVectorStore(string vectorStoreId, CancellationToken cancellationToken = default);
4560 [EditorBrowsable(EditorBrowsableState.Never)]
4561 public virtual Task<ClientResult> DeleteVectorStoreAsync(string vectorStoreId, RequestOptions options);
4562 public virtual Task<ClientResult<VectorStoreDeletionResult>> DeleteVectorStoreAsync(string vectorStoreId, CancellationToken cancellationToken = default);
4563 public virtual ClientResult<VectorStoreBatchFileJob> GetBatchFileJob(string vectorStoreId, string batchJobId, CancellationToken cancellationToken = default);
4564 public virtual Task<ClientResult<VectorStoreBatchFileJob>> GetBatchFileJobAsync(string vectorStoreId, string batchJobId, CancellationToken cancellationToken = default);
4565 [EditorBrowsable(EditorBrowsableState.Never)]
4566 public virtual ClientResult GetFileAssociation(string vectorStoreId, string fileId, RequestOptions options);
4567 public virtual ClientResult<VectorStoreFileAssociation> GetFileAssociation(string vectorStoreId, string fileId, CancellationToken cancellationToken = default);
4568 [EditorBrowsable(EditorBrowsableState.Never)]
4569 public virtual Task<ClientResult> GetFileAssociationAsync(string vectorStoreId, string fileId, RequestOptions options);
4570 public virtual Task<ClientResult<VectorStoreFileAssociation>> GetFileAssociationAsync(string vectorStoreId, string fileId, CancellationToken cancellationToken = default);
4571 public virtual CollectionResult<VectorStoreFileAssociation> GetFileAssociations(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
4572 public virtual CollectionResult<VectorStoreFileAssociation> GetFileAssociations(string vectorStoreId, VectorStoreFileAssociationCollectionOptions options = null, CancellationToken cancellationToken = default);
4573 [EditorBrowsable(EditorBrowsableState.Never)]
4574 public virtual CollectionResult GetFileAssociations(string vectorStoreId, int? limit, string order, string after, string before, string filter, RequestOptions options);
4575 public virtual CollectionResult<VectorStoreFileAssociation> GetFileAssociations(string vectorStoreId, string batchJobId, VectorStoreFileAssociationCollectionOptions options = null, CancellationToken cancellationToken = default);
4576 public virtual CollectionResult<VectorStoreFileAssociation> GetFileAssociations(string vectorStoreId, string batchJobId, ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
4577 [EditorBrowsable(EditorBrowsableState.Never)]
4578 public virtual CollectionResult GetFileAssociations(string vectorStoreId, string batchId, int? limit, string order, string after, string before, string filter, RequestOptions options);
4579 public virtual AsyncCollectionResult<VectorStoreFileAssociation> GetFileAssociationsAsync(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
4580 public virtual AsyncCollectionResult<VectorStoreFileAssociation> GetFileAssociationsAsync(string vectorStoreId, VectorStoreFileAssociationCollectionOptions options = null, CancellationToken cancellationToken = default);
4581 [EditorBrowsable(EditorBrowsableState.Never)]
4582 public virtual AsyncCollectionResult GetFileAssociationsAsync(string vectorStoreId, int? limit, string order, string after, string before, string filter, RequestOptions options);
4583 public virtual AsyncCollectionResult<VectorStoreFileAssociation> GetFileAssociationsAsync(string vectorStoreId, string batchJobId, VectorStoreFileAssociationCollectionOptions options = null, CancellationToken cancellationToken = default);
4584 public virtual AsyncCollectionResult<VectorStoreFileAssociation> GetFileAssociationsAsync(string vectorStoreId, string batchJobId, ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
4585 [EditorBrowsable(EditorBrowsableState.Never)]
4586 public virtual AsyncCollectionResult GetFileAssociationsAsync(string vectorStoreId, string batchId, int? limit, string order, string after, string before, string filter, RequestOptions options);
4587 public virtual ClientResult<VectorStore> GetVectorStore(string vectorStoreId, CancellationToken cancellationToken = default);
4588 public virtual CollectionResult<VectorStore> GetVectorStores(VectorStoreCollectionOptions options = null, CancellationToken cancellationToken = default);
4589 public virtual CollectionResult<VectorStore> GetVectorStores(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
4590 [EditorBrowsable(EditorBrowsableState.Never)]
4591 public virtual CollectionResult GetVectorStores(int? limit, string order, string after, string before, RequestOptions options);
4592 public virtual AsyncCollectionResult<VectorStore> GetVectorStoresAsync(VectorStoreCollectionOptions options = null, CancellationToken cancellationToken = default);
4593 public virtual AsyncCollectionResult<VectorStore> GetVectorStoresAsync(ContinuationToken firstPageToken, CancellationToken cancellationToken = default);
4594 [EditorBrowsable(EditorBrowsableState.Never)]
4595 public virtual AsyncCollectionResult GetVectorStoresAsync(int? limit, string order, string after, string before, RequestOptions options);
4596 public virtual ClientResult<VectorStore> ModifyVectorStore(string vectorStoreId, VectorStoreModificationOptions options, CancellationToken cancellationToken = default);
4597 [EditorBrowsable(EditorBrowsableState.Never)]
4598 public virtual ClientResult ModifyVectorStore(string vectorStoreId, BinaryContent content, RequestOptions options = null);
4599 public virtual Task<ClientResult<VectorStore>> ModifyVectorStoreAsync(string vectorStoreId, VectorStoreModificationOptions options, CancellationToken cancellationToken = default);
4600 [EditorBrowsable(EditorBrowsableState.Never)]
4601 public virtual Task<ClientResult> ModifyVectorStoreAsync(string vectorStoreId, BinaryContent content, RequestOptions options = null);
4602 [EditorBrowsable(EditorBrowsableState.Never)]
4603 public virtual ClientResult RemoveFileFromStore(string vectorStoreId, string fileId, RequestOptions options);
4604 public virtual ClientResult<FileFromStoreRemovalResult> RemoveFileFromStore(string vectorStoreId, string fileId, CancellationToken cancellationToken = default);
4605 [EditorBrowsable(EditorBrowsableState.Never)]
4606 public virtual Task<ClientResult> RemoveFileFromStoreAsync(string vectorStoreId, string fileId, RequestOptions options);
4607 public virtual Task<ClientResult<FileFromStoreRemovalResult>> RemoveFileFromStoreAsync(string vectorStoreId, string fileId, CancellationToken cancellationToken = default);
4608 public virtual ClientResult RetrieveVectorStoreFileContent(string vectorStoreId, string fileId, RequestOptions options);
4609 public virtual Task<ClientResult> RetrieveVectorStoreFileContentAsync(string vectorStoreId, string fileId, RequestOptions options);
4610 public virtual ClientResult SearchVectorStore(string vectorStoreId, BinaryContent content, RequestOptions options = null);
4611 public virtual Task<ClientResult> SearchVectorStoreAsync(string vectorStoreId, BinaryContent content, RequestOptions options = null);
4612 public virtual ClientResult UpdateVectorStoreFileAttributes(string vectorStoreId, string fileId, BinaryContent content, RequestOptions options = null);
4613 public virtual ClientResult<VectorStoreFileAssociation> UpdateVectorStoreFileAttributes(string vectorStoreId, string fileId, IDictionary<string, BinaryData> attributes, CancellationToken cancellationToken = default);
4614 public virtual Task<ClientResult> UpdateVectorStoreFileAttributesAsync(string vectorStoreId, string fileId, BinaryContent content, RequestOptions options = null);
4615 public virtual Task<ClientResult<VectorStoreFileAssociation>> UpdateVectorStoreFileAttributesAsync(string vectorStoreId, string fileId, IDictionary<string, BinaryData> attributes, CancellationToken cancellationToken = default);
4616 }
4617 public class VectorStoreCollectionOptions {
4618 public string AfterId { get; set; }
4619 public string BeforeId { get; set; }
4620 public VectorStoreCollectionOrder? Order { get; set; }
4621 public int? PageSizeLimit { get; set; }
4622 }
4623 public readonly partial struct VectorStoreCollectionOrder : IEquatable<VectorStoreCollectionOrder> {
4624 public VectorStoreCollectionOrder(string value);
4625 public static VectorStoreCollectionOrder Ascending { get; }
4626 public static VectorStoreCollectionOrder Descending { get; }
4627 public readonly bool Equals(VectorStoreCollectionOrder other);
4628 [EditorBrowsable(EditorBrowsableState.Never)]
4629 public override readonly bool Equals(object obj);
4630 [EditorBrowsable(EditorBrowsableState.Never)]
4631 public override readonly int GetHashCode();
4632 public static bool operator ==(VectorStoreCollectionOrder left, VectorStoreCollectionOrder right);
4633 public static implicit operator VectorStoreCollectionOrder(string value);
4634 public static bool operator !=(VectorStoreCollectionOrder left, VectorStoreCollectionOrder right);
4635 public override readonly string ToString();
4636 }
4637 public class VectorStoreCreationOptions : IJsonModel<VectorStoreCreationOptions>, IPersistableModel<VectorStoreCreationOptions> {
4638 public FileChunkingStrategy ChunkingStrategy { get; set; }
4639 public VectorStoreExpirationPolicy ExpirationPolicy { get; set; }
4640 public IList<string> FileIds { get; }
4641 public IDictionary<string, string> Metadata { get; }
4642 public string Name { get; set; }
4643 protected virtual VectorStoreCreationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4644 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4645 protected virtual VectorStoreCreationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4646 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4647 }
4648 public class VectorStoreDeletionResult : IJsonModel<VectorStoreDeletionResult>, IPersistableModel<VectorStoreDeletionResult> {
4649 public bool Deleted { get; }
4650 public string VectorStoreId { get; }
4651 protected virtual VectorStoreDeletionResult JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4652 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4653 protected virtual VectorStoreDeletionResult PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4654 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4655 }
4656 public enum VectorStoreExpirationAnchor {
4657 Unknown = 0,
4658 LastActiveAt = 1
4659 }
4660 public class VectorStoreExpirationPolicy : IJsonModel<VectorStoreExpirationPolicy>, IPersistableModel<VectorStoreExpirationPolicy> {
4661 public VectorStoreExpirationPolicy(VectorStoreExpirationAnchor anchor, int days);
4662 public VectorStoreExpirationAnchor Anchor { get; set; }
4663 public int Days { get; set; }
4664 protected virtual VectorStoreExpirationPolicy JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4665 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4666 protected virtual VectorStoreExpirationPolicy PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4667 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4668 }
4669 public class VectorStoreFileAssociation : IJsonModel<VectorStoreFileAssociation>, IPersistableModel<VectorStoreFileAssociation> {
4670 public IDictionary<string, BinaryData> Attributes { get; }
4671 public FileChunkingStrategy ChunkingStrategy { get; }
4672 public DateTimeOffset CreatedAt { get; }
4673 public string FileId { get; }
4674 public VectorStoreFileAssociationError LastError { get; }
4675 public int Size { get; }
4676 public VectorStoreFileAssociationStatus Status { get; }
4677 public string VectorStoreId { get; }
4678 protected virtual VectorStoreFileAssociation JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4679 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4680 protected virtual VectorStoreFileAssociation PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4681 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4682 }
4683 public class VectorStoreFileAssociationCollectionOptions {
4684 public string AfterId { get; set; }
4685 public string BeforeId { get; set; }
4686 public VectorStoreFileStatusFilter? Filter { get; set; }
4687 public VectorStoreFileAssociationCollectionOrder? Order { get; set; }
4688 public int? PageSizeLimit { get; set; }
4689 }
4690 public readonly partial struct VectorStoreFileAssociationCollectionOrder : IEquatable<VectorStoreFileAssociationCollectionOrder> {
4691 public VectorStoreFileAssociationCollectionOrder(string value);
4692 public static VectorStoreFileAssociationCollectionOrder Ascending { get; }
4693 public static VectorStoreFileAssociationCollectionOrder Descending { get; }
4694 public readonly bool Equals(VectorStoreFileAssociationCollectionOrder other);
4695 [EditorBrowsable(EditorBrowsableState.Never)]
4696 public override readonly bool Equals(object obj);
4697 [EditorBrowsable(EditorBrowsableState.Never)]
4698 public override readonly int GetHashCode();
4699 public static bool operator ==(VectorStoreFileAssociationCollectionOrder left, VectorStoreFileAssociationCollectionOrder right);
4700 public static implicit operator VectorStoreFileAssociationCollectionOrder(string value);
4701 public static bool operator !=(VectorStoreFileAssociationCollectionOrder left, VectorStoreFileAssociationCollectionOrder right);
4702 public override readonly string ToString();
4703 }
4704 public class VectorStoreFileAssociationError : IJsonModel<VectorStoreFileAssociationError>, IPersistableModel<VectorStoreFileAssociationError> {
4705 public VectorStoreFileAssociationErrorCode Code { get; }
4706 public string Message { get; }
4707 protected virtual VectorStoreFileAssociationError JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4708 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4709 protected virtual VectorStoreFileAssociationError PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4710 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4711 }
4712 public readonly partial struct VectorStoreFileAssociationErrorCode : IEquatable<VectorStoreFileAssociationErrorCode> {
4713 public VectorStoreFileAssociationErrorCode(string value);
4714 public static VectorStoreFileAssociationErrorCode InvalidFile { get; }
4715 public static VectorStoreFileAssociationErrorCode ServerError { get; }
4716 public static VectorStoreFileAssociationErrorCode UnsupportedFile { get; }
4717 public readonly bool Equals(VectorStoreFileAssociationErrorCode other);
4718 [EditorBrowsable(EditorBrowsableState.Never)]
4719 public override readonly bool Equals(object obj);
4720 [EditorBrowsable(EditorBrowsableState.Never)]
4721 public override readonly int GetHashCode();
4722 public static bool operator ==(VectorStoreFileAssociationErrorCode left, VectorStoreFileAssociationErrorCode right);
4723 public static implicit operator VectorStoreFileAssociationErrorCode(string value);
4724 public static bool operator !=(VectorStoreFileAssociationErrorCode left, VectorStoreFileAssociationErrorCode right);
4725 public override readonly string ToString();
4726 }
4727 public enum VectorStoreFileAssociationStatus {
4728 Unknown = 0,
4729 InProgress = 1,
4730 Completed = 2,
4731 Cancelled = 3,
4732 Failed = 4
4733 }
4734 public class VectorStoreFileCounts : IJsonModel<VectorStoreFileCounts>, IPersistableModel<VectorStoreFileCounts> {
4735 public int Cancelled { get; }
4736 public int Completed { get; }
4737 public int Failed { get; }
4738 public int InProgress { get; }
4739 public int Total { get; }
4740 protected virtual VectorStoreFileCounts JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4741 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4742 protected virtual VectorStoreFileCounts PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4743 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4744 }
4745 public readonly partial struct VectorStoreFileStatusFilter : IEquatable<VectorStoreFileStatusFilter> {
4746 public VectorStoreFileStatusFilter(string value);
4747 public static VectorStoreFileStatusFilter Cancelled { get; }
4748 public static VectorStoreFileStatusFilter Completed { get; }
4749 public static VectorStoreFileStatusFilter Failed { get; }
4750 public static VectorStoreFileStatusFilter InProgress { get; }
4751 public readonly bool Equals(VectorStoreFileStatusFilter other);
4752 [EditorBrowsable(EditorBrowsableState.Never)]
4753 public override readonly bool Equals(object obj);
4754 [EditorBrowsable(EditorBrowsableState.Never)]
4755 public override readonly int GetHashCode();
4756 public static bool operator ==(VectorStoreFileStatusFilter left, VectorStoreFileStatusFilter right);
4757 public static implicit operator VectorStoreFileStatusFilter(string value);
4758 public static bool operator !=(VectorStoreFileStatusFilter left, VectorStoreFileStatusFilter right);
4759 public override readonly string ToString();
4760 }
4761 public class VectorStoreModificationOptions : IJsonModel<VectorStoreModificationOptions>, IPersistableModel<VectorStoreModificationOptions> {
4762 public VectorStoreExpirationPolicy ExpirationPolicy { get; set; }
4763 public IDictionary<string, string> Metadata { get; }
4764 public string Name { get; set; }
4765 protected virtual VectorStoreModificationOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
4766 protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
4767 protected virtual VectorStoreModificationOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
4768 protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
4769 }
4770 public enum VectorStoreStatus {
4771 Unknown = 0,
4772 InProgress = 1,
4773 Completed = 2,
4774 Expired = 3
4775 }
4776}