Module: IntelliAgent::OpenAI

Defined in:
lib/intelli_agent/openai.rb

Defined Under Namespace

Modules: ResponseExtender Classes: Messages

Constant Summary collapse

GPT_BASIC_MODEL = 
ENV.fetch('OPENAI_GPT_BASIC_MODEL', 'gpt-4o-mini')
GPT_ADVANCED_MODEL = 
ENV.fetch('OPENAI_GPT_ADVANCED_MODEL', 'gpt-4o-2024-08-06')
O1_BASIC_MODEL = 
ENV.fetch('OPENAI_O1_BASIC_MODEL', 'o1-mini')
O1_ADVANCED_MODEL = 
ENV.fetch('OPENAI_O1_ADVANCED_MODEL', 'o1-preview')
MAX_TOKENS = 
ENV.fetch('OPENAI_MAX_TOKENS', 16_383).to_i

Class Method Summary collapse

Class Method Details

.chat(messages:, model: :gpt_basic, response_format: nil, max_tokens: MAX_TOKENS, store: true, metadata: nil, tools: nil, auto_run_functions: false, function_context: nil) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/intelli_agent/openai.rb', line 74

def self.chat(messages:, model: :gpt_basic, response_format: nil, max_tokens: MAX_TOKENS, store: true, metadata: nil, tools: nil, auto_run_functions: false, function_context: nil)
  model = select_model(model)
  is_o1_model = model.start_with?('o1')

  messages = IntelliAgent::OpenAI::Messages.new(messages) unless messages.is_a?(IntelliAgent::OpenAI::Messages)
  
  parameters = { model:, messages:, store: }
  parameters[:metadata] = metadata if metadata

  # o1 family models doesn't support max_tokens params. Instead, use max_completion_tokens
  parameters[:max_completion_tokens] = max_tokens if is_o1_model
  parameters[:max_tokens] = max_tokens unless is_o1_model

  parameters[:response_format] = { type: 'json_object' } if response_format.eql?(:json)
  parameters[:tools] = tools if tools

  begin
    response = OpenAI::Client.new.chat(parameters:)
  rescue => e
    raise "Error in OpenAI chat: #{e.message}\nParameters: #{parameters.inspect}"
  end
  
  response[:chat_params] = parameters   
  response.extend(ResponseExtender)

  if response.functions? && auto_run_functions
    raise 'Function context not provided for auto-running functions' if function_context.nil?
    parameters[:messages] << response.message
    parameters[:messages] += response.functions_run_all(context: function_context)

    response = chat(**parameters.except(:chat_params))
  end
 
  response
end

.embeddings(input, model: 'text-embedding-3-large') ⇒ Object 



55
56
57
58
59
 
# File 'lib/intelli_agent/openai.rb', line 55

def self.embeddings(input, model: 'text-embedding-3-large')
  response = OpenAI::Client.new.embeddings(parameters: { input:, model: })
  def response.embeddings = dig('data', 0, 'embedding')
  response
end

.models ⇒ Object 



110
 
# File 'lib/intelli_agent/openai.rb', line 110

def self.models = OpenAI::Client.new.models.list

.select_model(model) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/intelli_agent/openai.rb', line 112

def self.select_model(model)
  case model
  when :gpt_basic
    GPT_BASIC_MODEL
  when :gpt_advanced
    GPT_ADVANCED_MODEL
  when :o1_basic
    O1_BASIC_MODEL
  when :o1_advanced
    O1_ADVANCED_MODEL
  else
    model
  end
end

.single_chat(system:, user:, model: :gpt_basic, response_format: nil, max_tokens: MAX_TOKENS, store: true, metadata: nil, tools: nil, auto_run_functions: false, function_context: nil) ⇒ Object 



70
71
72
 
# File 'lib/intelli_agent/openai.rb', line 70

def self.single_chat(system:, user:, model: :gpt_basic, response_format: nil, max_tokens: MAX_TOKENS, store: true, metadata: nil, tools: nil, auto_run_functions: false, function_context: nil)
  chat(messages: [{ system: }, { user: }], model:, response_format:, max_tokens:, store:, tools:, auto_run_functions:, function_context:)
end

.single_prompt(prompt:, model: :gpt_basic, response_format: nil, max_tokens: MAX_TOKENS, store: true, metadata: nil, tools: nil, auto_run_functions: false, function_context: nil) ⇒ Object 



66
67
68
 
# File 'lib/intelli_agent/openai.rb', line 66

def self.single_prompt(prompt:, model: :gpt_basic, response_format: nil, max_tokens: MAX_TOKENS, store: true, metadata: nil, tools: nil, auto_run_functions: false, function_context: nil)
  chat(messages: [{ user: prompt }], model:, response_format:, max_tokens:, store:, tools:, auto_run_functions:, function_context:)
end

.vision(prompt:, image_url:, model: :gpt_advanced, response_format: nil, max_tokens: MAX_TOKENS, store: true, metadata: nil, tools: nil, auto_run_functions: false, function_context: nil) ⇒ Object 



61
62
63
64
 
# File 'lib/intelli_agent/openai.rb', line 61

def self.vision(prompt:, image_url:, model: :gpt_advanced, response_format: nil, max_tokens: MAX_TOKENS, store: true, metadata: nil, tools: nil, auto_run_functions: false, function_context: nil)
  message_content = [{ type: :text, text: prompt }, { type: :image_url, image_url: { url: image_url } }]
  chat(messages: [{ role: :user, content: message_content }], model:, response_format:, max_tokens:, store:, tools:, auto_run_functions:, function_context:)    
end