Class: LLM::OpenAI

Inherits:
Provider show all
Defined in:
lib/llm/providers/openai.rb,
lib/llm/providers/openai/audio.rb,
lib/llm/providers/openai/files.rb,
lib/llm/providers/openai/format.rb,
lib/llm/providers/openai/images.rb,
lib/llm/providers/openai/responses.rb,
lib/llm/providers/openai/error_handler.rb,
lib/llm/providers/openai/response_parser.rb

Overview

The OpenAI class implements a provider for OpenAI

Defined Under Namespace

Classes: Audio, Files, Images, Responses

Constant Summary collapse

HOST = 
"api.openai.com"

Instance Method Summary collapse

Methods inherited from Provider

#chat, #chat!, #inspect, #respond, #respond!

Constructor Details

#initialize(secret) ⇒ OpenAI

Returns a new instance of OpenAI.

Parameters:

  • secret (String) —

    The secret key for authentication



21
22
23
 
# File 'lib/llm/providers/openai.rb', line 21

def initialize(secret, **)
  super(secret, host: HOST, **)
end

Instance Method Details

#models ⇒ Object 



97
98
99
 
# File 'lib/llm/providers/openai.rb', line 97

def models
  @models ||= load_models!("openai")
end

#embed(input, model: "text-embedding-3-small", **params) ⇒ LLM::Response::Embedding

Provides an embedding

Parameters:

  • input (String, Array<String>) —

    The input to embed

  • model (String) (defaults to: "text-embedding-3-small") —

    The embedding model to use

  • params (Hash) —

    Other embedding parameters

Returns:

Raises:

See Also:



33
34
35
36
37
38
 
# File 'lib/llm/providers/openai.rb', line 33

def embed(input, model: "text-embedding-3-small", **params)
  req = Net::HTTP::Post.new("/v1/embeddings", headers)
  req.body = JSON.dump({input:, model:}.merge!(params))
  res = request(@http, req)
  Response::Embedding.new(res).extend(response_parser)
end

#complete(prompt, role = :user, model: "gpt-4o-mini", **params) ⇒ LLM::Response::Completion

Provides an interface to the chat completions API

Examples:

llm = LLM.openai(ENV["KEY"])
messages = [
  {role: "system", content: "Your task is to answer all of my questions"},
  {role: "system", content: "Your answers should be short and concise"},
]
res = llm.complete("Hello. What is the answer to 5 + 2 ?", :user, messages:)
print "[#{res.choices[0].role}]", res.choices[0].content, "\n"

Parameters:

  • prompt (String) —

    The input prompt to be completed

  • role (Symbol) (defaults to: :user) —

    The role of the prompt (e.g. :user, :system)

  • model (String) (defaults to: "gpt-4o-mini") —

    The model to use for the completion

  • params (Hash) —

    Other completion parameters

Returns:

Raises:

See Also:



50
51
52
53
54
55
56
57
 
# File 'lib/llm/providers/openai.rb', line 50

def complete(prompt, role = :user, model: "gpt-4o-mini", **params)
  params   = {model:}.merge!(params)
  req      = Net::HTTP::Post.new("/v1/chat/completions", headers)
  messages = [*(params.delete(:messages) || []), Message.new(role, prompt)]
  req.body = JSON.dump({messages: format(messages, :complete)}.merge!(params))
  res      = request(@http, req)
  Response::Completion.new(res).extend(response_parser)
end

#responses ⇒ LLM::OpenAI::Responses

Provides an interface to OpenAI’s response API

Returns:

See Also:



63
64
65
 
# File 'lib/llm/providers/openai.rb', line 63

def responses
  LLM::OpenAI::Responses.new(self)
end

#images ⇒ LLM::OpenAI::Images

Provides an interface to OpenAI’s image generation API

Returns:

See Also:



71
72
73
 
# File 'lib/llm/providers/openai.rb', line 71

def images
  LLM::OpenAI::Images.new(self)
end

#audio ⇒ LLM::OpenAI::Audio

Provides an interface to OpenAI’s audio generation API

Returns:

See Also:



79
80
81
 
# File 'lib/llm/providers/openai.rb', line 79

def audio
  LLM::OpenAI::Audio.new(self)
end

#files ⇒ LLM::OpenAI::Files

Provides an interface to OpenAI’s files API

Returns:

See Also:



87
88
89
 
# File 'lib/llm/providers/openai.rb', line 87

def files
  LLM::OpenAI::Files.new(self)
end

#assistant_role ⇒ String

Returns the role of the assistant in the conversation. Usually “assistant” or “model”

Returns:

  • (String) —

    Returns the role of the assistant in the conversation. Usually “assistant” or “model”



93
94
95
 
# File 'lib/llm/providers/openai.rb', line 93

def assistant_role
  "assistant"
end