Skip to content

Commit e37b454

Browse files
authored
Merge pull request #233 from openai/dev/steve/update-from-snapshot
Update OpenAPI spec
2 parents 23e75ca + 4319e79 commit e37b454

File tree

1 file changed

+38
-19
lines changed

1 file changed

+38
-19
lines changed

openapi.yaml

Lines changed: 38 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1704,14 +1704,14 @@ paths:
17041704
from openai import OpenAI
17051705
client = OpenAI()
17061706
1707-
content = client.files.retrieve_content("file-abc123")
1707+
content = client.files.content("file-abc123")
17081708
node.js: |
17091709
import OpenAI from "openai";
17101710
17111711
const openai = new OpenAI();
17121712
17131713
async function main() {
1714-
const file = await openai.files.retrieveContent("file-abc123");
1714+
const file = await openai.files.content("file-abc123");
17151715
17161716
console.log(file);
17171717
}
@@ -5578,7 +5578,7 @@ paths:
55785578
from openai import OpenAI
55795579
client = OpenAI()
55805580
5581-
vector_stores = client.vector_stores.list()
5581+
vector_stores = client.beta.vector_stores.list()
55825582
print(vector_stores)
55835583
node.js: |
55845584
import OpenAI from "openai";
@@ -5664,7 +5664,7 @@ paths:
56645664
from openai import OpenAI
56655665
client = OpenAI()
56665666
5667-
vector_store = client.vector_stores.create(
5667+
vector_store = client.beta.vector_stores.create(
56685668
name="Support FAQ"
56695669
)
56705670
print(vector_store)
@@ -5732,7 +5732,7 @@ paths:
57325732
from openai import OpenAI
57335733
client = OpenAI()
57345734
5735-
vector_store = client.vector_stores.retrieve(
5735+
vector_store = client.beta.vector_stores.retrieve(
57365736
vector_store_id="vs_abc123"
57375737
)
57385738
print(vector_store)
@@ -5798,7 +5798,7 @@ paths:
57985798
from openai import OpenAI
57995799
client = OpenAI()
58005800
5801-
vector_store = client.vector_stores.update(
5801+
vector_store = client.beta.vector_stores.update(
58025802
vector_store_id="vs_abc123",
58035803
name="Support FAQ"
58045804
)
@@ -5870,7 +5870,7 @@ paths:
58705870
from openai import OpenAI
58715871
client = OpenAI()
58725872
5873-
deleted_vector_store = client.vector_stores.delete(
5873+
deleted_vector_store = client.beta.vector_stores.delete(
58745874
vector_store_id="vs_abc123"
58755875
)
58765876
print(deleted_vector_store)
@@ -5959,7 +5959,7 @@ paths:
59595959
from openai import OpenAI
59605960
client = OpenAI()
59615961
5962-
vector_store_files = client.vector_stores.files.list(
5962+
vector_store_files = client.beta.vector_stores.files.list(
59635963
vector_store_id="vs_abc123"
59645964
)
59655965
print(vector_store_files)
@@ -6052,7 +6052,7 @@ paths:
60526052
const openai = new OpenAI();
60536053
60546054
async function main() {
6055-
const myVectorStoreFile = await openai.beta.vector_stores.files.create(
6055+
const myVectorStoreFile = await openai.beta.vectorStores.files.create(
60566056
"vs_abc123",
60576057
{
60586058
file_id: "file-abc123"
@@ -6114,7 +6114,7 @@ paths:
61146114
from openai import OpenAI
61156115
client = OpenAI()
61166116
6117-
vector_store_file = client.vector_stores.files.retrieve(
6117+
vector_store_file = client.beta.vector_stores.files.retrieve(
61186118
vector_store_id="vs_abc123",
61196119
file_id="file-abc123"
61206120
)
@@ -6191,7 +6191,7 @@ paths:
61916191
const openai = new OpenAI();
61926192
61936193
async function main() {
6194-
const deletedVectorStoreFile = await openai.beta.vector_stores.files.del(
6194+
const deletedVectorStoreFile = await openai.beta.vectorStores.files.del(
61956195
"vs_abc123",
61966196
"file-abc123"
61976197
);
@@ -6253,7 +6253,7 @@ paths:
62536253
from openai import OpenAI
62546254
client = OpenAI()
62556255
6256-
vector_store_file_batch = client.beta.vector_stores.fileBatches.create(
6256+
vector_store_file_batch = client.beta.vector_stores.file_batches.create(
62576257
vector_store_id="vs_abc123",
62586258
file_ids=["file-abc123", "file-abc456"]
62596259
)
@@ -6263,7 +6263,7 @@ paths:
62636263
const openai = new OpenAI();
62646264
62656265
async function main() {
6266-
const myVectorStoreFileBatch = await openai.beta.vector_stores.fileBatches.create(
6266+
const myVectorStoreFileBatch = await openai.beta.vectorStores.fileBatches.create(
62676267
"vs_abc123",
62686268
{
62696269
file_ids: ["file-abc123", "file-abc456"]
@@ -6333,7 +6333,7 @@ paths:
63336333
from openai import OpenAI
63346334
client = OpenAI()
63356335
6336-
vector_store_file_batch = client.vector_stores.fileBatches.retrieve(
6336+
vector_store_file_batch = client.beta.vector_stores.file_batches.retrieve(
63376337
vector_store_id="vs_abc123",
63386338
batch_id="vsfb_abc123"
63396339
)
@@ -6402,7 +6402,7 @@ paths:
64026402
from openai import OpenAI
64036403
client = OpenAI()
64046404
6405-
deleted_vector_store_file_batch = client.vector_stores.fileBatches.cancel(
6405+
deleted_vector_store_file_batch = client.beta.vector_stores.file_batches.cancel(
64066406
vector_store_id="vs_abc123",
64076407
file_batch_id="vsfb_abc123"
64086408
)
@@ -6508,7 +6508,7 @@ paths:
65086508
from openai import OpenAI
65096509
client = OpenAI()
65106510
6511-
vector_store_files = client.vector_stores.fileBatches.files.list(
6511+
vector_store_files = client.beta.vector_stores.file_batches.files.list(
65126512
vector_store_id="vs_abc123",
65136513
batch_id="vsfb_abc123"
65146514
)
@@ -6609,6 +6609,15 @@ paths:
66096609
"endpoint": "/v1/chat/completions",
66106610
"completion_window": "24h"
66116611
}'
6612+
python: |
6613+
from openai import OpenAI
6614+
client = OpenAI()
6615+
6616+
client.batches.create(
6617+
input_file_id="file-abc123",
6618+
endpoint="/v1/chat/completions",
6619+
completion_window="24h"
6620+
)
66126621
response: |
66136622
{
66146623
"id": "batch_abc123",
@@ -6745,6 +6754,11 @@ paths:
67456754
curl https://api.openai.com/v1/batches/batch_abc123 \
67466755
-H "Authorization: Bearer $OPENAI_API_KEY" \
67476756
-H "Content-Type: application/json" \
6757+
python: |
6758+
from openai import OpenAI
6759+
client = OpenAI()
6760+
6761+
client.batches.retrieve("batch_abc123")
67486762
response: &batch_object |
67496763
{
67506764
"id": "batch_abc123",
@@ -6807,6 +6821,11 @@ paths:
68076821
-H "Authorization: Bearer $OPENAI_API_KEY" \
68086822
-H "Content-Type: application/json" \
68096823
-X POST
6824+
python: |
6825+
from openai import OpenAI
6826+
client = OpenAI()
6827+
6828+
client.batches.cancel("batch_abc123")
68106829
response: |
68116830
{
68126831
"id": "batch_abc123",
@@ -10773,7 +10792,7 @@ components:
1077310792
file_id:
1077410793
type: string
1077510794
description: The ID of the file to attach to the message.
10776-
add_to:
10795+
tools:
1077710796
type: array
1077810797
items:
1077910798
type: string
@@ -10903,15 +10922,15 @@ components:
1090310922
file_id:
1090410923
type: string
1090510924
description: The ID of the file to attach to the message.
10906-
add_to:
10925+
tools:
1090710926
type: array
1090810927
items:
1090910928
type: string
1091010929
enum: ["file_search", "code_interpreter"]
1091110930
description: A list of files attached to the message, and the tools they should be added to.
1091210931
required:
1091310932
- file_id
10914-
- add_to
10933+
- tools
1091510934
nullable: true
1091610935
metadata:
1091710936
description: *metadata_description

0 commit comments

Comments
 (0)