-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Expand file tree
/
Copy paththread_create_params.py
More file actions
196 lines (141 loc) · 6.96 KB
/
thread_create_params.py
File metadata and controls
196 lines (141 loc) · 6.96 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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
from typing import Union, Iterable, Optional
from typing_extensions import Literal, Required, TypeAlias, TypedDict
from ..._types import SequenceNotStr
from ..shared_params.metadata import Metadata
from .code_interpreter_tool_param import CodeInterpreterToolParam
from .threads.message_content_part_param import MessageContentPartParam
__all__ = [
"ThreadCreateParams",
"Message",
"MessageAttachment",
"MessageAttachmentTool",
"MessageAttachmentToolFileSearch",
"ToolResources",
"ToolResourcesCodeInterpreter",
"ToolResourcesFileSearch",
"ToolResourcesFileSearchVectorStore",
"ToolResourcesFileSearchVectorStoreChunkingStrategy",
"ToolResourcesFileSearchVectorStoreChunkingStrategyAuto",
"ToolResourcesFileSearchVectorStoreChunkingStrategyStatic",
"ToolResourcesFileSearchVectorStoreChunkingStrategyStaticStatic",
]
class ThreadCreateParams(TypedDict, total=False):
messages: Iterable[Message]
"""
A list of [messages](https://platform.openai.com/docs/api-reference/messages) to
start the thread with.
"""
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.
"""
tool_resources: Optional[ToolResources]
"""
A set of resources that are made available to the assistant's tools in this
thread. The resources are specific to the type of tool. For example, the
`code_interpreter` tool requires a list of file IDs, while the `file_search`
tool requires a list of vector store IDs.
"""
class MessageAttachmentToolFileSearch(TypedDict, total=False):
type: Required[Literal["file_search"]]
"""The type of tool being defined: `file_search`"""
MessageAttachmentTool: TypeAlias = Union[CodeInterpreterToolParam, MessageAttachmentToolFileSearch]
class MessageAttachment(TypedDict, total=False):
file_id: str
"""The ID of the file to attach to the message."""
tools: Iterable[MessageAttachmentTool]
"""The tools to add this file to."""
class Message(TypedDict, total=False):
content: Required[Union[str, Iterable[MessageContentPartParam]]]
"""The text contents of the message."""
role: Required[Literal["user", "assistant"]]
"""The role of the entity that is creating the message. Allowed values include:
- `user`: Indicates the message is sent by an actual user and should be used in
most cases to represent user-generated messages.
- `assistant`: Indicates the message is generated by the assistant. Use this
value to insert messages from the assistant into the conversation.
"""
attachments: Optional[Iterable[MessageAttachment]]
"""A list of files attached to the message, and the tools they should be added to."""
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.
"""
class ToolResourcesCodeInterpreter(TypedDict, total=False):
file_ids: SequenceNotStr[str]
"""
A list of [file](https://platform.openai.com/docs/api-reference/files) IDs made
available to the `code_interpreter` tool. There can be a maximum of 20 files
associated with the tool.
"""
class ToolResourcesFileSearchVectorStoreChunkingStrategyAuto(TypedDict, total=False):
"""The default strategy.
This strategy currently uses a `max_chunk_size_tokens` of `800` and `chunk_overlap_tokens` of `400`.
"""
type: Required[Literal["auto"]]
"""Always `auto`."""
class ToolResourcesFileSearchVectorStoreChunkingStrategyStaticStatic(TypedDict, total=False):
chunk_overlap_tokens: Required[int]
"""The number of tokens that overlap between chunks. The default value is `400`.
Note that the overlap must not exceed half of `max_chunk_size_tokens`.
"""
max_chunk_size_tokens: Required[int]
"""The maximum number of tokens in each chunk.
The default value is `800`. The minimum value is `100` and the maximum value is
`4096`.
"""
class ToolResourcesFileSearchVectorStoreChunkingStrategyStatic(TypedDict, total=False):
static: Required[ToolResourcesFileSearchVectorStoreChunkingStrategyStaticStatic]
type: Required[Literal["static"]]
"""Always `static`."""
ToolResourcesFileSearchVectorStoreChunkingStrategy: TypeAlias = Union[
ToolResourcesFileSearchVectorStoreChunkingStrategyAuto, ToolResourcesFileSearchVectorStoreChunkingStrategyStatic
]
class ToolResourcesFileSearchVectorStore(TypedDict, total=False):
chunking_strategy: ToolResourcesFileSearchVectorStoreChunkingStrategy
"""The chunking strategy used to chunk the file(s).
If not set, will use the `auto` strategy.
"""
file_ids: SequenceNotStr[str]
"""
A list of [file](https://platform.openai.com/docs/api-reference/files) IDs to
add to the vector store. For vector stores created before Nov 2025, there can be
a maximum of 10,000 files in a vector store. For vector stores created starting
in Nov 2025, the limit is 100,000,000 files.
"""
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.
"""
class ToolResourcesFileSearch(TypedDict, total=False):
vector_store_ids: SequenceNotStr[str]
"""
The
[vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
attached to this thread. There can be a maximum of 1 vector store attached to
the thread.
"""
vector_stores: Iterable[ToolResourcesFileSearchVectorStore]
"""
A helper to create a
[vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
with file_ids and attach it to this thread. There can be a maximum of 1 vector
store attached to the thread.
"""
class ToolResources(TypedDict, total=False):
"""
A set of resources that are made available to the assistant's tools in this thread. The resources are specific to the type of tool. For example, the `code_interpreter` tool requires a list of file IDs, while the `file_search` tool requires a list of vector store IDs.
"""
code_interpreter: ToolResourcesCodeInterpreter
file_search: ToolResourcesFileSearch