Skip to content

Commit 3d93711

Browse files
committed
feat: convert Files API to use FastAPI router
Signed-off-by: Matthew F Leader <mleader@redhat.com>
1 parent 722d9c5 commit 3d93711

22 files changed

Lines changed: 1299 additions & 535 deletions

File tree

client-sdks/stainless/openapi.yml

Lines changed: 156 additions & 60 deletions
Large diffs are not rendered by default.
Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
---
2-
description: |
3-
Files
4-
5-
This API is used to upload documents that can be used with other Llama Stack APIs.
2+
description: "Files API for managing file uploads and retrieval."
63
sidebar_label: Files
74
title: Files
85
---
@@ -11,8 +8,6 @@ title: Files
118

129
## Overview
1310

14-
Files
15-
16-
This API is used to upload documents that can be used with other Llama Stack APIs.
11+
Files API for managing file uploads and retrieval.
1712

1813
This section contains documentation for all available providers for the **files** API.

docs/static/deprecated-llama-stack-spec.yaml

Lines changed: 107 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3092,19 +3092,24 @@ components:
30923092
$ref: '#/components/schemas/OpenAIFileObject'
30933093
type: array
30943094
title: Data
3095+
description: The list of files.
30953096
has_more:
30963097
type: boolean
30973098
title: Has More
3099+
description: Whether there are more files available beyond this page.
30983100
first_id:
30993101
type: string
31003102
title: First Id
3103+
description: The ID of the first file in the list for pagination.
31013104
last_id:
31023105
type: string
31033106
title: Last Id
3107+
description: The ID of the last file in the list for pagination.
31043108
object:
31053109
type: string
31063110
const: list
31073111
title: Object
3112+
description: The object type, which is always 'list'.
31083113
default: list
31093114
type: object
31103115
required:
@@ -3120,24 +3125,31 @@ components:
31203125
type: string
31213126
const: file
31223127
title: Object
3128+
description: The object type, which is always 'file'.
31233129
default: file
31243130
id:
31253131
type: string
31263132
title: Id
3133+
description: The file identifier, which can be referenced in the API endpoints.
31273134
bytes:
31283135
type: integer
31293136
title: Bytes
3137+
description: The size of the file, in bytes.
31303138
created_at:
31313139
type: integer
31323140
title: Created At
3141+
description: The Unix timestamp (in seconds) for when the file was created.
31333142
expires_at:
31343143
type: integer
31353144
title: Expires At
3145+
description: The Unix timestamp (in seconds) for when the file expires.
31363146
filename:
31373147
type: string
31383148
title: Filename
3149+
description: The name of the file.
31393150
purpose:
31403151
$ref: '#/components/schemas/OpenAIFilePurpose'
3152+
description: The intended purpose of the file.
31413153
type: object
31423154
required:
31433155
- id
@@ -3154,35 +3166,35 @@ components:
31543166
type: string
31553167
const: created_at
31563168
title: Anchor
3169+
description: The anchor point for expiration, must be 'created_at'.
31573170
seconds:
31583171
type: integer
31593172
maximum: 2592000.0
31603173
minimum: 3600.0
31613174
title: Seconds
3175+
description: Seconds until expiration, between 3600 (1 hour) and 2592000 (30 days).
31623176
type: object
31633177
required:
31643178
- anchor
31653179
- seconds
31663180
title: ExpiresAfter
3167-
description: |-
3168-
Control expiration of uploaded files.
3169-
3170-
Params:
3171-
- anchor, must be "created_at"
3172-
- seconds, must be int between 3600 and 2592000 (1 hour to 30 days)
3181+
description: Control expiration of uploaded files.
31733182
OpenAIFileDeleteResponse:
31743183
properties:
31753184
id:
31763185
type: string
31773186
title: Id
3187+
description: The file identifier that was deleted.
31783188
object:
31793189
type: string
31803190
const: file
31813191
title: Object
3192+
description: The object type, which is always 'file'.
31823193
default: file
31833194
deleted:
31843195
type: boolean
31853196
title: Deleted
3197+
description: Whether the file was successfully deleted.
31863198
type: object
31873199
required:
31883200
- id
@@ -8634,25 +8646,28 @@ components:
86348646
- output_tokens_details
86358647
- total_tokens
86368648
title: BatchUsage
8637-
Body_openai_upload_file_v1_files_post:
8649+
Body_upload_file_v1_files_post:
86388650
properties:
86398651
file:
86408652
type: string
86418653
format: binary
86428654
title: File
8655+
description: The file to upload.
86438656
purpose:
86448657
$ref: '#/components/schemas/OpenAIFilePurpose'
8658+
description: The intended purpose of the uploaded file.
86458659
expires_after:
86468660
anyOf:
86478661
- $ref: '#/components/schemas/ExpiresAfter'
86488662
title: ExpiresAfter
86498663
- type: 'null'
8664+
description: Optional expiration settings.
86508665
title: ExpiresAfter
86518666
type: object
86528667
required:
86538668
- file
86548669
- purpose
8655-
title: Body_openai_upload_file_v1_files_post
8670+
title: Body_upload_file_v1_files_post
86568671
Chunk-Input:
86578672
properties:
86588673
content:
@@ -10638,6 +10653,90 @@ components:
1063810653
- adapter_type
1063910654
title: RemoteProviderSpec
1064010655
type: object
10656+
ListFilesRequest:
10657+
description: Request model for listing files.
10658+
properties:
10659+
after:
10660+
anyOf:
10661+
- type: string
10662+
- type: 'null'
10663+
description: A cursor for pagination. Returns files after this ID.
10664+
nullable: true
10665+
limit:
10666+
anyOf:
10667+
- type: integer
10668+
- type: 'null'
10669+
default: 10000
10670+
description: Maximum number of files to return (1-10,000).
10671+
order:
10672+
anyOf:
10673+
- $ref: '#/components/schemas/Order'
10674+
title: Order
10675+
- type: 'null'
10676+
default: desc
10677+
description: Sort order by created_at timestamp ('asc' or 'desc').
10678+
title: Order
10679+
purpose:
10680+
anyOf:
10681+
- $ref: '#/components/schemas/OpenAIFilePurpose'
10682+
title: OpenAIFilePurpose
10683+
- type: 'null'
10684+
description: Filter files by purpose.
10685+
nullable: true
10686+
title: OpenAIFilePurpose
10687+
title: ListFilesRequest
10688+
type: object
10689+
RetrieveFileRequest:
10690+
description: Request model for retrieving a file.
10691+
properties:
10692+
file_id:
10693+
description: The ID of the file to retrieve.
10694+
title: File Id
10695+
type: string
10696+
required:
10697+
- file_id
10698+
title: RetrieveFileRequest
10699+
type: object
10700+
DeleteFileRequest:
10701+
description: Request model for deleting a file.
10702+
properties:
10703+
file_id:
10704+
description: The ID of the file to delete.
10705+
title: File Id
10706+
type: string
10707+
required:
10708+
- file_id
10709+
title: DeleteFileRequest
10710+
type: object
10711+
RetrieveFileContentRequest:
10712+
description: Request model for retrieving file content.
10713+
properties:
10714+
file_id:
10715+
description: The ID of the file to retrieve content from.
10716+
title: File Id
10717+
type: string
10718+
required:
10719+
- file_id
10720+
title: RetrieveFileContentRequest
10721+
type: object
10722+
UploadFileRequest:
10723+
description: Request model for uploading a file.
10724+
properties:
10725+
purpose:
10726+
$ref: '#/components/schemas/OpenAIFilePurpose'
10727+
description: The intended purpose of the uploaded file.
10728+
expires_after:
10729+
anyOf:
10730+
- $ref: '#/components/schemas/ExpiresAfter'
10731+
title: ExpiresAfter
10732+
- type: 'null'
10733+
description: Optional expiration settings for the file.
10734+
nullable: true
10735+
title: ExpiresAfter
10736+
required:
10737+
- purpose
10738+
title: UploadFileRequest
10739+
type: object
1064110740
PostTrainingJobLogStream:
1064210741
description: Stream of logs from a finetuning job.
1064310742
properties:

0 commit comments

Comments
 (0)