Re-exports§
pub use crate::types::CompletionTokensDetails;pub use crate::types::ImageDetail;pub use crate::types::PromptTokensDetails;pub use crate::types::ReasoningEffort;pub use crate::types::ResponseFormatJsonSchema;
Structs§
- AnyItem
Reference - Billing
- Click
Param - A click action.
- Code
Interpreter Container Auto - Auto configuration for code interpreter container.
- Code
Interpreter File - Code
Interpreter Output Image - Code
Interpreter Output Logs - Code
Interpreter Tool - Code
Interpreter Tool Args - Builder for
CodeInterpreterTool. - Code
Interpreter Tool Call - Output of a code interpreter request.
- Comparison
Filter - Single comparison filter.
- Compound
Filter - Combine multiple filters using
andoror. - Computer
Call Output Item Param - Computer
Call Safety Check Param - Computer
Screen Content - Computer
Screenshot Image - A computer screenshot image used with the computer use tool.
- Computer
Tool Call - Output from a computer tool call.
- Computer
UsePreview Tool - Computer
UsePreview Tool Args - Builder for
ComputerUsePreviewTool. - Container
File Citation Body - Conversation
- Conversation
Item List - A list of Conversation items.
- Conversation
Resource - Represents a conversation object.
- Create
Conversation Items Request - Request to create conversation items.
- Create
Conversation Items Request Args - Builder for
CreateConversationItemsRequest. - Create
Conversation Request - Request to create a conversation. openapi spec type: CreateConversationBody
- Create
Conversation Request Args - Builder for
CreateConversationRequest. - Create
Response - Builder for a Responses API request.
- Create
Response Args - Builder for
CreateResponse. - Custom
Grammar Format Param - Custom
Grammar Format Param Builder - Builder for
CustomGrammarFormatParam. - Custom
Tool Call - Custom
Tool Call Output - Custom
Tool Param - Custom
Tool Param Builder - Builder for
CustomToolParam. - Delete
Conversation Response - Represents a deleted conversation.
- Delete
Response - Double
Click Action - A double click action.
- Drag
- A drag action.
- Drag
Point - A point in 2D space.
- Easy
Input Message - A simplified message input to the model (EasyInputMessage in the OpenAPI spec).
- Easy
Input Message Args - Builder for
EasyInputMessage. - Error
Object - Error returned by the API when a request fails.
- File
Citation Body - File
Path - File
Search Tool - File
Search Tool Args - Builder for
FileSearchTool. - File
Search Tool Call - File search tool call output.
- File
Search Tool Call Result - A single result from a file search.
- Function
Call Output Item Param - Output from a function call that you’re providing back to the model.
- Function
Tool - Function
Tool Args - Builder for
FunctionTool. - Function
Tool Call - Hybrid
Search - Image
GenTool - Image generation tool definition.
- Image
GenTool Call - Image
GenTool Input Image Mask - Image
Generation Args - Builder for
ImageGenTool. - Incomplete
Details - Details about an incomplete response.
- Input
File Args - Builder for
InputFileContent. - Input
File Content - Input
Image Args - Builder for
InputImageContent. - Input
Image Content - Input
Message - A structured message input to the model (InputMessage in the OpenAPI spec).
- Input
Message Args - Builder for
InputMessage. - Input
Text Content - Input
Token Details - Item
Reference - A reference to an existing item by ID.
- KeyPress
Action - A keypress action.
- List
Conversation Items Query - Query parameters for listing conversation items.
- List
Conversation Items Query Args - Builder for
ListConversationItemsQuery. - Local
Shell Exec Action - Define the shape of a local shell action (exec).
- Local
Shell Output - Output from a local shell command execution.
- Local
Shell Tool Call - Local
Shell Tool Call Output - Output from a local shell tool call that you’re providing back to the model.
- LogProb
- MCPApproval
Request - MCPApproval
Response - An MCP approval response that you’re providing back to the model.
- MCPList
Tools - MCPTool
Call - Output of an MCP server tool invocation.
- Message
- Move
- A mouse move action.
- Output
Message - A message generated by the model.
- Output
Text Content - A simple text output from the model.
- Output
Token Details - Prompt
- Ranking
Options - Options for search result ranking.
- Reasoning
- o-series reasoning settings.
- Reasoning
Args - Builder for
Reasoning. - Reasoning
Item - A reasoning item representing the model’s chain of thought, including summary paragraphs.
- Reasoning
Text Content - Refusal
Content - A refusal explanation from the model.
- Response
- The complete response returned by the Responses API.
- Response
Code Interpreter Call Code Delta Event - Response
Code Interpreter Call Code Done Event - Response
Code Interpreter Call Completed Event - Response
Code Interpreter Call InProgress Event - Response
Code Interpreter Call Interpreting Event - Response
Completed Event - Response
Content Part Added Event - Response
Content Part Done Event - Response
Created Event - Response
Custom Tool Call Input Delta Event - Response
Custom Tool Call Input Done Event - Response
Error Event - Response
Failed Event - Response
File Search Call Completed Event - Response
File Search Call InProgress Event - Response
File Search Call Searching Event - Response
Function Call Arguments Delta Event - Response
Function Call Arguments Done Event - Response
Image GenCall Completed Event - Response
Image GenCall Generating Event - Response
Image GenCall InProgress Event - Response
Image GenCall Partial Image Event - Response
InProgress Event - Response
Incomplete Event - Response
Item List - A list of Response items.
- Response
LogProb - ResponseMCP
Call Arguments Delta Event - ResponseMCP
Call Arguments Done Event - ResponseMCP
Call Completed Event - ResponseMCP
Call Failed Event - ResponseMCP
Call InProgress Event - ResponseMCP
List Tools Completed Event - ResponseMCP
List Tools Failed Event - ResponseMCP
List Tools InProgress Event - Response
Output Item Added Event - Response
Output Item Done Event - Response
Output Text Annotation Added Event - Response
Queued Event - Response
Reasoning Summary Part Added Event - Response
Reasoning Summary Part Done Event - Response
Reasoning Summary Text Delta Event - Response
Reasoning Summary Text Done Event - Response
Reasoning Text Delta Event - Response
Reasoning Text Done Event - Response
Refusal Delta Event - Response
Refusal Done Event - Response
Stream Options - Response
Text Delta Event - Response
Text Done Event - Response
Text Param - Configuration for text response format.
- Response
TopLob Prob - Response
Usage - Usage statistics for a response.
- Response
WebSearch Call Completed Event - Response
WebSearch Call InProgress Event - Response
WebSearch Call Searching Event - Scroll
- A scroll action.
- Summary
- A single summary text fragment from reasoning.
- Summary
Text Content - Text
Content - Token
Counts Body - Token
Counts Body Args - Builder for
TokenCountsBody. - Token
Counts Resource - Tool
Choice Allowed - Tool
Choice Custom - Tool
Choice Function - Tool
ChoiceMCP - TopLog
Prob - Type
- A typing (text entry) action.
- Update
Conversation Request - Request to update a conversation.
- Update
Conversation Request Args - Builder for
UpdateConversationRequest. - UrlCitation
Body - WebSearch
Action Find - WebSearch
Action Open Page - WebSearch
Action Search - WebSearch
Action Search Source - WebSearch
Approximate Location - Approximate user location for web search.
- WebSearch
Approximate Location Args - Builder for
WebSearchApproximateLocation. - WebSearch
Tool - WebSearch
Tool Args - Builder for
WebSearchTool. - WebSearch
Tool Call - Web search tool call output.
- WebSearch
Tool Filters
Enums§
- Annotation
- Assistant
Role - The role for an output message - always
assistant. This type ensures type safety by only allowing the assistant role. - Click
Button Type - Code
Interpreter Tool Call Output - Individual result from a code interpreter: either logs or files.
- Code
Interpreter Tool Call Status - Code
Interpreter Tool Container - Container configuration for a code interpreter.
- Comparison
Type - Compound
Type - Computer
Action - Represents all user‐triggered actions.
- Computer
Environment - Computer
Screenshot Image Type - Computer
UsePreview Tool Args Error - Error type for ComputerUsePreviewToolArgs
- Conversation
Item - Conversation
Param - Custom
Grammar Format Param Builder Error - Error type for CustomGrammarFormatParamBuilder
- Custom
Tool Call Output Output - Custom
Tool Param Builder Error - Error type for CustomToolParamBuilder
- Custom
Tool Param Format - Easy
Input Content - Content for EasyInputMessage - can be a simple string or structured list.
- File
Search Tool Call Status - Filter
- Filters for file search.
- Function
Call Output - Function
Tool Args Error - Error type for FunctionToolArgs
- Grammar
Syntax - Image
GenTool Background - Image
GenTool Call Status - Image
GenTool Moderation - Image
GenTool Output Format - Image
GenTool Quality - Image
GenTool Size - Include
Enum - Include
Param - Additional fields to include in the response.
- Input
Content - Parts of a message: text, image, file, or audio.
- Input
Fidelity - Input
Item - Input item that can be used in the context for generating a response.
- Input
Param - Input
Role - The role for an input message - can only be
user,system, ordeveloper. This type ensures type safety by excluding theassistantrole (use OutputMessage for that). - Instructions
- Item
- Content item used to generate a response.
- Item
Reference Type - Item
Resource - Item
Resource Item - List
Order - The order to return items in.
- MCPTool
Call Status - Message
Content - Message
Item - A message item used within the
Itemenum. - Message
Role - Message
Status - Message
Type - Output
Content - Output
Item - Output item
- Output
Message Content - Output
Status - Status of input/output items.
- Rank
Version Type - Reasoning
Summary - Response
Prompt Variables - Response
Stream Event - Event types for streaming responses from the Responses API
- Role
- Role of messages in the API.
- Service
Tier - Status
- Summary
Part - Text
Response Format Configuration - Tool
- Definitions for model-callable tools.
- Tool
Choice Allowed Mode - Tool
Choice Options - Tool
Choice Param - Tool
Choice Types - The type of hosted tool the model should to use. Learn more about built-in tools.
- Truncation
- Truncation strategies.
- Verbosity
- o-series reasoning settings.
- WebSearch
Approximate Location Type - WebSearch
Tool Args Error - Error type for WebSearchToolArgs
- WebSearch
Tool Call Action - WebSearch
Tool Call Status - WebSearch
Tool Search Context Size
Type Aliases§
- Response
Stream - Stream of response events