FilesOperations interface
Interface representing a Files operations.
Properties
| delete | Delete a previously uploaded file. |
| get | Returns information about a specific file. Does not retrieve file content. |
| get |
Retrieves the raw content of a specific file. |
| list | Gets a list of previously uploaded files. |
| upload | Uploads a file for use by other operations. |
| upload |
Uploads a file for use by other operations with polling |
Property Details
delete
Delete a previously uploaded file.
delete: (fileId: string, options?: FilesDeleteFileOptionalParams) => Promise<FileDeletionStatus>Property Value
(fileId: string, options?: FilesDeleteFileOptionalParams) => Promise<FileDeletionStatus>
get
Returns information about a specific file. Does not retrieve file content.
get: (fileId: string, options?: FilesGetFileOptionalParams) => Promise<FileInfo>Property Value
(fileId: string, options?: FilesGetFileOptionalParams) => Promise<FileInfo>
getContent
Retrieves the raw content of a specific file.
getContent: (fileId: string, options?: FilesGetFileContentOptionalParams) => StreamableMethod<string | Uint8Array>Property Value
(fileId: string, options?: FilesGetFileContentOptionalParams) => StreamableMethod<string | Uint8Array>
list
Gets a list of previously uploaded files.
list: (options?: FilesListFilesOptionalParams) => Promise<FileListResponse>Property Value
(options?: FilesListFilesOptionalParams) => Promise<FileListResponse>
upload
Uploads a file for use by other operations.
upload: (file: ReadableStream<Uint8Array> | ReadableStream, purpose: FilePurpose, options: FilesUploadFileOptionalParams) => Promise<FileInfo>Property Value
(file: ReadableStream<Uint8Array> | ReadableStream, purpose: FilePurpose, options: FilesUploadFileOptionalParams) => Promise<FileInfo>
uploadAndPoll
Uploads a file for use by other operations with polling
uploadAndPoll: (file: ReadableStream<Uint8Array> | ReadableStream, purpose: FilePurpose, options: FilesUploadFileOptionalParams) => PollerLike<OperationState<FileInfo>, FileInfo>Property Value
(file: ReadableStream<Uint8Array> | ReadableStream, purpose: FilePurpose, options: FilesUploadFileOptionalParams) => PollerLike<OperationState<FileInfo>, FileInfo>
