GitVita
New repositoryImport repositoryNew issue
Your repositories Your dashboard Sign in

openai/openai-dotnet

Public

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

Watch0Fork0Star0
CodeCommitsIssuesPull requestsActionsInsightsSecurity
copilot/sub-pr-1135

Branches

Tags

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

Clone

HTTPS

Download ZIP

openai-dotnet/api

api/OpenAI.Responses.net10.0.cs

1853lines · modecode

RawDownload
Latest commit unavailable.
1//------------------------------------------------------------------------------
2// <auto-generated>
3// This file is auto-generated by scripts/Export-Api.ps1 and must not be
4// modified manually. To update it, make the necessary source-code changes
5// and re-run scripts/Export-Api.ps1 to regenerate it.
6// </auto-generated>
7//------------------------------------------------------------------------------
8namespace OpenAI.Responses {
9 [Experimental("OPENAI001")]
10 public class ApplyPatchCallItem : ResponseItem, IJsonModel<ApplyPatchCallItem>, IPersistableModel<ApplyPatchCallItem> {
11 public ApplyPatchCallItem(string callId, ApplyPatchOperation operation);
12 public string CallId { get; set; }
13 public string CreatedBy { get; set; }
14 public ApplyPatchOperation Operation { get; set; }
15 public ApplyPatchCallStatus? Status { get; set; }
16 }
17 [Experimental("OPENAI001")]
18 public class ApplyPatchCallOutputItem : ResponseItem, IJsonModel<ApplyPatchCallOutputItem>, IPersistableModel<ApplyPatchCallOutputItem> {
19 public ApplyPatchCallOutputItem(string callId, ApplyPatchCallOutputStatus status);
20 public string CallId { get; set; }
21 public string CreatedBy { get; set; }
22 public string Output { get; set; }
23 public ApplyPatchCallOutputStatus Status { get; set; }
24 }
25 [Experimental("OPENAI001")]
26 public readonly partial struct ApplyPatchCallOutputStatus : IEquatable<ApplyPatchCallOutputStatus> {
27 public ApplyPatchCallOutputStatus(string value);
28 public static ApplyPatchCallOutputStatus Completed { get; }
29 public static ApplyPatchCallOutputStatus Failed { get; }
30 public readonly bool Equals(ApplyPatchCallOutputStatus other);
31 [EditorBrowsable(EditorBrowsableState.Never)]
32 public override readonly bool Equals(object obj);
33 [EditorBrowsable(EditorBrowsableState.Never)]
34 public override readonly int GetHashCode();
35 public static bool operator ==(ApplyPatchCallOutputStatus left, ApplyPatchCallOutputStatus right);
36 public static implicit operator ApplyPatchCallOutputStatus(string value);
37 public static implicit operator ApplyPatchCallOutputStatus?(string value);
38 public static bool operator !=(ApplyPatchCallOutputStatus left, ApplyPatchCallOutputStatus right);
39 public override readonly string ToString();
40 }
41 [Experimental("OPENAI001")]
42 public readonly partial struct ApplyPatchCallStatus : IEquatable<ApplyPatchCallStatus> {
43 public ApplyPatchCallStatus(string value);
44 public static ApplyPatchCallStatus Completed { get; }
45 public static ApplyPatchCallStatus InProgress { get; }
46 public readonly bool Equals(ApplyPatchCallStatus other);
47 [EditorBrowsable(EditorBrowsableState.Never)]
48 public override readonly bool Equals(object obj);
49 [EditorBrowsable(EditorBrowsableState.Never)]
50 public override readonly int GetHashCode();
51 public static bool operator ==(ApplyPatchCallStatus left, ApplyPatchCallStatus right);
52 public static implicit operator ApplyPatchCallStatus(string value);
53 public static implicit operator ApplyPatchCallStatus?(string value);
54 public static bool operator !=(ApplyPatchCallStatus left, ApplyPatchCallStatus right);
55 public override readonly string ToString();
56 }
57 [Experimental("OPENAI001")]
58 public class ApplyPatchCreateFileOperation : ApplyPatchOperation, IJsonModel<ApplyPatchCreateFileOperation>, IPersistableModel<ApplyPatchCreateFileOperation> {
59 public ApplyPatchCreateFileOperation(string filePath, string diff);
60 public string Diff { get; set; }
61 public string FilePath { get; set; }
62 }
63 [Experimental("OPENAI001")]
64 public class ApplyPatchDeleteFileOperation : ApplyPatchOperation, IJsonModel<ApplyPatchDeleteFileOperation>, IPersistableModel<ApplyPatchDeleteFileOperation> {
65 public ApplyPatchDeleteFileOperation(string filePath);
66 public string FilePath { get; set; }
67 }
68 [Experimental("OPENAI001")]
69 public class ApplyPatchOperation : IJsonModel<ApplyPatchOperation>, IPersistableModel<ApplyPatchOperation> {
70 [Serialization.JsonIgnore]
71 [EditorBrowsable(EditorBrowsableState.Never)]
72 [Experimental("SCME0001")]
73 public ref JsonPatch Patch { get; }
74 }
75 [Experimental("OPENAI001")]
76 public class ApplyPatchTool : ResponseTool, IJsonModel<ApplyPatchTool>, IPersistableModel<ApplyPatchTool> {
77 public ApplyPatchTool();
78 }
79 [Experimental("OPENAI001")]
80 public class ApplyPatchUpdateFileOperation : ApplyPatchOperation, IJsonModel<ApplyPatchUpdateFileOperation>, IPersistableModel<ApplyPatchUpdateFileOperation> {
81 public ApplyPatchUpdateFileOperation(string filePath, string diff);
82 public string Diff { get; set; }
83 public string FilePath { get; set; }
84 }
85 [Experimental("OPENAI001")]
86 public class AutomaticCodeInterpreterToolContainerConfiguration : CodeInterpreterToolContainerConfiguration, IJsonModel<AutomaticCodeInterpreterToolContainerConfiguration>, IPersistableModel<AutomaticCodeInterpreterToolContainerConfiguration> {
87 public AutomaticCodeInterpreterToolContainerConfiguration();
88 public IList<string> FileIds { get; }
89 }
90 [Experimental("OPENAI001")]
91 public class CodeInterpreterCallImageOutput : CodeInterpreterCallOutput, IJsonModel<CodeInterpreterCallImageOutput>, IPersistableModel<CodeInterpreterCallImageOutput> {
92 public CodeInterpreterCallImageOutput(Uri imageUri);
93 public Uri ImageUri { get; set; }
94 }
95 [Experimental("OPENAI001")]
96 public class CodeInterpreterCallLogsOutput : CodeInterpreterCallOutput, IJsonModel<CodeInterpreterCallLogsOutput>, IPersistableModel<CodeInterpreterCallLogsOutput> {
97 public CodeInterpreterCallLogsOutput(string logs);
98 public string Logs { get; set; }
99 }
100 [Experimental("OPENAI001")]
101 public class CodeInterpreterCallOutput : IJsonModel<CodeInterpreterCallOutput>, IPersistableModel<CodeInterpreterCallOutput> {
102 [Serialization.JsonIgnore]
103 [EditorBrowsable(EditorBrowsableState.Never)]
104 [Experimental("SCME0001")]
105 public ref JsonPatch Patch { get; }
106 }
107 [Experimental("OPENAI001")]
108 public class CodeInterpreterCallResponseItem : ResponseItem, IJsonModel<CodeInterpreterCallResponseItem>, IPersistableModel<CodeInterpreterCallResponseItem> {
109 public CodeInterpreterCallResponseItem(string code);
110 public string Code { get; set; }
111 public string ContainerId { get; set; }
112 public IList<CodeInterpreterCallOutput> Outputs { get; }
113 public CodeInterpreterCallStatus? Status { get; set; }
114 }
115 [Experimental("OPENAI001")]
116 public enum CodeInterpreterCallStatus {
117 InProgress = 0,
118 Interpreting = 1,
119 Completed = 2,
120 Incomplete = 3,
121 Failed = 4
122 }
123 [Experimental("OPENAI001")]
124 public class CodeInterpreterTool : ResponseTool, IJsonModel<CodeInterpreterTool>, IPersistableModel<CodeInterpreterTool> {
125 public CodeInterpreterTool(CodeInterpreterToolContainer container);
126 public CodeInterpreterToolContainer Container { get; }
127 }
128 [Experimental("OPENAI001")]
129 public class CodeInterpreterToolContainer : IJsonModel<CodeInterpreterToolContainer>, IPersistableModel<CodeInterpreterToolContainer> {
130 public CodeInterpreterToolContainer(CodeInterpreterToolContainerConfiguration containerConfiguration);
131 public CodeInterpreterToolContainer(string containerId);
132 public CodeInterpreterToolContainerConfiguration ContainerConfiguration { get; }
133 public string ContainerId { get; }
134 [Serialization.JsonIgnore]
135 [EditorBrowsable(EditorBrowsableState.Never)]
136 [Experimental("SCME0001")]
137 public ref JsonPatch Patch { get; }
138 }
139 [Experimental("OPENAI001")]
140 public class CodeInterpreterToolContainerConfiguration : IJsonModel<CodeInterpreterToolContainerConfiguration>, IPersistableModel<CodeInterpreterToolContainerConfiguration> {
141 [Serialization.JsonIgnore]
142 [EditorBrowsable(EditorBrowsableState.Never)]
143 [Experimental("SCME0001")]
144 public ref JsonPatch Patch { get; }
145 public static AutomaticCodeInterpreterToolContainerConfiguration CreateAutomaticContainerConfiguration(IEnumerable<string> fileIds = null);
146 }
147 [Experimental("OPENAICUA001")]
148 public class ComputerCallAction : IJsonModel<ComputerCallAction>, IPersistableModel<ComputerCallAction> {
149 public Drawing.Point? ClickCoordinates { get; }
150 public ComputerCallActionMouseButton? ClickMouseButton { get; }
151 public Drawing.Point? DoubleClickCoordinates { get; }
152 public IList<Drawing.Point> DragPath { get; }
153 public IList<string> KeyPressKeyCodes { get; }
154 public ComputerCallActionKind Kind { get; }
155 public Drawing.Point? MoveCoordinates { get; }
156 [Serialization.JsonIgnore]
157 [EditorBrowsable(EditorBrowsableState.Never)]
158 [Experimental("SCME0001")]
159 public ref JsonPatch Patch { get; }
160 public Drawing.Point? ScrollCoordinates { get; }
161 public int? ScrollHorizontalOffset { get; }
162 public int? ScrollVerticalOffset { get; }
163 public string TypeText { get; }
164 public static ComputerCallAction CreateClickAction(Drawing.Point clickCoordinates, ComputerCallActionMouseButton clickMouseButton);
165 public static ComputerCallAction CreateDoubleClickAction(Drawing.Point doubleClickCoordinates, ComputerCallActionMouseButton doubleClickMouseButton);
166 public static ComputerCallAction CreateDragAction(IList<Drawing.Point> dragPath);
167 public static ComputerCallAction CreateKeyPressAction(IList<string> keyCodes);
168 public static ComputerCallAction CreateMoveAction(Drawing.Point moveCoordinates);
169 public static ComputerCallAction CreateScreenshotAction();
170 public static ComputerCallAction CreateScrollAction(Drawing.Point scrollCoordinates, int horizontalOffset, int verticalOffset);
171 public static ComputerCallAction CreateTypeAction(string typeText);
172 public static ComputerCallAction CreateWaitAction();
173 }
174 [Experimental("OPENAICUA001")]
175 public enum ComputerCallActionKind {
176 Click = 0,
177 DoubleClick = 1,
178 Drag = 2,
179 KeyPress = 3,
180 Move = 4,
181 Screenshot = 5,
182 Scroll = 6,
183 Type = 7,
184 Wait = 8
185 }
186 [Experimental("OPENAICUA001")]
187 public enum ComputerCallActionMouseButton {
188 Left = 0,
189 Right = 1,
190 Wheel = 2,
191 Back = 3,
192 Forward = 4
193 }
194 [Experimental("OPENAICUA001")]
195 public class ComputerCallOutput : IJsonModel<ComputerCallOutput>, IPersistableModel<ComputerCallOutput> {
196 [Serialization.JsonIgnore]
197 [EditorBrowsable(EditorBrowsableState.Never)]
198 [Experimental("SCME0001")]
199 public ref JsonPatch Patch { get; }
200 public static ComputerCallOutput CreateScreenshotOutput(BinaryData screenshotImageBytes, string screenshotImageBytesMediaType);
201 public static ComputerCallOutput CreateScreenshotOutput(string screenshotImageFileId);
202 public static ComputerCallOutput CreateScreenshotOutput(Uri screenshotImageUri);
203 }
204 [Experimental("OPENAICUA001")]
205 public class ComputerCallOutputResponseItem : ResponseItem, IJsonModel<ComputerCallOutputResponseItem>, IPersistableModel<ComputerCallOutputResponseItem> {
206 public ComputerCallOutputResponseItem(string callId, ComputerCallOutput output);
207 public IList<ComputerCallSafetyCheck> AcknowledgedSafetyChecks { get; }
208 public string CallId { get; set; }
209 public ComputerCallOutput Output { get; set; }
210 public ComputerCallOutputStatus? Status { get; set; }
211 }
212 [Experimental("OPENAICUA001")]
213 public enum ComputerCallOutputStatus {
214 InProgress = 0,
215 Completed = 1,
216 Incomplete = 2
217 }
218 [Experimental("OPENAICUA001")]
219 public class ComputerCallResponseItem : ResponseItem, IJsonModel<ComputerCallResponseItem>, IPersistableModel<ComputerCallResponseItem> {
220 public ComputerCallResponseItem(string callId, ComputerCallAction action, IEnumerable<ComputerCallSafetyCheck> pendingSafetyChecks);
221 public ComputerCallAction Action { get; set; }
222 public string CallId { get; set; }
223 public IList<ComputerCallSafetyCheck> PendingSafetyChecks { get; }
224 public ComputerCallStatus? Status { get; set; }
225 }
226 [Experimental("OPENAICUA001")]
227 public class ComputerCallSafetyCheck : IJsonModel<ComputerCallSafetyCheck>, IPersistableModel<ComputerCallSafetyCheck> {
228 public ComputerCallSafetyCheck(string id, string code, string message);
229 public string Code { get; set; }
230 public string Id { get; set; }
231 public string Message { get; set; }
232 [Serialization.JsonIgnore]
233 [EditorBrowsable(EditorBrowsableState.Never)]
234 [Experimental("SCME0001")]
235 public ref JsonPatch Patch { get; }
236 }
237 [Experimental("OPENAICUA001")]
238 public enum ComputerCallStatus {
239 InProgress = 0,
240 Completed = 1,
241 Incomplete = 2
242 }
243 [Experimental("OPENAI001")]
244 public class ComputerTool : ResponseTool, IJsonModel<ComputerTool>, IPersistableModel<ComputerTool> {
245 public ComputerTool(ComputerToolEnvironment environment, int displayWidth, int displayHeight);
246 public int DisplayHeight { get; set; }
247 public int DisplayWidth { get; set; }
248 public ComputerToolEnvironment Environment { get; set; }
249 }
250 [Experimental("OPENAICUA001")]
251 public readonly partial struct ComputerToolEnvironment : IEquatable<ComputerToolEnvironment> {
252 public ComputerToolEnvironment(string value);
253 public static ComputerToolEnvironment Browser { get; }
254 public static ComputerToolEnvironment Linux { get; }
255 public static ComputerToolEnvironment Mac { get; }
256 public static ComputerToolEnvironment Ubuntu { get; }
257 public static ComputerToolEnvironment Windows { get; }
258 public readonly bool Equals(ComputerToolEnvironment other);
259 [EditorBrowsable(EditorBrowsableState.Never)]
260 public override readonly bool Equals(object obj);
261 [EditorBrowsable(EditorBrowsableState.Never)]
262 public override readonly int GetHashCode();
263 public static bool operator ==(ComputerToolEnvironment left, ComputerToolEnvironment right);
264 public static implicit operator ComputerToolEnvironment(string value);
265 public static implicit operator ComputerToolEnvironment?(string value);
266 public static bool operator !=(ComputerToolEnvironment left, ComputerToolEnvironment right);
267 public override readonly string ToString();
268 }
269 [Experimental("OPENAI001")]
270 public class ContainerFileCitationMessageAnnotation : ResponseMessageAnnotation, IJsonModel<ContainerFileCitationMessageAnnotation>, IPersistableModel<ContainerFileCitationMessageAnnotation> {
271 public ContainerFileCitationMessageAnnotation(string containerId, string fileId, int startIndex, int endIndex, string filename);
272 public string ContainerId { get; set; }
273 public int EndIndex { get; set; }
274 public string FileId { get; set; }
275 public string Filename { get; set; }
276 public int StartIndex { get; set; }
277 }
278 [Experimental("OPENAI001")]
279 public class CreateResponseOptions : IJsonModel<CreateResponseOptions>, IPersistableModel<CreateResponseOptions> {
280 public CreateResponseOptions();
281 public CreateResponseOptions(string model, IEnumerable<ResponseItem> inputItems);
282 public bool? BackgroundModeEnabled { get; set; }
283 public ResponseConversationOptions ConversationOptions { get; set; }
284 public string EndUserId { get; set; }
285 public IList<IncludedResponseProperty> IncludedProperties { get; }
286 public IList<ResponseItem> InputItems { get; }
287 public string Instructions { get; set; }
288 public int? MaxOutputTokenCount { get; set; }
289 public int? MaxToolCallCount { get; set; }
290 public IDictionary<string, string> Metadata { get; }
291 public string Model { get; set; }
292 public bool? ParallelToolCallsEnabled { get; set; }
293 [Serialization.JsonIgnore]
294 [EditorBrowsable(EditorBrowsableState.Never)]
295 [Experimental("SCME0001")]
296 public ref JsonPatch Patch { get; }
297 public string PreviousResponseId { get; set; }
298 public ResponseReasoningOptions ReasoningOptions { get; set; }
299 public string SafetyIdentifier { get; set; }
300 public ResponseServiceTier? ServiceTier { get; set; }
301 public bool? StoredOutputEnabled { get; set; }
302 public bool? StreamingEnabled { get; set; }
303 public float? Temperature { get; set; }
304 public ResponseTextOptions TextOptions { get; set; }
305 public ResponseToolChoice ToolChoice { get; set; }
306 public IList<ResponseTool> Tools { get; }
307 public int? TopLogProbabilityCount { get; set; }
308 public float? TopP { get; set; }
309 public ResponseTruncationMode? TruncationMode { get; set; }
310 public static implicit operator BinaryContent(CreateResponseOptions createResponseOptions);
311 }
312 [Experimental("OPENAI001")]
313 public class CustomMcpToolCallApprovalPolicy : IJsonModel<CustomMcpToolCallApprovalPolicy>, IPersistableModel<CustomMcpToolCallApprovalPolicy> {
314 [Serialization.JsonIgnore]
315 [EditorBrowsable(EditorBrowsableState.Never)]
316 [Experimental("SCME0001")]
317 public ref JsonPatch Patch { get; }
318 public McpToolFilter ToolsAlwaysRequiringApproval { get; set; }
319 public McpToolFilter ToolsNeverRequiringApproval { get; set; }
320 }
321 [Experimental("OPENAI001")]
322 public class FileCitationMessageAnnotation : ResponseMessageAnnotation, IJsonModel<FileCitationMessageAnnotation>, IPersistableModel<FileCitationMessageAnnotation> {
323 public FileCitationMessageAnnotation(string fileId, int index, string filename);
324 public string FileId { get; set; }
325 public string Filename { get; set; }
326 public int Index { get; set; }
327 }
328 [Experimental("OPENAI001")]
329 public class FilePathMessageAnnotation : ResponseMessageAnnotation, IJsonModel<FilePathMessageAnnotation>, IPersistableModel<FilePathMessageAnnotation> {
330 public FilePathMessageAnnotation(string fileId, int index);
331 public string FileId { get; set; }
332 public int Index { get; set; }
333 }
334 [Experimental("OPENAI001")]
335 public class FileSearchCallResponseItem : ResponseItem, IJsonModel<FileSearchCallResponseItem>, IPersistableModel<FileSearchCallResponseItem> {
336 public FileSearchCallResponseItem(IEnumerable<string> queries);
337 public IList<string> Queries { get; }
338 public IList<FileSearchCallResult> Results { get; set; }
339 public FileSearchCallStatus? Status { get; set; }
340 }
341 [Experimental("OPENAI001")]
342 public class FileSearchCallResult : IJsonModel<FileSearchCallResult>, IPersistableModel<FileSearchCallResult> {
343 public IDictionary<string, BinaryData> Attributes { get; }
344 public string FileId { get; set; }
345 public string Filename { get; set; }
346 [Serialization.JsonIgnore]
347 [EditorBrowsable(EditorBrowsableState.Never)]
348 [Experimental("SCME0001")]
349 public ref JsonPatch Patch { get; }
350 public float? Score { get; set; }
351 public string Text { get; set; }
352 }
353 [Experimental("OPENAI001")]
354 public enum FileSearchCallStatus {
355 InProgress = 0,
356 Searching = 1,
357 Completed = 2,
358 Incomplete = 3,
359 Failed = 4
360 }
361 [Experimental("OPENAI001")]
362 public class FileSearchTool : ResponseTool, IJsonModel<FileSearchTool>, IPersistableModel<FileSearchTool> {
363 public FileSearchTool(IEnumerable<string> vectorStoreIds);
364 public BinaryData Filters { get; set; }
365 public int? MaxResultCount { get; set; }
366 public FileSearchToolRankingOptions RankingOptions { get; set; }
367 public IList<string> VectorStoreIds { get; }
368 }
369 [Experimental("OPENAI001")]
370 public readonly partial struct FileSearchToolRanker : IEquatable<FileSearchToolRanker> {
371 public FileSearchToolRanker(string value);
372 public static FileSearchToolRanker Auto { get; }
373 public static FileSearchToolRanker Default20241115 { get; }
374 public readonly bool Equals(FileSearchToolRanker other);
375 [EditorBrowsable(EditorBrowsableState.Never)]
376 public override readonly bool Equals(object obj);
377 [EditorBrowsable(EditorBrowsableState.Never)]
378 public override readonly int GetHashCode();
379 public static bool operator ==(FileSearchToolRanker left, FileSearchToolRanker right);
380 public static implicit operator FileSearchToolRanker(string value);
381 public static implicit operator FileSearchToolRanker?(string value);
382 public static bool operator !=(FileSearchToolRanker left, FileSearchToolRanker right);
383 public override readonly string ToString();
384 }
385 [Experimental("OPENAI001")]
386 public class FileSearchToolRankingOptions : IJsonModel<FileSearchToolRankingOptions>, IPersistableModel<FileSearchToolRankingOptions> {
387 [Serialization.JsonIgnore]
388 [EditorBrowsable(EditorBrowsableState.Never)]
389 [Experimental("SCME0001")]
390 public ref JsonPatch Patch { get; }
391 public FileSearchToolRanker? Ranker { get; set; }
392 public float? ScoreThreshold { get; set; }
393 }
394 [Experimental("OPENAI001")]
395 public class FunctionCallOutputResponseItem : ResponseItem, IJsonModel<FunctionCallOutputResponseItem>, IPersistableModel<FunctionCallOutputResponseItem> {
396 public FunctionCallOutputResponseItem(string callId, string functionOutput);
397 public string CallId { get; set; }
398 public string FunctionOutput { get; set; }
399 public FunctionCallOutputStatus? Status { get; set; }
400 }
401 [Experimental("OPENAI001")]
402 public enum FunctionCallOutputStatus {
403 InProgress = 0,
404 Completed = 1,
405 Incomplete = 2
406 }
407 [Experimental("OPENAI001")]
408 public class FunctionCallResponseItem : ResponseItem, IJsonModel<FunctionCallResponseItem>, IPersistableModel<FunctionCallResponseItem> {
409 public FunctionCallResponseItem(string callId, string functionName, BinaryData functionArguments);
410 public string CallId { get; set; }
411 public BinaryData FunctionArguments { get; set; }
412 public string FunctionName { get; set; }
413 public FunctionCallStatus? Status { get; set; }
414 }
415 [Experimental("OPENAI001")]
416 public enum FunctionCallStatus {
417 InProgress = 0,
418 Completed = 1,
419 Incomplete = 2
420 }
421 [Experimental("OPENAI001")]
422 public class FunctionTool : ResponseTool, IJsonModel<FunctionTool>, IPersistableModel<FunctionTool> {
423 public FunctionTool(string functionName, BinaryData functionParameters, bool? strictModeEnabled);
424 public string FunctionDescription { get; set; }
425 public string FunctionName { get; set; }
426 public BinaryData FunctionParameters { get; set; }
427 public bool? StrictModeEnabled { get; set; }
428 }
429 [Experimental("OPENAI001")]
430 public class GetResponseOptions : IJsonModel<GetResponseOptions>, IPersistableModel<GetResponseOptions> {
431 public GetResponseOptions(string responseId);
432 public IList<IncludedResponseProperty> IncludedProperties { get; set; }
433 public bool? IncludeObfuscation { get; set; }
434 [Serialization.JsonIgnore]
435 [EditorBrowsable(EditorBrowsableState.Never)]
436 [Experimental("SCME0001")]
437 public ref JsonPatch Patch { get; }
438 public string ResponseId { get; }
439 public int? StartingAfter { get; set; }
440 public bool? StreamingEnabled { get; set; }
441 }
442 [Experimental("OPENAI001")]
443 public readonly partial struct GlobalMcpToolCallApprovalPolicy : IEquatable<GlobalMcpToolCallApprovalPolicy> {
444 public GlobalMcpToolCallApprovalPolicy(string value);
445 public static GlobalMcpToolCallApprovalPolicy AlwaysRequireApproval { get; }
446 public static GlobalMcpToolCallApprovalPolicy NeverRequireApproval { get; }
447 public readonly bool Equals(GlobalMcpToolCallApprovalPolicy other);
448 [EditorBrowsable(EditorBrowsableState.Never)]
449 public override readonly bool Equals(object obj);
450 [EditorBrowsable(EditorBrowsableState.Never)]
451 public override readonly int GetHashCode();
452 public static bool operator ==(GlobalMcpToolCallApprovalPolicy left, GlobalMcpToolCallApprovalPolicy right);
453 public static implicit operator GlobalMcpToolCallApprovalPolicy(string value);
454 public static implicit operator GlobalMcpToolCallApprovalPolicy?(string value);
455 public static bool operator !=(GlobalMcpToolCallApprovalPolicy left, GlobalMcpToolCallApprovalPolicy right);
456 public override readonly string ToString();
457 }
458 [Experimental("OPENAI001")]
459 public class ImageGenerationCallResponseItem : ResponseItem, IJsonModel<ImageGenerationCallResponseItem>, IPersistableModel<ImageGenerationCallResponseItem> {
460 public ImageGenerationCallResponseItem(BinaryData imageResultBytes);
461 public ImageGenerationToolAction? Action { get; set; }
462 public ImageGenerationToolBackground? Background { get; set; }
463 public BinaryData ImageResultBytes { get; set; }
464 public ImageGenerationToolOutputFileFormat? OutputFormat { get; set; }
465 public ImageGenerationToolQuality? Quality { get; set; }
466 public string RevisedPrompt { get; set; }
467 public ImageGenerationToolSize? Size { get; set; }
468 public ImageGenerationCallStatus? Status { get; set; }
469 }
470 [Experimental("OPENAI001")]
471 public enum ImageGenerationCallStatus {
472 InProgress = 0,
473 Completed = 1,
474 Generating = 2,
475 Failed = 3
476 }
477 [Experimental("OPENAI001")]
478 public class ImageGenerationTool : ResponseTool, IJsonModel<ImageGenerationTool>, IPersistableModel<ImageGenerationTool> {
479 public ImageGenerationTool();
480 public ImageGenerationToolAction? Action { get; set; }
481 public ImageGenerationToolBackground? Background { get; set; }
482 public ImageGenerationToolInputFidelity? InputFidelity { get; set; }
483 public ImageGenerationToolInputImageMask InputImageMask { get; set; }
484 public string Model { get; set; }
485 public ImageGenerationToolModerationLevel? ModerationLevel { get; set; }
486 public int? OutputCompressionFactor { get; set; }
487 public ImageGenerationToolOutputFileFormat? OutputFileFormat { get; set; }
488 public int? PartialImageCount { get; set; }
489 public ImageGenerationToolQuality? Quality { get; set; }
490 public ImageGenerationToolSize? Size { get; set; }
491 }
492 [Experimental("OPENAI001")]
493 public readonly partial struct ImageGenerationToolAction : IEquatable<ImageGenerationToolAction> {
494 public ImageGenerationToolAction(string value);
495 public static ImageGenerationToolAction Auto { get; }
496 public static ImageGenerationToolAction Edit { get; }
497 public static ImageGenerationToolAction Generate { get; }
498 public readonly bool Equals(ImageGenerationToolAction other);
499 [EditorBrowsable(EditorBrowsableState.Never)]
500 public override readonly bool Equals(object obj);
501 [EditorBrowsable(EditorBrowsableState.Never)]
502 public override readonly int GetHashCode();
503 public static bool operator ==(ImageGenerationToolAction left, ImageGenerationToolAction right);
504 public static implicit operator ImageGenerationToolAction(string value);
505 public static implicit operator ImageGenerationToolAction?(string value);
506 public static bool operator !=(ImageGenerationToolAction left, ImageGenerationToolAction right);
507 public override readonly string ToString();
508 }
509 [Experimental("OPENAI001")]
510 public readonly partial struct ImageGenerationToolBackground : IEquatable<ImageGenerationToolBackground> {
511 public ImageGenerationToolBackground(string value);
512 public static ImageGenerationToolBackground Auto { get; }
513 public static ImageGenerationToolBackground Opaque { get; }
514 public static ImageGenerationToolBackground Transparent { get; }
515 public readonly bool Equals(ImageGenerationToolBackground other);
516 [EditorBrowsable(EditorBrowsableState.Never)]
517 public override readonly bool Equals(object obj);
518 [EditorBrowsable(EditorBrowsableState.Never)]
519 public override readonly int GetHashCode();
520 public static bool operator ==(ImageGenerationToolBackground left, ImageGenerationToolBackground right);
521 public static implicit operator ImageGenerationToolBackground(string value);
522 public static implicit operator ImageGenerationToolBackground?(string value);
523 public static bool operator !=(ImageGenerationToolBackground left, ImageGenerationToolBackground right);
524 public override readonly string ToString();
525 }
526 [Experimental("OPENAI001")]
527 public readonly partial struct ImageGenerationToolInputFidelity : IEquatable<ImageGenerationToolInputFidelity> {
528 public ImageGenerationToolInputFidelity(string value);
529 public static ImageGenerationToolInputFidelity High { get; }
530 public static ImageGenerationToolInputFidelity Low { get; }
531 public readonly bool Equals(ImageGenerationToolInputFidelity other);
532 [EditorBrowsable(EditorBrowsableState.Never)]
533 public override readonly bool Equals(object obj);
534 [EditorBrowsable(EditorBrowsableState.Never)]
535 public override readonly int GetHashCode();
536 public static bool operator ==(ImageGenerationToolInputFidelity left, ImageGenerationToolInputFidelity right);
537 public static implicit operator ImageGenerationToolInputFidelity(string value);
538 public static implicit operator ImageGenerationToolInputFidelity?(string value);
539 public static bool operator !=(ImageGenerationToolInputFidelity left, ImageGenerationToolInputFidelity right);
540 public override readonly string ToString();
541 }
542 [Experimental("OPENAI001")]
543 public class ImageGenerationToolInputImageMask : IJsonModel<ImageGenerationToolInputImageMask>, IPersistableModel<ImageGenerationToolInputImageMask> {
544 public ImageGenerationToolInputImageMask(BinaryData imageBytes);
545 public ImageGenerationToolInputImageMask(string fileId);
546 public ImageGenerationToolInputImageMask(Uri imageUri);
547 public string FileId { get; set; }
548 public string ImageUri { get; set; }
549 [Serialization.JsonIgnore]
550 [EditorBrowsable(EditorBrowsableState.Never)]
551 [Experimental("SCME0001")]
552 public ref JsonPatch Patch { get; }
553 }
554 [Experimental("OPENAI001")]
555 public readonly partial struct ImageGenerationToolModerationLevel : IEquatable<ImageGenerationToolModerationLevel> {
556 public ImageGenerationToolModerationLevel(string value);
557 public static ImageGenerationToolModerationLevel Auto { get; }
558 public static ImageGenerationToolModerationLevel Low { get; }
559 public readonly bool Equals(ImageGenerationToolModerationLevel other);
560 [EditorBrowsable(EditorBrowsableState.Never)]
561 public override readonly bool Equals(object obj);
562 [EditorBrowsable(EditorBrowsableState.Never)]
563 public override readonly int GetHashCode();
564 public static bool operator ==(ImageGenerationToolModerationLevel left, ImageGenerationToolModerationLevel right);
565 public static implicit operator ImageGenerationToolModerationLevel(string value);
566 public static implicit operator ImageGenerationToolModerationLevel?(string value);
567 public static bool operator !=(ImageGenerationToolModerationLevel left, ImageGenerationToolModerationLevel right);
568 public override readonly string ToString();
569 }
570 [Experimental("OPENAI001")]
571 public readonly partial struct ImageGenerationToolOutputFileFormat : IEquatable<ImageGenerationToolOutputFileFormat> {
572 public ImageGenerationToolOutputFileFormat(string value);
573 public static ImageGenerationToolOutputFileFormat Jpeg { get; }
574 public static ImageGenerationToolOutputFileFormat Png { get; }
575 public static ImageGenerationToolOutputFileFormat Webp { get; }
576 public readonly bool Equals(ImageGenerationToolOutputFileFormat other);
577 [EditorBrowsable(EditorBrowsableState.Never)]
578 public override readonly bool Equals(object obj);
579 [EditorBrowsable(EditorBrowsableState.Never)]
580 public override readonly int GetHashCode();
581 public static bool operator ==(ImageGenerationToolOutputFileFormat left, ImageGenerationToolOutputFileFormat right);
582 public static implicit operator ImageGenerationToolOutputFileFormat(string value);
583 public static implicit operator ImageGenerationToolOutputFileFormat?(string value);
584 public static bool operator !=(ImageGenerationToolOutputFileFormat left, ImageGenerationToolOutputFileFormat right);
585 public override readonly string ToString();
586 }
587 [Experimental("OPENAI001")]
588 public readonly partial struct ImageGenerationToolQuality : IEquatable<ImageGenerationToolQuality> {
589 public ImageGenerationToolQuality(string value);
590 public static ImageGenerationToolQuality Auto { get; }
591 public static ImageGenerationToolQuality High { get; }
592 public static ImageGenerationToolQuality Low { get; }
593 public static ImageGenerationToolQuality Medium { get; }
594 public readonly bool Equals(ImageGenerationToolQuality other);
595 [EditorBrowsable(EditorBrowsableState.Never)]
596 public override readonly bool Equals(object obj);
597 [EditorBrowsable(EditorBrowsableState.Never)]
598 public override readonly int GetHashCode();
599 public static bool operator ==(ImageGenerationToolQuality left, ImageGenerationToolQuality right);
600 public static implicit operator ImageGenerationToolQuality(string value);
601 public static implicit operator ImageGenerationToolQuality?(string value);
602 public static bool operator !=(ImageGenerationToolQuality left, ImageGenerationToolQuality right);
603 public override readonly string ToString();
604 }
605 [Experimental("OPENAI001")]
606 public readonly partial struct ImageGenerationToolSize : IEquatable<ImageGenerationToolSize> {
607 public static readonly ImageGenerationToolSize W1024xH1024;
608 public static readonly ImageGenerationToolSize W1024xH1536;
609 public static readonly ImageGenerationToolSize W1536xH1024;
610 public ImageGenerationToolSize(int width, int height);
611 public static ImageGenerationToolSize Auto { get; }
612 public readonly bool Equals(ImageGenerationToolSize other);
613 [EditorBrowsable(EditorBrowsableState.Never)]
614 public override readonly bool Equals(object obj);
615 [EditorBrowsable(EditorBrowsableState.Never)]
616 public override readonly int GetHashCode();
617 public static bool operator ==(ImageGenerationToolSize left, ImageGenerationToolSize right);
618 public static bool operator !=(ImageGenerationToolSize left, ImageGenerationToolSize right);
619 public override readonly string ToString();
620 }
621 [Experimental("OPENAI001")]
622 public readonly partial struct IncludedResponseProperty : IEquatable<IncludedResponseProperty> {
623 public IncludedResponseProperty(string value);
624 public static IncludedResponseProperty CodeInterpreterCallOutputs { get; }
625 public static IncludedResponseProperty ComputerCallOutputImageUri { get; }
626 public static IncludedResponseProperty FileSearchCallResults { get; }
627 public static IncludedResponseProperty MessageInputImageUri { get; }
628 public static IncludedResponseProperty MessageOutputTextLogProbabilities { get; }
629 public static IncludedResponseProperty ReasoningEncryptedContent { get; }
630 public static IncludedResponseProperty WebSearchCallActionSources { get; }
631 public static IncludedResponseProperty WebSearchCallResults { get; }
632 public readonly bool Equals(IncludedResponseProperty other);
633 [EditorBrowsable(EditorBrowsableState.Never)]
634 public override readonly bool Equals(object obj);
635 [EditorBrowsable(EditorBrowsableState.Never)]
636 public override readonly int GetHashCode();
637 public static bool operator ==(IncludedResponseProperty left, IncludedResponseProperty right);
638 public static implicit operator IncludedResponseProperty(string value);
639 public static implicit operator IncludedResponseProperty?(string value);
640 public static bool operator !=(IncludedResponseProperty left, IncludedResponseProperty right);
641 public override readonly string ToString();
642 }
643 [Experimental("OPENAI001")]
644 public class McpTool : ResponseTool, IJsonModel<McpTool>, IPersistableModel<McpTool> {
645 public McpTool(string serverLabel, McpToolConnectorId connectorId);
646 public McpTool(string serverLabel, Uri serverUri);
647 public McpToolFilter AllowedTools { get; set; }
648 public string AuthorizationToken { get; set; }
649 public McpToolConnectorId? ConnectorId { get; set; }
650 public IDictionary<string, string> Headers { get; set; }
651 public string ServerDescription { get; set; }
652 public string ServerLabel { get; set; }
653 public Uri ServerUri { get; set; }
654 public McpToolCallApprovalPolicy ToolCallApprovalPolicy { get; set; }
655 }
656 [Experimental("OPENAI001")]
657 public class McpToolCallApprovalPolicy : IJsonModel<McpToolCallApprovalPolicy>, IPersistableModel<McpToolCallApprovalPolicy> {
658 public McpToolCallApprovalPolicy(CustomMcpToolCallApprovalPolicy customPolicy);
659 public McpToolCallApprovalPolicy(GlobalMcpToolCallApprovalPolicy globalPolicy);
660 public CustomMcpToolCallApprovalPolicy CustomPolicy { get; }
661 public GlobalMcpToolCallApprovalPolicy? GlobalPolicy { get; }
662 [Serialization.JsonIgnore]
663 [EditorBrowsable(EditorBrowsableState.Never)]
664 [Experimental("SCME0001")]
665 public ref JsonPatch Patch { get; }
666 public static implicit operator McpToolCallApprovalPolicy(CustomMcpToolCallApprovalPolicy customPolicy);
667 public static implicit operator McpToolCallApprovalPolicy(GlobalMcpToolCallApprovalPolicy globalPolicy);
668 }
669 [Experimental("OPENAI001")]
670 public class McpToolCallApprovalRequestItem : ResponseItem, IJsonModel<McpToolCallApprovalRequestItem>, IPersistableModel<McpToolCallApprovalRequestItem> {
671 public McpToolCallApprovalRequestItem(string id, string serverLabel, string toolName, BinaryData toolArguments);
672 public string ServerLabel { get; set; }
673 public BinaryData ToolArguments { get; set; }
674 public string ToolName { get; set; }
675 }
676 [Experimental("OPENAI001")]
677 public class McpToolCallApprovalResponseItem : ResponseItem, IJsonModel<McpToolCallApprovalResponseItem>, IPersistableModel<McpToolCallApprovalResponseItem> {
678 public McpToolCallApprovalResponseItem(string approvalRequestId, bool approved);
679 public string ApprovalRequestId { get; set; }
680 public bool Approved { get; set; }
681 public string Reason { get; set; }
682 }
683 [Experimental("OPENAI001")]
684 public class McpToolCallItem : ResponseItem, IJsonModel<McpToolCallItem>, IPersistableModel<McpToolCallItem> {
685 public McpToolCallItem(string serverLabel, string toolName, BinaryData toolArguments);
686 public BinaryData Error { get; set; }
687 public string ServerLabel { get; set; }
688 public BinaryData ToolArguments { get; set; }
689 public string ToolName { get; set; }
690 public string ToolOutput { get; set; }
691 }
692 [Experimental("OPENAI001")]
693 public readonly partial struct McpToolConnectorId : IEquatable<McpToolConnectorId> {
694 public McpToolConnectorId(string value);
695 public static McpToolConnectorId Dropbox { get; }
696 public static McpToolConnectorId Gmail { get; }
697 public static McpToolConnectorId GoogleCalendar { get; }
698 public static McpToolConnectorId GoogleDrive { get; }
699 public static McpToolConnectorId MicrosoftTeams { get; }
700 public static McpToolConnectorId OutlookCalendar { get; }
701 public static McpToolConnectorId OutlookEmail { get; }
702 public static McpToolConnectorId SharePoint { get; }
703 public readonly bool Equals(McpToolConnectorId other);
704 [EditorBrowsable(EditorBrowsableState.Never)]
705 public override readonly bool Equals(object obj);
706 [EditorBrowsable(EditorBrowsableState.Never)]
707 public override readonly int GetHashCode();
708 public static bool operator ==(McpToolConnectorId left, McpToolConnectorId right);
709 public static implicit operator McpToolConnectorId(string value);
710 public static implicit operator McpToolConnectorId?(string value);
711 public static bool operator !=(McpToolConnectorId left, McpToolConnectorId right);
712 public override readonly string ToString();
713 }
714 [Experimental("OPENAI001")]
715 public class McpToolDefinition : IJsonModel<McpToolDefinition>, IPersistableModel<McpToolDefinition> {
716 public McpToolDefinition(string name, BinaryData inputSchema);
717 public BinaryData Annotations { get; set; }
718 public string Description { get; set; }
719 public BinaryData InputSchema { get; set; }
720 public string Name { get; set; }
721 [Serialization.JsonIgnore]
722 [EditorBrowsable(EditorBrowsableState.Never)]
723 [Experimental("SCME0001")]
724 public ref JsonPatch Patch { get; }
725 }
726 [Experimental("OPENAI001")]
727 public class McpToolDefinitionListItem : ResponseItem, IJsonModel<McpToolDefinitionListItem>, IPersistableModel<McpToolDefinitionListItem> {
728 public McpToolDefinitionListItem(string serverLabel, IEnumerable<McpToolDefinition> toolDefinitions);
729 public BinaryData Error { get; set; }
730 public string ServerLabel { get; set; }
731 public IList<McpToolDefinition> ToolDefinitions { get; }
732 }
733 [Experimental("OPENAI001")]
734 public class McpToolFilter : IJsonModel<McpToolFilter>, IPersistableModel<McpToolFilter> {
735 public bool? IsReadOnly { get; set; }
736 [Serialization.JsonIgnore]
737 [EditorBrowsable(EditorBrowsableState.Never)]
738 [Experimental("SCME0001")]
739 public ref JsonPatch Patch { get; }
740 public IList<string> ToolNames { get; }
741 }
742 [Experimental("OPENAI001")]
743 public class MessageResponseItem : ResponseItem, IJsonModel<MessageResponseItem>, IPersistableModel<MessageResponseItem> {
744 public IList<ResponseContentPart> Content { get; }
745 public MessageRole Role { get; }
746 public MessageStatus? Status { get; set; }
747 }
748 [Experimental("OPENAI001")]
749 public enum MessageRole {
750 Unknown = 0,
751 Assistant = 1,
752 Developer = 2,
753 System = 3,
754 User = 4
755 }
756 [Experimental("OPENAI001")]
757 public enum MessageStatus {
758 InProgress = 0,
759 Completed = 1,
760 Incomplete = 2
761 }
762 [Experimental("OPENAI001")]
763 public class OpenAIResponsesContext : ModelReaderWriterContext {
764 public static OpenAIResponsesContext Default { get; }
765 protected override bool TryGetTypeBuilderCore(Type type, out ModelReaderWriterTypeBuilder builder);
766 }
767 [Experimental("SCME0002")]
768 public static class OpenAIResponsesHostBuilderExtensions {
769 public static IClientBuilder AddKeyedResponsesClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
770 public static IClientBuilder AddResponsesClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
771 }
772 [Experimental("OPENAI001")]
773 public class ReasoningResponseItem : ResponseItem, IJsonModel<ReasoningResponseItem>, IPersistableModel<ReasoningResponseItem> {
774 public ReasoningResponseItem(IEnumerable<ReasoningSummaryPart> summaryParts);
775 public ReasoningResponseItem(string summaryText);
776 public string EncryptedContent { get; set; }
777 public ReasoningStatus? Status { get; set; }
778 public IList<ReasoningSummaryPart> SummaryParts { get; }
779 public string GetSummaryText();
780 }
781 [Experimental("OPENAI001")]
782 public enum ReasoningStatus {
783 InProgress = 0,
784 Completed = 1,
785 Incomplete = 2
786 }
787 [Experimental("OPENAI001")]
788 public class ReasoningSummaryPart : IJsonModel<ReasoningSummaryPart>, IPersistableModel<ReasoningSummaryPart> {
789 [Serialization.JsonIgnore]
790 [EditorBrowsable(EditorBrowsableState.Never)]
791 [Experimental("SCME0001")]
792 public ref JsonPatch Patch { get; }
793 public static ReasoningSummaryTextPart CreateTextPart(string text);
794 }
795 [Experimental("OPENAI001")]
796 public class ReasoningSummaryTextPart : ReasoningSummaryPart, IJsonModel<ReasoningSummaryTextPart>, IPersistableModel<ReasoningSummaryTextPart> {
797 public ReasoningSummaryTextPart(string text);
798 public string Text { get; set; }
799 }
800 [Experimental("OPENAI001")]
801 public class ReferenceResponseItem : ResponseItem, IJsonModel<ReferenceResponseItem>, IPersistableModel<ReferenceResponseItem> {
802 public ReferenceResponseItem(string id);
803 }
804 [Experimental("OPENAI001")]
805 public class ResponseContentPart : IJsonModel<ResponseContentPart>, IPersistableModel<ResponseContentPart> {
806 public BinaryData InputFileBytes { get; }
807 public string InputFileBytesMediaType { get; }
808 public string InputFileId { get; }
809 public string InputFilename { get; }
810 public Uri InputFileUri { get; }
811 public ResponseImageDetailLevel? InputImageDetailLevel { get; }
812 public string InputImageFileId { get; }
813 public string InputImageUri { get; }
814 public ResponseContentPartKind Kind { get; }
815 public IReadOnlyList<ResponseMessageAnnotation> OutputTextAnnotations { get; }
816 [Serialization.JsonIgnore]
817 [EditorBrowsable(EditorBrowsableState.Never)]
818 [Experimental("SCME0001")]
819 public ref JsonPatch Patch { get; }
820 public string Refusal { get; }
821 public string Text { get; }
822 public static ResponseContentPart CreateInputFilePart(BinaryData fileBytes, string fileBytesMediaType, string filename);
823 public static ResponseContentPart CreateInputFilePart(string fileId);
824 public static ResponseContentPart CreateInputFilePart(Uri fileUri);
825 public static ResponseContentPart CreateInputImagePart(BinaryData imageBytes, ResponseImageDetailLevel? imageDetailLevel = null);
826 public static ResponseContentPart CreateInputImagePart(string imageFileId, ResponseImageDetailLevel? imageDetailLevel = null);
827 public static ResponseContentPart CreateInputImagePart(Uri imageUri, ResponseImageDetailLevel? imageDetailLevel = null);
828 public static ResponseContentPart CreateInputTextPart(string text);
829 public static ResponseContentPart CreateOutputTextPart(string text, IEnumerable<ResponseMessageAnnotation> annotations);
830 public static ResponseContentPart CreateRefusalPart(string refusal);
831 }
832 [Experimental("OPENAI001")]
833 public enum ResponseContentPartKind {
834 Unknown = 0,
835 InputText = 1,
836 InputImage = 2,
837 InputFile = 3,
838 OutputText = 4,
839 Refusal = 5
840 }
841 [Experimental("OPENAI001")]
842 public class ResponseConversationOptions : IJsonModel<ResponseConversationOptions>, IPersistableModel<ResponseConversationOptions> {
843 public ResponseConversationOptions(string conversationId);
844 public string ConversationId { get; set; }
845 [Serialization.JsonIgnore]
846 [EditorBrowsable(EditorBrowsableState.Never)]
847 [Experimental("SCME0001")]
848 public ref JsonPatch Patch { get; }
849 }
850 [Experimental("OPENAI001")]
851 public class ResponseDeletionResult : IJsonModel<ResponseDeletionResult>, IPersistableModel<ResponseDeletionResult> {
852 public bool Deleted { get; set; }
853 [EditorBrowsable(EditorBrowsableState.Never)]
854 public string Object { get; set; }
855 [Serialization.JsonIgnore]
856 [EditorBrowsable(EditorBrowsableState.Never)]
857 [Experimental("SCME0001")]
858 public ref JsonPatch Patch { get; }
859 public string ResponseId { get; set; }
860 public static explicit operator ResponseDeletionResult(ClientResult result);
861 }
862 [Experimental("OPENAI001")]
863 public class ResponseError : IJsonModel<ResponseError>, IPersistableModel<ResponseError> {
864 public ResponseErrorCode Code { get; }
865 public string Message { get; }
866 [Serialization.JsonIgnore]
867 [EditorBrowsable(EditorBrowsableState.Never)]
868 [Experimental("SCME0001")]
869 public ref JsonPatch Patch { get; }
870 }
871 [Experimental("OPENAI001")]
872 public readonly partial struct ResponseErrorCode : IEquatable<ResponseErrorCode> {
873 public ResponseErrorCode(string value);
874 public static ResponseErrorCode EmptyImageFile { get; }
875 public static ResponseErrorCode FailedToDownloadImage { get; }
876 public static ResponseErrorCode ImageContentPolicyViolation { get; }
877 public static ResponseErrorCode ImageFileNotFound { get; }
878 public static ResponseErrorCode ImageFileTooLarge { get; }
879 public static ResponseErrorCode ImageParseError { get; }
880 public static ResponseErrorCode ImageTooLarge { get; }
881 public static ResponseErrorCode ImageTooSmall { get; }
882 public static ResponseErrorCode InvalidBase64Image { get; }
883 public static ResponseErrorCode InvalidImage { get; }
884 public static ResponseErrorCode InvalidImageFormat { get; }
885 public static ResponseErrorCode InvalidImageMode { get; }
886 public static ResponseErrorCode InvalidImageUrl { get; }
887 public static ResponseErrorCode InvalidPrompt { get; }
888 public static ResponseErrorCode RateLimitExceeded { get; }
889 public static ResponseErrorCode ServerError { get; }
890 public static ResponseErrorCode UnsupportedImageMediaType { get; }
891 public static ResponseErrorCode VectorStoreTimeout { get; }
892 public readonly bool Equals(ResponseErrorCode other);
893 [EditorBrowsable(EditorBrowsableState.Never)]
894 public override readonly bool Equals(object obj);
895 [EditorBrowsable(EditorBrowsableState.Never)]
896 public override readonly int GetHashCode();
897 public static bool operator ==(ResponseErrorCode left, ResponseErrorCode right);
898 public static implicit operator ResponseErrorCode(string value);
899 public static implicit operator ResponseErrorCode?(string value);
900 public static bool operator !=(ResponseErrorCode left, ResponseErrorCode right);
901 public override readonly string ToString();
902 }
903 [Experimental("OPENAI001")]
904 public readonly partial struct ResponseImageDetailLevel : IEquatable<ResponseImageDetailLevel> {
905 public ResponseImageDetailLevel(string value);
906 public static ResponseImageDetailLevel Auto { get; }
907 public static ResponseImageDetailLevel High { get; }
908 public static ResponseImageDetailLevel Low { get; }
909 public readonly bool Equals(ResponseImageDetailLevel other);
910 [EditorBrowsable(EditorBrowsableState.Never)]
911 public override readonly bool Equals(object obj);
912 [EditorBrowsable(EditorBrowsableState.Never)]
913 public override readonly int GetHashCode();
914 public static bool operator ==(ResponseImageDetailLevel left, ResponseImageDetailLevel right);
915 public static implicit operator ResponseImageDetailLevel(string value);
916 public static implicit operator ResponseImageDetailLevel?(string value);
917 public static bool operator !=(ResponseImageDetailLevel left, ResponseImageDetailLevel right);
918 public override readonly string ToString();
919 }
920 [Experimental("OPENAI001")]
921 public class ResponseIncompleteStatusDetails : IJsonModel<ResponseIncompleteStatusDetails>, IPersistableModel<ResponseIncompleteStatusDetails> {
922 [Serialization.JsonIgnore]
923 [EditorBrowsable(EditorBrowsableState.Never)]
924 [Experimental("SCME0001")]
925 public ref JsonPatch Patch { get; }
926 public ResponseIncompleteStatusReason? Reason { get; }
927 }
928 [Experimental("OPENAI001")]
929 public readonly partial struct ResponseIncompleteStatusReason : IEquatable<ResponseIncompleteStatusReason> {
930 public ResponseIncompleteStatusReason(string value);
931 public static ResponseIncompleteStatusReason ContentFilter { get; }
932 public static ResponseIncompleteStatusReason MaxOutputTokens { get; }
933 public readonly bool Equals(ResponseIncompleteStatusReason other);
934 [EditorBrowsable(EditorBrowsableState.Never)]
935 public override readonly bool Equals(object obj);
936 [EditorBrowsable(EditorBrowsableState.Never)]
937 public override readonly int GetHashCode();
938 public static bool operator ==(ResponseIncompleteStatusReason left, ResponseIncompleteStatusReason right);
939 public static implicit operator ResponseIncompleteStatusReason(string value);
940 public static implicit operator ResponseIncompleteStatusReason?(string value);
941 public static bool operator !=(ResponseIncompleteStatusReason left, ResponseIncompleteStatusReason right);
942 public override readonly string ToString();
943 }
944 [Experimental("OPENAI001")]
945 public class ResponseInputTokenUsageDetails : IJsonModel<ResponseInputTokenUsageDetails>, IPersistableModel<ResponseInputTokenUsageDetails> {
946 public int CachedTokenCount { get; set; }
947 [Serialization.JsonIgnore]
948 [EditorBrowsable(EditorBrowsableState.Never)]
949 [Experimental("SCME0001")]
950 public ref JsonPatch Patch { get; }
951 }
952 [Experimental("OPENAI001")]
953 public class ResponseItem : IJsonModel<ResponseItem>, IPersistableModel<ResponseItem> {
954 public string Id { get; set; }
955 [Serialization.JsonIgnore]
956 [EditorBrowsable(EditorBrowsableState.Never)]
957 [Experimental("SCME0001")]
958 public ref JsonPatch Patch { get; }
959 public static ApplyPatchCallItem CreateApplyPatchCallItem(string callId, ApplyPatchOperation operation);
960 public static ApplyPatchCallOutputItem CreateApplyPatchCallOutputItem(string callId, ApplyPatchCallOutputStatus status);
961 public static MessageResponseItem CreateAssistantMessageItem(IEnumerable<ResponseContentPart> contentParts);
962 public static MessageResponseItem CreateAssistantMessageItem(string outputTextContent, IEnumerable<ResponseMessageAnnotation> annotations = null);
963 [Experimental("OPENAICUA001")]
964 public static ComputerCallResponseItem CreateComputerCallItem(string callId, ComputerCallAction action, IEnumerable<ComputerCallSafetyCheck> pendingSafetyChecks);
965 [Experimental("OPENAICUA001")]
966 public static ComputerCallOutputResponseItem CreateComputerCallOutputItem(string callId, ComputerCallOutput output);
967 public static MessageResponseItem CreateDeveloperMessageItem(IEnumerable<ResponseContentPart> contentParts);
968 public static MessageResponseItem CreateDeveloperMessageItem(string inputTextContent);
969 public static FileSearchCallResponseItem CreateFileSearchCallItem(IEnumerable<string> queries);
970 public static FunctionCallResponseItem CreateFunctionCallItem(string callId, string functionName, BinaryData functionArguments);
971 public static FunctionCallOutputResponseItem CreateFunctionCallOutputItem(string callId, string functionOutput);
972 public static McpToolCallApprovalRequestItem CreateMcpApprovalRequestItem(string id, string serverLabel, string name, BinaryData arguments);
973 public static McpToolCallApprovalResponseItem CreateMcpApprovalResponseItem(string approvalRequestId, bool approved);
974 public static McpToolCallItem CreateMcpToolCallItem(string serverLabel, string name, BinaryData arguments);
975 public static McpToolDefinitionListItem CreateMcpToolDefinitionListItem(string serverLabel, IEnumerable<McpToolDefinition> toolDefinitions);
976 public static ReasoningResponseItem CreateReasoningItem(IEnumerable<ReasoningSummaryPart> summaryParts);
977 public static ReasoningResponseItem CreateReasoningItem(string summaryText);
978 public static ReferenceResponseItem CreateReferenceItem(string id);
979 public static MessageResponseItem CreateSystemMessageItem(IEnumerable<ResponseContentPart> contentParts);
980 public static MessageResponseItem CreateSystemMessageItem(string inputTextContent);
981 public static MessageResponseItem CreateUserMessageItem(IEnumerable<ResponseContentPart> contentParts);
982 public static MessageResponseItem CreateUserMessageItem(string inputTextContent);
983 public static WebSearchCallResponseItem CreateWebSearchCallItem();
984 }
985 [Experimental("OPENAI001")]
986 public class ResponseItemCollectionOptions : IJsonModel<ResponseItemCollectionOptions>, IPersistableModel<ResponseItemCollectionOptions> {
987 public ResponseItemCollectionOptions(string responseId);
988 public string AfterId { get; set; }
989 public string BeforeId { get; set; }
990 public ResponseItemCollectionOrder? Order { get; set; }
991 public int? PageSizeLimit { get; set; }
992 public string ResponseId { get; }
993 }
994 [Experimental("OPENAI001")]
995 public readonly partial struct ResponseItemCollectionOrder : IEquatable<ResponseItemCollectionOrder> {
996 public ResponseItemCollectionOrder(string value);
997 public static ResponseItemCollectionOrder Ascending { get; }
998 public static ResponseItemCollectionOrder Descending { get; }
999 public readonly bool Equals(ResponseItemCollectionOrder other);
1000 [EditorBrowsable(EditorBrowsableState.Never)]
1001 public override readonly bool Equals(object obj);
1002 [EditorBrowsable(EditorBrowsableState.Never)]
1003 public override readonly int GetHashCode();
1004 public static bool operator ==(ResponseItemCollectionOrder left, ResponseItemCollectionOrder right);
1005 public static implicit operator ResponseItemCollectionOrder(string value);
1006 public static implicit operator ResponseItemCollectionOrder?(string value);
1007 public static bool operator !=(ResponseItemCollectionOrder left, ResponseItemCollectionOrder right);
1008 public override readonly string ToString();
1009 }
1010 [Experimental("OPENAI001")]
1011 public class ResponseItemCollectionPage : IJsonModel<ResponseItemCollectionPage>, IPersistableModel<ResponseItemCollectionPage> {
1012 public IList<ResponseItem> Data { get; }
1013 public string FirstId { get; set; }
1014 public bool HasMore { get; set; }
1015 public string LastId { get; set; }
1016 [EditorBrowsable(EditorBrowsableState.Never)]
1017 public string Object { get; set; }
1018 [Serialization.JsonIgnore]
1019 [EditorBrowsable(EditorBrowsableState.Never)]
1020 [Experimental("SCME0001")]
1021 public ref JsonPatch Patch { get; }
1022 public static explicit operator ResponseItemCollectionPage(ClientResult result);
1023 }
1024 [Experimental("OPENAI001")]
1025 public class ResponseMessageAnnotation : IJsonModel<ResponseMessageAnnotation>, IPersistableModel<ResponseMessageAnnotation> {
1026 public ResponseMessageAnnotationKind Kind { get; }
1027 [Serialization.JsonIgnore]
1028 [EditorBrowsable(EditorBrowsableState.Never)]
1029 [Experimental("SCME0001")]
1030 public ref JsonPatch Patch { get; }
1031 }
1032 [Experimental("OPENAI001")]
1033 public enum ResponseMessageAnnotationKind {
1034 FileCitation = 0,
1035 UriCitation = 1,
1036 FilePath = 2,
1037 ContainerFileCitation = 3
1038 }
1039 [Experimental("OPENAI001")]
1040 public class ResponseOutputTokenUsageDetails : IJsonModel<ResponseOutputTokenUsageDetails>, IPersistableModel<ResponseOutputTokenUsageDetails> {
1041 [Serialization.JsonIgnore]
1042 [EditorBrowsable(EditorBrowsableState.Never)]
1043 [Experimental("SCME0001")]
1044 public ref JsonPatch Patch { get; }
1045 public int ReasoningTokenCount { get; set; }
1046 }
1047 [Experimental("OPENAI001")]
1048 public readonly partial struct ResponseReasoningEffortLevel : IEquatable<ResponseReasoningEffortLevel> {
1049 public ResponseReasoningEffortLevel(string value);
1050 public static ResponseReasoningEffortLevel High { get; }
1051 public static ResponseReasoningEffortLevel Low { get; }
1052 public static ResponseReasoningEffortLevel Medium { get; }
1053 public static ResponseReasoningEffortLevel Minimal { get; }
1054 public static ResponseReasoningEffortLevel None { get; }
1055 public readonly bool Equals(ResponseReasoningEffortLevel other);
1056 [EditorBrowsable(EditorBrowsableState.Never)]
1057 public override readonly bool Equals(object obj);
1058 [EditorBrowsable(EditorBrowsableState.Never)]
1059 public override readonly int GetHashCode();
1060 public static bool operator ==(ResponseReasoningEffortLevel left, ResponseReasoningEffortLevel right);
1061 public static implicit operator ResponseReasoningEffortLevel(string value);
1062 public static implicit operator ResponseReasoningEffortLevel?(string value);
1063 public static bool operator !=(ResponseReasoningEffortLevel left, ResponseReasoningEffortLevel right);
1064 public override readonly string ToString();
1065 }
1066 [Experimental("OPENAI001")]
1067 public class ResponseReasoningOptions : IJsonModel<ResponseReasoningOptions>, IPersistableModel<ResponseReasoningOptions> {
1068 [Serialization.JsonIgnore]
1069 [EditorBrowsable(EditorBrowsableState.Never)]
1070 [Experimental("SCME0001")]
1071 public ref JsonPatch Patch { get; }
1072 public ResponseReasoningEffortLevel? ReasoningEffortLevel { get; set; }
1073 public ResponseReasoningSummaryVerbosity? ReasoningSummaryVerbosity { get; set; }
1074 }
1075 [Experimental("OPENAI001")]
1076 public readonly partial struct ResponseReasoningSummaryVerbosity : IEquatable<ResponseReasoningSummaryVerbosity> {
1077 public ResponseReasoningSummaryVerbosity(string value);
1078 public static ResponseReasoningSummaryVerbosity Auto { get; }
1079 public static ResponseReasoningSummaryVerbosity Concise { get; }
1080 public static ResponseReasoningSummaryVerbosity Detailed { get; }
1081 public readonly bool Equals(ResponseReasoningSummaryVerbosity other);
1082 [EditorBrowsable(EditorBrowsableState.Never)]
1083 public override readonly bool Equals(object obj);
1084 [EditorBrowsable(EditorBrowsableState.Never)]
1085 public override readonly int GetHashCode();
1086 public static bool operator ==(ResponseReasoningSummaryVerbosity left, ResponseReasoningSummaryVerbosity right);
1087 public static implicit operator ResponseReasoningSummaryVerbosity(string value);
1088 public static implicit operator ResponseReasoningSummaryVerbosity?(string value);
1089 public static bool operator !=(ResponseReasoningSummaryVerbosity left, ResponseReasoningSummaryVerbosity right);
1090 public override readonly string ToString();
1091 }
1092 [Experimental("OPENAI001")]
1093 public class ResponseResult : IJsonModel<ResponseResult>, IPersistableModel<ResponseResult> {
1094 public bool? BackgroundModeEnabled { get; set; }
1095 public ResponseConversationOptions ConversationOptions { get; set; }
1096 public DateTimeOffset CreatedAt { get; set; }
1097 public string EndUserId { get; set; }
1098 public ResponseError Error { get; set; }
1099 public string Id { get; set; }
1100 public ResponseIncompleteStatusDetails IncompleteStatusDetails { get; set; }
1101 public IList<ResponseItem> Instructions { get; }
1102 public int? MaxOutputTokenCount { get; set; }
1103 public int? MaxToolCallCount { get; set; }
1104 public IDictionary<string, string> Metadata { get; }
1105 public string Model { get; set; }
1106 [EditorBrowsable(EditorBrowsableState.Never)]
1107 public string Object { get; set; }
1108 public IList<ResponseItem> OutputItems { get; }
1109 public bool ParallelToolCallsEnabled { get; set; }
1110 [Serialization.JsonIgnore]
1111 [EditorBrowsable(EditorBrowsableState.Never)]
1112 [Experimental("SCME0001")]
1113 public ref JsonPatch Patch { get; }
1114 public string PreviousResponseId { get; set; }
1115 public ResponseReasoningOptions ReasoningOptions { get; set; }
1116 public string SafetyIdentifier { get; set; }
1117 public ResponseServiceTier? ServiceTier { get; set; }
1118 public ResponseStatus? Status { get; set; }
1119 public float? Temperature { get; set; }
1120 public ResponseTextOptions TextOptions { get; set; }
1121 public ResponseToolChoice ToolChoice { get; set; }
1122 public IList<ResponseTool> Tools { get; }
1123 public int? TopLogProbabilityCount { get; set; }
1124 public float? TopP { get; set; }
1125 public ResponseTruncationMode? TruncationMode { get; set; }
1126 public ResponseTokenUsage Usage { get; set; }
1127 public string GetOutputText();
1128 public static explicit operator ResponseResult(ClientResult result);
1129 }
1130 [Experimental("OPENAI001")]
1131 public class ResponsesClient {
1132 protected ResponsesClient();
1133 [Experimental("SCME0002")]
1134 public ResponsesClient(ResponsesClientSettings settings);
1135 public ResponsesClient(ApiKeyCredential credential, ResponsesClientOptions options);
1136 public ResponsesClient(ApiKeyCredential credential);
1137 public ResponsesClient(AuthenticationPolicy authenticationPolicy, ResponsesClientOptions options);
1138 public ResponsesClient(AuthenticationPolicy authenticationPolicy);
1139 protected internal ResponsesClient(ClientPipeline pipeline, ResponsesClientOptions options);
1140 public ResponsesClient(string apiKey);
1141 [Experimental("OPENAI001")]
1142 public virtual Uri Endpoint { get; }
1143 public ClientPipeline Pipeline { get; }
1144 public virtual ClientResult CancelResponse(string responseId, RequestOptions options);
1145 public virtual ClientResult<ResponseResult> CancelResponse(string responseId, CancellationToken cancellationToken = default);
1146 public virtual Task<ClientResult> CancelResponseAsync(string responseId, RequestOptions options);
1147 public virtual Task<ClientResult<ResponseResult>> CancelResponseAsync(string responseId, CancellationToken cancellationToken = default);
1148 public virtual ClientResult CompactResponse(BinaryContent content, string contentType, RequestOptions options = null);
1149 public virtual Task<ClientResult> CompactResponseAsync(BinaryContent content, string contentType, RequestOptions options = null);
1150 public virtual ClientResult<ResponseResult> CreateResponse(CreateResponseOptions options, CancellationToken cancellationToken = default);
1151 public virtual ClientResult CreateResponse(BinaryContent content, RequestOptions options = null);
1152 public virtual ClientResult<ResponseResult> CreateResponse(string model, IEnumerable<ResponseItem> inputItems, string previousResponseId = null, CancellationToken cancellationToken = default);
1153 public virtual ClientResult<ResponseResult> CreateResponse(string model, string userInputText, string previousResponseId = null, CancellationToken cancellationToken = default);
1154 public virtual Task<ClientResult<ResponseResult>> CreateResponseAsync(CreateResponseOptions options, CancellationToken cancellationToken = default);
1155 public virtual Task<ClientResult> CreateResponseAsync(BinaryContent content, RequestOptions options = null);
1156 public virtual Task<ClientResult<ResponseResult>> CreateResponseAsync(string model, IEnumerable<ResponseItem> inputItems, string previousResponseId = null, CancellationToken cancellationToken = default);
1157 public virtual Task<ClientResult<ResponseResult>> CreateResponseAsync(string model, string userInputText, string previousResponseId = null, CancellationToken cancellationToken = default);
1158 public virtual CollectionResult<StreamingResponseUpdate> CreateResponseStreaming(CreateResponseOptions options, CancellationToken cancellationToken = default);
1159 public virtual CollectionResult<StreamingResponseUpdate> CreateResponseStreaming(string model, IEnumerable<ResponseItem> inputItems, string previousResponseId = null, CancellationToken cancellationToken = default);
1160 public virtual CollectionResult<StreamingResponseUpdate> CreateResponseStreaming(string model, string userInputText, string previousResponseId = null, CancellationToken cancellationToken = default);
1161 public virtual AsyncCollectionResult<StreamingResponseUpdate> CreateResponseStreamingAsync(CreateResponseOptions options, CancellationToken cancellationToken = default);
1162 public virtual AsyncCollectionResult<StreamingResponseUpdate> CreateResponseStreamingAsync(string model, IEnumerable<ResponseItem> inputItems, string previousResponseId = null, CancellationToken cancellationToken = default);
1163 public virtual AsyncCollectionResult<StreamingResponseUpdate> CreateResponseStreamingAsync(string model, string userInputText, string previousResponseId = null, CancellationToken cancellationToken = default);
1164 public virtual ClientResult DeleteResponse(string responseId, RequestOptions options);
1165 public virtual ClientResult<ResponseDeletionResult> DeleteResponse(string responseId, CancellationToken cancellationToken = default);
1166 public virtual Task<ClientResult> DeleteResponseAsync(string responseId, RequestOptions options);
1167 public virtual Task<ClientResult<ResponseDeletionResult>> DeleteResponseAsync(string responseId, CancellationToken cancellationToken = default);
1168 public virtual ClientResult GetInputTokenCount(BinaryContent content, string contentType, RequestOptions options = null);
1169 public virtual Task<ClientResult> GetInputTokenCountAsync(BinaryContent content, string contentType, RequestOptions options = null);
1170 public virtual ClientResult<ResponseResult> GetResponse(GetResponseOptions options, CancellationToken cancellationToken = default);
1171 public virtual ClientResult GetResponse(string responseId, IEnumerable<IncludedResponseProperty> include, bool? stream, int? startingAfter, bool? includeObfuscation, RequestOptions options);
1172 public virtual ClientResult<ResponseResult> GetResponse(string responseId, CancellationToken cancellationToken = default);
1173 public virtual Task<ClientResult<ResponseResult>> GetResponseAsync(GetResponseOptions options, CancellationToken cancellationToken = default);
1174 public virtual Task<ClientResult> GetResponseAsync(string responseId, IEnumerable<IncludedResponseProperty> include, bool? stream, int? startingAfter, bool? includeObfuscation, RequestOptions options);
1175 public virtual Task<ClientResult<ResponseResult>> GetResponseAsync(string responseId, CancellationToken cancellationToken = default);
1176 public virtual ClientResult<ResponseItemCollectionPage> GetResponseInputItemCollectionPage(ResponseItemCollectionOptions options, CancellationToken cancellationToken = default);
1177 public virtual ClientResult GetResponseInputItemCollectionPage(string responseId, int? limit, string order, string after, string before, RequestOptions options);
1178 public virtual Task<ClientResult<ResponseItemCollectionPage>> GetResponseInputItemCollectionPageAsync(ResponseItemCollectionOptions options, CancellationToken cancellationToken = default);
1179 public virtual Task<ClientResult> GetResponseInputItemCollectionPageAsync(string responseId, int? limit, string order, string after, string before, RequestOptions options);
1180 public virtual CollectionResult<ResponseItem> GetResponseInputItems(ResponseItemCollectionOptions options, CancellationToken cancellationToken = default);
1181 public virtual CollectionResult<ResponseItem> GetResponseInputItems(string responseId, CancellationToken cancellationToken = default);
1182 public virtual AsyncCollectionResult<ResponseItem> GetResponseInputItemsAsync(ResponseItemCollectionOptions options, CancellationToken cancellationToken = default);
1183 public virtual AsyncCollectionResult<ResponseItem> GetResponseInputItemsAsync(string responseId, CancellationToken cancellationToken = default);
1184 public virtual CollectionResult<StreamingResponseUpdate> GetResponseStreaming(GetResponseOptions options, CancellationToken cancellationToken = default);
1185 public virtual CollectionResult<StreamingResponseUpdate> GetResponseStreaming(string responseId, CancellationToken cancellationToken = default);
1186 public virtual AsyncCollectionResult<StreamingResponseUpdate> GetResponseStreamingAsync(GetResponseOptions options, CancellationToken cancellationToken = default);
1187 public virtual AsyncCollectionResult<StreamingResponseUpdate> GetResponseStreamingAsync(string responseId, CancellationToken cancellationToken = default);
1188 }
1189 [Experimental("OPENAI001")]
1190 public class ResponsesClientOptions : ClientPipelineOptions {
1191 public Uri Endpoint { get; set; }
1192 public string OrganizationId { get; set; }
1193 public string ProjectId { get; set; }
1194 public string UserAgentApplicationId { get; set; }
1195 }
1196 [Experimental("SCME0002")]
1197 public sealed class ResponsesClientSettings : ClientSettings {
1198 public ResponsesClientOptions Options { get; set; }
1199 protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
1200 }
1201 [Experimental("OPENAI001")]
1202 public readonly partial struct ResponseServiceTier : IEquatable<ResponseServiceTier> {
1203 public ResponseServiceTier(string value);
1204 public static ResponseServiceTier Auto { get; }
1205 public static ResponseServiceTier Default { get; }
1206 public static ResponseServiceTier Flex { get; }
1207 public static ResponseServiceTier Scale { get; }
1208 public readonly bool Equals(ResponseServiceTier other);
1209 [EditorBrowsable(EditorBrowsableState.Never)]
1210 public override readonly bool Equals(object obj);
1211 [EditorBrowsable(EditorBrowsableState.Never)]
1212 public override readonly int GetHashCode();
1213 public static bool operator ==(ResponseServiceTier left, ResponseServiceTier right);
1214 public static implicit operator ResponseServiceTier(string value);
1215 public static implicit operator ResponseServiceTier?(string value);
1216 public static bool operator !=(ResponseServiceTier left, ResponseServiceTier right);
1217 public override readonly string ToString();
1218 }
1219 [Experimental("OPENAI001")]
1220 public enum ResponseStatus {
1221 InProgress = 0,
1222 Completed = 1,
1223 Cancelled = 2,
1224 Queued = 3,
1225 Incomplete = 4,
1226 Failed = 5
1227 }
1228 [Experimental("OPENAI001")]
1229 public class ResponseTextFormat : IJsonModel<ResponseTextFormat>, IPersistableModel<ResponseTextFormat> {
1230 public ResponseTextFormatKind Kind { get; set; }
1231 [Serialization.JsonIgnore]
1232 [EditorBrowsable(EditorBrowsableState.Never)]
1233 [Experimental("SCME0001")]
1234 public ref JsonPatch Patch { get; }
1235 public static ResponseTextFormat CreateJsonObjectFormat();
1236 public static ResponseTextFormat CreateJsonSchemaFormat(string jsonSchemaFormatName, BinaryData jsonSchema, string jsonSchemaFormatDescription = null, bool? jsonSchemaIsStrict = null);
1237 public static ResponseTextFormat CreateTextFormat();
1238 }
1239 [Experimental("OPENAI001")]
1240 public enum ResponseTextFormatKind {
1241 Unknown = 0,
1242 Text = 1,
1243 JsonObject = 2,
1244 JsonSchema = 3
1245 }
1246 [Experimental("OPENAI001")]
1247 public class ResponseTextOptions : IJsonModel<ResponseTextOptions>, IPersistableModel<ResponseTextOptions> {
1248 [Serialization.JsonIgnore]
1249 [EditorBrowsable(EditorBrowsableState.Never)]
1250 [Experimental("SCME0001")]
1251 public ref JsonPatch Patch { get; }
1252 public ResponseTextFormat TextFormat { get; set; }
1253 }
1254 [Experimental("OPENAI001")]
1255 public class ResponseTokenLogProbabilityDetails : IJsonModel<ResponseTokenLogProbabilityDetails>, IPersistableModel<ResponseTokenLogProbabilityDetails> {
1256 public ResponseTokenLogProbabilityDetails();
1257 public ResponseTokenLogProbabilityDetails(string token, float logProbability, ReadOnlyMemory<byte>? utf8Bytes, IEnumerable<ResponseTokenTopLogProbabilityDetails> topLogProbabilities);
1258 public float LogProbability { get; set; }
1259 [Serialization.JsonIgnore]
1260 [EditorBrowsable(EditorBrowsableState.Never)]
1261 [Experimental("SCME0001")]
1262 public ref JsonPatch Patch { get; }
1263 public string Token { get; set; }
1264 public IReadOnlyList<ResponseTokenTopLogProbabilityDetails> TopLogProbabilities { get; }
1265 public ReadOnlyMemory<byte>? Utf8Bytes { get; set; }
1266 }
1267 [Experimental("OPENAI001")]
1268 public class ResponseTokenTopLogProbabilityDetails : IJsonModel<ResponseTokenTopLogProbabilityDetails>, IPersistableModel<ResponseTokenTopLogProbabilityDetails> {
1269 public ResponseTokenTopLogProbabilityDetails();
1270 public ResponseTokenTopLogProbabilityDetails(string token, float logProbability, ReadOnlyMemory<byte>? utf8Bytes);
1271 public float LogProbability { get; set; }
1272 [Serialization.JsonIgnore]
1273 [EditorBrowsable(EditorBrowsableState.Never)]
1274 [Experimental("SCME0001")]
1275 public ref JsonPatch Patch { get; }
1276 public string Token { get; set; }
1277 public ReadOnlyMemory<byte>? Utf8Bytes { get; set; }
1278 }
1279 [Experimental("OPENAI001")]
1280 public class ResponseTokenUsage : IJsonModel<ResponseTokenUsage>, IPersistableModel<ResponseTokenUsage> {
1281 public int InputTokenCount { get; set; }
1282 public ResponseInputTokenUsageDetails InputTokenDetails { get; set; }
1283 public int OutputTokenCount { get; set; }
1284 public ResponseOutputTokenUsageDetails OutputTokenDetails { get; set; }
1285 [Serialization.JsonIgnore]
1286 [EditorBrowsable(EditorBrowsableState.Never)]
1287 [Experimental("SCME0001")]
1288 public ref JsonPatch Patch { get; }
1289 public int TotalTokenCount { get; set; }
1290 }
1291 [Experimental("OPENAI001")]
1292 public class ResponseTool : IJsonModel<ResponseTool>, IPersistableModel<ResponseTool> {
1293 [Serialization.JsonIgnore]
1294 [EditorBrowsable(EditorBrowsableState.Never)]
1295 [Experimental("SCME0001")]
1296 public ref JsonPatch Patch { get; }
1297 public static ApplyPatchTool CreateApplyPatchTool();
1298 public static CodeInterpreterTool CreateCodeInterpreterTool(CodeInterpreterToolContainer container);
1299 [Experimental("OPENAICUA001")]
1300 public static ComputerTool CreateComputerTool(ComputerToolEnvironment environment, int displayWidth, int displayHeight);
1301 public static FileSearchTool CreateFileSearchTool(IEnumerable<string> vectorStoreIds, int? maxResultCount = null, FileSearchToolRankingOptions rankingOptions = null, BinaryData filters = null);
1302 public static FunctionTool CreateFunctionTool(string functionName, BinaryData functionParameters, bool? strictModeEnabled, string functionDescription = null);
1303 public static ImageGenerationTool CreateImageGenerationTool(string model, ImageGenerationToolQuality? quality = null, ImageGenerationToolSize? size = null, ImageGenerationToolOutputFileFormat? outputFileFormat = null, int? outputCompressionFactor = null, ImageGenerationToolModerationLevel? moderationLevel = null, ImageGenerationToolBackground? background = null, ImageGenerationToolInputFidelity? inputFidelity = null, ImageGenerationToolInputImageMask inputImageMask = null, int? partialImageCount = null, ImageGenerationToolAction? action = null);
1304 public static McpTool CreateMcpTool(string serverLabel, McpToolConnectorId connectorId, string authorizationToken = null, string serverDescription = null, IDictionary<string, string> headers = null, McpToolFilter allowedTools = null, McpToolCallApprovalPolicy toolCallApprovalPolicy = null);
1305 public static McpTool CreateMcpTool(string serverLabel, Uri serverUri, string authorizationToken = null, string serverDescription = null, IDictionary<string, string> headers = null, McpToolFilter allowedTools = null, McpToolCallApprovalPolicy toolCallApprovalPolicy = null);
1306 public static WebSearchPreviewTool CreateWebSearchPreviewTool(WebSearchToolLocation userLocation = null, WebSearchToolContextSize? searchContextSize = null);
1307 public static WebSearchTool CreateWebSearchTool(WebSearchToolLocation userLocation = null, WebSearchToolContextSize? searchContextSize = null, WebSearchToolFilters filters = null);
1308 }
1309 [Experimental("OPENAI001")]
1310 public class ResponseToolChoice : IJsonModel<ResponseToolChoice>, IPersistableModel<ResponseToolChoice> {
1311 public string FunctionName { get; }
1312 public ResponseToolChoiceKind Kind { get; }
1313 public static ResponseToolChoice CreateAutoChoice();
1314 [Experimental("OPENAICUA001")]
1315 public static ResponseToolChoice CreateComputerChoice();
1316 public static ResponseToolChoice CreateFileSearchChoice();
1317 public static ResponseToolChoice CreateFunctionChoice(string functionName);
1318 public static ResponseToolChoice CreateNoneChoice();
1319 public static ResponseToolChoice CreateRequiredChoice();
1320 public static ResponseToolChoice CreateWebSearchChoice();
1321 }
1322 [Experimental("OPENAI001")]
1323 public enum ResponseToolChoiceKind {
1324 Unknown = 0,
1325 Auto = 1,
1326 None = 2,
1327 Required = 3,
1328 Function = 4,
1329 FileSearch = 5,
1330 WebSearch = 6,
1331 Computer = 7
1332 }
1333 [Experimental("OPENAI001")]
1334 public readonly partial struct ResponseTruncationMode : IEquatable<ResponseTruncationMode> {
1335 public ResponseTruncationMode(string value);
1336 public static ResponseTruncationMode Auto { get; }
1337 public static ResponseTruncationMode Disabled { get; }
1338 public readonly bool Equals(ResponseTruncationMode other);
1339 [EditorBrowsable(EditorBrowsableState.Never)]
1340 public override readonly bool Equals(object obj);
1341 [EditorBrowsable(EditorBrowsableState.Never)]
1342 public override readonly int GetHashCode();
1343 public static bool operator ==(ResponseTruncationMode left, ResponseTruncationMode right);
1344 public static implicit operator ResponseTruncationMode(string value);
1345 public static implicit operator ResponseTruncationMode?(string value);
1346 public static bool operator !=(ResponseTruncationMode left, ResponseTruncationMode right);
1347 public override readonly string ToString();
1348 }
1349 [Experimental("OPENAI001")]
1350 public class StreamingResponseCodeInterpreterCallCodeDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseCodeInterpreterCallCodeDeltaUpdate>, IPersistableModel<StreamingResponseCodeInterpreterCallCodeDeltaUpdate> {
1351 public StreamingResponseCodeInterpreterCallCodeDeltaUpdate();
1352 public string Delta { get; set; }
1353 public string ItemId { get; set; }
1354 public int OutputIndex { get; set; }
1355 }
1356 [Experimental("OPENAI001")]
1357 public class StreamingResponseCodeInterpreterCallCodeDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseCodeInterpreterCallCodeDoneUpdate>, IPersistableModel<StreamingResponseCodeInterpreterCallCodeDoneUpdate> {
1358 public StreamingResponseCodeInterpreterCallCodeDoneUpdate();
1359 public string Code { get; set; }
1360 public string ItemId { get; set; }
1361 public int OutputIndex { get; set; }
1362 }
1363 [Experimental("OPENAI001")]
1364 public class StreamingResponseCodeInterpreterCallCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseCodeInterpreterCallCompletedUpdate>, IPersistableModel<StreamingResponseCodeInterpreterCallCompletedUpdate> {
1365 public StreamingResponseCodeInterpreterCallCompletedUpdate();
1366 public string ItemId { get; set; }
1367 public int OutputIndex { get; set; }
1368 }
1369 [Experimental("OPENAI001")]
1370 public class StreamingResponseCodeInterpreterCallInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseCodeInterpreterCallInProgressUpdate>, IPersistableModel<StreamingResponseCodeInterpreterCallInProgressUpdate> {
1371 public StreamingResponseCodeInterpreterCallInProgressUpdate();
1372 public string ItemId { get; set; }
1373 public int OutputIndex { get; set; }
1374 }
1375 [Experimental("OPENAI001")]
1376 public class StreamingResponseCodeInterpreterCallInterpretingUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseCodeInterpreterCallInterpretingUpdate>, IPersistableModel<StreamingResponseCodeInterpreterCallInterpretingUpdate> {
1377 public StreamingResponseCodeInterpreterCallInterpretingUpdate();
1378 public string ItemId { get; set; }
1379 public int OutputIndex { get; set; }
1380 }
1381 [Experimental("OPENAI001")]
1382 public class StreamingResponseCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseCompletedUpdate>, IPersistableModel<StreamingResponseCompletedUpdate> {
1383 public StreamingResponseCompletedUpdate();
1384 public ResponseResult Response { get; set; }
1385 }
1386 [Experimental("OPENAI001")]
1387 public class StreamingResponseContentPartAddedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseContentPartAddedUpdate>, IPersistableModel<StreamingResponseContentPartAddedUpdate> {
1388 public StreamingResponseContentPartAddedUpdate();
1389 public int ContentIndex { get; set; }
1390 public string ItemId { get; set; }
1391 public int OutputIndex { get; set; }
1392 public ResponseContentPart Part { get; set; }
1393 }
1394 [Experimental("OPENAI001")]
1395 public class StreamingResponseContentPartDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseContentPartDoneUpdate>, IPersistableModel<StreamingResponseContentPartDoneUpdate> {
1396 public StreamingResponseContentPartDoneUpdate();
1397 public int ContentIndex { get; set; }
1398 public string ItemId { get; set; }
1399 public int OutputIndex { get; set; }
1400 public ResponseContentPart Part { get; set; }
1401 }
1402 [Experimental("OPENAI001")]
1403 public class StreamingResponseCreatedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseCreatedUpdate>, IPersistableModel<StreamingResponseCreatedUpdate> {
1404 public StreamingResponseCreatedUpdate();
1405 public ResponseResult Response { get; set; }
1406 }
1407 [Experimental("OPENAI001")]
1408 public class StreamingResponseErrorUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseErrorUpdate>, IPersistableModel<StreamingResponseErrorUpdate> {
1409 public StreamingResponseErrorUpdate();
1410 public string Code { get; set; }
1411 public string Message { get; set; }
1412 public string Param { get; set; }
1413 }
1414 [Experimental("OPENAI001")]
1415 public class StreamingResponseFailedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFailedUpdate>, IPersistableModel<StreamingResponseFailedUpdate> {
1416 public StreamingResponseFailedUpdate();
1417 public ResponseResult Response { get; set; }
1418 }
1419 [Experimental("OPENAI001")]
1420 public class StreamingResponseFileSearchCallCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFileSearchCallCompletedUpdate>, IPersistableModel<StreamingResponseFileSearchCallCompletedUpdate> {
1421 public StreamingResponseFileSearchCallCompletedUpdate();
1422 public string ItemId { get; set; }
1423 public int OutputIndex { get; set; }
1424 }
1425 [Experimental("OPENAI001")]
1426 public class StreamingResponseFileSearchCallInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFileSearchCallInProgressUpdate>, IPersistableModel<StreamingResponseFileSearchCallInProgressUpdate> {
1427 public StreamingResponseFileSearchCallInProgressUpdate();
1428 public string ItemId { get; set; }
1429 public int OutputIndex { get; set; }
1430 }
1431 [Experimental("OPENAI001")]
1432 public class StreamingResponseFileSearchCallSearchingUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFileSearchCallSearchingUpdate>, IPersistableModel<StreamingResponseFileSearchCallSearchingUpdate> {
1433 public StreamingResponseFileSearchCallSearchingUpdate();
1434 public string ItemId { get; set; }
1435 public int OutputIndex { get; set; }
1436 }
1437 [Experimental("OPENAI001")]
1438 public class StreamingResponseFunctionCallArgumentsDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFunctionCallArgumentsDeltaUpdate>, IPersistableModel<StreamingResponseFunctionCallArgumentsDeltaUpdate> {
1439 public StreamingResponseFunctionCallArgumentsDeltaUpdate();
1440 public BinaryData Delta { get; set; }
1441 public string ItemId { get; set; }
1442 public int OutputIndex { get; set; }
1443 }
1444 [Experimental("OPENAI001")]
1445 public class StreamingResponseFunctionCallArgumentsDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseFunctionCallArgumentsDoneUpdate>, IPersistableModel<StreamingResponseFunctionCallArgumentsDoneUpdate> {
1446 public StreamingResponseFunctionCallArgumentsDoneUpdate();
1447 public BinaryData FunctionArguments { get; set; }
1448 public string FunctionName { get; set; }
1449 public string ItemId { get; set; }
1450 public int OutputIndex { get; set; }
1451 }
1452 [Experimental("OPENAI001")]
1453 public class StreamingResponseImageGenerationCallCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseImageGenerationCallCompletedUpdate>, IPersistableModel<StreamingResponseImageGenerationCallCompletedUpdate> {
1454 public StreamingResponseImageGenerationCallCompletedUpdate();
1455 public string ItemId { get; set; }
1456 public int OutputIndex { get; set; }
1457 }
1458 [Experimental("OPENAI001")]
1459 public class StreamingResponseImageGenerationCallGeneratingUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseImageGenerationCallGeneratingUpdate>, IPersistableModel<StreamingResponseImageGenerationCallGeneratingUpdate> {
1460 public StreamingResponseImageGenerationCallGeneratingUpdate();
1461 public string ItemId { get; set; }
1462 public int OutputIndex { get; set; }
1463 }
1464 [Experimental("OPENAI001")]
1465 public class StreamingResponseImageGenerationCallInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseImageGenerationCallInProgressUpdate>, IPersistableModel<StreamingResponseImageGenerationCallInProgressUpdate> {
1466 public StreamingResponseImageGenerationCallInProgressUpdate();
1467 public string ItemId { get; set; }
1468 public int OutputIndex { get; set; }
1469 }
1470 [Experimental("OPENAI001")]
1471 public class StreamingResponseImageGenerationCallPartialImageUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseImageGenerationCallPartialImageUpdate>, IPersistableModel<StreamingResponseImageGenerationCallPartialImageUpdate> {
1472 public StreamingResponseImageGenerationCallPartialImageUpdate();
1473 public string ItemId { get; set; }
1474 public int OutputIndex { get; set; }
1475 public BinaryData PartialImageBytes { get; set; }
1476 public int PartialImageIndex { get; set; }
1477 }
1478 [Experimental("OPENAI001")]
1479 public class StreamingResponseIncompleteUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseIncompleteUpdate>, IPersistableModel<StreamingResponseIncompleteUpdate> {
1480 public StreamingResponseIncompleteUpdate();
1481 public ResponseResult Response { get; set; }
1482 }
1483 [Experimental("OPENAI001")]
1484 public class StreamingResponseInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseInProgressUpdate>, IPersistableModel<StreamingResponseInProgressUpdate> {
1485 public StreamingResponseInProgressUpdate();
1486 public ResponseResult Response { get; set; }
1487 }
1488 [Experimental("OPENAI001")]
1489 public class StreamingResponseMcpCallArgumentsDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseMcpCallArgumentsDeltaUpdate>, IPersistableModel<StreamingResponseMcpCallArgumentsDeltaUpdate> {
1490 public StreamingResponseMcpCallArgumentsDeltaUpdate();
1491 public BinaryData Delta { get; set; }
1492 public string ItemId { get; set; }
1493 public int OutputIndex { get; set; }
1494 }
1495 [Experimental("OPENAI001")]
1496 public class StreamingResponseMcpCallArgumentsDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseMcpCallArgumentsDoneUpdate>, IPersistableModel<StreamingResponseMcpCallArgumentsDoneUpdate> {
1497 public StreamingResponseMcpCallArgumentsDoneUpdate();
1498 public string ItemId { get; set; }
1499 public int OutputIndex { get; set; }
1500 public BinaryData ToolArguments { get; set; }
1501 }
1502 [Experimental("OPENAI001")]
1503 public class StreamingResponseMcpCallCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseMcpCallCompletedUpdate>, IPersistableModel<StreamingResponseMcpCallCompletedUpdate> {
1504 public StreamingResponseMcpCallCompletedUpdate();
1505 public string ItemId { get; set; }
1506 public int OutputIndex { get; set; }
1507 }
1508 [Experimental("OPENAI001")]
1509 public class StreamingResponseMcpCallFailedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseMcpCallFailedUpdate>, IPersistableModel<StreamingResponseMcpCallFailedUpdate> {
1510 public StreamingResponseMcpCallFailedUpdate();
1511 public string ItemId { get; set; }
1512 public int OutputIndex { get; set; }
1513 }
1514 [Experimental("OPENAI001")]
1515 public class StreamingResponseMcpCallInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseMcpCallInProgressUpdate>, IPersistableModel<StreamingResponseMcpCallInProgressUpdate> {
1516 public StreamingResponseMcpCallInProgressUpdate();
1517 public string ItemId { get; set; }
1518 public int OutputIndex { get; set; }
1519 }
1520 [Experimental("OPENAI001")]
1521 public class StreamingResponseMcpListToolsCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseMcpListToolsCompletedUpdate>, IPersistableModel<StreamingResponseMcpListToolsCompletedUpdate> {
1522 public StreamingResponseMcpListToolsCompletedUpdate();
1523 public string ItemId { get; set; }
1524 public int OutputIndex { get; set; }
1525 }
1526 [Experimental("OPENAI001")]
1527 public class StreamingResponseMcpListToolsFailedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseMcpListToolsFailedUpdate>, IPersistableModel<StreamingResponseMcpListToolsFailedUpdate> {
1528 public StreamingResponseMcpListToolsFailedUpdate();
1529 public string ItemId { get; set; }
1530 public int OutputIndex { get; set; }
1531 }
1532 [Experimental("OPENAI001")]
1533 public class StreamingResponseMcpListToolsInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseMcpListToolsInProgressUpdate>, IPersistableModel<StreamingResponseMcpListToolsInProgressUpdate> {
1534 public StreamingResponseMcpListToolsInProgressUpdate();
1535 public string ItemId { get; set; }
1536 public int OutputIndex { get; set; }
1537 }
1538 [Experimental("OPENAI001")]
1539 public class StreamingResponseOutputItemAddedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseOutputItemAddedUpdate>, IPersistableModel<StreamingResponseOutputItemAddedUpdate> {
1540 public StreamingResponseOutputItemAddedUpdate();
1541 public ResponseItem Item { get; set; }
1542 public int OutputIndex { get; set; }
1543 }
1544 [Experimental("OPENAI001")]
1545 public class StreamingResponseOutputItemDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseOutputItemDoneUpdate>, IPersistableModel<StreamingResponseOutputItemDoneUpdate> {
1546 public StreamingResponseOutputItemDoneUpdate();
1547 public ResponseItem Item { get; set; }
1548 public int OutputIndex { get; set; }
1549 }
1550 [Experimental("OPENAI001")]
1551 public class StreamingResponseOutputTextAnnotationAddedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseOutputTextAnnotationAddedUpdate>, IPersistableModel<StreamingResponseOutputTextAnnotationAddedUpdate> {
1552 public StreamingResponseOutputTextAnnotationAddedUpdate();
1553 public ResponseMessageAnnotation Annotation { get; set; }
1554 public int AnnotationIndex { get; set; }
1555 public int ContentIndex { get; set; }
1556 public string ItemId { get; set; }
1557 public int OutputIndex { get; set; }
1558 }
1559 [Experimental("OPENAI001")]
1560 public class StreamingResponseOutputTextDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseOutputTextDeltaUpdate>, IPersistableModel<StreamingResponseOutputTextDeltaUpdate> {
1561 public StreamingResponseOutputTextDeltaUpdate();
1562 public int ContentIndex { get; set; }
1563 public string Delta { get; set; }
1564 public string ItemId { get; set; }
1565 public int OutputIndex { get; set; }
1566 public IList<ResponseTokenLogProbabilityDetails> TokenLogProbabilities { get; }
1567 }
1568 [Experimental("OPENAI001")]
1569 public class StreamingResponseOutputTextDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseOutputTextDoneUpdate>, IPersistableModel<StreamingResponseOutputTextDoneUpdate> {
1570 public StreamingResponseOutputTextDoneUpdate();
1571 public int ContentIndex { get; set; }
1572 public string ItemId { get; set; }
1573 public int OutputIndex { get; set; }
1574 public string Text { get; set; }
1575 public IList<ResponseTokenLogProbabilityDetails> TokenLogProbabilities { get; }
1576 }
1577 [Experimental("OPENAI001")]
1578 public class StreamingResponseQueuedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseQueuedUpdate>, IPersistableModel<StreamingResponseQueuedUpdate> {
1579 public StreamingResponseQueuedUpdate();
1580 public ResponseResult Response { get; set; }
1581 }
1582 [Experimental("OPENAI001")]
1583 public class StreamingResponseReasoningSummaryPartAddedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseReasoningSummaryPartAddedUpdate>, IPersistableModel<StreamingResponseReasoningSummaryPartAddedUpdate> {
1584 public StreamingResponseReasoningSummaryPartAddedUpdate();
1585 public string ItemId { get; set; }
1586 public int OutputIndex { get; set; }
1587 public ReasoningSummaryPart Part { get; set; }
1588 public int SummaryIndex { get; set; }
1589 }
1590 [Experimental("OPENAI001")]
1591 public class StreamingResponseReasoningSummaryPartDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseReasoningSummaryPartDoneUpdate>, IPersistableModel<StreamingResponseReasoningSummaryPartDoneUpdate> {
1592 public StreamingResponseReasoningSummaryPartDoneUpdate();
1593 public string ItemId { get; set; }
1594 public int OutputIndex { get; set; }
1595 public ReasoningSummaryPart Part { get; set; }
1596 public int SummaryIndex { get; set; }
1597 }
1598 [Experimental("OPENAI001")]
1599 public class StreamingResponseReasoningSummaryTextDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseReasoningSummaryTextDeltaUpdate>, IPersistableModel<StreamingResponseReasoningSummaryTextDeltaUpdate> {
1600 public StreamingResponseReasoningSummaryTextDeltaUpdate();
1601 public string Delta { get; set; }
1602 public string ItemId { get; set; }
1603 public int OutputIndex { get; set; }
1604 public int SummaryIndex { get; set; }
1605 }
1606 [Experimental("OPENAI001")]
1607 public class StreamingResponseReasoningSummaryTextDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseReasoningSummaryTextDoneUpdate>, IPersistableModel<StreamingResponseReasoningSummaryTextDoneUpdate> {
1608 public StreamingResponseReasoningSummaryTextDoneUpdate();
1609 public string ItemId { get; set; }
1610 public int OutputIndex { get; set; }
1611 public int SummaryIndex { get; set; }
1612 public string Text { get; set; }
1613 }
1614 [Experimental("OPENAI001")]
1615 public class StreamingResponseReasoningTextDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseReasoningTextDeltaUpdate>, IPersistableModel<StreamingResponseReasoningTextDeltaUpdate> {
1616 public StreamingResponseReasoningTextDeltaUpdate();
1617 public int ContentIndex { get; set; }
1618 public string Delta { get; set; }
1619 public string ItemId { get; set; }
1620 public int OutputIndex { get; set; }
1621 }
1622 [Experimental("OPENAI001")]
1623 public class StreamingResponseReasoningTextDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseReasoningTextDoneUpdate>, IPersistableModel<StreamingResponseReasoningTextDoneUpdate> {
1624 public StreamingResponseReasoningTextDoneUpdate();
1625 public int ContentIndex { get; set; }
1626 public string ItemId { get; set; }
1627 public int OutputIndex { get; set; }
1628 public string Text { get; set; }
1629 }
1630 [Experimental("OPENAI001")]
1631 public class StreamingResponseRefusalDeltaUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseRefusalDeltaUpdate>, IPersistableModel<StreamingResponseRefusalDeltaUpdate> {
1632 public StreamingResponseRefusalDeltaUpdate();
1633 public int ContentIndex { get; set; }
1634 public string Delta { get; set; }
1635 public string ItemId { get; set; }
1636 public int OutputIndex { get; set; }
1637 }
1638 [Experimental("OPENAI001")]
1639 public class StreamingResponseRefusalDoneUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseRefusalDoneUpdate>, IPersistableModel<StreamingResponseRefusalDoneUpdate> {
1640 public StreamingResponseRefusalDoneUpdate();
1641 public int ContentIndex { get; set; }
1642 public string ItemId { get; set; }
1643 public int OutputIndex { get; set; }
1644 public string Refusal { get; set; }
1645 }
1646 [Experimental("OPENAI001")]
1647 public class StreamingResponseUpdate : IJsonModel<StreamingResponseUpdate>, IPersistableModel<StreamingResponseUpdate> {
1648 public StreamingResponseUpdateKind Kind { get; }
1649 [Serialization.JsonIgnore]
1650 [EditorBrowsable(EditorBrowsableState.Never)]
1651 [Experimental("SCME0001")]
1652 public ref JsonPatch Patch { get; }
1653 public int SequenceNumber { get; set; }
1654 }
1655 [Experimental("OPENAI001")]
1656 public readonly partial struct StreamingResponseUpdateKind : IEquatable<StreamingResponseUpdateKind> {
1657 public StreamingResponseUpdateKind(string value);
1658 public static StreamingResponseUpdateKind Error { get; }
1659 public static StreamingResponseUpdateKind ResponseAudioDelta { get; }
1660 public static StreamingResponseUpdateKind ResponseAudioDone { get; }
1661 public static StreamingResponseUpdateKind ResponseAudioTranscriptDelta { get; }
1662 public static StreamingResponseUpdateKind ResponseAudioTranscriptDone { get; }
1663 public static StreamingResponseUpdateKind ResponseCodeInterpreterCallCodeDelta { get; }
1664 public static StreamingResponseUpdateKind ResponseCodeInterpreterCallCodeDone { get; }
1665 public static StreamingResponseUpdateKind ResponseCodeInterpreterCallCompleted { get; }
1666 public static StreamingResponseUpdateKind ResponseCodeInterpreterCallInProgress { get; }
1667 public static StreamingResponseUpdateKind ResponseCodeInterpreterCallInterpreting { get; }
1668 public static StreamingResponseUpdateKind ResponseCompleted { get; }
1669 public static StreamingResponseUpdateKind ResponseContentPartAdded { get; }
1670 public static StreamingResponseUpdateKind ResponseContentPartDone { get; }
1671 public static StreamingResponseUpdateKind ResponseCreated { get; }
1672 public static StreamingResponseUpdateKind ResponseCustomToolCallInputDelta { get; }
1673 public static StreamingResponseUpdateKind ResponseCustomToolCallInputDone { get; }
1674 public static StreamingResponseUpdateKind ResponseFailed { get; }
1675 public static StreamingResponseUpdateKind ResponseFileSearchCallCompleted { get; }
1676 public static StreamingResponseUpdateKind ResponseFileSearchCallInProgress { get; }
1677 public static StreamingResponseUpdateKind ResponseFileSearchCallSearching { get; }
1678 public static StreamingResponseUpdateKind ResponseFunctionCallArgumentsDelta { get; }
1679 public static StreamingResponseUpdateKind ResponseFunctionCallArgumentsDone { get; }
1680 public static StreamingResponseUpdateKind ResponseImageGenerationCallCompleted { get; }
1681 public static StreamingResponseUpdateKind ResponseImageGenerationCallGenerating { get; }
1682 public static StreamingResponseUpdateKind ResponseImageGenerationCallInProgress { get; }
1683 public static StreamingResponseUpdateKind ResponseImageGenerationCallPartialImage { get; }
1684 public static StreamingResponseUpdateKind ResponseIncomplete { get; }
1685 public static StreamingResponseUpdateKind ResponseInProgress { get; }
1686 public static StreamingResponseUpdateKind ResponseMcpCallArgumentsDelta { get; }
1687 public static StreamingResponseUpdateKind ResponseMcpCallArgumentsDone { get; }
1688 public static StreamingResponseUpdateKind ResponseMcpCallCompleted { get; }
1689 public static StreamingResponseUpdateKind ResponseMcpCallFailed { get; }
1690 public static StreamingResponseUpdateKind ResponseMcpCallInProgress { get; }
1691 public static StreamingResponseUpdateKind ResponseMcpListToolsCompleted { get; }
1692 public static StreamingResponseUpdateKind ResponseMcpListToolsFailed { get; }
1693 public static StreamingResponseUpdateKind ResponseMcpListToolsInProgress { get; }
1694 public static StreamingResponseUpdateKind ResponseOutputItemAdded { get; }
1695 public static StreamingResponseUpdateKind ResponseOutputItemDone { get; }
1696 public static StreamingResponseUpdateKind ResponseOutputTextAnnotationAdded { get; }
1697 public static StreamingResponseUpdateKind ResponseOutputTextDelta { get; }
1698 public static StreamingResponseUpdateKind ResponseOutputTextDone { get; }
1699 public static StreamingResponseUpdateKind ResponseQueued { get; }
1700 public static StreamingResponseUpdateKind ResponseReasoningSummaryPartAdded { get; }
1701 public static StreamingResponseUpdateKind ResponseReasoningSummaryPartDone { get; }
1702 public static StreamingResponseUpdateKind ResponseReasoningSummaryTextDelta { get; }
1703 public static StreamingResponseUpdateKind ResponseReasoningSummaryTextDone { get; }
1704 public static StreamingResponseUpdateKind ResponseReasoningTextDelta { get; }
1705 public static StreamingResponseUpdateKind ResponseReasoningTextDone { get; }
1706 public static StreamingResponseUpdateKind ResponseRefusalDelta { get; }
1707 public static StreamingResponseUpdateKind ResponseRefusalDone { get; }
1708 public static StreamingResponseUpdateKind ResponseWebSearchCallCompleted { get; }
1709 public static StreamingResponseUpdateKind ResponseWebSearchCallInProgress { get; }
1710 public static StreamingResponseUpdateKind ResponseWebSearchCallSearching { get; }
1711 public readonly bool Equals(StreamingResponseUpdateKind other);
1712 [EditorBrowsable(EditorBrowsableState.Never)]
1713 public override readonly bool Equals(object obj);
1714 [EditorBrowsable(EditorBrowsableState.Never)]
1715 public override readonly int GetHashCode();
1716 public static bool operator ==(StreamingResponseUpdateKind left, StreamingResponseUpdateKind right);
1717 public static implicit operator StreamingResponseUpdateKind(string value);
1718 public static implicit operator StreamingResponseUpdateKind?(string value);
1719 public static bool operator !=(StreamingResponseUpdateKind left, StreamingResponseUpdateKind right);
1720 public override readonly string ToString();
1721 }
1722 [Experimental("OPENAI001")]
1723 public class StreamingResponseWebSearchCallCompletedUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseWebSearchCallCompletedUpdate>, IPersistableModel<StreamingResponseWebSearchCallCompletedUpdate> {
1724 public StreamingResponseWebSearchCallCompletedUpdate();
1725 public string ItemId { get; set; }
1726 public int OutputIndex { get; set; }
1727 }
1728 [Experimental("OPENAI001")]
1729 public class StreamingResponseWebSearchCallInProgressUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseWebSearchCallInProgressUpdate>, IPersistableModel<StreamingResponseWebSearchCallInProgressUpdate> {
1730 public StreamingResponseWebSearchCallInProgressUpdate();
1731 public string ItemId { get; set; }
1732 public int OutputIndex { get; set; }
1733 }
1734 [Experimental("OPENAI001")]
1735 public class StreamingResponseWebSearchCallSearchingUpdate : StreamingResponseUpdate, IJsonModel<StreamingResponseWebSearchCallSearchingUpdate>, IPersistableModel<StreamingResponseWebSearchCallSearchingUpdate> {
1736 public StreamingResponseWebSearchCallSearchingUpdate();
1737 public string ItemId { get; set; }
1738 public int OutputIndex { get; set; }
1739 }
1740 [Experimental("OPENAI001")]
1741 public class UriCitationMessageAnnotation : ResponseMessageAnnotation, IJsonModel<UriCitationMessageAnnotation>, IPersistableModel<UriCitationMessageAnnotation> {
1742 public UriCitationMessageAnnotation(Uri uri, int startIndex, int endIndex, string title);
1743 public int EndIndex { get; set; }
1744 public int StartIndex { get; set; }
1745 public string Title { get; set; }
1746 public Uri Uri { get; set; }
1747 }
1748 [Experimental("OPENAI001")]
1749 public class WebSearchAction : IJsonModel<WebSearchAction>, IPersistableModel<WebSearchAction> {
1750 [Serialization.JsonIgnore]
1751 [EditorBrowsable(EditorBrowsableState.Never)]
1752 [Experimental("SCME0001")]
1753 public ref JsonPatch Patch { get; }
1754 }
1755 [Experimental("OPENAI001")]
1756 public class WebSearchActionSource : IJsonModel<WebSearchActionSource>, IPersistableModel<WebSearchActionSource> {
1757 [Serialization.JsonIgnore]
1758 [EditorBrowsable(EditorBrowsableState.Never)]
1759 [Experimental("SCME0001")]
1760 public ref JsonPatch Patch { get; }
1761 }
1762 [Experimental("OPENAI001")]
1763 public class WebSearchActionUriSource : WebSearchActionSource, IJsonModel<WebSearchActionUriSource>, IPersistableModel<WebSearchActionUriSource> {
1764 public WebSearchActionUriSource(Uri uri);
1765 public Uri Uri { get; set; }
1766 }
1767 [Experimental("OPENAI001")]
1768 public class WebSearchCallResponseItem : ResponseItem, IJsonModel<WebSearchCallResponseItem>, IPersistableModel<WebSearchCallResponseItem> {
1769 public WebSearchCallResponseItem();
1770 public WebSearchAction Action { get; set; }
1771 public WebSearchCallStatus? Status { get; set; }
1772 }
1773 [Experimental("OPENAI001")]
1774 public enum WebSearchCallStatus {
1775 InProgress = 0,
1776 Searching = 1,
1777 Completed = 2,
1778 Failed = 3
1779 }
1780 [Experimental("OPENAI001")]
1781 public class WebSearchFindInPageAction : WebSearchAction, IJsonModel<WebSearchFindInPageAction>, IPersistableModel<WebSearchFindInPageAction> {
1782 public WebSearchFindInPageAction(Uri uri, string pattern);
1783 public string Pattern { get; set; }
1784 public Uri Uri { get; set; }
1785 }
1786 [Experimental("OPENAI001")]
1787 public class WebSearchOpenPageAction : WebSearchAction, IJsonModel<WebSearchOpenPageAction>, IPersistableModel<WebSearchOpenPageAction> {
1788 public WebSearchOpenPageAction();
1789 public Uri Uri { get; set; }
1790 }
1791 [Experimental("OPENAI001")]
1792 public class WebSearchPreviewTool : ResponseTool, IJsonModel<WebSearchPreviewTool>, IPersistableModel<WebSearchPreviewTool> {
1793 public WebSearchPreviewTool();
1794 public WebSearchToolContextSize? SearchContextSize { get; set; }
1795 public WebSearchToolLocation UserLocation { get; set; }
1796 }
1797 [Experimental("OPENAI001")]
1798 public class WebSearchSearchAction : WebSearchAction, IJsonModel<WebSearchSearchAction>, IPersistableModel<WebSearchSearchAction> {
1799 public WebSearchSearchAction();
1800 public IList<string> Queries { get; }
1801 [Obsolete("This property is obsolete. Use the Queries property instead.")]
1802 public string Query { get; set; }
1803 public IList<WebSearchActionSource> Sources { get; }
1804 }
1805 [Experimental("OPENAI001")]
1806 public class WebSearchTool : ResponseTool, IJsonModel<WebSearchTool>, IPersistableModel<WebSearchTool> {
1807 public WebSearchTool();
1808 public WebSearchToolFilters Filters { get; set; }
1809 public WebSearchToolContextSize? SearchContextSize { get; set; }
1810 public WebSearchToolLocation UserLocation { get; set; }
1811 }
1812 [Experimental("OPENAI001")]
1813 public class WebSearchToolApproximateLocation : WebSearchToolLocation, IJsonModel<WebSearchToolApproximateLocation>, IPersistableModel<WebSearchToolApproximateLocation> {
1814 public WebSearchToolApproximateLocation();
1815 public string City { get; set; }
1816 public string Country { get; set; }
1817 public string Region { get; set; }
1818 public string Timezone { get; set; }
1819 }
1820 [Experimental("OPENAI001")]
1821 public readonly partial struct WebSearchToolContextSize : IEquatable<WebSearchToolContextSize> {
1822 public WebSearchToolContextSize(string value);
1823 public static WebSearchToolContextSize High { get; }
1824 public static WebSearchToolContextSize Low { get; }
1825 public static WebSearchToolContextSize Medium { get; }
1826 public readonly bool Equals(WebSearchToolContextSize other);
1827 [EditorBrowsable(EditorBrowsableState.Never)]
1828 public override readonly bool Equals(object obj);
1829 [EditorBrowsable(EditorBrowsableState.Never)]
1830 public override readonly int GetHashCode();
1831 public static bool operator ==(WebSearchToolContextSize left, WebSearchToolContextSize right);
1832 public static implicit operator WebSearchToolContextSize(string value);
1833 public static implicit operator WebSearchToolContextSize?(string value);
1834 public static bool operator !=(WebSearchToolContextSize left, WebSearchToolContextSize right);
1835 public override readonly string ToString();
1836 }
1837 [Experimental("OPENAI001")]
1838 public class WebSearchToolFilters : IJsonModel<WebSearchToolFilters>, IPersistableModel<WebSearchToolFilters> {
1839 public IList<string> AllowedDomains { get; set; }
1840 [Serialization.JsonIgnore]
1841 [EditorBrowsable(EditorBrowsableState.Never)]
1842 [Experimental("SCME0001")]
1843 public ref JsonPatch Patch { get; }
1844 }
1845 [Experimental("OPENAI001")]
1846 public class WebSearchToolLocation : IJsonModel<WebSearchToolLocation>, IPersistableModel<WebSearchToolLocation> {
1847 [Serialization.JsonIgnore]
1848 [EditorBrowsable(EditorBrowsableState.Never)]
1849 [Experimental("SCME0001")]
1850 public ref JsonPatch Patch { get; }
1851 public static WebSearchToolApproximateLocation CreateApproximateLocation(string country = null, string region = null, string city = null, string timezone = null);
1852 }
1853}