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.netstandard2.0.cs

5537lines · modecode

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