openai-python/src/openai/types/beta/assistant_update_params.py at next · openai/openai-python · GitHub

Repository navigation

History

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

# File generated from our OpenAPI spec by Castiron. See CONTRIBUTING.md for details.

from __future__ import annotations

from typing import Union, Iterable, Optional

from typing_extensions import Literal, TypedDict

from ..._types import SequenceNotStr

from .assistant_tool_param import AssistantToolParam

from ..shared_params.metadata import Metadata

from ..shared.reasoning_effort import ReasoningEffort

from .assistant_response_format_option_param import AssistantResponseFormatOptionParam

__all__ = ["AssistantUpdateParams", "ToolResources", "ToolResourcesCodeInterpreter", "ToolResourcesFileSearch"]

class AssistantUpdateParams(TypedDict, total=False):

description: Optional[str]

"""The description of the assistant. The maximum length is 512 characters."""

instructions: Optional[str]

"""The system instructions that the assistant uses.

The maximum length is 256,000 characters.

"""

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.

"""

model: Union[

str,

Literal[

"gpt-5",

"gpt-5-mini",

"gpt-5-nano",

"gpt-5-2025-08-07",

"gpt-5-mini-2025-08-07",

"gpt-5-nano-2025-08-07",

"gpt-4.1",

"gpt-4.1-mini",

"gpt-4.1-nano",

"gpt-4.1-2025-04-14",

"gpt-4.1-mini-2025-04-14",

"gpt-4.1-nano-2025-04-14",

"o3-mini",

"o3-mini-2025-01-31",

"o1",

"o1-2024-12-17",

"gpt-4o",

"gpt-4o-2024-11-20",

"gpt-4o-2024-08-06",

"gpt-4o-2024-05-13",

"gpt-4o-mini",

"gpt-4o-mini-2024-07-18",

"gpt-4.5-preview",

"gpt-4.5-preview-2025-02-27",

"gpt-4-turbo",

"gpt-4-turbo-2024-04-09",

"gpt-4-0125-preview",

"gpt-4-turbo-preview",

"gpt-4-1106-preview",

"gpt-4-vision-preview",

"gpt-4",

"gpt-4-0314",

"gpt-4-0613",

"gpt-4-32k",

"gpt-4-32k-0314",

"gpt-4-32k-0613",

"gpt-3.5-turbo",

"gpt-3.5-turbo-16k",

"gpt-3.5-turbo-0613",

"gpt-3.5-turbo-1106",

"gpt-3.5-turbo-0125",

"gpt-3.5-turbo-16k-0613",

]

"""ID of the model to use.

You can use the

[List models](https://developers.openai.com/api/reference/resources/models/methods/list)

API to see all of your available models, or see our

[Model overview](https://developers.openai.com/api/docs/models) for descriptions

of them.

"""

name: Optional[str]

"""The name of the assistant. The maximum length is 256 characters."""

reasoning_effort: Optional[ReasoningEffort]

"""Constrains effort on reasoning for reasoning models.

Currently supported values are `none`, `minimal`, `low`, `medium`, `high`,

`xhigh`, and `max`. Reducing reasoning effort can result in faster responses and

fewer tokens used on reasoning in a response. Not all reasoning models support

every value. See the

[reasoning guide](https://developers.openai.com/api/docs/guides/reasoning) for

model-specific support.

"""

response_format: Optional[AssistantResponseFormatOptionParam]

"""Specifies the format that the model must output.

Compatible with [GPT-4o](https://developers.openai.com/api/docs/models/gpt-4o),

[GPT-4 Turbo](https://developers.openai.com/api/docs/models/gpt-4-turbo), and

all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.

Setting to `{ "type": "json_schema", "json_schema": {...} }` enables Structured

Outputs which ensures the model will match your supplied JSON schema. Learn more

in the

[Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).

Setting to `{ "type": "json_object" }` enables JSON mode, which ensures the

message the model generates is valid JSON.

**Important:** when using JSON mode, you **must** also instruct the model to

produce JSON yourself via a system or user message. Without this, the model may

generate an unending stream of whitespace until the generation reaches the token

limit, resulting in a long-running and seemingly "stuck" request. Also note that

the message content may be partially cut off if `finish_reason="length"`, which

indicates the generation exceeded `max_tokens` or the conversation exceeded the

max context length.

"""

temperature: Optional[float]

"""What sampling temperature to use, between 0 and 2.

Higher values like 0.8 will make the output more random, while lower values like

0.2 will make it more focused and deterministic.

"""

tool_resources: Optional[ToolResources]

"""A set of resources that are used by the assistant's tools.

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.

"""

tools: Iterable[AssistantToolParam]

"""A list of tool enabled on the assistant.

There can be a maximum of 128 tools per assistant. Tools can be of types

`code_interpreter`, `file_search`, or `function`.

"""

top_p: Optional[float]

"""

An alternative to sampling with temperature, called nucleus sampling, where the

model considers the results of the tokens with top_p probability mass. So 0.1

means only the tokens comprising the top 10% probability mass are considered.

We generally recommend altering this or temperature but not both.

"""

class ToolResourcesCodeInterpreter(TypedDict, total=False):

file_ids: SequenceNotStr[str]

"""

Overrides the list of

[file](https://developers.openai.com/api/reference/resources/files) IDs made

available to the `code_interpreter` tool. There can be a maximum of 20 files

associated with the tool.

"""

class ToolResourcesFileSearch(TypedDict, total=False):

vector_store_ids: SequenceNotStr[str]

"""

Overrides the

[vector store](https://developers.openai.com/api/reference/resources/vector_stores)

attached to this assistant. There can be a maximum of 1 vector store attached to

the assistant.

"""

class ToolResources(TypedDict, total=False):

"""A set of resources that are used by the assistant's tools.

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

openai-python/src/openai/types/beta/assistant_update_params.py at next · openai/openai-python · GitHub

Repository navigation

Expand file tree

Breadcrumbs

assistant_update_params.py

Latest commit

History

Breadcrumbs

assistant_update_params.py

File metadata and controls