-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
17950 lines (17950 loc) · 882 KB
/
openapi.yaml
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
info:
title: "[Dev] orq.ai API"
version: "2.0"
description: "orq.ai API documentation"
security:
- ApiKey: []
servers:
- url: "https://my.orq.ai"
openapi: "3.1.0"
x-speakeasy-timeout: 600000
externalDocs:
url: "https://docs.orq.ai"
description: "orq.ai Documentation"
x-tagGroups: [{"name": "Core API", "tags": ["Contacts", "Deployments", "Feedback", "Files", "Models", "Memory Stores", "Prompts", "Remote Configs", "Tools"]}, {"name": "Agents API", "tags": ["Agents", "Agent Tasks", "Agent Actions"]}, {"name": "Proxy", "tags": ["Audio", "Chat", "Embeddings", "Batch", "Completions", "Images", "Models", "Moderations"]}]
x-speakeasy-globals: {"parameters": [{"name": "contactId", "in": "header", "schema": {"type": "string"}, "x-speakeasy-globals-hidden": true}, {"name": "environment", "in": "header", "schema": {"type": "string"}, "x-speakeasy-globals-hidden": true}]}
components:
securitySchemes:
"ApiKey":
type: "http"
scheme: "bearer"
bearerFormat: "JWT"
schemas:
"UpdateUserInformationRequest":
type: "object"
properties:
"external_id":
type: "string"
minLength: 1
description: "Unique string value to identify the contact user in the customer's system"
"display_name":
type:
- "string"
- "null"
description: "Display name or nickname of the user"
"email":
type:
- "string"
- "null"
format: "email"
description: "Email address of the user"
"avatar_url":
type:
- "string"
- "null"
description: "URL linking to the user's avatar image"
"tags":
type: "array"
items:
type: "string"
format: "uuid"
description: "Array of UUIDs representing tags associated with the user"
"metadata":
type: "object"
additionalProperties: {}
description: "Additional custom metadata associated with the user as key-value pairs"
required:
- "external_id"
"UpdateUserInformationResponse":
type: "object"
properties:
"success":
type: "boolean"
description: "Indicate whether the contact have been added or updated."
required:
- "success"
"ReportFeedbackRequest":
type: "object"
properties:
"property":
type: "string"
description: "A string describing the specific property or aspect rated."
"value":
anyOf:
- type: "string"
- type: "array"
items:
type: "string"
description: "The feedback value. For single selection of multiple choice, the value should be an array of strings. For `correction`, the value should be a string."
"trace_id":
type: "string"
description: "The id returned by the [`get_config`]() or [`invoke`](https://docs.orq.ai/reference/post_deployments-invoke-1) endpoints"
required:
- "property"
- "value"
- "trace_id"
"ReportFeedbackResponse":
type: "object"
properties:
"property":
type: "string"
description: "A string describing the specific property or aspect rated."
"value":
anyOf:
- type: "string"
- type: "array"
items:
type: "string"
description: "The feedback value. For single selection of multiple choice, the value should be an array of strings. For `correction`, the value should be a string."
"trace_id":
type: "string"
description: "The id returned by the [`get_config`]() or [`invoke`](https://docs.orq.ai/reference/post_deployments-invoke-1) endpoints"
"id":
type: "string"
format: "ulid"
required:
- "property"
- "value"
- "trace_id"
- "id"
"DeploymentGetConfigRequest":
type: "object"
properties:
"key":
type: "string"
description: "The deployment key to invoke"
"inputs":
type: "object"
additionalProperties:
anyOf:
- type: "string"
- type: "number"
- type: "boolean"
description: "Key-value pairs variables to replace in your prompts. If a variable is not provided that is defined in the prompt, the default variables are used."
"context":
type: "object"
additionalProperties: {}
description: "Key-value pairs that match your data model and fields declared in your configuration matrix. If you send multiple prompt keys, the context will be applied to the evaluation of each key."
"prefix_messages":
type: "array"
items:
oneOf:
- type: "object"
properties:
"role":
type: "string"
enum:
- "developer"
description: "The role of the messages author, in this case `developer`."
"content":
type: "string"
description: "The contents of the developer message."
"name":
type: "string"
description: "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
required:
- "role"
- "content"
title: "Developer message"
- type: "object"
properties:
"role":
type: "string"
enum:
- "system"
description: "The role of the messages author, in this case `system`."
"content":
type: "string"
description: "The contents of the system message."
"name":
type: "string"
description: "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
required:
- "role"
- "content"
title: "System message"
- type: "object"
properties:
"role":
type: "string"
enum:
- "user"
description: "The role of the messages author, in this case `user`."
"name":
type: "string"
description: "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
"content":
anyOf:
- type: "string"
description: "The text contents of the message."
- type: "array"
items:
oneOf:
- type: "object"
properties:
"type":
type: "string"
enum:
- "text"
"text":
type: "string"
required:
- "type"
- "text"
- type: "object"
properties:
"type":
type: "string"
enum:
- "image_url"
"image_url":
type: "object"
properties:
"url":
type: "string"
description: "Either a URL of the image or the base64 encoded image data."
"detail":
type: "string"
enum:
- "low"
- "high"
- "auto"
description: "Specifies the detail level of the image."
required:
- "url"
required:
- "type"
- "image_url"
- type: "object"
properties:
"type":
type: "string"
enum:
- "input_audio"
"input_audio":
type: "object"
properties:
"data":
type: "string"
description: "Base64 encoded audio data."
"format":
type: "string"
enum:
- "mp3"
- "wav"
description: "The format of the encoded audio data. Currently supports `wav` and `mp3`."
required:
- "data"
- "format"
required:
- "type"
- "input_audio"
description: "An array of content parts with a defined type. Supported options differ based on the model being used to generate the response. Can contain text, image, or audio inputs."
description: "The contents of the user message."
required:
- "role"
- "content"
title: "User message"
- type: "object"
properties:
"content":
anyOf:
- type: "string"
description: "The contents of the assistant message."
- type: "array"
items:
oneOf:
- type: "object"
properties:
"type":
type: "string"
enum:
- "text"
description: "The type of the content part."
"text":
type: "string"
description: "The text content."
required:
- "type"
- "text"
title: "Text content part"
- type: "object"
properties:
"type":
type: "string"
enum:
- "refusal"
description: "The type of the content part."
"refusal":
type: "string"
description: "The refusal message generated by the model."
required:
- "type"
- "refusal"
title: "Refusal content part"
description: "An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`."
- type: "null"
description: "The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified."
"refusal":
type:
- "string"
- "null"
description: "The refusal message by the assistant."
"role":
type: "string"
enum:
- "assistant"
description: "The role of the messages author, in this case `assistant`."
"name":
type: "string"
description: "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
"audio":
type:
- "object"
- "null"
properties:
"id":
type: "string"
description: "Unique identifier for a previous audio response from the model."
required:
- "id"
description: "Data about a previous audio response from the model. "
"tool_calls":
type: "array"
items:
type: "object"
properties:
"id":
type: "string"
description: "The ID of the tool call."
"type":
type: "string"
enum:
- "function"
description: "The type of the tool. Currently, only `function` is supported."
"function":
type: "object"
properties:
"name":
type: "string"
description: "The name of the function to call."
"arguments":
type: "string"
description: "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."
required:
- "id"
- "type"
- "function"
description: "The tool calls generated by the model, such as function calls."
required:
- "role"
title: "Assistant message"
- type: "object"
properties:
"role":
type: "string"
enum:
- "tool"
description: "The role of the messages author, in this case tool."
"content":
anyOf:
- type: "string"
- type: "array"
items:
type: "string"
description: "The contents of the tool message."
"tool_call_id":
type: "string"
description: "Tool call that this message is responding to."
required:
- "role"
- "content"
- "tool_call_id"
title: "Tool message"
description: "A list of messages to include after the `System` message, but before the `User` and `Assistant` pairs configured in your deployment."
"messages":
type: "array"
items:
oneOf:
- type: "object"
properties:
"role":
type: "string"
enum:
- "developer"
description: "The role of the messages author, in this case `developer`."
"content":
type: "string"
description: "The contents of the developer message."
"name":
type: "string"
description: "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
required:
- "role"
- "content"
title: "Developer message"
- type: "object"
properties:
"role":
type: "string"
enum:
- "system"
description: "The role of the messages author, in this case `system`."
"content":
type: "string"
description: "The contents of the system message."
"name":
type: "string"
description: "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
required:
- "role"
- "content"
title: "System message"
- type: "object"
properties:
"role":
type: "string"
enum:
- "user"
description: "The role of the messages author, in this case `user`."
"name":
type: "string"
description: "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
"content":
anyOf:
- type: "string"
description: "The text contents of the message."
- type: "array"
items:
oneOf:
- type: "object"
properties:
"type":
type: "string"
enum:
- "text"
"text":
type: "string"
required:
- "type"
- "text"
- type: "object"
properties:
"type":
type: "string"
enum:
- "image_url"
"image_url":
type: "object"
properties:
"url":
type: "string"
description: "Either a URL of the image or the base64 encoded image data."
"detail":
type: "string"
enum:
- "low"
- "high"
- "auto"
description: "Specifies the detail level of the image."
required:
- "url"
required:
- "type"
- "image_url"
- type: "object"
properties:
"type":
type: "string"
enum:
- "input_audio"
"input_audio":
type: "object"
properties:
"data":
type: "string"
description: "Base64 encoded audio data."
"format":
type: "string"
enum:
- "mp3"
- "wav"
description: "The format of the encoded audio data. Currently supports `wav` and `mp3`."
required:
- "data"
- "format"
required:
- "type"
- "input_audio"
description: "An array of content parts with a defined type. Supported options differ based on the model being used to generate the response. Can contain text, image, or audio inputs."
description: "The contents of the user message."
required:
- "role"
- "content"
title: "User message"
- type: "object"
properties:
"content":
anyOf:
- type: "string"
description: "The contents of the assistant message."
- type: "array"
items:
oneOf:
- type: "object"
properties:
"type":
type: "string"
enum:
- "text"
description: "The type of the content part."
"text":
type: "string"
description: "The text content."
required:
- "type"
- "text"
title: "Text content part"
- type: "object"
properties:
"type":
type: "string"
enum:
- "refusal"
description: "The type of the content part."
"refusal":
type: "string"
description: "The refusal message generated by the model."
required:
- "type"
- "refusal"
title: "Refusal content part"
description: "An array of content parts with a defined type. Can be one or more of type `text`, or exactly one of type `refusal`."
- type: "null"
description: "The contents of the assistant message. Required unless `tool_calls` or `function_call` is specified."
"refusal":
type:
- "string"
- "null"
description: "The refusal message by the assistant."
"role":
type: "string"
enum:
- "assistant"
description: "The role of the messages author, in this case `assistant`."
"name":
type: "string"
description: "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
"audio":
type:
- "object"
- "null"
properties:
"id":
type: "string"
description: "Unique identifier for a previous audio response from the model."
required:
- "id"
description: "Data about a previous audio response from the model. "
"tool_calls":
type: "array"
items:
type: "object"
properties:
"id":
type: "string"
description: "The ID of the tool call."
"type":
type: "string"
enum:
- "function"
description: "The type of the tool. Currently, only `function` is supported."
"function":
type: "object"
properties:
"name":
type: "string"
description: "The name of the function to call."
"arguments":
type: "string"
description: "The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function."
required:
- "id"
- "type"
- "function"
description: "The tool calls generated by the model, such as function calls."
required:
- "role"
title: "Assistant message"
- type: "object"
properties:
"role":
type: "string"
enum:
- "tool"
description: "The role of the messages author, in this case tool."
"content":
anyOf:
- type: "string"
- type: "array"
items:
type: "string"
description: "The contents of the tool message."
"tool_call_id":
type: "string"
description: "Tool call that this message is responding to."
required:
- "role"
- "content"
- "tool_call_id"
title: "Tool message"
description: "A list of messages to send to the deployment."
"file_ids":
type: "array"
items:
type: "string"
description: "A list of file IDs that are associated with the deployment request."
"metadata":
type: "object"
additionalProperties: {}
description: "Key-value pairs that you want to attach to the log generated by this request."
"extra_params":
type: "object"
additionalProperties: {}
description: "Utilized for passing additional parameters to the model provider. Exercise caution when using this feature, as the included parameters will overwrite any parameters specified in the deployment prompt configuration."
"documents":
type: "array"
items:
type: "object"
properties:
"text":
type: "string"
description: "The text content of the document"
"metadata":
type: "object"
properties:
"file_name":
type: "string"
description: "Name of the file the text is from."
"file_type":
type: "string"
description: "Content type of the file the text is from."
"page_number":
type: "number"
description: "The page number the text is from."
description: "Metadata about the document"
required:
- "text"
description: "A list of relevant documents that evaluators and guardrails can cite to evaluate the user input or the model response based on your deployment settings."
"invoke_options":
type: "object"
properties:
"include_retrievals":
type: "boolean"
default: false
description: "Whether to include the retrieved knowledge chunks in the response."
"mock_response":
type: "string"
description: "A mock response to use instead of calling the LLM API. This is useful for testing purposes. When provided, the system will return a response object with this content as the completion, without making an actual API call to the LLM provider. This works for both streaming and non-streaming requests. Mock responses will not generate logs, traces or be counted for your plan usage."
"thread":
type: "object"
properties:
"id":
type: "string"
description: "Unique thread identifier to group related invocations."
"tags":
type: "array"
items:
type: "string"
description: "Optional tags to differentiate or categorize threads"
required:
- "id"
required:
- "key"
"DeploymentGetConfigResponse":
type: "object"
properties:
"id":
type: "string"
description: "A unique identifier for the response. Can be used to add metrics to the transaction."
"provider":
type: "string"
description: "The provider of the model"
"model":
type: "string"
description: "The model of the configuration"
"type":
type: "string"
enum:
- "chat"
- "completion"
- "embedding"
- "vision"
- "image"
- "tts"
- "stt"
- "rerank"
- "moderations"
description: "The type of the model. Current `chat`,`completion` and `image` are supported"
"version":
type: "string"
description: "The current version of the deployment"
"messages":
type: "array"
items:
type: "object"
properties:
"role":
type: "string"
enum:
- "system"
- "assistant"
- "user"
- "exception"
- "tool"
- "prompt"
- "correction"
- "expected_output"
description: "The role of the prompt message"
"content":
anyOf:
- type: "string"
- type: "array"
items:
oneOf:
- type: "object"
properties:
"type":
type: "string"
enum:
- "text"
"text":
type: "string"
required:
- "type"
- "text"
description: "Text content part of a prompt message"
- type: "object"
properties:
"type":
type: "string"
enum:
- "image_url"
"image_url":
type: "object"
properties:
"id":
type: "string"
format: "ulid"
description: "The orq.ai id of the image"
readOnly: true
"url":
anyOf:
- type: "string"
- type: "string"
format: "uri"
description: "Either a URL of the image or the base64 encoded data URI."
examples:
- "https://picsum.photos/id/1/200/300"
- "data:image/jpeg;base64,/9j/4QDcRXhpZgAASUkqAAgAAAAGABIBAwABAAAAAQAAABoBBQABAAAAVgAAABsBBQABAAAAXgAAACgBAwABAAAAAgAAABMCAwABAAAAAQAAAGmHBAABAAAAZgAAAAAAAABIAAAAAQAAAEgAAAABAAAABwAAkAcABAAAADAyMTABkQcABAAAAAECAwCGkgcAFAAAAMAAAAAAoAcABAAAADAxMDABoAMAAQAAAP//AAACoAQAAQAAADIAAAADoAQAAQAAADIAAAAAAAAAQVNDSUkAAABQaWNzdW0gSUQ6IDH/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wgARCAAyADIDASIAAhEBAxEB/8QAGgAAAwEBAQEAAAAAAAAAAAAAAAUGBAMCAf/EABgBAAMBAQAAAAAAAAAAAAAAAAACAwEE/9oADAMBAAIQAxAAAAGJ8VqTNw8a3ojTukdLSJLgZZlZdd6TV3CHYj9EWPM6bhUaNGKXfClLIL11F7/cfh02i8CpWBzWy5A6I+PgAAB//8QAIhAAAQQCAgIDAQAAAAAAAAAAAQACAwQSEwURFDIgISIj/9oACAEBAAEFAnQPYtaw6HSrfpk1Zpi6U1uqwOvALjX+aJeJ6RjdEYR/LS1X2a7q4WGdtkqbVqFlkbfMcrVEWn16sDBsmY+e+GQvsPmOYWSF47i5rI4ZjhycvcuZWX1sTao2TGJsBsvCL8iSs12nk4D2se/w/8QAHhEAAgIBBQEAAAAAAAAAAAAAAAECESEQEhMgMUH/2gAIAQMBAT8BErRHKo4is0RwSk2b5CT+lrWXnT//xAAbEQACAgMBAAAAAAAAAAAAAAAAAQIREiExIP/aAAgBAgEBPwEbpj1szFtWTVkYJGMRyiuFMssh3x//xAAqEAABAwIEBQMFAAAAAAAAAAABAAIRAxIQITFREyAiI2EyQXEEQlJigf/aAAgBAQAGPwLqGGYOeDmbqWDMYFjiah2aF2aFNnk9RVVv1HcjMSrqOmzlDha7D0hVNjnhfw3WFuqzU1Yt+FbTogjdxXoCFVz7Q0Q5TRYC78no3hwj3jpVwDS8+VLzOIMRC4tIxP27fHhERcVaCMtYHJ+moVmU+wC1IKnm/nL/AP/EACIQAAICAgEEAwEAAAAAAAAAAAERACExQVEQYXGBobHB0f/aAAgBAQABPyEgQjvByg05hUo2LiFjFYI7W43EDiVaHswr6T+yviNWy8EGiuNR40cj6MPOzDuOGmTHfziwMq+76EShwYJ8LmPkvUA0DK7y8RUIwU4Wf1moJxadQT0/YfMYyGLPkJiCZ6Rw+gHEOyLDRUgnkkfo7QoEZmabf4SsxCxwB3gBm9QgAYBbhGy6dySFOwYVeIcGHyxFUUo4LJ6JIxoBUkQiSuY4Ooc9f//aAAwDAQACAAMAAAAQK/6xMJVNTaRAi9cA/8QAHBEBAQEAAgMBAAAAAAAAAAAAAQARECExQVFh/9oACAEDAQE/ENJdCAjLX2X0Wzsr5v0mqx7MJOb3z//EAB0RAQEBAAAHAAAAAAAAAAAAAAEAERAgITFhcaH/2gAIAQIBAT8QxhwZqxessJqwhet4oA+Y0FeQTtx//8QAIxABAAICAQUAAgMAAAAAAAAAAQARITFBUWFxgZEQobHB0f/aAAgBAQABPxB2tTC0xLVUH7haUN2g1vP+RNGh8gq4UTGuGBUZ4MHv3iLSr8RIRqqi6Yv1carl4onc0eoWxjg8RD1aVFzk6f6b9/Y70zAti+Kx71GvjJeYuVsc6QwgBr5D/a/xfW1rFYoOcjjrK7p8CjoUUGXu5eMk0ZEmr6iVhzq4Hhj0LyLoGUvPiDGiXFOoUx6C6YKtA/EOTpu4FoAQGnL1SFVoWNDsQt27RtZg8GOQ6mm5/hiDjAW62BbV23sLxFbn20oMclu8B8lPIPaU4y+1hNDrowVllngQ2LIsGVq3iXxdrsPZu+8NsVhdHaO+tLVdwQ3CKME80BZTdNRSUt7WbPXP6zm5YlVv5//Z"
"detail":
type: "string"
description: "Specifies the detail level of the image. Currently only supported with OpenAI models"
required:
- "url"
required:
- "type"
- "image_url"
description: "The image part of the prompt message. Only supported with vision models."
description: "The contents of the user message. Either the text content of the message or an array of content parts with a defined type, each can be of type `text` or `image_url` when passing in images. You can pass multiple images by adding multiple `image_url` content parts. "
"tool_calls":
type: "array"
items:
type: "object"
properties:
"id":
type: "string"
"index":
type: "number"
"type":
type: "string"
enum:
- "function"
"function":
type: "object"
properties:
"name":
type: "string"
"arguments":
type: "string"
description: "JSON string arguments for the functions"
required:
- "name"
- "arguments"
required:
- "type"
- "function"
required:
- "role"
- "content"
"parameters":
type: "object"
properties:
"temperature":
type: "number"
description: "Only supported on `chat` and `completion` models."
"maxTokens":
type: "number"
description: "Only supported on `chat` and `completion` models."
"topK":
type: "number"
description: "Only supported on `chat` and `completion` models."
"topP":
type: "number"
description: "Only supported on `chat` and `completion` models."
"frequencyPenalty":
type: "number"
description: "Only supported on `chat` and `completion` models."
"presencePenalty":
type: "number"
description: "Only supported on `chat` and `completion` models."
"numImages":
type: "number"
description: "Only supported on `image` models."
"seed":
type: "number"
description: "Best effort deterministic seed for the model. Currently only OpenAI models support these"
"format":
type: "string"
enum:
- "url"
- "b64_json"
- "text"
- "json_object"
description: "Only supported on `image` models."
"dimensions":
type: "string"
description: "Only supported on `image` models."
"quality":
type: "string"
description: "Only supported on `image` models."
"style":
type: "string"
description: "Only supported on `image` models."
"responseFormat":
oneOf:
- type: "object"
properties:
"type":
type: "string"
enum:
- "json_schema"
"json_schema":
type: "object"
properties:
"name":
type: "string"
"strict":
type: "boolean"
"schema":
type: "object"
additionalProperties: {}
required:
- "name"
- "strict"
- "schema"
required:
- "type"
- "json_schema"
- type: "object"
properties:
"type":
type: "string"
enum:
- "json_object"
required:
- "type"
- type: "null"
description: "An object specifying the format that the model must output. \n\n Setting to `{ \"type\": \"json_schema\", \"json_schema\": {...} }` enables Structured Outputs which ensures the model will match your supplied JSON schema \n\n Setting to `{ \"type\": \"json_object\" }` enables JSON mode, which ensures the message the model generates is valid JSON.\n\nImportant: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly \"stuck\" request. Also note that the message content may be partially cut off if finish_reason=\"length\", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length."
"photoRealVersion":
type: "string"
enum:
- "v1"
- "v2"
description: "The version of photoReal to use. Must be v1 or v2. Only available for `leonardoai` provider"
"encoding_format":
type: "string"
enum:
- "float"
- "base64"
description: "The format to return the embeddings"
"reasoningEffort":
type: "string"
enum:
- "low"
- "medium"
- "high"
description: "Constrains effort on reasoning for reasoning models. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response."
"budgetTokens":
type: "number"
description: "Gives the model enhanced reasoning capabilities for complex tasks. A value of 0 disables thinking. The minimum budget tokens for thinking are 1024. The Budget Tokens should never exceed the Max Tokens parameter. Only supported by `Anthropic` "
description: "Model Parameters: Not all parameters apply to every model"
"tools":
type: "array"
items:
type: "object"
properties:
"type":
type: "string"
enum:
- "function"
description: "The type of the tool. Currently, only `function` is supported."
"function":
type: "object"
properties:
"name":
type: "string"
description: "The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64."
"description":
type: "string"
description: "A description of what the function does, used by the model to choose when and how to call the function."
"parameters":
type: "object"
additionalProperties: {}
description: "The parameters the functions accepts, described as a JSON Schema object. \n\n Omitting `parameters` defines a function with an empty parameter list."
required:
- "name"
required:
- "type"
- "function"
description: "A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for."
required:
- "id"
- "provider"
- "model"
- "version"
- "messages"
- "parameters"
"DeploymentMetricsRequest":
type: "object"
properties:
"metadata":
type: "object"
additionalProperties: {}
description: "Your own custom key-value pairs can be attached to the logs. This is useful for storing additional information related to your interactions with the LLM providers or specifics within your application."
"usage":
type: "object"
properties:
"prompt_tokens":
type: "number"
description: "Number of tokens in the prompt."
"completion_tokens":
type: "number"
description: "Number of tokens in the generated completion."
"total_tokens":
type: "number"
description: "Total number of tokens used in the request (prompt + completion)."
required:
- "prompt_tokens"
- "completion_tokens"
description: "Usage statistics to add to the deployment"
"performance":
type: "object"
properties:
"latency":
type: "number"
description: "Total time in milliseconds of the request to the LLM provider API."
"time_to_first_token":
type: "number"
description: "Total time in milliseconds to generate the first token of the completion."
required:
- "latency"
"messages":
type: "array"
items:
oneOf:
- type: "object"
properties:
"role":
type: "string"
enum:
- "developer"
description: "The role of the messages author, in this case `developer`."
"content":
type: "string"
description: "The contents of the developer message."
"name":
type: "string"
description: "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
required:
- "role"
- "content"
title: "Developer message"
- type: "object"
properties:
"role":
type: "string"
enum:
- "system"
description: "The role of the messages author, in this case `system`."
"content":
type: "string"
description: "The contents of the system message."
"name":
type: "string"
description: "An optional name for the participant. Provides the model information to differentiate between participants of the same role."
required:
- "role"
- "content"
title: "System message"
- type: "object"