openai/openai-dotnet

Public

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

CodeCommitsIssuesPull requestsActionsInsightsSecurity
OpenAI_2.4.0

Branches

Tags

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

Clone

HTTPS

Download ZIP

api/OpenAI.net8.0.cs

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