Interface UseChatBackend

pkg/aiusechat/usechat-backend.go:20–56

UseChatBackend defines the interface for AI chat backend providers (OpenAI, Anthropic, etc.) This interface abstracts the provider-specific API calls needed by the usechat system.

// UseChatBackend defines the interface for AI chat backend providers (OpenAI, Anthropic, etc.)
// This interface abstracts the provider-specific API calls needed by the usechat system.
type UseChatBackend interface {
	// RunChatStep executes a single step in the chat conversation with the AI backend.
	// Returns the stop reason, native messages from the response, rate limit info, and any error.
	// The cont parameter allows continuing from a previous response (e.g., after rate limiting).
	RunChatStep(
		ctx context.Context,
		sseHandler *sse.SSEHandlerCh,
		chatOpts uctypes.WaveChatOpts,
		cont *uctypes.WaveContinueResponse,
	) (*uctypes.WaveStopReason, []uctypes.GenAIMessage, *uctypes.RateLimitInfo, error)

	// UpdateToolUseData updates the tool use data for a specific tool call in the chat.
	// This is used to update the UI state for tool execution (approval status, results, etc.)
	UpdateToolUseData(chatId string, toolCallId string, toolUseData uctypes.UIMessageDataToolUse) error

	// RemoveToolUseCall removes a tool use call from the chat's native messages.
	// This is used to clean up incomplete or canceled tool calls when stopping execution.
	RemoveToolUseCall(chatId string, toolCallId string) error

	// ConvertToolResultsToNativeChatMessage converts tool execution results into native chat messages
	// that can be sent back to the AI backend. Returns a slice of messages (some backends may
	// require multiple messages per tool result).
	ConvertToolResultsToNativeChatMessage(toolResults []uctypes.AIToolResult) ([]uctypes.GenAIMessage, error)

	// ConvertAIMessageToNativeChatMessage converts a generic AIMessage (from the user)
	// into the backend's native message format for sending to the API.
	ConvertAIMessageToNativeChatMessage(message uctypes.AIMessage) (uctypes.GenAIMessage, error)

	// GetFunctionCallInputByToolCallId retrieves the function call input data for a specific
	// tool call ID from the chat history. Returns the function call structure
	// or nil if not found.
	GetFunctionCallInputByToolCallId(aiChat uctypes.AIChat, toolCallId string) *uctypes.AIFunctionCallInput

	// ConvertAIChatToUIChat converts a stored AIChat (with native backend messages) into
	// a UI-friendly UIChat format that can be displayed in the frontend.
	ConvertAIChatToUIChat(aiChat uctypes.AIChat) (*uctypes.UIChat, error)
}

// Compile-time interface checks
var _ UseChatBackend = (*openaiResponsesBackend)(nil)