llama-stack-client 0.2.16-rc1 → 0.2.17-rc1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (149) hide show
  1. package/LICENSE +4 -198
  2. package/index.d.mts +2 -2
  3. package/index.d.ts +2 -2
  4. package/index.d.ts.map +1 -1
  5. package/index.js.map +1 -1
  6. package/index.mjs +1 -1
  7. package/index.mjs.map +1 -1
  8. package/package.json +2 -6
  9. package/resources/agents/agents.d.ts +29 -2
  10. package/resources/agents/agents.d.ts.map +1 -1
  11. package/resources/agents/agents.js.map +1 -1
  12. package/resources/agents/agents.mjs.map +1 -1
  13. package/resources/agents/session.d.ts +18 -0
  14. package/resources/agents/session.d.ts.map +1 -1
  15. package/resources/agents/steps.d.ts +4 -1
  16. package/resources/agents/steps.d.ts.map +1 -1
  17. package/resources/agents/turn.d.ts +113 -8
  18. package/resources/agents/turn.d.ts.map +1 -1
  19. package/resources/benchmarks.d.ts +15 -0
  20. package/resources/benchmarks.d.ts.map +1 -1
  21. package/resources/chat/chat.d.ts +24 -0
  22. package/resources/chat/chat.d.ts.map +1 -1
  23. package/resources/chat/chat.js.map +1 -1
  24. package/resources/chat/chat.mjs.map +1 -1
  25. package/resources/chat/completions.d.ts +648 -6
  26. package/resources/chat/completions.d.ts.map +1 -1
  27. package/resources/datasets.d.ts +42 -6
  28. package/resources/datasets.d.ts.map +1 -1
  29. package/resources/eval/eval.d.ts +9 -0
  30. package/resources/eval/eval.d.ts.map +1 -1
  31. package/resources/eval/eval.js.map +1 -1
  32. package/resources/eval/eval.mjs.map +1 -1
  33. package/resources/files.d.ts +9 -0
  34. package/resources/files.d.ts.map +1 -1
  35. package/resources/index.d.ts +1 -1
  36. package/resources/index.d.ts.map +1 -1
  37. package/resources/index.js.map +1 -1
  38. package/resources/index.mjs +1 -1
  39. package/resources/index.mjs.map +1 -1
  40. package/resources/inference.d.ts +36 -0
  41. package/resources/inference.d.ts.map +1 -1
  42. package/resources/inspect.d.ts +45 -1
  43. package/resources/inspect.d.ts.map +1 -1
  44. package/resources/inspect.js +1 -1
  45. package/resources/inspect.mjs +1 -1
  46. package/resources/models.d.ts +21 -0
  47. package/resources/models.d.ts.map +1 -1
  48. package/resources/post-training/job.d.ts +95 -2
  49. package/resources/post-training/job.d.ts.map +1 -1
  50. package/resources/post-training/post-training.d.ts +206 -0
  51. package/resources/post-training/post-training.d.ts.map +1 -1
  52. package/resources/post-training/post-training.js.map +1 -1
  53. package/resources/post-training/post-training.mjs.map +1 -1
  54. package/resources/providers.d.ts +9 -0
  55. package/resources/providers.d.ts.map +1 -1
  56. package/resources/responses/input-items.d.ts +114 -0
  57. package/resources/responses/input-items.d.ts.map +1 -1
  58. package/resources/responses/responses.d.ts +1265 -12
  59. package/resources/responses/responses.d.ts.map +1 -1
  60. package/resources/responses/responses.js.map +1 -1
  61. package/resources/responses/responses.mjs.map +1 -1
  62. package/resources/routes.d.ts +10 -1
  63. package/resources/routes.d.ts.map +1 -1
  64. package/resources/routes.js +1 -1
  65. package/resources/routes.mjs +1 -1
  66. package/resources/safety.d.ts +72 -1
  67. package/resources/safety.d.ts.map +1 -1
  68. package/resources/safety.js +6 -0
  69. package/resources/safety.js.map +1 -1
  70. package/resources/safety.mjs +6 -0
  71. package/resources/safety.mjs.map +1 -1
  72. package/resources/scoring-functions.d.ts +51 -0
  73. package/resources/scoring-functions.d.ts.map +1 -1
  74. package/resources/scoring.d.ts +9 -0
  75. package/resources/scoring.d.ts.map +1 -1
  76. package/resources/shared.d.ts +209 -3
  77. package/resources/shared.d.ts.map +1 -1
  78. package/resources/shields.d.ts +7 -1
  79. package/resources/shields.d.ts.map +1 -1
  80. package/resources/synthetic-data-generation.d.ts +18 -1
  81. package/resources/synthetic-data-generation.d.ts.map +1 -1
  82. package/resources/synthetic-data-generation.js +3 -0
  83. package/resources/synthetic-data-generation.js.map +1 -1
  84. package/resources/synthetic-data-generation.mjs +3 -0
  85. package/resources/synthetic-data-generation.mjs.map +1 -1
  86. package/resources/telemetry.d.ts +214 -0
  87. package/resources/telemetry.d.ts.map +1 -1
  88. package/resources/tool-runtime/rag-tool.d.ts +16 -4
  89. package/resources/tool-runtime/rag-tool.d.ts.map +1 -1
  90. package/resources/tool-runtime/rag-tool.js +2 -2
  91. package/resources/tool-runtime/rag-tool.mjs +2 -2
  92. package/resources/tool-runtime/tool-runtime.d.ts +52 -1
  93. package/resources/tool-runtime/tool-runtime.d.ts.map +1 -1
  94. package/resources/tool-runtime/tool-runtime.js.map +1 -1
  95. package/resources/tool-runtime/tool-runtime.mjs.map +1 -1
  96. package/resources/toolgroups.d.ts +30 -0
  97. package/resources/toolgroups.d.ts.map +1 -1
  98. package/resources/tools.d.ts +45 -0
  99. package/resources/tools.d.ts.map +1 -1
  100. package/resources/vector-dbs.d.ts +45 -0
  101. package/resources/vector-dbs.d.ts.map +1 -1
  102. package/resources/vector-io.d.ts +9 -0
  103. package/resources/vector-io.d.ts.map +1 -1
  104. package/resources/vector-stores/files.d.ts +149 -1
  105. package/resources/vector-stores/files.d.ts.map +1 -1
  106. package/resources/vector-stores/vector-stores.d.ts +121 -1
  107. package/resources/vector-stores/vector-stores.d.ts.map +1 -1
  108. package/resources/vector-stores/vector-stores.js.map +1 -1
  109. package/resources/vector-stores/vector-stores.mjs.map +1 -1
  110. package/src/index.ts +9 -1
  111. package/src/resources/agents/agents.ts +29 -2
  112. package/src/resources/agents/session.ts +18 -0
  113. package/src/resources/agents/steps.ts +4 -1
  114. package/src/resources/agents/turn.ts +113 -8
  115. package/src/resources/benchmarks.ts +15 -0
  116. package/src/resources/chat/chat.ts +24 -0
  117. package/src/resources/chat/completions.ts +678 -0
  118. package/src/resources/datasets.ts +42 -6
  119. package/src/resources/eval/eval.ts +9 -0
  120. package/src/resources/files.ts +9 -0
  121. package/src/resources/index.ts +7 -1
  122. package/src/resources/inference.ts +36 -0
  123. package/src/resources/inspect.ts +45 -1
  124. package/src/resources/models.ts +21 -0
  125. package/src/resources/post-training/job.ts +95 -2
  126. package/src/resources/post-training/post-training.ts +206 -0
  127. package/src/resources/providers.ts +9 -0
  128. package/src/resources/responses/input-items.ts +114 -0
  129. package/src/resources/responses/responses.ts +1265 -12
  130. package/src/resources/routes.ts +10 -1
  131. package/src/resources/safety.ts +83 -1
  132. package/src/resources/scoring-functions.ts +51 -0
  133. package/src/resources/scoring.ts +9 -0
  134. package/src/resources/shared.ts +209 -3
  135. package/src/resources/shields.ts +7 -1
  136. package/src/resources/synthetic-data-generation.ts +18 -1
  137. package/src/resources/telemetry.ts +214 -0
  138. package/src/resources/tool-runtime/rag-tool.ts +16 -4
  139. package/src/resources/tool-runtime/tool-runtime.ts +52 -1
  140. package/src/resources/toolgroups.ts +30 -0
  141. package/src/resources/tools.ts +45 -0
  142. package/src/resources/vector-dbs.ts +45 -0
  143. package/src/resources/vector-io.ts +9 -0
  144. package/src/resources/vector-stores/files.ts +149 -1
  145. package/src/resources/vector-stores/vector-stores.ts +121 -1
  146. package/src/version.ts +1 -1
  147. package/version.d.ts +1 -1
  148. package/version.js +1 -1
  149. package/version.mjs +1 -1
@@ -141,6 +141,7 @@ export namespace CompletionCreateResponse {
141
141
  | Array<
142
142
  | OpenAIUserMessageParam.OpenAIChatCompletionContentPartTextParam
143
143
  | OpenAIUserMessageParam.OpenAIChatCompletionContentPartImageParam
144
+ | OpenAIUserMessageParam.OpenAIFile
144
145
  >;
145
146
 
146
147
  /**
@@ -155,25 +156,68 @@ export namespace CompletionCreateResponse {
155
156
  }
156
157
 
157
158
  export namespace OpenAIUserMessageParam {
159
+ /**
160
+ * Text content part for OpenAI-compatible chat completion messages.
161
+ */
158
162
  export interface OpenAIChatCompletionContentPartTextParam {
163
+ /**
164
+ * The text content of the message
165
+ */
159
166
  text: string;
160
167
 
168
+ /**
169
+ * Must be "text" to identify this as text content
170
+ */
161
171
  type: 'text';
162
172
  }
163
173
 
174
+ /**
175
+ * Image content part for OpenAI-compatible chat completion messages.
176
+ */
164
177
  export interface OpenAIChatCompletionContentPartImageParam {
178
+ /**
179
+ * Image URL specification and processing details
180
+ */
165
181
  image_url: OpenAIChatCompletionContentPartImageParam.ImageURL;
166
182
 
183
+ /**
184
+ * Must be "image_url" to identify this as image content
185
+ */
167
186
  type: 'image_url';
168
187
  }
169
188
 
170
189
  export namespace OpenAIChatCompletionContentPartImageParam {
190
+ /**
191
+ * Image URL specification and processing details
192
+ */
171
193
  export interface ImageURL {
194
+ /**
195
+ * URL of the image to include in the message
196
+ */
172
197
  url: string;
173
198
 
199
+ /**
200
+ * (Optional) Level of detail for image processing. Can be "low", "high", or "auto"
201
+ */
174
202
  detail?: string;
175
203
  }
176
204
  }
205
+
206
+ export interface OpenAIFile {
207
+ file: OpenAIFile.File;
208
+
209
+ type: 'file';
210
+ }
211
+
212
+ export namespace OpenAIFile {
213
+ export interface File {
214
+ file_data?: string;
215
+
216
+ file_id?: string;
217
+
218
+ filename?: string;
219
+ }
220
+ }
177
221
  }
178
222
 
179
223
  /**
@@ -199,9 +243,18 @@ export namespace CompletionCreateResponse {
199
243
  }
200
244
 
201
245
  export namespace OpenAISystemMessageParam {
246
+ /**
247
+ * Text content part for OpenAI-compatible chat completion messages.
248
+ */
202
249
  export interface UnionMember1 {
250
+ /**
251
+ * The text content of the message
252
+ */
203
253
  text: string;
204
254
 
255
+ /**
256
+ * Must be "text" to identify this as text content
257
+ */
205
258
  type: 'text';
206
259
  }
207
260
  }
@@ -233,26 +286,59 @@ export namespace CompletionCreateResponse {
233
286
  }
234
287
 
235
288
  export namespace OpenAIAssistantMessageParam {
289
+ /**
290
+ * Text content part for OpenAI-compatible chat completion messages.
291
+ */
236
292
  export interface UnionMember1 {
293
+ /**
294
+ * The text content of the message
295
+ */
237
296
  text: string;
238
297
 
298
+ /**
299
+ * Must be "text" to identify this as text content
300
+ */
239
301
  type: 'text';
240
302
  }
241
303
 
304
+ /**
305
+ * Tool call specification for OpenAI-compatible chat completion responses.
306
+ */
242
307
  export interface ToolCall {
308
+ /**
309
+ * Must be "function" to identify this as a function call
310
+ */
243
311
  type: 'function';
244
312
 
313
+ /**
314
+ * (Optional) Unique identifier for the tool call
315
+ */
245
316
  id?: string;
246
317
 
318
+ /**
319
+ * (Optional) Function call details
320
+ */
247
321
  function?: ToolCall.Function;
248
322
 
323
+ /**
324
+ * (Optional) Index of the tool call in the list
325
+ */
249
326
  index?: number;
250
327
  }
251
328
 
252
329
  export namespace ToolCall {
330
+ /**
331
+ * (Optional) Function call details
332
+ */
253
333
  export interface Function {
334
+ /**
335
+ * (Optional) Arguments to pass to the function as a JSON string
336
+ */
254
337
  arguments?: string;
255
338
 
339
+ /**
340
+ * (Optional) Name of the function to call
341
+ */
256
342
  name?: string;
257
343
  }
258
344
  }
@@ -280,9 +366,18 @@ export namespace CompletionCreateResponse {
280
366
  }
281
367
 
282
368
  export namespace OpenAIToolMessageParam {
369
+ /**
370
+ * Text content part for OpenAI-compatible chat completion messages.
371
+ */
283
372
  export interface UnionMember1 {
373
+ /**
374
+ * The text content of the message
375
+ */
284
376
  text: string;
285
377
 
378
+ /**
379
+ * Must be "text" to identify this as text content
380
+ */
286
381
  type: 'text';
287
382
  }
288
383
  }
@@ -308,9 +403,18 @@ export namespace CompletionCreateResponse {
308
403
  }
309
404
 
310
405
  export namespace OpenAIDeveloperMessageParam {
406
+ /**
407
+ * Text content part for OpenAI-compatible chat completion messages.
408
+ */
311
409
  export interface UnionMember1 {
410
+ /**
411
+ * The text content of the message
412
+ */
312
413
  text: string;
313
414
 
415
+ /**
416
+ * Must be "text" to identify this as text content
417
+ */
314
418
  type: 'text';
315
419
  }
316
420
  }
@@ -470,6 +574,7 @@ export namespace CompletionRetrieveResponse {
470
574
  | Array<
471
575
  | OpenAIUserMessageParam.OpenAIChatCompletionContentPartTextParam
472
576
  | OpenAIUserMessageParam.OpenAIChatCompletionContentPartImageParam
577
+ | OpenAIUserMessageParam.OpenAIFile
473
578
  >;
474
579
 
475
580
  /**
@@ -484,25 +589,68 @@ export namespace CompletionRetrieveResponse {
484
589
  }
485
590
 
486
591
  export namespace OpenAIUserMessageParam {
592
+ /**
593
+ * Text content part for OpenAI-compatible chat completion messages.
594
+ */
487
595
  export interface OpenAIChatCompletionContentPartTextParam {
596
+ /**
597
+ * The text content of the message
598
+ */
488
599
  text: string;
489
600
 
601
+ /**
602
+ * Must be "text" to identify this as text content
603
+ */
490
604
  type: 'text';
491
605
  }
492
606
 
607
+ /**
608
+ * Image content part for OpenAI-compatible chat completion messages.
609
+ */
493
610
  export interface OpenAIChatCompletionContentPartImageParam {
611
+ /**
612
+ * Image URL specification and processing details
613
+ */
494
614
  image_url: OpenAIChatCompletionContentPartImageParam.ImageURL;
495
615
 
616
+ /**
617
+ * Must be "image_url" to identify this as image content
618
+ */
496
619
  type: 'image_url';
497
620
  }
498
621
 
499
622
  export namespace OpenAIChatCompletionContentPartImageParam {
623
+ /**
624
+ * Image URL specification and processing details
625
+ */
500
626
  export interface ImageURL {
627
+ /**
628
+ * URL of the image to include in the message
629
+ */
501
630
  url: string;
502
631
 
632
+ /**
633
+ * (Optional) Level of detail for image processing. Can be "low", "high", or "auto"
634
+ */
503
635
  detail?: string;
504
636
  }
505
637
  }
638
+
639
+ export interface OpenAIFile {
640
+ file: OpenAIFile.File;
641
+
642
+ type: 'file';
643
+ }
644
+
645
+ export namespace OpenAIFile {
646
+ export interface File {
647
+ file_data?: string;
648
+
649
+ file_id?: string;
650
+
651
+ filename?: string;
652
+ }
653
+ }
506
654
  }
507
655
 
508
656
  /**
@@ -528,9 +676,18 @@ export namespace CompletionRetrieveResponse {
528
676
  }
529
677
 
530
678
  export namespace OpenAISystemMessageParam {
679
+ /**
680
+ * Text content part for OpenAI-compatible chat completion messages.
681
+ */
531
682
  export interface UnionMember1 {
683
+ /**
684
+ * The text content of the message
685
+ */
532
686
  text: string;
533
687
 
688
+ /**
689
+ * Must be "text" to identify this as text content
690
+ */
534
691
  type: 'text';
535
692
  }
536
693
  }
@@ -562,26 +719,59 @@ export namespace CompletionRetrieveResponse {
562
719
  }
563
720
 
564
721
  export namespace OpenAIAssistantMessageParam {
722
+ /**
723
+ * Text content part for OpenAI-compatible chat completion messages.
724
+ */
565
725
  export interface UnionMember1 {
726
+ /**
727
+ * The text content of the message
728
+ */
566
729
  text: string;
567
730
 
731
+ /**
732
+ * Must be "text" to identify this as text content
733
+ */
568
734
  type: 'text';
569
735
  }
570
736
 
737
+ /**
738
+ * Tool call specification for OpenAI-compatible chat completion responses.
739
+ */
571
740
  export interface ToolCall {
741
+ /**
742
+ * Must be "function" to identify this as a function call
743
+ */
572
744
  type: 'function';
573
745
 
746
+ /**
747
+ * (Optional) Unique identifier for the tool call
748
+ */
574
749
  id?: string;
575
750
 
751
+ /**
752
+ * (Optional) Function call details
753
+ */
576
754
  function?: ToolCall.Function;
577
755
 
756
+ /**
757
+ * (Optional) Index of the tool call in the list
758
+ */
578
759
  index?: number;
579
760
  }
580
761
 
581
762
  export namespace ToolCall {
763
+ /**
764
+ * (Optional) Function call details
765
+ */
582
766
  export interface Function {
767
+ /**
768
+ * (Optional) Arguments to pass to the function as a JSON string
769
+ */
583
770
  arguments?: string;
584
771
 
772
+ /**
773
+ * (Optional) Name of the function to call
774
+ */
585
775
  name?: string;
586
776
  }
587
777
  }
@@ -609,9 +799,18 @@ export namespace CompletionRetrieveResponse {
609
799
  }
610
800
 
611
801
  export namespace OpenAIToolMessageParam {
802
+ /**
803
+ * Text content part for OpenAI-compatible chat completion messages.
804
+ */
612
805
  export interface UnionMember1 {
806
+ /**
807
+ * The text content of the message
808
+ */
613
809
  text: string;
614
810
 
811
+ /**
812
+ * Must be "text" to identify this as text content
813
+ */
615
814
  type: 'text';
616
815
  }
617
816
  }
@@ -637,9 +836,18 @@ export namespace CompletionRetrieveResponse {
637
836
  }
638
837
 
639
838
  export namespace OpenAIDeveloperMessageParam {
839
+ /**
840
+ * Text content part for OpenAI-compatible chat completion messages.
841
+ */
640
842
  export interface UnionMember1 {
843
+ /**
844
+ * The text content of the message
845
+ */
641
846
  text: string;
642
847
 
848
+ /**
849
+ * Must be "text" to identify this as text content
850
+ */
643
851
  type: 'text';
644
852
  }
645
853
  }
@@ -730,6 +938,7 @@ export namespace CompletionRetrieveResponse {
730
938
  | Array<
731
939
  | OpenAIUserMessageParam.OpenAIChatCompletionContentPartTextParam
732
940
  | OpenAIUserMessageParam.OpenAIChatCompletionContentPartImageParam
941
+ | OpenAIUserMessageParam.OpenAIFile
733
942
  >;
734
943
 
735
944
  /**
@@ -744,25 +953,68 @@ export namespace CompletionRetrieveResponse {
744
953
  }
745
954
 
746
955
  export namespace OpenAIUserMessageParam {
956
+ /**
957
+ * Text content part for OpenAI-compatible chat completion messages.
958
+ */
747
959
  export interface OpenAIChatCompletionContentPartTextParam {
960
+ /**
961
+ * The text content of the message
962
+ */
748
963
  text: string;
749
964
 
965
+ /**
966
+ * Must be "text" to identify this as text content
967
+ */
750
968
  type: 'text';
751
969
  }
752
970
 
971
+ /**
972
+ * Image content part for OpenAI-compatible chat completion messages.
973
+ */
753
974
  export interface OpenAIChatCompletionContentPartImageParam {
975
+ /**
976
+ * Image URL specification and processing details
977
+ */
754
978
  image_url: OpenAIChatCompletionContentPartImageParam.ImageURL;
755
979
 
980
+ /**
981
+ * Must be "image_url" to identify this as image content
982
+ */
756
983
  type: 'image_url';
757
984
  }
758
985
 
759
986
  export namespace OpenAIChatCompletionContentPartImageParam {
987
+ /**
988
+ * Image URL specification and processing details
989
+ */
760
990
  export interface ImageURL {
991
+ /**
992
+ * URL of the image to include in the message
993
+ */
761
994
  url: string;
762
995
 
996
+ /**
997
+ * (Optional) Level of detail for image processing. Can be "low", "high", or "auto"
998
+ */
763
999
  detail?: string;
764
1000
  }
765
1001
  }
1002
+
1003
+ export interface OpenAIFile {
1004
+ file: OpenAIFile.File;
1005
+
1006
+ type: 'file';
1007
+ }
1008
+
1009
+ export namespace OpenAIFile {
1010
+ export interface File {
1011
+ file_data?: string;
1012
+
1013
+ file_id?: string;
1014
+
1015
+ filename?: string;
1016
+ }
1017
+ }
766
1018
  }
767
1019
 
768
1020
  /**
@@ -788,9 +1040,18 @@ export namespace CompletionRetrieveResponse {
788
1040
  }
789
1041
 
790
1042
  export namespace OpenAISystemMessageParam {
1043
+ /**
1044
+ * Text content part for OpenAI-compatible chat completion messages.
1045
+ */
791
1046
  export interface UnionMember1 {
1047
+ /**
1048
+ * The text content of the message
1049
+ */
792
1050
  text: string;
793
1051
 
1052
+ /**
1053
+ * Must be "text" to identify this as text content
1054
+ */
794
1055
  type: 'text';
795
1056
  }
796
1057
  }
@@ -822,26 +1083,59 @@ export namespace CompletionRetrieveResponse {
822
1083
  }
823
1084
 
824
1085
  export namespace OpenAIAssistantMessageParam {
1086
+ /**
1087
+ * Text content part for OpenAI-compatible chat completion messages.
1088
+ */
825
1089
  export interface UnionMember1 {
1090
+ /**
1091
+ * The text content of the message
1092
+ */
826
1093
  text: string;
827
1094
 
1095
+ /**
1096
+ * Must be "text" to identify this as text content
1097
+ */
828
1098
  type: 'text';
829
1099
  }
830
1100
 
1101
+ /**
1102
+ * Tool call specification for OpenAI-compatible chat completion responses.
1103
+ */
831
1104
  export interface ToolCall {
1105
+ /**
1106
+ * Must be "function" to identify this as a function call
1107
+ */
832
1108
  type: 'function';
833
1109
 
1110
+ /**
1111
+ * (Optional) Unique identifier for the tool call
1112
+ */
834
1113
  id?: string;
835
1114
 
1115
+ /**
1116
+ * (Optional) Function call details
1117
+ */
836
1118
  function?: ToolCall.Function;
837
1119
 
1120
+ /**
1121
+ * (Optional) Index of the tool call in the list
1122
+ */
838
1123
  index?: number;
839
1124
  }
840
1125
 
841
1126
  export namespace ToolCall {
1127
+ /**
1128
+ * (Optional) Function call details
1129
+ */
842
1130
  export interface Function {
1131
+ /**
1132
+ * (Optional) Arguments to pass to the function as a JSON string
1133
+ */
843
1134
  arguments?: string;
844
1135
 
1136
+ /**
1137
+ * (Optional) Name of the function to call
1138
+ */
845
1139
  name?: string;
846
1140
  }
847
1141
  }
@@ -869,9 +1163,18 @@ export namespace CompletionRetrieveResponse {
869
1163
  }
870
1164
 
871
1165
  export namespace OpenAIToolMessageParam {
1166
+ /**
1167
+ * Text content part for OpenAI-compatible chat completion messages.
1168
+ */
872
1169
  export interface UnionMember1 {
1170
+ /**
1171
+ * The text content of the message
1172
+ */
873
1173
  text: string;
874
1174
 
1175
+ /**
1176
+ * Must be "text" to identify this as text content
1177
+ */
875
1178
  type: 'text';
876
1179
  }
877
1180
  }
@@ -897,23 +1200,50 @@ export namespace CompletionRetrieveResponse {
897
1200
  }
898
1201
 
899
1202
  export namespace OpenAIDeveloperMessageParam {
1203
+ /**
1204
+ * Text content part for OpenAI-compatible chat completion messages.
1205
+ */
900
1206
  export interface UnionMember1 {
1207
+ /**
1208
+ * The text content of the message
1209
+ */
901
1210
  text: string;
902
1211
 
1212
+ /**
1213
+ * Must be "text" to identify this as text content
1214
+ */
903
1215
  type: 'text';
904
1216
  }
905
1217
  }
906
1218
  }
907
1219
 
1220
+ /**
1221
+ * Response from listing OpenAI-compatible chat completions.
1222
+ */
908
1223
  export interface CompletionListResponse {
1224
+ /**
1225
+ * List of chat completion objects with their input messages
1226
+ */
909
1227
  data: Array<CompletionListResponse.Data>;
910
1228
 
1229
+ /**
1230
+ * ID of the first completion in this list
1231
+ */
911
1232
  first_id: string;
912
1233
 
1234
+ /**
1235
+ * Whether there are more completions available beyond this list
1236
+ */
913
1237
  has_more: boolean;
914
1238
 
1239
+ /**
1240
+ * ID of the last completion in this list
1241
+ */
915
1242
  last_id: string;
916
1243
 
1244
+ /**
1245
+ * Must be "list" to identify this as a list response
1246
+ */
917
1247
  object: 'list';
918
1248
  }
919
1249
 
@@ -997,6 +1327,7 @@ export namespace CompletionListResponse {
997
1327
  | Array<
998
1328
  | OpenAIUserMessageParam.OpenAIChatCompletionContentPartTextParam
999
1329
  | OpenAIUserMessageParam.OpenAIChatCompletionContentPartImageParam
1330
+ | OpenAIUserMessageParam.OpenAIFile
1000
1331
  >;
1001
1332
 
1002
1333
  /**
@@ -1011,25 +1342,68 @@ export namespace CompletionListResponse {
1011
1342
  }
1012
1343
 
1013
1344
  export namespace OpenAIUserMessageParam {
1345
+ /**
1346
+ * Text content part for OpenAI-compatible chat completion messages.
1347
+ */
1014
1348
  export interface OpenAIChatCompletionContentPartTextParam {
1349
+ /**
1350
+ * The text content of the message
1351
+ */
1015
1352
  text: string;
1016
1353
 
1354
+ /**
1355
+ * Must be "text" to identify this as text content
1356
+ */
1017
1357
  type: 'text';
1018
1358
  }
1019
1359
 
1360
+ /**
1361
+ * Image content part for OpenAI-compatible chat completion messages.
1362
+ */
1020
1363
  export interface OpenAIChatCompletionContentPartImageParam {
1364
+ /**
1365
+ * Image URL specification and processing details
1366
+ */
1021
1367
  image_url: OpenAIChatCompletionContentPartImageParam.ImageURL;
1022
1368
 
1369
+ /**
1370
+ * Must be "image_url" to identify this as image content
1371
+ */
1023
1372
  type: 'image_url';
1024
1373
  }
1025
1374
 
1026
1375
  export namespace OpenAIChatCompletionContentPartImageParam {
1376
+ /**
1377
+ * Image URL specification and processing details
1378
+ */
1027
1379
  export interface ImageURL {
1380
+ /**
1381
+ * URL of the image to include in the message
1382
+ */
1028
1383
  url: string;
1029
1384
 
1385
+ /**
1386
+ * (Optional) Level of detail for image processing. Can be "low", "high", or "auto"
1387
+ */
1030
1388
  detail?: string;
1031
1389
  }
1032
1390
  }
1391
+
1392
+ export interface OpenAIFile {
1393
+ file: OpenAIFile.File;
1394
+
1395
+ type: 'file';
1396
+ }
1397
+
1398
+ export namespace OpenAIFile {
1399
+ export interface File {
1400
+ file_data?: string;
1401
+
1402
+ file_id?: string;
1403
+
1404
+ filename?: string;
1405
+ }
1406
+ }
1033
1407
  }
1034
1408
 
1035
1409
  /**
@@ -1055,9 +1429,18 @@ export namespace CompletionListResponse {
1055
1429
  }
1056
1430
 
1057
1431
  export namespace OpenAISystemMessageParam {
1432
+ /**
1433
+ * Text content part for OpenAI-compatible chat completion messages.
1434
+ */
1058
1435
  export interface UnionMember1 {
1436
+ /**
1437
+ * The text content of the message
1438
+ */
1059
1439
  text: string;
1060
1440
 
1441
+ /**
1442
+ * Must be "text" to identify this as text content
1443
+ */
1061
1444
  type: 'text';
1062
1445
  }
1063
1446
  }
@@ -1089,26 +1472,59 @@ export namespace CompletionListResponse {
1089
1472
  }
1090
1473
 
1091
1474
  export namespace OpenAIAssistantMessageParam {
1475
+ /**
1476
+ * Text content part for OpenAI-compatible chat completion messages.
1477
+ */
1092
1478
  export interface UnionMember1 {
1479
+ /**
1480
+ * The text content of the message
1481
+ */
1093
1482
  text: string;
1094
1483
 
1484
+ /**
1485
+ * Must be "text" to identify this as text content
1486
+ */
1095
1487
  type: 'text';
1096
1488
  }
1097
1489
 
1490
+ /**
1491
+ * Tool call specification for OpenAI-compatible chat completion responses.
1492
+ */
1098
1493
  export interface ToolCall {
1494
+ /**
1495
+ * Must be "function" to identify this as a function call
1496
+ */
1099
1497
  type: 'function';
1100
1498
 
1499
+ /**
1500
+ * (Optional) Unique identifier for the tool call
1501
+ */
1101
1502
  id?: string;
1102
1503
 
1504
+ /**
1505
+ * (Optional) Function call details
1506
+ */
1103
1507
  function?: ToolCall.Function;
1104
1508
 
1509
+ /**
1510
+ * (Optional) Index of the tool call in the list
1511
+ */
1105
1512
  index?: number;
1106
1513
  }
1107
1514
 
1108
1515
  export namespace ToolCall {
1516
+ /**
1517
+ * (Optional) Function call details
1518
+ */
1109
1519
  export interface Function {
1520
+ /**
1521
+ * (Optional) Arguments to pass to the function as a JSON string
1522
+ */
1110
1523
  arguments?: string;
1111
1524
 
1525
+ /**
1526
+ * (Optional) Name of the function to call
1527
+ */
1112
1528
  name?: string;
1113
1529
  }
1114
1530
  }
@@ -1136,9 +1552,18 @@ export namespace CompletionListResponse {
1136
1552
  }
1137
1553
 
1138
1554
  export namespace OpenAIToolMessageParam {
1555
+ /**
1556
+ * Text content part for OpenAI-compatible chat completion messages.
1557
+ */
1139
1558
  export interface UnionMember1 {
1559
+ /**
1560
+ * The text content of the message
1561
+ */
1140
1562
  text: string;
1141
1563
 
1564
+ /**
1565
+ * Must be "text" to identify this as text content
1566
+ */
1142
1567
  type: 'text';
1143
1568
  }
1144
1569
  }
@@ -1164,9 +1589,18 @@ export namespace CompletionListResponse {
1164
1589
  }
1165
1590
 
1166
1591
  export namespace OpenAIDeveloperMessageParam {
1592
+ /**
1593
+ * Text content part for OpenAI-compatible chat completion messages.
1594
+ */
1167
1595
  export interface UnionMember1 {
1596
+ /**
1597
+ * The text content of the message
1598
+ */
1168
1599
  text: string;
1169
1600
 
1601
+ /**
1602
+ * Must be "text" to identify this as text content
1603
+ */
1170
1604
  type: 'text';
1171
1605
  }
1172
1606
  }
@@ -1257,6 +1691,7 @@ export namespace CompletionListResponse {
1257
1691
  | Array<
1258
1692
  | OpenAIUserMessageParam.OpenAIChatCompletionContentPartTextParam
1259
1693
  | OpenAIUserMessageParam.OpenAIChatCompletionContentPartImageParam
1694
+ | OpenAIUserMessageParam.OpenAIFile
1260
1695
  >;
1261
1696
 
1262
1697
  /**
@@ -1271,25 +1706,68 @@ export namespace CompletionListResponse {
1271
1706
  }
1272
1707
 
1273
1708
  export namespace OpenAIUserMessageParam {
1709
+ /**
1710
+ * Text content part for OpenAI-compatible chat completion messages.
1711
+ */
1274
1712
  export interface OpenAIChatCompletionContentPartTextParam {
1713
+ /**
1714
+ * The text content of the message
1715
+ */
1275
1716
  text: string;
1276
1717
 
1718
+ /**
1719
+ * Must be "text" to identify this as text content
1720
+ */
1277
1721
  type: 'text';
1278
1722
  }
1279
1723
 
1724
+ /**
1725
+ * Image content part for OpenAI-compatible chat completion messages.
1726
+ */
1280
1727
  export interface OpenAIChatCompletionContentPartImageParam {
1728
+ /**
1729
+ * Image URL specification and processing details
1730
+ */
1281
1731
  image_url: OpenAIChatCompletionContentPartImageParam.ImageURL;
1282
1732
 
1733
+ /**
1734
+ * Must be "image_url" to identify this as image content
1735
+ */
1283
1736
  type: 'image_url';
1284
1737
  }
1285
1738
 
1286
1739
  export namespace OpenAIChatCompletionContentPartImageParam {
1740
+ /**
1741
+ * Image URL specification and processing details
1742
+ */
1287
1743
  export interface ImageURL {
1744
+ /**
1745
+ * URL of the image to include in the message
1746
+ */
1288
1747
  url: string;
1289
1748
 
1749
+ /**
1750
+ * (Optional) Level of detail for image processing. Can be "low", "high", or "auto"
1751
+ */
1290
1752
  detail?: string;
1291
1753
  }
1292
1754
  }
1755
+
1756
+ export interface OpenAIFile {
1757
+ file: OpenAIFile.File;
1758
+
1759
+ type: 'file';
1760
+ }
1761
+
1762
+ export namespace OpenAIFile {
1763
+ export interface File {
1764
+ file_data?: string;
1765
+
1766
+ file_id?: string;
1767
+
1768
+ filename?: string;
1769
+ }
1770
+ }
1293
1771
  }
1294
1772
 
1295
1773
  /**
@@ -1315,9 +1793,18 @@ export namespace CompletionListResponse {
1315
1793
  }
1316
1794
 
1317
1795
  export namespace OpenAISystemMessageParam {
1796
+ /**
1797
+ * Text content part for OpenAI-compatible chat completion messages.
1798
+ */
1318
1799
  export interface UnionMember1 {
1800
+ /**
1801
+ * The text content of the message
1802
+ */
1319
1803
  text: string;
1320
1804
 
1805
+ /**
1806
+ * Must be "text" to identify this as text content
1807
+ */
1321
1808
  type: 'text';
1322
1809
  }
1323
1810
  }
@@ -1349,26 +1836,59 @@ export namespace CompletionListResponse {
1349
1836
  }
1350
1837
 
1351
1838
  export namespace OpenAIAssistantMessageParam {
1839
+ /**
1840
+ * Text content part for OpenAI-compatible chat completion messages.
1841
+ */
1352
1842
  export interface UnionMember1 {
1843
+ /**
1844
+ * The text content of the message
1845
+ */
1353
1846
  text: string;
1354
1847
 
1848
+ /**
1849
+ * Must be "text" to identify this as text content
1850
+ */
1355
1851
  type: 'text';
1356
1852
  }
1357
1853
 
1854
+ /**
1855
+ * Tool call specification for OpenAI-compatible chat completion responses.
1856
+ */
1358
1857
  export interface ToolCall {
1858
+ /**
1859
+ * Must be "function" to identify this as a function call
1860
+ */
1359
1861
  type: 'function';
1360
1862
 
1863
+ /**
1864
+ * (Optional) Unique identifier for the tool call
1865
+ */
1361
1866
  id?: string;
1362
1867
 
1868
+ /**
1869
+ * (Optional) Function call details
1870
+ */
1363
1871
  function?: ToolCall.Function;
1364
1872
 
1873
+ /**
1874
+ * (Optional) Index of the tool call in the list
1875
+ */
1365
1876
  index?: number;
1366
1877
  }
1367
1878
 
1368
1879
  export namespace ToolCall {
1880
+ /**
1881
+ * (Optional) Function call details
1882
+ */
1369
1883
  export interface Function {
1884
+ /**
1885
+ * (Optional) Arguments to pass to the function as a JSON string
1886
+ */
1370
1887
  arguments?: string;
1371
1888
 
1889
+ /**
1890
+ * (Optional) Name of the function to call
1891
+ */
1372
1892
  name?: string;
1373
1893
  }
1374
1894
  }
@@ -1396,9 +1916,18 @@ export namespace CompletionListResponse {
1396
1916
  }
1397
1917
 
1398
1918
  export namespace OpenAIToolMessageParam {
1919
+ /**
1920
+ * Text content part for OpenAI-compatible chat completion messages.
1921
+ */
1399
1922
  export interface UnionMember1 {
1923
+ /**
1924
+ * The text content of the message
1925
+ */
1400
1926
  text: string;
1401
1927
 
1928
+ /**
1929
+ * Must be "text" to identify this as text content
1930
+ */
1402
1931
  type: 'text';
1403
1932
  }
1404
1933
  }
@@ -1424,9 +1953,18 @@ export namespace CompletionListResponse {
1424
1953
  }
1425
1954
 
1426
1955
  export namespace OpenAIDeveloperMessageParam {
1956
+ /**
1957
+ * Text content part for OpenAI-compatible chat completion messages.
1958
+ */
1427
1959
  export interface UnionMember1 {
1960
+ /**
1961
+ * The text content of the message
1962
+ */
1428
1963
  text: string;
1429
1964
 
1965
+ /**
1966
+ * Must be "text" to identify this as text content
1967
+ */
1430
1968
  type: 'text';
1431
1969
  }
1432
1970
  }
@@ -1575,6 +2113,7 @@ export namespace CompletionCreateParams {
1575
2113
  | Array<
1576
2114
  | OpenAIUserMessageParam.OpenAIChatCompletionContentPartTextParam
1577
2115
  | OpenAIUserMessageParam.OpenAIChatCompletionContentPartImageParam
2116
+ | OpenAIUserMessageParam.OpenAIFile
1578
2117
  >;
1579
2118
 
1580
2119
  /**
@@ -1589,25 +2128,68 @@ export namespace CompletionCreateParams {
1589
2128
  }
1590
2129
 
1591
2130
  export namespace OpenAIUserMessageParam {
2131
+ /**
2132
+ * Text content part for OpenAI-compatible chat completion messages.
2133
+ */
1592
2134
  export interface OpenAIChatCompletionContentPartTextParam {
2135
+ /**
2136
+ * The text content of the message
2137
+ */
1593
2138
  text: string;
1594
2139
 
2140
+ /**
2141
+ * Must be "text" to identify this as text content
2142
+ */
1595
2143
  type: 'text';
1596
2144
  }
1597
2145
 
2146
+ /**
2147
+ * Image content part for OpenAI-compatible chat completion messages.
2148
+ */
1598
2149
  export interface OpenAIChatCompletionContentPartImageParam {
2150
+ /**
2151
+ * Image URL specification and processing details
2152
+ */
1599
2153
  image_url: OpenAIChatCompletionContentPartImageParam.ImageURL;
1600
2154
 
2155
+ /**
2156
+ * Must be "image_url" to identify this as image content
2157
+ */
1601
2158
  type: 'image_url';
1602
2159
  }
1603
2160
 
1604
2161
  export namespace OpenAIChatCompletionContentPartImageParam {
2162
+ /**
2163
+ * Image URL specification and processing details
2164
+ */
1605
2165
  export interface ImageURL {
2166
+ /**
2167
+ * URL of the image to include in the message
2168
+ */
1606
2169
  url: string;
1607
2170
 
2171
+ /**
2172
+ * (Optional) Level of detail for image processing. Can be "low", "high", or "auto"
2173
+ */
1608
2174
  detail?: string;
1609
2175
  }
1610
2176
  }
2177
+
2178
+ export interface OpenAIFile {
2179
+ file: OpenAIFile.File;
2180
+
2181
+ type: 'file';
2182
+ }
2183
+
2184
+ export namespace OpenAIFile {
2185
+ export interface File {
2186
+ file_data?: string;
2187
+
2188
+ file_id?: string;
2189
+
2190
+ filename?: string;
2191
+ }
2192
+ }
1611
2193
  }
1612
2194
 
1613
2195
  /**
@@ -1633,9 +2215,18 @@ export namespace CompletionCreateParams {
1633
2215
  }
1634
2216
 
1635
2217
  export namespace OpenAISystemMessageParam {
2218
+ /**
2219
+ * Text content part for OpenAI-compatible chat completion messages.
2220
+ */
1636
2221
  export interface UnionMember1 {
2222
+ /**
2223
+ * The text content of the message
2224
+ */
1637
2225
  text: string;
1638
2226
 
2227
+ /**
2228
+ * Must be "text" to identify this as text content
2229
+ */
1639
2230
  type: 'text';
1640
2231
  }
1641
2232
  }
@@ -1667,26 +2258,59 @@ export namespace CompletionCreateParams {
1667
2258
  }
1668
2259
 
1669
2260
  export namespace OpenAIAssistantMessageParam {
2261
+ /**
2262
+ * Text content part for OpenAI-compatible chat completion messages.
2263
+ */
1670
2264
  export interface UnionMember1 {
2265
+ /**
2266
+ * The text content of the message
2267
+ */
1671
2268
  text: string;
1672
2269
 
2270
+ /**
2271
+ * Must be "text" to identify this as text content
2272
+ */
1673
2273
  type: 'text';
1674
2274
  }
1675
2275
 
2276
+ /**
2277
+ * Tool call specification for OpenAI-compatible chat completion responses.
2278
+ */
1676
2279
  export interface ToolCall {
2280
+ /**
2281
+ * Must be "function" to identify this as a function call
2282
+ */
1677
2283
  type: 'function';
1678
2284
 
2285
+ /**
2286
+ * (Optional) Unique identifier for the tool call
2287
+ */
1679
2288
  id?: string;
1680
2289
 
2290
+ /**
2291
+ * (Optional) Function call details
2292
+ */
1681
2293
  function?: ToolCall.Function;
1682
2294
 
2295
+ /**
2296
+ * (Optional) Index of the tool call in the list
2297
+ */
1683
2298
  index?: number;
1684
2299
  }
1685
2300
 
1686
2301
  export namespace ToolCall {
2302
+ /**
2303
+ * (Optional) Function call details
2304
+ */
1687
2305
  export interface Function {
2306
+ /**
2307
+ * (Optional) Arguments to pass to the function as a JSON string
2308
+ */
1688
2309
  arguments?: string;
1689
2310
 
2311
+ /**
2312
+ * (Optional) Name of the function to call
2313
+ */
1690
2314
  name?: string;
1691
2315
  }
1692
2316
  }
@@ -1714,9 +2338,18 @@ export namespace CompletionCreateParams {
1714
2338
  }
1715
2339
 
1716
2340
  export namespace OpenAIToolMessageParam {
2341
+ /**
2342
+ * Text content part for OpenAI-compatible chat completion messages.
2343
+ */
1717
2344
  export interface UnionMember1 {
2345
+ /**
2346
+ * The text content of the message
2347
+ */
1718
2348
  text: string;
1719
2349
 
2350
+ /**
2351
+ * Must be "text" to identify this as text content
2352
+ */
1720
2353
  type: 'text';
1721
2354
  }
1722
2355
  }
@@ -1742,36 +2375,81 @@ export namespace CompletionCreateParams {
1742
2375
  }
1743
2376
 
1744
2377
  export namespace OpenAIDeveloperMessageParam {
2378
+ /**
2379
+ * Text content part for OpenAI-compatible chat completion messages.
2380
+ */
1745
2381
  export interface UnionMember1 {
2382
+ /**
2383
+ * The text content of the message
2384
+ */
1746
2385
  text: string;
1747
2386
 
2387
+ /**
2388
+ * Must be "text" to identify this as text content
2389
+ */
1748
2390
  type: 'text';
1749
2391
  }
1750
2392
  }
1751
2393
 
2394
+ /**
2395
+ * Text response format for OpenAI-compatible chat completion requests.
2396
+ */
1752
2397
  export interface OpenAIResponseFormatText {
2398
+ /**
2399
+ * Must be "text" to indicate plain text response format
2400
+ */
1753
2401
  type: 'text';
1754
2402
  }
1755
2403
 
2404
+ /**
2405
+ * JSON schema response format for OpenAI-compatible chat completion requests.
2406
+ */
1756
2407
  export interface OpenAIResponseFormatJsonSchema {
2408
+ /**
2409
+ * The JSON schema specification for the response
2410
+ */
1757
2411
  json_schema: OpenAIResponseFormatJsonSchema.JsonSchema;
1758
2412
 
2413
+ /**
2414
+ * Must be "json_schema" to indicate structured JSON response format
2415
+ */
1759
2416
  type: 'json_schema';
1760
2417
  }
1761
2418
 
1762
2419
  export namespace OpenAIResponseFormatJsonSchema {
2420
+ /**
2421
+ * The JSON schema specification for the response
2422
+ */
1763
2423
  export interface JsonSchema {
2424
+ /**
2425
+ * Name of the schema
2426
+ */
1764
2427
  name: string;
1765
2428
 
2429
+ /**
2430
+ * (Optional) Description of the schema
2431
+ */
1766
2432
  description?: string;
1767
2433
 
2434
+ /**
2435
+ * (Optional) The JSON schema definition
2436
+ */
1768
2437
  schema?: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
1769
2438
 
2439
+ /**
2440
+ * (Optional) Whether to enforce strict adherence to the schema
2441
+ */
1770
2442
  strict?: boolean;
1771
2443
  }
1772
2444
  }
1773
2445
 
2446
+ /**
2447
+ * JSON object response format for OpenAI-compatible chat completion requests.
2448
+ */
1774
2449
  export interface OpenAIResponseFormatJsonObject {
2450
+ /**
2451
+ * Must be "json_object" to indicate generic JSON object response format
2452
+ */
1775
2453
  type: 'json_object';
1776
2454
  }
1777
2455