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
achandmsft-patch-2

Branches

Tags

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

Clone

HTTPS

Download ZIP

openai-dotnet/api

api/OpenAI.net8.0.cs

5677lines · modecode

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