responses library
Classes
- Annotation
- CodeInterpreterCall
- CodeInterpreterContainer
- CodeInterpreterContainerAuto
- CodeInterpreterContainerId
- CodeInterpreterFiles
- CodeInterpreterLogs
- CodeInterpreterResult
- CodeInterpreterResultFile
- CodeInterpreterResultOther
- CodeInterpreterTool
- — code_interpreter
- CodeInterpreterToolCallStatus
- ComputerAction
- Base-class for every computer-action payload.
- ComputerActionClick
- ComputerActionDoubleClick
- ComputerActionDrag
- ComputerActionKeyPress
- ComputerActionMove
- ComputerActionScreenshot
- ComputerActionScroll
- ComputerActionType
- ComputerActionWait
- ComputerCall
- ComputerCallOutput
- ComputerResultStatus
- ComputerSafetyCheck
- ComputerSafetyCheckStatus
- ComputerScreenshotOutput
-
ComputerUsePreviewTool<
T> - — computer_use_preview
- ContainerFileCitation
- ErrorEvent
- FileCitation
- FilePath
- FileSearchCall
- FileSearchFilter
- FileSearchFilterAnd
- FileSearchFilterOr
- FileSearchTool
- — file_search
- FileSearchToolCallResult
- FileSearchToolCallStatus
- FunctionCall
- FunctionCallOutput
- FunctionTool
- — function_tool
- FunctionToolCallStatus
- ImageDetail
- ImageGenerationBackground
- ImageGenerationCall
- ImageGenerationCallStatus
- ImageGenerationTool
- — image_generation
- ImageOutputFormat
- ImageOutputQuality
- ImageOutputSize
- IncompleteDetails
- Explains why the response is incomplete.
- Input
- InputFileContent
-
input_file(inline or by ID) - InputImageContent
-
input_image(by URL or by file-ID) - InputImageMask
- InputImageMaskFile
- InputImageMaskUrl
- InputMessage
- InputText
- InputTextContent
-
input_text - ItemReference
- LocalShellAction
- LocalShellCall
- LocalShellCallOutput
- LocalShellCallStatus
- LocalShellTool
- — local_shell
- LogProbs
- McpApprovalRequest
- McpApprovalResponse
- McpCall
- McpError
- MCPListToolItem
- McpListTools
- McpTool
- — mcp
- McpToolApproval
- McpToolApprovalAlways
- McpToolApprovalList
- MCPToolApprovalNever
- OtherAnnotation
- OtherComputerAction
- OtherResponseContent
- Simple wrapper for unexpected shapes.
- OtherResponseEvent
- Fallback wrapper for unseen summary part types.
- OtherResponseItem
- OtherTool
- Fallback for bespoke tool types.
- OutputMessage
- OutputTextContent
-
output_text - Point
- Prompt
- RankingOptions
- Reasoning
- ReasoningDetail
- ReasoningEffort
- ReasoningEvent
- ReasoningOptions
- ReasoningOutputStatus
- ReasoningSummary
- ReasoningSummaryEvent
- ReasoningSummaryPart
- ReasoningSummaryPartOther
- Fallback wrapper for unseen summary part types.
- ReasoningSummaryTextPart
- The common “summary_text” variant.
- RefusalContent
-
refusal - ResponeFunctionCallArgumentsDone
- Response
- Top-level result object returned by the API.
- ResponseCodeInterpreterCallCodeDelta
- ResponseCodeInterpreterCallCodeDone
- ResponseCodeInterpreterCallCompleted
- ResponseCodeInterpreterCallEvent
- ResponseCodeInterpreterCallInProgress
- ResponseCodeInterpreterCallInterpreting
- ResponseCompleted
- Emitted once the model has fully finished generating a response.
- ResponseContent
- ResponseContentPartAdded
- ResponseContentPartDone
- ResponseCreated
-
Emitted whenever a new
Responseobject is created. - ResponseError
- Error information returned when the model fails to generate a response.
- ResponseEvent
- ResponseFailed
- Emitted when the model fails to generate a response.
- ResponseFileSearchCallCompleted
- ResponseFileSearchCallEvent
- ResponseFileSearchCallInProgress
- ResponseFileSearchCallSearching
- ResponseFunctionCallArgumentsDelta
- ResponseImageGenerationCallCompleted
- ResponseImageGenerationCallEvent
- ResponseImageGenerationCallGenerating
- ResponseImageGenerationCallInProgress
- ResponseImageGenerationCallPartialImage
- ResponseIncomplete
- Emitted when the model finishes but the response is incomplete.
- ResponseInProgress
-
Emitted while a
Responseis still being generated (streaming). - ResponseInputItems
- Holds a list of structured input items.
- ResponseInputText
- Holds a single instruction / prompt string.
- ResponseItem
- ResponseMcpCallArgumentsDelta
-
response.mcp_call_arguments.delta - ResponseMcpCallArgumentsDone
-
response.mcp_call_arguments.done - ResponseMcpCallArgumentsEvent
- ResponseMcpCallCompleted
- ResponseMcpCallEvent
- ResponseMcpCallFailed
- ResponseMcpCallInProgress
- Thin wrappers for the simple lifecycle notifications.
- ResponseMcpListToolsCompleted
- ResponseMcpListToolsEvent
- ResponseMcpListToolsFailed
- ResponseMcpListToolsInProgress
- ResponseOutputItemAdded
-
Emitted each time a new entry is appended to the
Response.outputarray. - ResponseOutputItemDone
- ResponseOutputTextDelta
- ResponseOutputTextDone
- ResponsePromptVariables
- ResponseQueued
- ResponseReasoningDelta
- ResponseReasoningDone
- ResponseReasoningSummaryDelta
- ResponseReasoningSummaryDone
- ResponseReasoningSummaryPartAdded
- ResponseReasoningSummaryPartDone
- ResponseReasoningSummaryTextDelta
- ResponseReasoningSummaryTextDone
- ResponseRefusalDelta
- Emitted as partial refusal text streams in.
- ResponseRefusalDone
- Emitted once refusal text is finalised.
- ResponseStream
- ResponseTextAnnotationAdded
- ResponseWebSearchCallCompleted
- ResponseWebSearchCallEvent
- ResponseWebSearchCallInProgress
- ResponseWebSearchCallSearching
- SearchContextSize
- ServiceTier
- TextFormat
- TextFormatJsonObject
- TextFormatJsonSchema
- TextFormatOther
- TextFormatText
- Tool
- ToolChoice
- ToolChoiceAuto
- ToolChoiceCodeInterpreter
- ToolChoiceComputerUsePreview
- ToolChoiceFileSearch
- ToolChoiceFunction
- ToolChoiceImageGeneration
- ToolChoiceMcp
- ToolChoiceNone
- ToolChoiceOther
- ToolChoiceRequired
- ToolChoiceWebSearchPreview
- Truncation
- UrlCitation
- UserLocation
- WebSearchCall
- WebSearchPreviewTool
- — web_search_preview
- WebSearchToolCallStatus