Class: LLM::OpenAI::Models

Inherits:

Object

• Object
• LLM::OpenAI::Models

Defined in:

lib/llm/providers/openai/models.rb

Overview

The LLM::OpenAI::Models class provides a model object for interacting with OpenAI's models API. The models API allows a client to query OpenAI for a list of models that are available for use with the OpenAI API.

Examples:

#!/usr/bin/env ruby
require "llm"

llm = LLM.openai(key: ENV["KEY"])
res = llm.models.all
res.each do |model|
  print "id: ", model.id, "\n"
end

Instance Method Summary

• #initialize(provider) ⇒ LLM::OpenAI::Files constructor

  Returns a new Models object.

• #all(**params) ⇒ LLM::Response

  List all models.

Constructor Details

#initialize(provider) ⇒ LLM::OpenAI::Files

Returns a new Models object

Parameters:

• provider (LLM::Provider)

# File 'lib/llm/providers/openai/models.rb', line 24

def initialize(provider)
  @provider = provider
end

Instance Method Details

#all(**params) ⇒ LLM::Response

List all models

Examples:

llm = LLM.openai(key: ENV["KEY"])
res = llm.models.all
res.each do |model|
  print "id: ", model.id, "\n"
end

Parameters:

• params (Hash) —

  Other parameters (see OpenAI docs)

Returns:

• (LLM::Response)

See Also:

• OpenAI docs

# File 'lib/llm/providers/openai/models.rb', line 40

def all(**params)
  query = URI.encode_www_form(params)
  req = Net::HTTP::Get.new("/v1/models?#{query}", headers)
  res, span = execute(request: req, operation: "request")
  res = ResponseAdapter.adapt(res, type: :enumerable)
  finish_trace(operation: "request", res:, span:)
end