Expand description
OpenResponses specification types.
This module defines types that conform to the OpenResponses specification. See https://www.openresponses.org/specification for details.
Structs§
- Assistant
Message Item Param - Assistant message item parameter.
- Developer
Message Item Param - Developer message item parameter.
- Function
Call Item Param - Function call item parameter.
- Function
Call Output Item Param - Function call output item parameter.
- Function
Tool Param - Function tool parameter.
- Incomplete
Details - Incomplete details for partial responses.
- Input
File Content - Input file content.
- Input
Image Content - Input image content.
- Input
Text Content - Input text content for user/system/developer messages.
- Item
Reference Param - Item reference parameter for referencing previous items.
- Open
Responses Response - OpenResponses API response body.
- Output
Text Content - Output text content for assistant messages.
- Reasoning
Item Param - Reasoning item parameter.
- Reasoning
Summary Content - Reasoning summary content.
- Reasoning
Usage - Usage information for reasoning items.
- Refusal
Content - Refusal content for when the model refuses a request.
- Response
Error - Error object.
- Response
Usage - Response usage statistics.
- Specific
Function Choice - Specific function choice.
- System
Message Item Param - System message item parameter.
- User
Message Item Param - User message item parameter.
Enums§
- Annotation
- Annotation for citations.
- Function
Call Status - Status for function calls.
- Image
Detail - Image detail level.
- Input
Content - Content part union for input messages.
- Item
Param - Union of all item parameters that can be sent as input.
- Item
Status - Status for items that have a lifecycle.
- Item
Type - The type of an item in the OpenResponses API.
- Message
Role - Role for message items.
- Output
Content - Content part union for output messages.
- Response
Status - Response status.
- Tool
Choice Param - Tool choice parameter union.
- Tool
Choice Value - Tool choice values.