generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 0
/
models.yml
222 lines (208 loc) · 5.34 KB
/
models.yml
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
openapi: 3.0.0
info:
title: Models API
version: 1.0.0
description: API for retrieving information about available LLM models, including base models and fine-tuned models
paths:
/v1/models/base:
get:
summary: List all available base LLM models
tags:
- Base Models
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/ItemsPerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/BaseModelResponse'
pagination:
$ref: '#/components/schemas/Pagination'
'401':
$ref: '#/components/responses/Unauthorized'
/v1/models/base/{model_name}:
get:
summary: Get detailed information about a specific base model
tags:
- Base Models
security:
- ApiKeyAuth: []
parameters:
- name: model_name
in: path
required: true
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BaseModelResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
/v1/models/fine-tuned:
get:
summary: List all fine-tuned models for the current user
tags:
- Fine-tuned Models
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/PageParam'
- $ref: '#/components/parameters/ItemsPerPageParam'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/FineTunedModelResponse'
pagination:
$ref: '#/components/schemas/Pagination'
'401':
$ref: '#/components/responses/Unauthorized'
/v1/models/fine-tuned/{model_name}:
get:
summary: Get detailed information about a specific fine-tuned model
tags:
- Fine-tuned Models
security:
- ApiKeyAuth: []
parameters:
- name: model_name
in: path
required: true
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/FineTunedModelResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
components:
schemas:
BaseModelResponse:
type: object
properties:
id:
type: string
format: uuid
description:
type: string
hf_url:
type: string
status:
type: string
enum: [ACTIVE, INACTIVE, DEPRECATED]
name:
type: string
meta:
type: object
additionalProperties: true
FineTunedModelResponse:
type: object
properties:
id:
type: string
format: uuid
created_at:
type: string
format: date-time
fine_tuning_job_name:
type: string
name:
type: string
description:
type: string
artifacts:
type: object
additionalProperties: true
Pagination:
type: object
properties:
total_pages:
type: integer
current_page:
type: integer
items_per_page:
type: integer
ErrorResponse:
type: object
properties:
status:
type: integer
message:
type: string
responses:
BadRequest:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
Forbidden:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
parameters:
PageParam:
in: query
name: page
schema:
type: integer
default: 1
minimum: 1
description: Page number to retrieve
ItemsPerPageParam:
in: query
name: items_per_page
schema:
type: integer
default: 20
minimum: 1
maximum: 100
description: Number of items to return per page
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key