Structs§
- Assistant
Object - Represents an
assistantthat can call the model and use tools. - Assistant
Tool Code Interpreter Resources - Assistant
Tool File Search Resources - Assistant
Tool Resources - Assistant
Tools File Search - Retrieval tool
- Assistant
Tools File Search Overrides - Assistant
Tools Function - Function tool
- Assistant
Vector Store - Assistants
Named Tool Choice - Specifies a tool the model should use. Use to force the model to call a specific tool.
- Code
Interpreter - Create
Assistant Request - Create
Assistant Request Args - Builder for
CreateAssistantRequest. - Create
Assistant Tool File Search Resources - Create
Assistant Tool Resources - Create
Message Request - Create
Message Request Args - Builder for
CreateMessageRequest. - Create
RunRequest - Create
RunRequest Args - Builder for
CreateRunRequest. - Create
Thread AndRun Request - Create
Thread AndRun Request Args - Builder for
CreateThreadAndRunRequest. - Create
Thread Request - Create
Thread Request Args - Builder for
CreateThreadRequest. - Delete
Assistant Response - Delete
Message Response - Delete
Thread Response - Delta
Code Interpreter - File
Citation - File
Path - File
Search Ranking Options - The ranking options for the file search. If not specified, the file search tool will use the
autoranker and a score_threshold of 0. - Image
File - Last
Error - List
Assistants Response - List
Messages Response - List
RunSteps Response - List
Runs Response - Message
Attachment - Message
Content Image File Object - References an image File in the content of a message.
- Message
Content Image UrlObject - References an image URL in the content of a message.
- Message
Content Refusal Object - Message
Content Text Annotations File Citation Object - A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the “file_search” tool to search files.
- Message
Content Text Annotations File Path Object - Message
Content Text Object - The text content that is part of a message.
- Message
Creation - Message
Delta - Message
Delta Content Image File Object - References an image File in the content of a message.
- Message
Delta Content Image UrlObject - Message
Delta Content Refusal Object - Message
Delta Content Text - Message
Delta Content Text Annotations File Citation Object - A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the “file_search” tool to search files.
- Message
Delta Content Text Annotations File Path Object - A URL for the file that’s generated when the assistant used the
code_interpretertool to generate a file. - Message
Delta Content Text Object - The text content that is part of a message.
- Message
Delta Object - Represents a message delta i.e. any changed fields on a message during streaming.
- Message
Incomplete Details - Message
Object - Represents a message within a thread.
- Message
Request Content Text Object - Modify
Assistant Request - Modify
Assistant Request Args - Builder for
ModifyAssistantRequest. - Modify
Message Request - Modify
RunRequest - Modify
Thread Request - Required
Action - RunCompletion
Usage - RunObject
- Represents an execution run on a thread.
- RunObject
Incomplete Details - RunStep
Completion Usage - RunStep
Delta - RunStep
Delta Object - Represents a run step delta i.e. any changed fields on a run step during streaming.
- RunStep
Delta Step Details Message Creation Object - Details of the message creation by the run step.
- RunStep
Delta Step Details Tool Calls Code Object - Details of the Code Interpreter tool call the run step was involved in.
- RunStep
Delta Step Details Tool Calls Code Output Image Object - Code interpreter image output
- RunStep
Delta Step Details Tool Calls Code Output Logs Object - Text output from the Code Interpreter tool call as part of a run step.
- RunStep
Delta Step Details Tool Calls File Search Object - RunStep
Delta Step Details Tool Calls Function Object - Function tool call
- RunStep
Delta Step Details Tool Calls Object - Details of the tool call.
- RunStep
Details Message Creation Object - Details of the message creation by the run step.
- RunStep
Details Tool Calls Code Object - Code interpreter tool call
- RunStep
Details Tool Calls Code Output Image Object - RunStep
Details Tool Calls Code Output Logs Object - Text output from the Code Interpreter tool call as part of a run step.
- RunStep
Details Tool Calls File Search Object - File search tool call
- RunStep
Details Tool Calls File Search Object File Search - RunStep
Details Tool Calls File Search Result Object - A result instance of the file search.
- RunStep
Details Tool Calls File Search Result Object Content - RunStep
Details Tool Calls Function Object - RunStep
Details Tool Calls Object - Details of the tool call.
- RunStep
Function Object - RunStep
Function Object Delta - RunStep
Object - Represents a step in execution of a run.
- RunTool
Call Object - Static
Chunking Strategy - Static Chunking Strategy
- Submit
Tool Outputs - Submit
Tool Outputs RunRequest - Text
Data - Thread
Object - Represents a thread that contains messages.
- Tools
Outputs - Tools
Outputs Args - Builder for
ToolsOutputs. - Truncation
Object - Thread Truncation Controls
Enums§
- Assistant
Stream Event - Represents an event emitted when streaming a Run.
- Assistant
Tool Type - Assistant
Tools - Assistant
Vector Store Chunking Strategy - Assistants
ApiResponse Format Option - Specifies the format that the model must output. Compatible with GPT-4o, GPT-4 Turbo, and all GPT-3.5 Turbo models since
gpt-3.5-turbo-1106. - Assistants
ApiTool Choice Option - Controls which (if any) tool is called by the model.
nonemeans the model will not call any tools and instead generates a message.autois the default value and means the model can pick between generating a message or calling one or more tools.requiredmeans the model must call one or more tools before responding to the user. Specifying a particular tool like{"type": "file_search"}or{"type": "function", "function": {"name": "my_function"}}forces the model to call that tool. - Code
Interpreter Output - Create
Message Request Content - Delta
Code Interpreter Output - Delta
Step Details - File
Search Ranker - Last
Error Code - Message
Attachment Tool - Message
Content - Message
Content Input - Message
Content Text Annotations - Message
Delta Content - Message
Delta Content Text Annotations - Message
Incomplete Details Type - Message
Role - Message
Status - RunObject
Incomplete Details Reason - RunStatus
- RunStep
Delta Step Details Tool Calls - RunStep
Details Tool Calls - RunStep
Type - Step
Details - Truncation
Object Type