OpenAIResponsesCapability class abstract

OpenAI-specific capability interface for stateful Responses API

This interface extends beyond basic chat capabilities to provide stateful conversation management, background processing, and response lifecycle management specific to OpenAI's Responses API.

Implementers

• OpenAIResponses

Available extensions

• OpenAIResponsesCapabilityExtensions

Constructors

OpenAIResponsesCapability()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

cancelResponse(String responseId) → Future<ChatResponse>

Cancel a background response by ID

chat(List<ChatMessage> messages) → Future<ChatResponse>

Available on OpenAIResponsesCapability, provided by the OpenAIResponsesCapabilityExtensions extension

Convenience method for simple chat without tools

chatBackground(List<ChatMessage> messages) → Future<ChatResponse>

Available on OpenAIResponsesCapability, provided by the OpenAIResponsesCapabilityExtensions extension

Convenience method for background chat without tools

chatStream(List<ChatMessage> messages, {List<Tool>? tools}) → Stream<ChatStreamEvent>

Stream chat responses with tools

chatWithTools(List<ChatMessage> messages, List<Tool>? tools) → Future<ChatResponse>

Create a response with tools support

chatWithToolsBackground(List<ChatMessage> messages, List<Tool>? tools) → Future<ChatResponse>

Create a response with background processing

continueConversation(String previousResponseId, List<ChatMessage> newMessages, {List<Tool>? tools, bool background = false}) → Future<ChatResponse>

Create a new response that continues from a previous response

deleteResponse(String responseId) → Future<bool>

Delete a model response by ID

forkConversation(String fromResponseId, List<ChatMessage> newMessages, {List<Tool>? tools, bool background = false}) → Future<ChatResponse>

Fork a conversation from a specific response

getResponse(String responseId, {List<String>? include, int? startingAfter, bool stream = false}) → Future<ChatResponse>

Retrieve a model response by ID

getResponseText(String responseId) → Future<String?>

Available on OpenAIResponsesCapability, provided by the OpenAIResponsesCapabilityExtensions extension

Get response text directly

getResponseThinking(String responseId) → Future<String?>

Available on OpenAIResponsesCapability, provided by the OpenAIResponsesCapabilityExtensions extension

Get response thinking content directly

listInputItems(String responseId, {String? after, String? before, List<String>? include, int limit = 20, String order = 'desc'}) → Future<ResponseInputItemsList>

List input items for a response

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

responseExists(String responseId) → Future<bool>

Available on OpenAIResponsesCapability, provided by the OpenAIResponsesCapabilityExtensions extension

Check if a response exists and is accessible

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited