Class: Spectre::Openai::Completions

Inherits:
Object
  • Object
show all
Defined in:
lib/spectre/openai/completions.rb

Constant Summary collapse

API_URL = 
'https://api.openai.com/v1/chat/completions'
DEFAULT_MODEL = 
'gpt-4o-mini'

Class Method Summary collapse

Class Method Details

.create(messages:, model: DEFAULT_MODEL, json_schema: nil, max_tokens: nil, tools: nil) ⇒ Hash

Class method to generate a completion based on user messages and optional tools

Parameters:

  • messages (Array<Hash>) —

    The conversation messages, each with a role and content

  • model (String) (defaults to: DEFAULT_MODEL) —

    The model to be used for generating completions, defaults to DEFAULT_MODEL

  • json_schema (Hash, nil) (defaults to: nil) —

    An optional JSON schema to enforce structured output

  • max_tokens (Integer) (defaults to: nil) —

    The maximum number of tokens for the completion (default: 50)

  • tools (Array<Hash>, nil) (defaults to: nil) —

    An optional array of tool definitions for function calling

Returns:

  • (Hash) —

    The parsed response including any function calls or content

Raises:

  • (APIKeyNotConfiguredError) —

    If the API key is not set

  • (RuntimeError) —

    For general API errors or unexpected issues



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/spectre/openai/completions.rb', line 23

def self.create(messages:, model: DEFAULT_MODEL, json_schema: nil, max_tokens: nil, tools: nil)
  api_key = Spectre.api_key
  raise APIKeyNotConfiguredError, "API key is not configured" unless api_key

  validate_messages!(messages)

  uri = URI(API_URL)
  http = Net::HTTP.new(uri.host, uri.port)
  http.use_ssl = true
  http.read_timeout = 10 # seconds
  http.open_timeout = 10 # seconds

  request = Net::HTTP::Post.new(uri.path, {
    'Content-Type' => 'application/json',
    'Authorization' => "Bearer #{api_key}"
  })

  request.body = generate_body(messages, model, json_schema, max_tokens, tools).to_json
  response = http.request(request)

  unless response.is_a?(Net::HTTPSuccess)
    raise "OpenAI API Error: #{response.code} - #{response.message}: #{response.body}"
  end

  parsed_response = JSON.parse(response.body)

  handle_response(parsed_response)
rescue JSON::ParserError => e
  raise "JSON Parse Error: #{e.message}"
rescue Net::OpenTimeout, Net::ReadTimeout => e
  raise "Request Timeout: #{e.message}"
end