-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Expand file tree
/
Copy pathbatch_create_params.py
More file actions
86 lines (64 loc) · 2.79 KB
/
batch_create_params.py
File metadata and controls
86 lines (64 loc) · 2.79 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
from typing import Optional
from typing_extensions import Literal, Required, TypedDict
from .shared_params.metadata import Metadata
__all__ = ["BatchCreateParams", "OutputExpiresAfter"]
class BatchCreateParams(TypedDict, total=False):
completion_window: Required[Literal["24h"]]
"""The time frame within which the batch should be processed.
Currently only `24h` is supported.
"""
endpoint: Required[
Literal[
"/v1/responses",
"/v1/chat/completions",
"/v1/embeddings",
"/v1/completions",
"/v1/moderations",
"/v1/images/generations",
"/v1/images/edits",
"/v1/videos",
]
]
"""The endpoint to be used for all requests in the batch.
Currently `/v1/responses`, `/v1/chat/completions`, `/v1/embeddings`,
`/v1/completions`, `/v1/moderations`, `/v1/images/generations`,
`/v1/images/edits`, and `/v1/videos` are supported. Note that `/v1/embeddings`
batches are also restricted to a maximum of 50,000 embedding inputs across all
requests in the batch.
"""
input_file_id: Required[str]
"""The ID of an uploaded file that contains requests for the new batch.
See [upload file](https://platform.openai.com/docs/api-reference/files/create)
for how to upload a file.
Your input file must be formatted as a
[JSONL file](https://platform.openai.com/docs/api-reference/batch/request-input),
and must be uploaded with the purpose `batch`. The file can contain up to 50,000
requests, and can be up to 200 MB in size.
"""
metadata: Optional[Metadata]
"""Set of 16 key-value pairs that can be attached to an object.
This can be useful for storing additional information about the object in a
structured format, and querying for objects via API or the dashboard.
Keys are strings with a maximum length of 64 characters. Values are strings with
a maximum length of 512 characters.
"""
output_expires_after: OutputExpiresAfter
"""
The expiration policy for the output and/or error file that are generated for a
batch.
"""
class OutputExpiresAfter(TypedDict, total=False):
"""
The expiration policy for the output and/or error file that are generated for a batch.
"""
anchor: Required[Literal["created_at"]]
"""Anchor timestamp after which the expiration policy applies.
Supported anchors: `created_at`. Note that the anchor is the file creation time,
not the time the batch is created.
"""
seconds: Required[int]
"""The number of seconds after the anchor time that the file will expire.
Must be between 3600 (1 hour) and 2592000 (30 days).
"""