Re-exports§
pub use crate::spec::CompletionTokensDetails;pub use crate::spec::ImageDetail;pub use crate::spec::PromptTokensDetails;pub use crate::spec::ReasoningEffort;pub use crate::spec::ResponseFormatJsonSchema;
Structs§
- Click
- A click action.
- Code
Interpreter - Code interpreter tool definition.
- Code
Interpreter Builder - 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 Builder - Builder for
ComputerUsePreview. - Create
Response - Builder for a Responses API request.
- Create
Response Builder - 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 Builder - Builder for
FileSearch. - File
Search Call Output - File search tool call output.
- File
Search Result - A single result from a file search.
- Function
- Function
Builder - Builder for
Function. - Function
Call - Metadata for a function call request.
- Image
Generation - Image generation tool definition.
- Image
Generation Builder - Builder for
ImageGeneration. - Image
Generation Call Output - Output of an image generation request.
- Incomplete
Details - Details about an incomplete response.
- Input
File - Input
File Builder - Builder for
InputFile. - Input
Image - Input
Image Builder - Builder for
InputImage. - Input
Image Mask - Mask image input for image generation.
- Input
Message - A message to prime the model.
- Input
Message Builder - 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
Builder - 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.
- McpBuilder
- 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
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 Builder - 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.
- Safety
Check - Scroll
- A scroll action.
- Summary
Text - A single summary text fragment from reasoning.
- 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 Builder - 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 Builder Error - Error type for ComputerUsePreviewBuilder
- Content
- Content
Type - Parts of a message: text, image, file, or audio.
- File
Search Call Output Status - Filter
- Filters for file search.
- Function
Builder Error - Error type for FunctionBuilder
- 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 - 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 Builder Error - Error type for WebSearchPreviewBuilder