Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Batch API file purpose #251

Merged
merged 1 commit into from
May 8, 2024
Merged

Batch API file purpose #251

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6718,7 +6718,7 @@ paths:
{
"id": "batch_abc123",
"object": "batch",
"endpoint": "/v1/completions",
"endpoint": "/v1/chat/completions",
"errors": null,
"input_file_id": "file-abc123",
"completion_window": "24h",
Expand Down Expand Up @@ -6806,7 +6806,7 @@ paths:
{
"id": "batch_abc123",
"object": "batch",
"endpoint": "/v1/completions",
"endpoint": "/v1/chat/completions",
"errors": null,
"input_file_id": "file-abc123",
"completion_window": "24h",
Expand Down Expand Up @@ -6969,7 +6969,7 @@ paths:
{
"id": "batch_abc123",
"object": "batch",
"endpoint": "/v1/completions",
"endpoint": "/v1/chat/completions",
"errors": null,
"input_file_id": "file-abc123",
"completion_window": "24h",
Expand Down Expand Up @@ -8592,9 +8592,9 @@ components:
description: |
The intended purpose of the uploaded file.

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.
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).
type: string
enum: ["fine-tune", "assistants"]
enum: ["assistants", "batch", "fine-tune"]
required:
- file
- purpose
Expand Down Expand Up @@ -9225,13 +9225,16 @@ components:
enum: ["file"]
purpose:
type: string
description: The intended purpose of the file. Supported values are `fine-tune`, `fine-tune-results`, `assistants`, and `assistants_output`.
description: The intended purpose of the file. Supported values are `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, and `fine-tune-results`.
enum:
[
"fine-tune",
"fine-tune-results",
"assistants",
"assistants_output",
"batch",
"batch_output",
"fine-tune",
"fine-tune-results",

]
status:
type: string
Expand Down Expand Up @@ -13045,7 +13048,7 @@ x-oaiMeta:
- id: files
title: Files
description: |
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).
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).
navigationGroup: endpoints
sections:
- type: endpoint
Expand Down
Loading