openai/openai-dotnet

Public

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

CodeCommitsIssuesPull requestsActionsInsightsSecurity
OpenAI_2.3.0

Branches

Tags

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

Clone

HTTPS

Download ZIP

api/OpenAI.netstandard2.0.cs

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