openai/openai-dotnet

Public

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

CodeCommitsIssuesPull requestsActionsInsightsSecurity
copilot/update-dotnet-version-to-10

Branches

Tags

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

Clone

HTTPS

Download ZIP

api/OpenAI.net8.0.cs

7114lines · modecode

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