Class: Ace::LLM::Organisms::OpenAIClient

Inherits:
BaseClient
  • Object
show all
Includes:
Molecules::OpenAICompatibleParams
Defined in:
lib/ace/llm/organisms/openai_client.rb

Overview

OpenAIClient handles interactions with OpenAI’s API

Constant Summary collapse

API_BASE_URL = 
"https://api.openai.com"
DEFAULT_MODEL = 
"gpt-4o"
GENERATION_KEYS =

Generation parameters to include in API request

%i[temperature max_tokens top_p frequency_penalty presence_penalty].freeze
DEFAULT_GENERATION_CONFIG = 
{
  temperature: 0.7,
  max_tokens: nil,
  top_p: nil,
  frequency_penalty: nil,
  presence_penalty: nil
}.freeze

Constants inherited from BaseClient

BaseClient::DEFAULT_SYSTEM_PROMPT_SEPARATOR

Instance Attribute Summary

Attributes inherited from BaseClient

#api_key, #base_url, #generation_config, #http_client, #model

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Molecules::OpenAICompatibleParams

#extract_openai_compatible_options

Methods inherited from BaseClient

#initialize, #needs_credentials?, #provider_name

Constructor Details

This class inherits a constructor from Ace::LLM::Organisms::BaseClient

Class Method Details

.provider_name ⇒ String

Get the provider name

Returns:

  • (String) —

    Provider name



29
30
31
 
# File 'lib/ace/llm/organisms/openai_client.rb', line 29

def self.provider_name
  "openai"
end

Instance Method Details

#generate(messages, **options) ⇒ Hash

Generate a response from OpenAI

Parameters:

  • messages (Array<Hash>, String) —

    Messages or prompt

  • options (Hash) —

    Generation options

Returns:

  • (Hash) —

    Response with text and metadata



37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/ace/llm/organisms/openai_client.rb', line 37

def generate(messages, **options)
  messages_array = build_messages(messages)
  generation_params = extract_generation_options(options)

  request_body = build_request_body(messages_array, generation_params)
  response = make_api_request(request_body)

  parse_response(response)
rescue => e
  handle_api_error(e)
end