Class: ActiveAgent::Providers::OpenAI::ChatProvider

Inherits:

Base

• Object
• BaseProvider
• Base
• ActiveAgent::Providers::OpenAI::ChatProvider

Includes:

ToolChoiceClearing

Defined in:

lib/active_agent/providers/open_ai/chat_provider.rb

Overview

Provider implementation for OpenAI’s Chat Completions API

Handles chat-based interactions including streaming responses, function/tool calling, and message management.

See Also:

• Base
• https://platform.openai.com/docs/api-reference/chat

Direct Known Subclasses

ActiveAgent::Providers::OllamaProvider, ActiveAgent::Providers::OpenRouterProvider

Class Method Summary

• .options_klass ⇒ Class

  The options class for this provider.

• .prompt_request_type ⇒ Chat::RequestType

  Request type instance for chat completions.

Methods included from ToolChoiceClearing

#prepare_prompt_request_tools

Methods inherited from Base

#client, service_name

Methods inherited from BaseProvider

#embed, embed_request_type, #initialize, namespace, #preview, #prompt, service_name, tag_name

Methods included from Previewable

#preview_prompt

Methods included from Instrumentation

#instrumentation_prompt_payload

Methods included from ExceptionHandler

#configure_exception_handler, #rescue_with_handler, #with_exception_handling

Constructor Details

This class inherits a constructor from ActiveAgent::Providers::BaseProvider

Class Method Details

.options_klass ⇒ Class

Returns the options class for this provider.

Returns:

• (Class) —

  the options class for this provider

# File 'lib/active_agent/providers/open_ai/chat_provider.rb', line 18

def self.options_klass
  Options
end

.prompt_request_type ⇒ Chat::RequestType

Returns request type instance for chat completions.

Returns:

• (Chat::RequestType) —

  request type instance for chat completions

# File 'lib/active_agent/providers/open_ai/chat_provider.rb', line 23

def self.prompt_request_type
  Chat::RequestType.new
end