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§
- Click
- A click action.
- Code
Interpreter - Code interpreter tool definition.
- Code
Interpreter Args - Builder for
CodeInterpreter. - Code
Interpreter Call Output - Output of a code interpreter request.
- Code
Interpreter File - Code
Interpreter File Output - The output containing file references.
- Code
Interpreter Text Output - The output containing execution logs.
- Comparison
Filter - Single comparison filter.
- Compound
Filter - Combine multiple filters.
- Computer
Call Output - Output from a computer tool call.
- Computer
UsePreview - Computer
UsePreview Args - Builder for
ComputerUsePreview. - Content
Part - Content part
- Create
Response - Builder for a Responses API request.
- Create
Response Args - Builder for
CreateResponse. - Double
Click - A double click action.
- Drag
- A drag action.
- Error
Object - Error returned by the API when a request fails.
- File
Citation - File
Path - File
Search - File
Search Args - Builder for
FileSearch. - File
Search Call Output - File search tool call output.
- File
Search Result - A single result from a file search.
- Function
- Function
Args - Builder for
Function. - Function
Call - Metadata for a function call request.
- Image
Generation - Image generation tool definition.
- Image
Generation Args - Builder for
ImageGeneration. - Image
Generation Call Output - Output of an image generation request.
- Incomplete
Details - Details about an incomplete response.
- Input
File - Input
File Args - Builder for
InputFile. - Input
Image - Input
Image Args - Builder for
InputImage. - Input
Image Mask - Mask image input for image generation.
- Input
Message - A message to prime the model.
- Input
Message Args - Builder for
InputMessage. - Input
Text - KeyPress
- A keypress action.
- Local
Shell Action - Define the shape of a local shell action (exec).
- Local
Shell Call Output - Output of a local shell command request.
- Location
- Approximate user location for web search.
- Location
Args - Builder for
Location. - Mcp
- MCP (Model Context Protocol) tool configuration.
- McpAllowed
Tools Filter - Filter object for MCP allowed tools.
- McpApproval
Filter - Filter object for MCP tool approval.
- McpApproval
Request Output - Output representing a human approval request for an MCP tool.
- McpArgs
- Builder for
Mcp. - McpCall
Output - Output of an MCP server tool invocation.
- McpList
Tools Output - Output listing tools available on an MCP server.
- McpTool
Info - Information about a single tool on an MCP server.
- Move
Action - A mouse move action.
- Output
Item - Output item
- Output
Message - A message generated by the model.
- Output
Text - A simple text output from the model.
- Point
- A point in 2D space.
- Prompt
Config - Service tier request options.
- Ranking
Options - Options for search result ranking.
- Reasoning
Config - o-series reasoning settings.
- Reasoning
Config Args - Builder for
ReasoningConfig. - Reasoning
Item - A reasoning item representing the model’s chain of thought, including summary paragraphs.
- Refusal
- A refusal explanation from the model.
- Response
- The complete response returned by the Responses API.
- Response
Code Interpreter Call Code Delta - Code interpreter call code delta event
- Response
Code Interpreter Call Code Done - Code interpreter call code done event
- Response
Code Interpreter Call Completed - Code interpreter call completed event
- Response
Code Interpreter Call InProgress - Code interpreter call in progress event
- Response
Code Interpreter Call Interpreting - Code interpreter call interpreting event
- Response
Completed - Response completed event
- Response
Content Part Added - Response
Content Part Done - Response
Created - Response
Error - Error event
- Response
Failed - Response failed event
- Response
File Search Call Completed - File search call completed event
- Response
File Search Call InProgress - File search call in progress event
- Response
File Search Call Searching - File search call searching event
- Response
Function Call Arguments Delta - Function call arguments delta event
- Response
Function Call Arguments Done - Function call arguments done event
- Response
Image Generation Call Completed - Image generation call completed event
- Response
Image Generation Call Generating - Image generation call generating event
- Response
Image Generation Call InProgress - Image generation call in progress event
- Response
Image Generation Call Partial Image - Image generation call partial image event
- Response
InProgress - Response
Incomplete - Response incomplete event
- Response
McpCall Arguments Delta - MCP call arguments delta event
- Response
McpCall Arguments Done - MCP call arguments done event
- Response
McpCall Completed - MCP call completed event
- Response
McpCall Failed - MCP call failed event
- Response
McpCall InProgress - MCP call in progress event
- Response
McpList Tools Completed - MCP list tools completed event
- Response
McpList Tools Failed - MCP list tools failed event
- Response
McpList Tools InProgress - MCP list tools in progress event
- Response
Metadata - Response metadata
- Response
Output Item Added - Response
Output Item Done - Response
Output Text Annotation Added - Collects streaming response events into a complete response Output text annotation added event
- Response
Output Text Delta - Response
Output Text Done - Text output completed event
- Response
Queued - Response queued event
- Response
Reasoning Summary Delta - Reasoning summary delta event
- Response
Reasoning Summary Done - Reasoning summary done event
- Response
Reasoning Summary Part Added - Reasoning summary part added event
- Response
Reasoning Summary Part Done - Reasoning summary part done event
- Response
Reasoning Summary Text Delta - Reasoning summary text delta event
- Response
Reasoning Summary Text Done - Reasoning summary text done event
- Response
Refusal Delta - Refusal delta event
- Response
Refusal Done - Refusal done event
- Response
WebSearch Call Completed - Web search call completed event
- Response
WebSearch Call InProgress - Web search call in progress event
- Response
WebSearch Call Searching - Web search call searching event
- Safety
Check - Scroll
- A scroll action.
- Summary
Text - A single summary text fragment from reasoning.
- Text
Annotation - Text annotation object for output text
- Text
Config - Configuration for text response format.
- Type
Action - A typing (text entry) action.
- UrlCitation
- Usage
- Usage statistics for a response.
- WebSearch
Call Output - Web search tool call output.
- WebSearch
Preview - WebSearch
Preview Args - Builder for
WebSearchPreview.
Enums§
- Allowed
Tools - Allowed tools configuration for MCP.
- Annotation
- Button
Press - Code
Interpreter Container - Container configuration for a code interpreter.
- Code
Interpreter Container Kind - Auto configuration for code interpreter container.
- Code
Interpreter Result - Individual result from a code interpreter: either logs or files.
- Comparison
Type - Compound
Type - Computer
Call Action - Represents all user‐triggered actions.
- Computer
UsePreview Args Error - Error type for ComputerUsePreviewArgs
- Content
- Content
Type - Parts of a message: text, image, file, or audio.
- File
Search Call Output Status - Filter
- Filters for file search.
- Function
Args Error - Error type for FunctionArgs
- Hosted
Tool Type - Hosted tool type identifiers.
- Image
Generation Background - Image
Generation Output Format - Image
Generation Quality - Image
Generation Size - Input
- Input payload: raw text or structured context items.
- Input
Content - Input
Item - A context item: currently only messages.
- Input
Message Type - Output
Content - Nested content within an output message.
- Output
Status - Status of input/output items.
- Reasoning
Summary - Require
Approval - Approval policy or filter for MCP tools.
- Require
Approval Policy - Response
Event - Event types for streaming responses from the Responses API
- Role
- Role of messages in the API.
- Service
Tier - Service tier request options.
- Status
- Text
Response Format - Tool
Choice - Control how the model picks or is forced to pick a tool.
- Tool
Choice Mode - Simple tool-choice modes.
- Tool
Definition - Definitions for model-callable tools.
- Truncation
- Truncation strategies.
- WebSearch
Context Size - WebSearch
Preview Args Error - Error type for WebSearchPreviewArgs
Type Aliases§
- Response
Stream - Stream of response events