Skip to content

Package com.paragon.responses.spec

This docs was updated at: 2026-02-23


Classs

Name Description
ApplyPatchTool Allows the assistant to create, delete, or update files using unified diffs
ApplyPatchToolCall A tool call representing a request to create, delete, or update files using diff patches
CodeInterpreterToolCall A tool call to run code
ComputerToolCall A tool call to a computer use tool
CreateResponsePayload Creates a model response
CustomToolCall A call to a custom tool created by the model
DeveloperMessage Represents a developer-level message with the highest instruction priority
FileSearchToolCall The results of a file search tool call
FunctionShellToolCall A tool representing a request to execute one or more shell commands
FunctionTool Defines a function in your own code the model can choose to call
FunctionToolCall A tool call to run a function
FunctionToolFactory A factory for creating FunctionTool instances with a shared JsonSchemaProducer
FunctionToolStore A store that maps function names to their implementations
ImageGenerationCall An image generation request made by the model
LocalShellCall A tool call to run a command on the local shell
McpToolCall An invocation of a tool on an MCP server
Message Represents a message input to an AI model with role-based instruction hierarchy
OutputMessage Represents an assistant output message with optional structured output support
ParsedResponse
Response
ToolChoiceDeserializer Custom deserializer for ToolChoice to handle polymorphic deserialization
UserLocation The approximate location of the user
UserMessage Represents a user message containing instructions or queries from end users
WebSearchToolCall The results of a web search tool call
extends
is

Interfaces

Name Description
CodeInterpreterOutput The outputs generated by the code interpreter, such as logs or images
CustomToolCallOutputKind The output from the custom tool call generated by your code
CustomToolInputFormat The input format for the custom tool
FileSearchFilter A filter to apply
FunctionShellToolCallChunkOutcome The exit or timeout outcome associated with this shell call
FunctionToolCallOutputKind Text, image, or file output of the function tool call
LocalShellAction Execute a shell command on the server
ReasoningContent Contents of a reasoning
ReasoningSummary Reasoning summary content
ResponseInputItem Text, image, or file inputs to the model, used to generate a response
Source The sources used in the search
ToolChoice Represents which tool the AI need to run
WebAction An object describing the specific action taken in this web search call

Records

Name Description
AcknowledgedSafetyCheck The safety checks reported by the API that have been acknowledged by the developer
AllowedTools Constrains the tools available to the model to a pre-defined set
ApplyPatchCreateFileOperation Instruction for creating a new file via the apply_patch tool
ApplyPatchDeleteFileOperation Instruction for deleting an existing file via the apply_patch tool
ApplyPatchParams Params for the ApplyPatch Tool
ApplyPatchToolCallOutput The streamed output emitted by an apply patch tool call
ApplyPatchUpdateFileOperation Instruction for updating an existing file via the apply_patch tool
ClickAction A click action
CodeInterpreterOutputImage The image output from the code interpreter
CodeInterpreterOutputLogs The logs output from the code interpreter
CodeInterpreterTool A tool that runs Python code to help generate a response to a prompt
ComparisonFilter A filter used to compare a specified attribute key to a given value using a defined comparison op…
ComparisonFilterArrayValue Comparison filter array value
ComparisonFilterBooleanValue Comparison filter boolean value
ComparisonFilterNumberValue Comparison filter number value
ComparisonFilterStringValue Comparison filter string value
CompoundFilter Combine multiple filters using and or or
ComputerToolCallOutput A tool call to a computer use tool
ComputerUseOutput A computer screenshot image used with the computer use tool
ComputerUseTool A tool that controls a virtual computer
Conversation The conversation that this response belongs to
Coordinate Represents an immutable 2D coordinate using the Flyweight design pattern
CustomTool A custom tool that processes input using a specified format
CustomToolCallOutput The output of a custom tool call from your code, being sent back to the model
CustomToolInputFormatGrammar A grammar defined by the user
CustomToolInputFormatText Unconstrained free-form text
DoubleClickAction A double click action
DragAction A drag action
File A file input to the model
FileSearchRankingOptions Ranking options for search
FileSearchTool A tool that searches for relevant content from uploaded files
FileSearchToolCallResult The results of the file search tool call
FindAction Action type "find": Searches for a pattern within a loaded page
FunctionShellAction The shell commands and limits that describe how to run the tool call
FunctionShellToolCallChunkExitOutcome Indicates that the shell commands finished and returned an exit code
FunctionShellToolCallChunkTimeoutOutcome Indicates that the shell call exceeded its configured time limit
FunctionShellToolCallOutput The streamed output items emitted by a function shell tool call
FunctionShellToolCallOutputChunk Captured chunks of stdout and stderr output, along with their associated outcomes
FunctionToolCallOutput The output of a function tool call
FunctionToolDefinition A concrete, deserializable representation of a function tool definition
HybridSearchRankingOption Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse…
Image An image input to the model
ImageGenerationTool A tool that generates images using a model like gpt-image-1
IncompleteDetails Details about why the response is incomplete
InputImageMask Optional mask for inpainting
KeyPressAction A collection of keypresses the model would like to perform
LocalShellCallOutput The output of a local shell tool call
LocalShellExecAction Represents an exec action in a local shell
LocalShellTool A tool that allows the model to execute shell commands in a local environment
McpApprovalRequest A request for human approval of a tool invocation
McpApprovalResponse A response to an MCP approval request
McpListToolResult The tools available on the server
McpListTools A list of tools available on an MCP server
McpTool Give the model access to additional tools via remote Model Context Protocol (MCP) servers
McpToolApprovalFilter Specify which of the MCP server's tools require approval
McpToolFilter List of allowed tool names or a filter object
MoveAction A mouse move action
OpenPageAction Action type "open_page" - Opens a specific URL from search results
PendingSafetyCheck The pending safety checks for the computer call
Reasoning A description of the chain of thought used by a reasoning model while generating a response
ReasoningSummaryText Represents a summary of the reasoning output from the model so far
ReasoningTextContent Reasoning text content
ResponseError An error object returned when the model fails to generate a Response
ScreenshotAction A screenshot action
ScrollAction A scroll action
SearchAction Action type "search" - Performs a web search query
ShellTool A tool that allows the model to execute shell commands
Text Represents a text input to the model
TypeAction An action to type in text
UrlSource A url source used in the search
WaitAction A wait action
WebSearchFilters Filters for the search
WebSearchTool Search the Internet for sources related to the prompt

Enums

Name Description
AllowedToolsMode Constrains the tools available to the model to a pre-defined set
ApplyPatchToolCallStatus The status of the apply patch tool call output
Background Background type for the generated image
ClickButton Indicates which mouse button was pressed during the click
CodeInterpreterToolCallStatus The status of the code interpreter tool call
ComparisonFilterType Specifies the comparison operator: eq, ne, gt, gte,lt, lte,in, nin
ComputerToolCallOutputStatus The status of the item
ComputerToolCallStatus The status of the ComputerToolCall
ComputerUseEnvironment The type of computer environment to control
CustomToolInputFormatGrammarSyntax The syntax of the grammar definition
ErrorCode OpenRouter error code
FileSearchToolCallStatus The status of the file search tool call
FunctionShellToolCallStatus The status of the shell call
FunctionToolCallOutputStatus The status of a function tool call
FunctionToolCallStatus The status of the item
ImageDetail Details of the Image
ImageGenerationModeration Moderation level for the generated image
ImageSize The size of the generated image
LocalShellCallOutputStatus The status of the item
McpToolCallStatus The status of the tool call
OutputDataInclude Specify additional output data to include in the model response
OutputFormat The output format of the generated image
ResponseObject The object type of this resource - always set to response