45 added, 0 removed.
files.delete(file_id) -> FileDeleted
delete /files/{file_id}
Delete a file and remove it from all vector stores.
file_id: Stringclass FileDeleted
id: String
deleted: bool
object: :file
:filerequire "openai"
openai = OpenAI::Client.new(api_key: "My API Key")
file_deleted = openai.files.delete("file_id")
puts(file_deleted)
{
"id": "id",
"deleted": true,
"object": "file"
}
1## Delete file
2
3`files.delete(file_id) -> FileDeleted`
4
5**delete** `/files/{file_id}`
6
7Delete a file and remove it from all vector stores.
8
9### Parameters
10
11- `file_id: String`
12
13### Returns
14
15- `class FileDeleted`
16
17 - `id: String`
18
19 - `deleted: bool`
20
21 - `object: :file`
22
23 - `:file`
24
25### Example
26
27```ruby
28require "openai"
29
30openai = OpenAI::Client.new(api_key: "My API Key")
31
32file_deleted = openai.files.delete("file_id")
33
34puts(file_deleted)
35```
36
37#### Response
38
39```json
40{
41 "id": "id",
42 "deleted": true,
43 "object": "file"
44}
45```