-
Notifications
You must be signed in to change notification settings - Fork 96
/
Copy pathopenapi.yaml
630 lines (630 loc) · 14.9 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
openapi: 3.0.2
info:
title: LangSmith
version: 0.1.0
paths:
/runs/{run_id}:
patch:
tags:
- run
summary: Update Run
description: Update a run.
operationId: update_run_runs__run_id__patch
parameters:
- required: true
schema:
title: Run Id
type: string
format: uuid
name: run_id
in: path
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RunUpdateSchemaExtended'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/runs:
post:
tags:
- run
summary: Create Run
description: Create a new run.
operationId: create_run_runs_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RunCreateSchemaExtended'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
RunUpdateSchemaExtended:
title: RunUpdateSchemaExtended
type: object
properties:
end_time:
title: End Time
type: string
format: date-time
error:
title: Error
type: string
inputs:
title: Inputs
anyOf:
- type: object
- $ref: '#/components/schemas/CreateChatCompletionRequest'
- $ref: '#/components/schemas/CreateCompletionRequest'
outputs:
title: Outputs
anyOf:
- type: object
- $ref: '#/components/schemas/CreateChatCompletionResponse'
- $ref: '#/components/schemas/CreateCompletionResponse'
events:
title: Events
type: array
items:
type: object
CreateChatCompletionRequest:
title: CreateChatCompletionRequest
type: object
properties:
model:
title: Model
type: string
default: ''
messages:
title: Messages
type: array
items:
$ref: '#/components/schemas/ChatCompletionRequestMessage'
default: []
functions:
title: Functions
type: array
items:
$ref: '#/components/schemas/ChatCompletionFunctions'
default: []
temperature:
title: Temperature
type: number
top_p:
title: Top P
type: number
n:
title: N
type: integer
stream:
title: Stream
type: boolean
stop:
title: Stop
anyOf:
- type: string
- type: array
items:
type: string
max_tokens:
title: Max Tokens
type: integer
presence_penalty:
title: Presence Penalty
type: number
frequency_penalty:
title: Frequency Penalty
type: number
logit_bias:
title: Logit Bias
type: object
additionalProperties:
type: integer
ChatCompletionRequestMessage:
title: ChatCompletionRequestMessage
type: object
properties:
role:
title: Role
type: string
default: ''
content:
title: Content
type: string
name:
title: Name
type: string
function_call:
$ref: '#/components/schemas/ChatCompletionFunctionCall'
ChatCompletionFunctionCall:
title: ChatCompletionFunctionCall
type: object
properties:
name:
title: Name
type: string
default: ''
arguments:
title: Arguments
type: string
default: ''
ChatCompletionFunctions:
title: ChatCompletionFunctions
type: object
properties:
name:
title: Name
type: string
default: ''
description:
title: Description
type: string
default: ''
parameters:
$ref: '#/components/schemas/ChatCompletionFunctionParameters'
ChatCompletionFunctionParameters:
title: ChatCompletionFunctionParameters
type: object
properties:
type:
title: Type
type: string
default: ''
properties:
title: Properties
type: object
default: {}
CreateCompletionRequest:
title: CreateCompletionRequest
required:
- model
- prompt
type: object
properties:
model:
title: Model
anyOf:
- type: string
- type: object
additionalProperties:
anyOf:
- type: string
- type: array
items:
type: string
prompt:
title: Prompt
anyOf:
- type: string
- type: array
items:
type: string
- type: array
items:
type: integer
- type: array
items:
type: array
items:
type: integer
suffix:
title: Suffix
type: string
max_tokens:
title: Max Tokens
type: integer
temperature:
title: Temperature
type: number
top_p:
title: Top P
type: number
n:
title: N
type: integer
stream:
title: Stream
type: boolean
logprobs:
title: Logprobs
type: integer
echo:
title: Echo
type: boolean
stop:
title: Stop
anyOf:
- type: string
- type: array
items:
type: string
presence_penalty:
title: Presence Penalty
type: number
frequency_penalty:
title: Frequency Penalty
type: number
best_of:
title: Best Of
type: integer
logit_bias:
title: Logit Bias
type: object
additionalProperties:
type: integer
user:
title: User
type: string
CreateChatCompletionResponse:
title: CreateChatCompletionResponse
type: object
properties:
id:
title: Id
type: string
default: ''
object:
title: Object
type: string
default: ''
created:
title: Created
type: integer
default: 0
model:
title: Model
type: string
default: ''
choices:
title: Choices
type: array
items:
$ref: '#/components/schemas/ChatCompletionChoice'
default: []
usage:
$ref: '#/components/schemas/CompletionUsage'
ChatCompletionChoice:
title: ChatCompletionChoice
type: object
properties:
index:
title: Index
type: integer
default: 0
message:
$ref: '#/components/schemas/ChatCompletionResponseMessage'
finish_reason:
title: Finish Reason
type: string
default: ''
ChatCompletionResponseMessage:
title: ChatCompletionResponseMessage
type: object
properties:
role:
title: Role
type: string
default: ''
content:
title: Content
type: string
function_call:
$ref: '#/components/schemas/ChatCompletionFunctionCall'
CompletionUsage:
title: CompletionUsage
type: object
properties:
prompt_tokens:
title: Prompt Tokens
type: integer
default: 0
completion_tokens:
title: Completion Tokens
type: integer
default: 0
total_tokens:
title: Total Tokens
type: integer
default: 0
CreateCompletionResponse:
title: CreateCompletionResponse
type: object
properties:
id:
title: Id
type: string
object:
title: Object
type: string
created:
title: Created
type: string
model:
title: Model
type: string
choices:
title: Choices
type: array
items:
$ref: '#/components/schemas/Choice'
default: []
usage:
$ref: '#/components/schemas/CompletionUsage'
Choice:
title: Choice
type: object
properties:
text:
title: Text
type: string
default: ''
index:
title: Index
type: integer
default: 0
logprobs:
$ref: '#/components/schemas/Logprobs'
finish_reason:
title: Finish Reason
type: string
default: ''
Logprobs:
title: Logprobs
type: object
properties:
tokens:
title: Tokens
type: array
items:
type: string
default: []
token_logprobs:
title: Token Logprobs
type: array
items:
type: number
default: []
top_logprobs:
title: Top Logprobs
type: array
items:
type: object
additionalProperties:
type: integer
default: []
text_offset:
title: Text Offset
type: array
items:
type: integer
default: []
HTTPValidationError:
title: HTTPValidationError
type: object
properties:
detail:
title: Detail
type: array
items:
$ref: '#/components/schemas/ValidationError'
ValidationError:
title: ValidationError
required:
- loc
- msg
- type
type: object
properties:
loc:
title: Location
type: array
items:
anyOf:
- type: string
- type: integer
msg:
title: Message
type: string
type:
title: Error Type
type: string
RunCreateSchemaExtended:
title: RunCreateSchemaExtended
required:
- name
- run_type
type: object
properties:
name:
title: Name
type: string
inputs:
title: Inputs
anyOf:
- type: object
- $ref: '#/components/schemas/CreateChatCompletionRequest'
- $ref: '#/components/schemas/CreateCompletionRequest'
run_type:
$ref: '#/components/schemas/RunTypeEnum'
start_time:
title: Start Time
type: string
format: date-time
end_time:
title: End Time
type: string
format: date-time
extra:
title: Extra
type: object
error:
title: Error
type: string
execution_order:
title: Execution Order
minimum: 1.0
type: integer
default: 1
serialized:
title: Serialized
type: object
outputs:
title: Outputs
anyOf:
- type: object
- $ref: '#/components/schemas/CreateChatCompletionResponse'
- $ref: '#/components/schemas/CreateCompletionResponse'
parent_run_id:
title: Parent Run Id
type: string
format: uuid
manifest_id:
title: Manifest Id
type: string
format: uuid
events:
title: Events
type: array
items:
type: object
tags:
title: Tags
type: array
items:
type: string
id:
title: Id
type: string
format: uuid
session_id:
title: Session Id
type: string
format: uuid
session_name:
title: Session Name
type: string
child_runs:
title: Child Runs
type: array
items:
$ref: '#/components/schemas/RunCreateSchema'
reference_example_id:
title: Reference Example Id
type: string
format: uuid
description: Create class for a run object, with additional typehints.
RunTypeEnum:
title: RunTypeEnum
enum:
- tool
- chain
- llm
- retriever
- embedding
- prompt
- parser
type: string
description: Enum for run types.
RunCreateSchema:
title: RunCreateSchema
required:
- name
- run_type
type: object
properties:
name:
title: Name
type: string
inputs:
title: Inputs
type: object
run_type:
$ref: '#/components/schemas/RunTypeEnum'
start_time:
title: Start Time
type: string
format: date-time
end_time:
title: End Time
type: string
format: date-time
extra:
title: Extra
type: object
error:
title: Error
type: string
execution_order:
title: Execution Order
minimum: 1.0
type: integer
default: 1
serialized:
title: Serialized
type: object
outputs:
title: Outputs
type: object
parent_run_id:
title: Parent Run Id
type: string
format: uuid
manifest_id:
title: Manifest Id
type: string
format: uuid
events:
title: Events
type: array
items:
type: object
tags:
title: Tags
type: array
items:
type: string
id:
title: Id
type: string
format: uuid
session_id:
title: Session Id
type: string
format: uuid
session_name:
title: Session Name
type: string
child_runs:
title: Child Runs
type: array
items:
$ref: '#/components/schemas/RunCreateSchema'
reference_example_id:
title: Reference Example Id
type: string
format: uuid
description: Create class for a Run object.