-
Notifications
You must be signed in to change notification settings - Fork 386
Expand file tree
/
Copy pathOpenAI.netstandard2.0.cs
More file actions
6343 lines (6343 loc) · 436 KB
/
OpenAI.netstandard2.0.cs
File metadata and controls
6343 lines (6343 loc) · 436 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//------------------------------------------------------------------------------
// <auto-generated>
// This file is auto-generated by scripts/Export-Api.ps1 and must not be
// modified manually. To update it, make the necessary source-code changes
// and re-run scripts/Export-Api.ps1 to regenerate it.
// </auto-generated>
//------------------------------------------------------------------------------
namespace OpenAI {
public class OpenAIClient {
protected OpenAIClient();
public OpenAIClient(ApiKeyCredential credential, OpenAIClientOptions options);
public OpenAIClient(ApiKeyCredential credential);
public OpenAIClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public OpenAIClient(AuthenticationPolicy authenticationPolicy);
protected internal OpenAIClient(ClientPipeline pipeline, OpenAIClientOptions options);
public OpenAIClient(string apiKey);
public Uri Endpoint { get; }
public ClientPipeline Pipeline { get; }
public virtual AssistantClient GetAssistantClient();
public virtual AudioClient GetAudioClient(string model);
public virtual BatchClient GetBatchClient();
public virtual ChatClient GetChatClient(string model);
public virtual ContainerClient GetContainerClient();
public virtual ConversationClient GetConversationClient();
public virtual EmbeddingClient GetEmbeddingClient(string model);
public virtual EvaluationClient GetEvaluationClient();
public virtual FineTuningClient GetFineTuningClient();
public virtual GraderClient GetGraderClient();
public virtual ImageClient GetImageClient(string model);
public virtual ModerationClient GetModerationClient(string model);
public virtual OpenAIFileClient GetOpenAIFileClient();
public virtual OpenAIModelClient GetOpenAIModelClient();
public virtual RealtimeClient GetRealtimeClient();
public virtual ResponsesClient GetResponsesClient();
public virtual SkillClient GetSkillClient();
public virtual VectorStoreClient GetVectorStoreClient();
public virtual VideoClient GetVideoClient();
}
public class OpenAIClientOptions : ClientPipelineOptions {
public Uri Endpoint { get; set; }
public string OrganizationId { get; set; }
public string ProjectId { get; set; }
public string UserAgentApplicationId { get; set; }
}
public class OpenAIContext : ModelReaderWriterContext {
public static OpenAIContext Default { get; }
protected override bool TryGetTypeBuilderCore(Type type, out ModelReaderWriterTypeBuilder builder);
}
public static class OpenAIHostBuilderExtensions {
public static IClientBuilder AddAssistantClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddAudioClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddBatchClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddChatClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddContainerClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddConversationClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddEmbeddingClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddEvaluationClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddFineTuningClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddGraderClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddImageClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddKeyedAssistantClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedAudioClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedBatchClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedChatClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedContainerClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedConversationClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedEmbeddingClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedEvaluationClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedFineTuningClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedGraderClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedImageClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedModerationClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedOpenAIFileClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedOpenAIModelClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedRealtimeClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedResponsesClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedSkillClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedVectorStoreClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddKeyedVideoClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string serviceKey, string sectionName);
public static IClientBuilder AddModerationClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddOpenAIFileClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddOpenAIModelClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddRealtimeClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddResponsesClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddSkillClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddVectorStoreClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
public static IClientBuilder AddVideoClient(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string sectionName);
}
}
namespace OpenAI.Assistants {
public class Assistant : IJsonModel<Assistant>, IPersistableModel<Assistant> {
public DateTimeOffset CreatedAt { get; }
public string Description { get; }
public string Id { get; }
public string Instructions { get; }
public IReadOnlyDictionary<string, string> Metadata { get; }
public string Model { get; }
public string Name { get; }
public float? NucleusSamplingFactor { get; }
public AssistantResponseFormat ResponseFormat { get; }
public float? Temperature { get; }
public ToolResources ToolResources { get; }
public IReadOnlyList<ToolDefinition> Tools { get; }
public static explicit operator Assistant(ClientResult result);
}
public class AssistantClient {
protected AssistantClient();
public AssistantClient(AssistantClientSettings settings);
public AssistantClient(ApiKeyCredential credential, OpenAIClientOptions options);
public AssistantClient(ApiKeyCredential credential);
public AssistantClient(AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public AssistantClient(AuthenticationPolicy authenticationPolicy);
protected internal AssistantClient(ClientPipeline pipeline, OpenAIClientOptions options);
public AssistantClient(string apiKey);
public Uri Endpoint { get; }
public ClientPipeline Pipeline { get; }
public virtual ClientResult CancelRun(string threadId, string runId, RequestOptions options);
public virtual ClientResult<ThreadRun> CancelRun(string threadId, string runId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CancelRunAsync(string threadId, string runId, RequestOptions options);
public virtual Task<ClientResult<ThreadRun>> CancelRunAsync(string threadId, string runId, CancellationToken cancellationToken = default);
public virtual ClientResult CreateAssistant(BinaryContent content, RequestOptions options = null);
public virtual ClientResult<Assistant> CreateAssistant(string model, AssistantCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CreateAssistantAsync(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<Assistant>> CreateAssistantAsync(string model, AssistantCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult<ThreadMessage> CreateMessage(string threadId, MessageRole role, IEnumerable<MessageContent> content, MessageCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult CreateMessage(string threadId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<ThreadMessage>> CreateMessageAsync(string threadId, MessageRole role, IEnumerable<MessageContent> content, MessageCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CreateMessageAsync(string threadId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult CreateRun(string threadId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult<ThreadRun> CreateRun(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CreateRunAsync(string threadId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<ThreadRun>> CreateRunAsync(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult<StreamingUpdate> CreateRunStreaming(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<StreamingUpdate> CreateRunStreamingAsync(string threadId, string assistantId, RunCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult<AssistantThread> CreateThread(ThreadCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult CreateThread(BinaryContent content, RequestOptions options = null);
public virtual ClientResult CreateThreadAndRun(BinaryContent content, RequestOptions options = null);
public virtual ClientResult<ThreadRun> CreateThreadAndRun(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CreateThreadAndRunAsync(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<ThreadRun>> CreateThreadAndRunAsync(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
public virtual CollectionResult<StreamingUpdate> CreateThreadAndRunStreaming(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<StreamingUpdate> CreateThreadAndRunStreamingAsync(string assistantId, ThreadCreationOptions threadOptions = null, RunCreationOptions runOptions = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<AssistantThread>> CreateThreadAsync(ThreadCreationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> CreateThreadAsync(BinaryContent content, RequestOptions options = null);
public virtual ClientResult DeleteAssistant(string assistantId, RequestOptions options);
public virtual ClientResult<AssistantDeletionResult> DeleteAssistant(string assistantId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> DeleteAssistantAsync(string assistantId, RequestOptions options);
public virtual Task<ClientResult<AssistantDeletionResult>> DeleteAssistantAsync(string assistantId, CancellationToken cancellationToken = default);
public virtual ClientResult DeleteMessage(string threadId, string messageId, RequestOptions options);
public virtual ClientResult<MessageDeletionResult> DeleteMessage(string threadId, string messageId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> DeleteMessageAsync(string threadId, string messageId, RequestOptions options);
public virtual Task<ClientResult<MessageDeletionResult>> DeleteMessageAsync(string threadId, string messageId, CancellationToken cancellationToken = default);
public virtual ClientResult DeleteThread(string threadId, RequestOptions options);
public virtual ClientResult<ThreadDeletionResult> DeleteThread(string threadId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> DeleteThreadAsync(string threadId, RequestOptions options);
public virtual Task<ClientResult<ThreadDeletionResult>> DeleteThreadAsync(string threadId, CancellationToken cancellationToken = default);
public virtual ClientResult GetAssistant(string assistantId, RequestOptions options);
public virtual ClientResult<Assistant> GetAssistant(string assistantId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetAssistantAsync(string assistantId, RequestOptions options);
public virtual Task<ClientResult<Assistant>> GetAssistantAsync(string assistantId, CancellationToken cancellationToken = default);
public virtual CollectionResult<Assistant> GetAssistants(AssistantCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult GetAssistants(int? limit, string order, string after, string before, RequestOptions options);
public virtual AsyncCollectionResult<Assistant> GetAssistantsAsync(AssistantCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult GetAssistantsAsync(int? limit, string order, string after, string before, RequestOptions options);
public virtual ClientResult GetMessage(string threadId, string messageId, RequestOptions options);
public virtual ClientResult<ThreadMessage> GetMessage(string threadId, string messageId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetMessageAsync(string threadId, string messageId, RequestOptions options);
public virtual Task<ClientResult<ThreadMessage>> GetMessageAsync(string threadId, string messageId, CancellationToken cancellationToken = default);
public virtual CollectionResult<ThreadMessage> GetMessages(string threadId, MessageCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult GetMessages(string threadId, int? limit, string order, string after, string before, RequestOptions options);
public virtual AsyncCollectionResult<ThreadMessage> GetMessagesAsync(string threadId, MessageCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult GetMessagesAsync(string threadId, int? limit, string order, string after, string before, RequestOptions options);
public virtual ClientResult GetRun(string threadId, string runId, RequestOptions options);
public virtual ClientResult<ThreadRun> GetRun(string threadId, string runId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetRunAsync(string threadId, string runId, RequestOptions options);
public virtual Task<ClientResult<ThreadRun>> GetRunAsync(string threadId, string runId, CancellationToken cancellationToken = default);
public virtual CollectionResult<ThreadRun> GetRuns(string threadId, RunCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult GetRuns(string threadId, int? limit, string order, string after, string before, RequestOptions options);
public virtual AsyncCollectionResult<ThreadRun> GetRunsAsync(string threadId, RunCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult GetRunsAsync(string threadId, int? limit, string order, string after, string before, RequestOptions options);
public virtual ClientResult GetRunStep(string threadId, string runId, string stepId, RequestOptions options);
public virtual ClientResult<RunStep> GetRunStep(string threadId, string runId, string stepId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetRunStepAsync(string threadId, string runId, string stepId, RequestOptions options);
public virtual Task<ClientResult<RunStep>> GetRunStepAsync(string threadId, string runId, string stepId, CancellationToken cancellationToken = default);
public virtual CollectionResult<RunStep> GetRunSteps(string threadId, string runId, RunStepCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult GetRunSteps(string threadId, string runId, int? limit, string order, string after, string before, RequestOptions options);
public virtual AsyncCollectionResult<RunStep> GetRunStepsAsync(string threadId, string runId, RunStepCollectionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult GetRunStepsAsync(string threadId, string runId, int? limit, string order, string after, string before, RequestOptions options);
public virtual ClientResult GetThread(string threadId, RequestOptions options);
public virtual ClientResult<AssistantThread> GetThread(string threadId, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GetThreadAsync(string threadId, RequestOptions options);
public virtual Task<ClientResult<AssistantThread>> GetThreadAsync(string threadId, CancellationToken cancellationToken = default);
public virtual ClientResult<Assistant> ModifyAssistant(string assistantId, AssistantModificationOptions options, CancellationToken cancellationToken = default);
public virtual ClientResult ModifyAssistant(string assistantId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<Assistant>> ModifyAssistantAsync(string assistantId, AssistantModificationOptions options, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> ModifyAssistantAsync(string assistantId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult<ThreadMessage> ModifyMessage(string threadId, string messageId, MessageModificationOptions options, CancellationToken cancellationToken = default);
public virtual ClientResult ModifyMessage(string threadId, string messageId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<ThreadMessage>> ModifyMessageAsync(string threadId, string messageId, MessageModificationOptions options, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> ModifyMessageAsync(string threadId, string messageId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult ModifyRun(string threadId, string runId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult> ModifyRunAsync(string threadId, string runId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult<AssistantThread> ModifyThread(string threadId, ThreadModificationOptions options, CancellationToken cancellationToken = default);
public virtual ClientResult ModifyThread(string threadId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<AssistantThread>> ModifyThreadAsync(string threadId, ThreadModificationOptions options, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> ModifyThreadAsync(string threadId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult SubmitToolOutputsToRun(string threadId, string runId, BinaryContent content, RequestOptions options = null);
public virtual ClientResult<ThreadRun> SubmitToolOutputsToRun(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> SubmitToolOutputsToRunAsync(string threadId, string runId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<ThreadRun>> SubmitToolOutputsToRunAsync(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
public virtual CollectionResult<StreamingUpdate> SubmitToolOutputsToRunStreaming(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<StreamingUpdate> SubmitToolOutputsToRunStreamingAsync(string threadId, string runId, IEnumerable<ToolOutput> toolOutputs, CancellationToken cancellationToken = default);
}
public sealed class AssistantClientSettings : ClientSettings {
public OpenAIClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
public class AssistantCollectionOptions : IJsonModel<AssistantCollectionOptions>, IPersistableModel<AssistantCollectionOptions> {
public string AfterId { get; set; }
public string BeforeId { get; set; }
public AssistantCollectionOrder? Order { get; set; }
public int? PageSizeLimit { get; set; }
}
public readonly partial struct AssistantCollectionOrder : IEquatable<AssistantCollectionOrder> {
public AssistantCollectionOrder(string value);
public static AssistantCollectionOrder Ascending { get; }
public static AssistantCollectionOrder Descending { get; }
public readonly bool Equals(AssistantCollectionOrder other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(AssistantCollectionOrder left, AssistantCollectionOrder right);
public static implicit operator AssistantCollectionOrder(string value);
public static implicit operator AssistantCollectionOrder?(string value);
public static bool operator !=(AssistantCollectionOrder left, AssistantCollectionOrder right);
public override readonly string ToString();
}
public class AssistantCreationOptions : IJsonModel<AssistantCreationOptions>, IPersistableModel<AssistantCreationOptions> {
public string Description { get; set; }
public string Instructions { get; set; }
public IDictionary<string, string> Metadata { get; }
public string Name { get; set; }
public float? NucleusSamplingFactor { get; set; }
public AssistantResponseFormat ResponseFormat { get; set; }
public float? Temperature { get; set; }
public ToolResources ToolResources { get; set; }
public IList<ToolDefinition> Tools { get; }
}
public class AssistantDeletionResult : IJsonModel<AssistantDeletionResult>, IPersistableModel<AssistantDeletionResult> {
public string AssistantId { get; }
public bool Deleted { get; }
public static explicit operator AssistantDeletionResult(ClientResult result);
}
public class AssistantModificationOptions : IJsonModel<AssistantModificationOptions>, IPersistableModel<AssistantModificationOptions> {
public IList<ToolDefinition> DefaultTools { get; }
public string Description { get; set; }
public string Instructions { get; set; }
public IDictionary<string, string> Metadata { get; }
public string Model { get; set; }
public string Name { get; set; }
public float? NucleusSamplingFactor { get; set; }
public AssistantResponseFormat ResponseFormat { get; set; }
public float? Temperature { get; set; }
public ToolResources ToolResources { get; set; }
}
public class AssistantResponseFormat : IEquatable<AssistantResponseFormat>, IEquatable<string>, IJsonModel<AssistantResponseFormat>, IPersistableModel<AssistantResponseFormat> {
public static AssistantResponseFormat Auto { get; }
public static AssistantResponseFormat JsonObject { get; }
public static AssistantResponseFormat Text { get; }
public static AssistantResponseFormat CreateAutoFormat();
public static AssistantResponseFormat CreateJsonObjectFormat();
public static AssistantResponseFormat CreateJsonSchemaFormat(string name, BinaryData jsonSchema, string description = null, bool? strictSchemaEnabled = null);
public static AssistantResponseFormat CreateTextFormat();
[EditorBrowsable(EditorBrowsableState.Never)]
public override bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override int GetHashCode();
[EditorBrowsable(EditorBrowsableState.Never)]
public static bool operator ==(AssistantResponseFormat first, AssistantResponseFormat second);
[EditorBrowsable(EditorBrowsableState.Never)]
public static implicit operator AssistantResponseFormat(string plainTextFormat);
[EditorBrowsable(EditorBrowsableState.Never)]
public static bool operator !=(AssistantResponseFormat first, AssistantResponseFormat second);
[EditorBrowsable(EditorBrowsableState.Never)]
bool IEquatable<AssistantResponseFormat>.Equals(AssistantResponseFormat other);
[EditorBrowsable(EditorBrowsableState.Never)]
bool IEquatable<string>.Equals(string other);
public override string ToString();
}
public class AssistantThread : IJsonModel<AssistantThread>, IPersistableModel<AssistantThread> {
public DateTimeOffset CreatedAt { get; }
public string Id { get; }
public IReadOnlyDictionary<string, string> Metadata { get; }
public ToolResources ToolResources { get; }
public static explicit operator AssistantThread(ClientResult result);
}
public class CodeInterpreterToolDefinition : ToolDefinition, IJsonModel<CodeInterpreterToolDefinition>, IPersistableModel<CodeInterpreterToolDefinition> {
public CodeInterpreterToolDefinition();
}
public class CodeInterpreterToolResources : IJsonModel<CodeInterpreterToolResources>, IPersistableModel<CodeInterpreterToolResources> {
public IList<string> FileIds { get; }
}
public readonly partial struct FileSearchRanker : IEquatable<FileSearchRanker> {
public FileSearchRanker(string value);
public static FileSearchRanker Auto { get; }
public static FileSearchRanker Default20240821 { get; }
public readonly bool Equals(FileSearchRanker other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(FileSearchRanker left, FileSearchRanker right);
public static implicit operator FileSearchRanker(string value);
public static implicit operator FileSearchRanker?(string value);
public static bool operator !=(FileSearchRanker left, FileSearchRanker right);
public override readonly string ToString();
}
public class FileSearchRankingOptions : IJsonModel<FileSearchRankingOptions>, IPersistableModel<FileSearchRankingOptions> {
public FileSearchRankingOptions(float scoreThreshold);
public FileSearchRanker? Ranker { get; set; }
public float ScoreThreshold { get; set; }
}
public class FileSearchToolDefinition : ToolDefinition, IJsonModel<FileSearchToolDefinition>, IPersistableModel<FileSearchToolDefinition> {
public FileSearchToolDefinition();
public int? MaxResults { get; set; }
public FileSearchRankingOptions RankingOptions { get; set; }
}
public class FileSearchToolResources : IJsonModel<FileSearchToolResources>, IPersistableModel<FileSearchToolResources> {
public IList<VectorStoreCreationHelper> NewVectorStores { get; }
public IList<string> VectorStoreIds { get; }
}
public class FunctionToolDefinition : ToolDefinition, IJsonModel<FunctionToolDefinition>, IPersistableModel<FunctionToolDefinition> {
public FunctionToolDefinition();
public FunctionToolDefinition(string name);
public string Description { get; set; }
public string FunctionName { get; set; }
public BinaryData Parameters { get; set; }
public bool? StrictParameterSchemaEnabled { get; set; }
}
public class MessageCollectionOptions : IJsonModel<MessageCollectionOptions>, IPersistableModel<MessageCollectionOptions> {
public string AfterId { get; set; }
public string BeforeId { get; set; }
public MessageCollectionOrder? Order { get; set; }
public int? PageSizeLimit { get; set; }
}
public readonly partial struct MessageCollectionOrder : IEquatable<MessageCollectionOrder> {
public MessageCollectionOrder(string value);
public static MessageCollectionOrder Ascending { get; }
public static MessageCollectionOrder Descending { get; }
public readonly bool Equals(MessageCollectionOrder other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(MessageCollectionOrder left, MessageCollectionOrder right);
public static implicit operator MessageCollectionOrder(string value);
public static implicit operator MessageCollectionOrder?(string value);
public static bool operator !=(MessageCollectionOrder left, MessageCollectionOrder right);
public override readonly string ToString();
}
public abstract class MessageContent : IJsonModel<MessageContent>, IPersistableModel<MessageContent> {
public MessageImageDetail? ImageDetail { get; }
public string ImageFileId { get; }
public Uri ImageUri { get; }
public string Refusal { get; }
public string Text { get; }
public IReadOnlyList<TextAnnotation> TextAnnotations { get; }
public static MessageContent FromImageFileId(string imageFileId, MessageImageDetail? detail = null);
public static MessageContent FromImageUri(Uri imageUri, MessageImageDetail? detail = null);
public static MessageContent FromText(string text);
public static implicit operator MessageContent(string value);
}
public class MessageContentUpdate : StreamingUpdate {
public MessageImageDetail? ImageDetail { get; }
public string ImageFileId { get; }
public string MessageId { get; }
public int MessageIndex { get; }
public string RefusalUpdate { get; }
public MessageRole? Role { get; }
public string Text { get; }
public TextAnnotationUpdate TextAnnotation { get; }
}
public class MessageCreationAttachment : IJsonModel<MessageCreationAttachment>, IPersistableModel<MessageCreationAttachment> {
public MessageCreationAttachment(string fileId, IEnumerable<ToolDefinition> tools);
public string FileId { get; }
public IReadOnlyList<ToolDefinition> Tools { get; }
}
public class MessageCreationOptions : IJsonModel<MessageCreationOptions>, IPersistableModel<MessageCreationOptions> {
public IList<MessageCreationAttachment> Attachments { get; set; }
public IDictionary<string, string> Metadata { get; }
}
public class MessageDeletionResult : IJsonModel<MessageDeletionResult>, IPersistableModel<MessageDeletionResult> {
public bool Deleted { get; }
public string MessageId { get; }
public static explicit operator MessageDeletionResult(ClientResult result);
}
public class MessageFailureDetails : IJsonModel<MessageFailureDetails>, IPersistableModel<MessageFailureDetails> {
public MessageFailureReason Reason { get; }
}
public readonly partial struct MessageFailureReason : IEquatable<MessageFailureReason> {
public MessageFailureReason(string value);
public static MessageFailureReason ContentFilter { get; }
public static MessageFailureReason MaxTokens { get; }
public static MessageFailureReason RunCancelled { get; }
public static MessageFailureReason RunExpired { get; }
public static MessageFailureReason RunFailed { get; }
public readonly bool Equals(MessageFailureReason other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(MessageFailureReason left, MessageFailureReason right);
public static implicit operator MessageFailureReason(string value);
public static implicit operator MessageFailureReason?(string value);
public static bool operator !=(MessageFailureReason left, MessageFailureReason right);
public override readonly string ToString();
}
public enum MessageImageDetail {
Auto = 0,
Low = 1,
High = 2
}
public class MessageModificationOptions : IJsonModel<MessageModificationOptions>, IPersistableModel<MessageModificationOptions> {
public IDictionary<string, string> Metadata { get; }
}
public enum MessageRole {
User = 0,
Assistant = 1
}
public readonly partial struct MessageStatus : IEquatable<MessageStatus> {
public MessageStatus(string value);
public static MessageStatus Completed { get; }
public static MessageStatus Incomplete { get; }
public static MessageStatus InProgress { get; }
public readonly bool Equals(MessageStatus other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(MessageStatus left, MessageStatus right);
public static implicit operator MessageStatus(string value);
public static implicit operator MessageStatus?(string value);
public static bool operator !=(MessageStatus left, MessageStatus right);
public override readonly string ToString();
}
public class MessageStatusUpdate : StreamingUpdate<ThreadMessage> {
}
public abstract class RequiredAction {
public string FunctionArguments { get; }
public string FunctionName { get; }
public string ToolCallId { get; }
}
public class RequiredActionUpdate : RunUpdate {
public string FunctionArguments { get; }
public string FunctionName { get; }
public string ToolCallId { get; }
public ThreadRun GetThreadRun();
}
public class RunCollectionOptions : IJsonModel<RunCollectionOptions>, IPersistableModel<RunCollectionOptions> {
public string AfterId { get; set; }
public string BeforeId { get; set; }
public RunCollectionOrder? Order { get; set; }
public int? PageSizeLimit { get; set; }
}
public readonly partial struct RunCollectionOrder : IEquatable<RunCollectionOrder> {
public RunCollectionOrder(string value);
public static RunCollectionOrder Ascending { get; }
public static RunCollectionOrder Descending { get; }
public readonly bool Equals(RunCollectionOrder other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RunCollectionOrder left, RunCollectionOrder right);
public static implicit operator RunCollectionOrder(string value);
public static implicit operator RunCollectionOrder?(string value);
public static bool operator !=(RunCollectionOrder left, RunCollectionOrder right);
public override readonly string ToString();
}
public class RunCreationOptions : IJsonModel<RunCreationOptions>, IPersistableModel<RunCreationOptions> {
public string AdditionalInstructions { get; set; }
public IList<ThreadInitializationMessage> AdditionalMessages { get; }
public bool? AllowParallelToolCalls { get; set; }
public string InstructionsOverride { get; set; }
public int? MaxInputTokenCount { get; set; }
public int? MaxOutputTokenCount { get; set; }
public IDictionary<string, string> Metadata { get; }
public string ModelOverride { get; set; }
public float? NucleusSamplingFactor { get; set; }
public AssistantResponseFormat ResponseFormat { get; set; }
public float? Temperature { get; set; }
public ToolConstraint ToolConstraint { get; set; }
public IList<ToolDefinition> ToolsOverride { get; }
public RunTruncationStrategy TruncationStrategy { get; set; }
}
public class RunError : IJsonModel<RunError>, IPersistableModel<RunError> {
public RunErrorCode Code { get; }
public string Message { get; }
}
public readonly partial struct RunErrorCode : IEquatable<RunErrorCode> {
public RunErrorCode(string value);
public static RunErrorCode InvalidPrompt { get; }
public static RunErrorCode RateLimitExceeded { get; }
public static RunErrorCode ServerError { get; }
public readonly bool Equals(RunErrorCode other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RunErrorCode left, RunErrorCode right);
public static implicit operator RunErrorCode(string value);
public static implicit operator RunErrorCode?(string value);
public static bool operator !=(RunErrorCode left, RunErrorCode right);
public override readonly string ToString();
}
public class RunIncompleteDetails : IJsonModel<RunIncompleteDetails>, IPersistableModel<RunIncompleteDetails> {
public RunIncompleteReason? Reason { get; }
}
public readonly partial struct RunIncompleteReason : IEquatable<RunIncompleteReason> {
public RunIncompleteReason(string value);
public static RunIncompleteReason MaxInputTokenCount { get; }
public static RunIncompleteReason MaxOutputTokenCount { get; }
public readonly bool Equals(RunIncompleteReason other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RunIncompleteReason left, RunIncompleteReason right);
public static implicit operator RunIncompleteReason(string value);
public static implicit operator RunIncompleteReason?(string value);
public static bool operator !=(RunIncompleteReason left, RunIncompleteReason right);
public override readonly string ToString();
}
public class RunModificationOptions : IJsonModel<RunModificationOptions>, IPersistableModel<RunModificationOptions> {
public IDictionary<string, string> Metadata { get; }
}
public readonly partial struct RunStatus : IEquatable<RunStatus> {
public RunStatus(string value);
public static RunStatus Cancelled { get; }
public static RunStatus Cancelling { get; }
public static RunStatus Completed { get; }
public static RunStatus Expired { get; }
public static RunStatus Failed { get; }
public static RunStatus Incomplete { get; }
public static RunStatus InProgress { get; }
public bool IsTerminal { get; }
public static RunStatus Queued { get; }
public static RunStatus RequiresAction { get; }
public readonly bool Equals(RunStatus other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RunStatus left, RunStatus right);
public static implicit operator RunStatus(string value);
public static implicit operator RunStatus?(string value);
public static bool operator !=(RunStatus left, RunStatus right);
public override readonly string ToString();
}
public class RunStep : IJsonModel<RunStep>, IPersistableModel<RunStep> {
public string AssistantId { get; }
public DateTimeOffset? CancelledAt { get; }
public DateTimeOffset? CompletedAt { get; }
public DateTimeOffset CreatedAt { get; }
public RunStepDetails Details { get; }
public DateTimeOffset? ExpiredAt { get; }
public DateTimeOffset? FailedAt { get; }
public string Id { get; }
public RunStepKind Kind { get; }
public RunStepError LastError { get; }
public IReadOnlyDictionary<string, string> Metadata { get; }
public string RunId { get; }
public RunStepStatus Status { get; }
public string ThreadId { get; }
public RunStepTokenUsage Usage { get; }
public static explicit operator RunStep(ClientResult result);
}
public abstract class RunStepCodeInterpreterOutput : IJsonModel<RunStepCodeInterpreterOutput>, IPersistableModel<RunStepCodeInterpreterOutput> {
public string ImageFileId { get; }
public string Logs { get; }
}
public class RunStepCollectionOptions : IJsonModel<RunStepCollectionOptions>, IPersistableModel<RunStepCollectionOptions> {
public string AfterId { get; set; }
public string BeforeId { get; set; }
public RunStepCollectionOrder? Order { get; set; }
public int? PageSizeLimit { get; set; }
}
public readonly partial struct RunStepCollectionOrder : IEquatable<RunStepCollectionOrder> {
public RunStepCollectionOrder(string value);
public static RunStepCollectionOrder Ascending { get; }
public static RunStepCollectionOrder Descending { get; }
public readonly bool Equals(RunStepCollectionOrder other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RunStepCollectionOrder left, RunStepCollectionOrder right);
public static implicit operator RunStepCollectionOrder(string value);
public static implicit operator RunStepCollectionOrder?(string value);
public static bool operator !=(RunStepCollectionOrder left, RunStepCollectionOrder right);
public override readonly string ToString();
}
public abstract class RunStepDetails : IJsonModel<RunStepDetails>, IPersistableModel<RunStepDetails> {
public string CreatedMessageId { get; }
public IReadOnlyList<RunStepToolCall> ToolCalls { get; }
}
public class RunStepDetailsUpdate : StreamingUpdate {
public string CodeInterpreterInput { get; }
public IReadOnlyList<RunStepUpdateCodeInterpreterOutput> CodeInterpreterOutputs { get; }
public string CreatedMessageId { get; }
public FileSearchRankingOptions FileSearchRankingOptions { get; }
public IReadOnlyList<RunStepFileSearchResult> FileSearchResults { get; }
public string FunctionArguments { get; }
public string FunctionName { get; }
public string FunctionOutput { get; }
public string StepId { get; }
public string ToolCallId { get; }
public int? ToolCallIndex { get; }
}
public class RunStepError : IJsonModel<RunStepError>, IPersistableModel<RunStepError> {
public RunStepErrorCode Code { get; }
public string Message { get; }
}
public readonly partial struct RunStepErrorCode : IEquatable<RunStepErrorCode> {
public RunStepErrorCode(string value);
public static RunStepErrorCode RateLimitExceeded { get; }
public static RunStepErrorCode ServerError { get; }
public readonly bool Equals(RunStepErrorCode other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RunStepErrorCode left, RunStepErrorCode right);
public static implicit operator RunStepErrorCode(string value);
public static implicit operator RunStepErrorCode?(string value);
public static bool operator !=(RunStepErrorCode left, RunStepErrorCode right);
public override readonly string ToString();
}
public class RunStepFileSearchResult : IJsonModel<RunStepFileSearchResult>, IPersistableModel<RunStepFileSearchResult> {
public IReadOnlyList<RunStepFileSearchResultContent> Content { get; }
public string FileId { get; }
public string FileName { get; }
public float Score { get; }
}
public class RunStepFileSearchResultContent : IJsonModel<RunStepFileSearchResultContent>, IPersistableModel<RunStepFileSearchResultContent> {
public RunStepFileSearchResultContentKind Kind { get; }
public string Text { get; }
}
public enum RunStepFileSearchResultContentKind {
Text = 0
}
public enum RunStepKind {
CreatedMessage = 0,
ToolCall = 1
}
public readonly partial struct RunStepStatus : IEquatable<RunStepStatus> {
public RunStepStatus(string value);
public static RunStepStatus Cancelled { get; }
public static RunStepStatus Completed { get; }
public static RunStepStatus Expired { get; }
public static RunStepStatus Failed { get; }
public static RunStepStatus InProgress { get; }
public readonly bool Equals(RunStepStatus other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(RunStepStatus left, RunStepStatus right);
public static implicit operator RunStepStatus(string value);
public static implicit operator RunStepStatus?(string value);
public static bool operator !=(RunStepStatus left, RunStepStatus right);
public override readonly string ToString();
}
public class RunStepTokenUsage : IJsonModel<RunStepTokenUsage>, IPersistableModel<RunStepTokenUsage> {
public int InputTokenCount { get; }
public int OutputTokenCount { get; }
public int TotalTokenCount { get; }
}
public class RunStepToolCall : IJsonModel<RunStepToolCall>, IPersistableModel<RunStepToolCall> {
public string CodeInterpreterInput { get; }
public IReadOnlyList<RunStepCodeInterpreterOutput> CodeInterpreterOutputs { get; }
public FileSearchRankingOptions FileSearchRankingOptions { get; }
public IReadOnlyList<RunStepFileSearchResult> FileSearchResults { get; }
public string FunctionArguments { get; }
public string FunctionName { get; }
public string FunctionOutput { get; }
public string Id { get; }
public RunStepToolCallKind Kind { get; }
}
public enum RunStepToolCallKind {
CodeInterpreter = 0,
FileSearch = 1,
Function = 2
}
public class RunStepUpdate : StreamingUpdate<RunStep> {
}
public class RunStepUpdateCodeInterpreterOutput : IJsonModel<RunStepUpdateCodeInterpreterOutput>, IPersistableModel<RunStepUpdateCodeInterpreterOutput> {
public string ImageFileId { get; }
public string Logs { get; }
public int OutputIndex { get; }
}
public class RunTokenUsage : IJsonModel<RunTokenUsage>, IPersistableModel<RunTokenUsage> {
public int InputTokenCount { get; }
public int OutputTokenCount { get; }
public int TotalTokenCount { get; }
}
public class RunTruncationStrategy : IJsonModel<RunTruncationStrategy>, IPersistableModel<RunTruncationStrategy> {
public static RunTruncationStrategy Auto { get; }
public int? LastMessages { get; }
public static RunTruncationStrategy CreateLastMessagesStrategy(int lastMessageCount);
}
public class RunUpdate : StreamingUpdate<ThreadRun> {
}
public abstract class StreamingUpdate {
public StreamingUpdateReason UpdateKind { get; }
}
public enum StreamingUpdateReason {
Unknown = 0,
ThreadCreated = 1,
RunCreated = 2,
RunQueued = 3,
RunInProgress = 4,
RunRequiresAction = 5,
RunCompleted = 6,
RunIncomplete = 7,
RunFailed = 8,
RunCancelling = 9,
RunCancelled = 10,
RunExpired = 11,
RunStepCreated = 12,
RunStepInProgress = 13,
RunStepUpdated = 14,
RunStepCompleted = 15,
RunStepFailed = 16,
RunStepCancelled = 17,
RunStepExpired = 18,
MessageCreated = 19,
MessageInProgress = 20,
MessageUpdated = 21,
MessageCompleted = 22,
MessageFailed = 23,
Error = 24,
Done = 25
}
public class StreamingUpdate<T> : StreamingUpdate where T : class {
public T Value { get; }
public static implicit operator T(StreamingUpdate<T> update);
}
public class TextAnnotation {
public int EndIndex { get; }
public string InputFileId { get; }
public string OutputFileId { get; }
public int StartIndex { get; }
public string TextToReplace { get; }
}
public class TextAnnotationUpdate {
public int ContentIndex { get; }
public int? EndIndex { get; }
public string InputFileId { get; }
public string OutputFileId { get; }
public int? StartIndex { get; }
public string TextToReplace { get; }
}
public class ThreadCreationOptions : IJsonModel<ThreadCreationOptions>, IPersistableModel<ThreadCreationOptions> {
public IList<ThreadInitializationMessage> InitialMessages { get; }
public IDictionary<string, string> Metadata { get; }
public ToolResources ToolResources { get; set; }
}
public class ThreadDeletionResult : IJsonModel<ThreadDeletionResult>, IPersistableModel<ThreadDeletionResult> {
public bool Deleted { get; }
public string ThreadId { get; }
public static explicit operator ThreadDeletionResult(ClientResult result);
}
public class ThreadInitializationMessage : MessageCreationOptions {
public ThreadInitializationMessage(MessageRole role, IEnumerable<MessageContent> content);
public static implicit operator ThreadInitializationMessage(string initializationMessage);
}
public class ThreadMessage : IJsonModel<ThreadMessage>, IPersistableModel<ThreadMessage> {
public string AssistantId { get; }
public IReadOnlyList<MessageCreationAttachment> Attachments { get; }
public DateTimeOffset? CompletedAt { get; }
public IReadOnlyList<MessageContent> Content { get; }
public DateTimeOffset CreatedAt { get; }
public string Id { get; }
public DateTimeOffset? IncompleteAt { get; }
public MessageFailureDetails IncompleteDetails { get; }
public IReadOnlyDictionary<string, string> Metadata { get; }
public MessageRole Role { get; }
public string RunId { get; }
public MessageStatus Status { get; }
public string ThreadId { get; }
public static explicit operator ThreadMessage(ClientResult result);
}
public class ThreadModificationOptions : IJsonModel<ThreadModificationOptions>, IPersistableModel<ThreadModificationOptions> {
public IDictionary<string, string> Metadata { get; }
public ToolResources ToolResources { get; set; }
}
public class ThreadRun : IJsonModel<ThreadRun>, IPersistableModel<ThreadRun> {
public bool? AllowParallelToolCalls { get; }
public string AssistantId { get; }
public DateTimeOffset? CancelledAt { get; }
public DateTimeOffset? CompletedAt { get; }
public DateTimeOffset CreatedAt { get; }
public DateTimeOffset? ExpiresAt { get; }
public DateTimeOffset? FailedAt { get; }
public string Id { get; }
public RunIncompleteDetails IncompleteDetails { get; }
public string Instructions { get; }
public RunError LastError { get; }
public int? MaxInputTokenCount { get; }
public int? MaxOutputTokenCount { get; }
public IReadOnlyDictionary<string, string> Metadata { get; }
public string Model { get; }
public float? NucleusSamplingFactor { get; }
public IReadOnlyList<RequiredAction> RequiredActions { get; }
public AssistantResponseFormat ResponseFormat { get; }
public DateTimeOffset? StartedAt { get; }
public RunStatus Status { get; }
public float? Temperature { get; }
public string ThreadId { get; }
public ToolConstraint ToolConstraint { get; }
public IReadOnlyList<ToolDefinition> Tools { get; }
public RunTruncationStrategy TruncationStrategy { get; }
public RunTokenUsage Usage { get; }
public static explicit operator ThreadRun(ClientResult result);
}
public class ThreadUpdate : StreamingUpdate<AssistantThread> {
public DateTimeOffset CreatedAt { get; }
public string Id { get; }
public IReadOnlyDictionary<string, string> Metadata { get; }
public ToolResources ToolResources { get; }
}
public class ToolConstraint : IJsonModel<ToolConstraint>, IPersistableModel<ToolConstraint> {
public ToolConstraint(ToolDefinition toolDefinition);
public static ToolConstraint Auto { get; }
public static ToolConstraint None { get; }
public static ToolConstraint Required { get; }
}
public class ToolDefinition : IJsonModel<ToolDefinition>, IPersistableModel<ToolDefinition> {
public static CodeInterpreterToolDefinition CreateCodeInterpreter();
public static FileSearchToolDefinition CreateFileSearch(int? maxResults = null);
public static FunctionToolDefinition CreateFunction(string name, string description = null, BinaryData parameters = null, bool? strictParameterSchemaEnabled = null);
}
public class ToolOutput : IJsonModel<ToolOutput>, IPersistableModel<ToolOutput> {
public ToolOutput();
public ToolOutput(string toolCallId, string output);
public string Output { get; set; }
public string ToolCallId { get; set; }
}
public class ToolResources : IJsonModel<ToolResources>, IPersistableModel<ToolResources> {
public CodeInterpreterToolResources CodeInterpreter { get; set; }
public FileSearchToolResources FileSearch { get; set; }
}
public class VectorStoreCreationHelper : IJsonModel<VectorStoreCreationHelper>, IPersistableModel<VectorStoreCreationHelper> {
public VectorStoreCreationHelper();
public VectorStoreCreationHelper(IEnumerable<OpenAIFile> files);
public VectorStoreCreationHelper(IEnumerable<string> fileIds);
public FileChunkingStrategy ChunkingStrategy { get; set; }
public IList<string> FileIds { get; }
public IDictionary<string, string> Metadata { get; }
}
}
namespace OpenAI.Audio {
public class AudioClient {
protected AudioClient();
public AudioClient(AudioClientSettings settings);
protected internal AudioClient(ClientPipeline pipeline, string model, OpenAIClientOptions options);
public AudioClient(string model, ApiKeyCredential credential, OpenAIClientOptions options);
public AudioClient(string model, ApiKeyCredential credential);
public AudioClient(string model, AuthenticationPolicy authenticationPolicy, OpenAIClientOptions options);
public AudioClient(string model, AuthenticationPolicy authenticationPolicy);
public AudioClient(string model, string apiKey);
public Uri Endpoint { get; }
public string Model { get; }
public ClientPipeline Pipeline { get; }
public virtual ClientResult CreateVoice(BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult> CreateVoiceAsync(BinaryContent content, string contentType, RequestOptions options = null);
public virtual ClientResult CreateVoiceConsent(BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult> CreateVoiceConsentAsync(BinaryContent content, string contentType, RequestOptions options = null);
public virtual ClientResult DeleteVoiceConsent(string consentId, RequestOptions options = null);
public virtual Task<ClientResult> DeleteVoiceConsentAsync(string consentId, RequestOptions options = null);
public virtual ClientResult GenerateSpeech(BinaryContent content, RequestOptions options = null);
public virtual ClientResult<BinaryData> GenerateSpeech(string text, GeneratedSpeechVoice voice, SpeechGenerationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult> GenerateSpeechAsync(BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult<BinaryData>> GenerateSpeechAsync(string text, GeneratedSpeechVoice voice, SpeechGenerationOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult<StreamingSpeechUpdate> GenerateSpeechStreaming(string text, GeneratedSpeechVoice voice, SpeechGenerationOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<StreamingSpeechUpdate> GenerateSpeechStreamingAsync(string text, GeneratedSpeechVoice voice, SpeechGenerationOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult GetVoiceConsent(string consentId, RequestOptions options = null);
public virtual Task<ClientResult> GetVoiceConsentAsync(string consentId, RequestOptions options = null);
public virtual CollectionResult GetVoiceConsents(string after = null, int? limit = null, RequestOptions options = null);
public virtual AsyncCollectionResult GetVoiceConsentsAsync(string after = null, int? limit = null, RequestOptions options = null);
public virtual ClientResult TranscribeAudio(BinaryContent content, string contentType, RequestOptions options = null);
public virtual ClientResult<AudioTranscription> TranscribeAudio(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult<AudioTranscription> TranscribeAudio(string audioFilePath, AudioTranscriptionOptions options = null);
public virtual Task<ClientResult> TranscribeAudioAsync(BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult<AudioTranscription>> TranscribeAudioAsync(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<AudioTranscription>> TranscribeAudioAsync(string audioFilePath, AudioTranscriptionOptions options = null);
public virtual ClientResult<DiarizedAudioTranscription> TranscribeAudioDiarized(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult<DiarizedAudioTranscription> TranscribeAudioDiarized(string audioFilePath, AudioTranscriptionOptions options = null);
public virtual Task<ClientResult<DiarizedAudioTranscription>> TranscribeAudioDiarizedAsync(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<DiarizedAudioTranscription>> TranscribeAudioDiarizedAsync(string audioFilePath, AudioTranscriptionOptions options = null);
public virtual CollectionResult<StreamingAudioTranscriptionUpdate> TranscribeAudioStreaming(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
public virtual CollectionResult<StreamingAudioTranscriptionUpdate> TranscribeAudioStreaming(string audioFilePath, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<StreamingAudioTranscriptionUpdate> TranscribeAudioStreamingAsync(Stream audio, string audioFilename, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
public virtual AsyncCollectionResult<StreamingAudioTranscriptionUpdate> TranscribeAudioStreamingAsync(string audioFilePath, AudioTranscriptionOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult TranslateAudio(BinaryContent content, string contentType, RequestOptions options = null);
public virtual ClientResult<AudioTranslation> TranslateAudio(Stream audio, string audioFilename, AudioTranslationOptions options = null, CancellationToken cancellationToken = default);
public virtual ClientResult<AudioTranslation> TranslateAudio(string audioFilePath, AudioTranslationOptions options = null);
public virtual Task<ClientResult> TranslateAudioAsync(BinaryContent content, string contentType, RequestOptions options = null);
public virtual Task<ClientResult<AudioTranslation>> TranslateAudioAsync(Stream audio, string audioFilename, AudioTranslationOptions options = null, CancellationToken cancellationToken = default);
public virtual Task<ClientResult<AudioTranslation>> TranslateAudioAsync(string audioFilePath, AudioTranslationOptions options = null);
public virtual ClientResult UpdateVoiceConsent(string consentId, BinaryContent content, RequestOptions options = null);
public virtual Task<ClientResult> UpdateVoiceConsentAsync(string consentId, BinaryContent content, RequestOptions options = null);
}
public sealed class AudioClientSettings : ClientSettings {
public string Model { get; set; }
public OpenAIClientOptions Options { get; set; }
protected override void BindCore(Microsoft.Extensions.Configuration.IConfigurationSection section);
}
[Flags]
public enum AudioTimestampGranularities {
Default = 0,
Word = 1,
Segment = 2
}
public class AudioTokenLogProbabilityDetails : IJsonModel<AudioTokenLogProbabilityDetails>, IPersistableModel<AudioTokenLogProbabilityDetails> {
public float LogProbability { get; }
public string Token { get; }
public ReadOnlyMemory<byte> Utf8Bytes { get; }
}
public class AudioTranscription : IJsonModel<AudioTranscription>, IPersistableModel<AudioTranscription> {
public TimeSpan? Duration { get; }
public string Language { get; }
public IReadOnlyList<TranscribedSegment> Segments { get; }
public string Text { get; }
public IReadOnlyList<AudioTokenLogProbabilityDetails> TranscriptionTokenLogProbabilities { get; }
public AudioTranscriptionUsage Usage { get; }
public IReadOnlyList<TranscribedWord> Words { get; }
public static explicit operator AudioTranscription(ClientResult result);
}
public class AudioTranscriptionChunkingStrategy : IJsonModel<AudioTranscriptionChunkingStrategy>, IPersistableModel<AudioTranscriptionChunkingStrategy> {
public AudioTranscriptionChunkingStrategy(AudioTranscriptionCustomChunkingStrategy customChunkingStrategy);
public AudioTranscriptionChunkingStrategy(AudioTranscriptionDefaultChunkingStrategy defaultChunkingStrategy);
public AudioTranscriptionCustomChunkingStrategy CustomChunkingStrategy { get; }
public AudioTranscriptionDefaultChunkingStrategy? DefaultChunkingStrategy { get; }
public static implicit operator AudioTranscriptionChunkingStrategy(AudioTranscriptionCustomChunkingStrategy customChunkingStrategy);
public static implicit operator AudioTranscriptionChunkingStrategy(AudioTranscriptionDefaultChunkingStrategy defaultChunkingStrategy);
}
public class AudioTranscriptionCustomChunkingStrategy : IJsonModel<AudioTranscriptionCustomChunkingStrategy>, IPersistableModel<AudioTranscriptionCustomChunkingStrategy> {
}
public class AudioTranscriptionCustomServerVadChunkingStrategy : AudioTranscriptionCustomChunkingStrategy, IJsonModel<AudioTranscriptionCustomServerVadChunkingStrategy>, IPersistableModel<AudioTranscriptionCustomServerVadChunkingStrategy> {
public AudioTranscriptionCustomServerVadChunkingStrategy();
public float? DetectionThreshold { get; set; }
public TimeSpan? PrefixPadding { get; set; }
public TimeSpan? SilenceDuration { get; set; }
}
public readonly partial struct AudioTranscriptionDefaultChunkingStrategy : IEquatable<AudioTranscriptionDefaultChunkingStrategy> {
public AudioTranscriptionDefaultChunkingStrategy(string value);
public static AudioTranscriptionDefaultChunkingStrategy Auto { get; }
public readonly bool Equals(AudioTranscriptionDefaultChunkingStrategy other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(AudioTranscriptionDefaultChunkingStrategy left, AudioTranscriptionDefaultChunkingStrategy right);
public static implicit operator AudioTranscriptionDefaultChunkingStrategy(string value);
public static implicit operator AudioTranscriptionDefaultChunkingStrategy?(string value);
public static bool operator !=(AudioTranscriptionDefaultChunkingStrategy left, AudioTranscriptionDefaultChunkingStrategy right);
public override readonly string ToString();
}
public class AudioTranscriptionDurationUsage : AudioTranscriptionUsage, IJsonModel<AudioTranscriptionDurationUsage>, IPersistableModel<AudioTranscriptionDurationUsage> {
public TimeSpan Duration { get; }
}
public readonly partial struct AudioTranscriptionFormat : IEquatable<AudioTranscriptionFormat> {
public AudioTranscriptionFormat(string value);
public static AudioTranscriptionFormat Diarized { get; }
public static AudioTranscriptionFormat Simple { get; }
public static AudioTranscriptionFormat Srt { get; }
[EditorBrowsable(EditorBrowsableState.Never)]
public static AudioTranscriptionFormat Text { get; }
public static AudioTranscriptionFormat Verbose { get; }
public static AudioTranscriptionFormat Vtt { get; }
public readonly bool Equals(AudioTranscriptionFormat other);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly bool Equals(object obj);
[EditorBrowsable(EditorBrowsableState.Never)]
public override readonly int GetHashCode();
public static bool operator ==(AudioTranscriptionFormat left, AudioTranscriptionFormat right);
public static implicit operator AudioTranscriptionFormat(string value);
public static implicit operator AudioTranscriptionFormat?(string value);
public static bool operator !=(AudioTranscriptionFormat left, AudioTranscriptionFormat right);
public override readonly string ToString();
}
[Flags]
public enum AudioTranscriptionIncludes {
Default = 0,
Logprobs = 1
}
public class AudioTranscriptionInputTokenUsageDetails : IJsonModel<AudioTranscriptionInputTokenUsageDetails>, IPersistableModel<AudioTranscriptionInputTokenUsageDetails> {