Skip to content

Commit 94d6407

Browse files
authored
Batch API file purpose (#251)
1 parent b4d127c commit 94d6407

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

openapi.yaml

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6718,7 +6718,7 @@ paths:
67186718
{
67196719
"id": "batch_abc123",
67206720
"object": "batch",
6721-
"endpoint": "/v1/completions",
6721+
"endpoint": "/v1/chat/completions",
67226722
"errors": null,
67236723
"input_file_id": "file-abc123",
67246724
"completion_window": "24h",
@@ -6806,7 +6806,7 @@ paths:
68066806
{
68076807
"id": "batch_abc123",
68086808
"object": "batch",
6809-
"endpoint": "/v1/completions",
6809+
"endpoint": "/v1/chat/completions",
68106810
"errors": null,
68116811
"input_file_id": "file-abc123",
68126812
"completion_window": "24h",
@@ -6969,7 +6969,7 @@ paths:
69696969
{
69706970
"id": "batch_abc123",
69716971
"object": "batch",
6972-
"endpoint": "/v1/completions",
6972+
"endpoint": "/v1/chat/completions",
69736973
"errors": null,
69746974
"input_file_id": "file-abc123",
69756975
"completion_window": "24h",
@@ -8592,9 +8592,9 @@ components:
85928592
description: |
85938593
The intended purpose of the uploaded file.
85948594
8595-
Use "fine-tune" for [Fine-tuning](/docs/api-reference/fine-tuning) and "assistants" for [Assistants](/docs/api-reference/assistants) and [Messages](/docs/api-reference/messages). This allows us to validate the format of the uploaded file is correct for fine-tuning.
8595+
Use "assistants" for [Assistants](/docs/api-reference/assistants) and [Messages](/docs/api-reference/messages), "batch" for [Batch API](/docs/guides/batch), and "fine-tune" for [Fine-tuning](/docs/api-reference/fine-tuning).
85968596
type: string
8597-
enum: ["fine-tune", "assistants"]
8597+
enum: ["assistants", "batch", "fine-tune"]
85988598
required:
85998599
- file
86008600
- purpose
@@ -9225,13 +9225,16 @@ components:
92259225
enum: ["file"]
92269226
purpose:
92279227
type: string
9228-
description: The intended purpose of the file. Supported values are `fine-tune`, `fine-tune-results`, `assistants`, and `assistants_output`.
9228+
description: The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, and `fine-tune-results`.
92299229
enum:
92309230
[
9231-
"fine-tune",
9232-
"fine-tune-results",
92339231
"assistants",
92349232
"assistants_output",
9233+
"batch",
9234+
"batch_output",
9235+
"fine-tune",
9236+
"fine-tune-results",
9237+
92359238
]
92369239
status:
92379240
type: string
@@ -13045,7 +13048,7 @@ x-oaiMeta:
1304513048
- id: files
1304613049
title: Files
1304713050
description: |
13048-
Files are used to upload documents that can be used with features like [Assistants](/docs/api-reference/assistants) and [Fine-tuning](/docs/api-reference/fine-tuning).
13051+
Files are used to upload documents that can be used with features like [Assistants](/docs/api-reference/assistants), [Fine-tuning](/docs/api-reference/fine-tuning), and [Batch API](/docs/guides/batch).
1304913052
navigationGroup: endpoints
1305013053
sections:
1305113054
- type: endpoint

0 commit comments

Comments
 (0)