Class: LLM::OpenAI::Files

Inherits:
Object
  • Object
show all
Defined in:
lib/llm/providers/openai/files.rb

Overview

The LLM::OpenAI::Files class provides a files object for interacting with OpenAI's Files API. The files API allows a client to upload files for use with OpenAI's models and API endpoints. OpenAI supports multiple file formats, including text files, CSV files, JSON files, and more.

Examples:

example #1

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

llm = LLM.openai(key: ENV["KEY"])
ctx = LLM::Context.new(llm)
file = llm.files.create file: "/books/goodread.pdf"
ctx.talk ["Tell me about this PDF", file]
ctx.messages.select(&:assistant?).each { print "[#{_1.role}]", _1.content, "\n" }

Direct Known Subclasses

DeepSeek::Files

Instance Method Summary collapse

Constructor Details

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

Returns a new Files object

Parameters:



25
26
27
 
# File 'lib/llm/providers/openai/files.rb', line 25

def initialize(llm)
  @llm = llm
end

Instance Method Details

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

List all files

Examples:

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

Parameters:

  • params (Hash) —

    Other parameters (see OpenAI docs)

Returns:

See Also:



41
42
43
44
45
46
47
48
 
# File 'lib/llm/providers/openai/files.rb', line 41

def all(**params)
  query = URI.encode_www_form(params)
  req = LLM::Transport::Request.get(path("/files?#{query}"), headers)
  res, span, tracer, request_id = execute(request: req, operation: "request")
  res = ResponseAdapter.adapt(res, type: :enumerable)
  tracer.on_request_finish(operation: "request", res:, span:, request_id:)
  res
end

#create(file:, purpose: "assistants", **params) ⇒ LLM::Response

Create a file

Examples:

llm = LLM.openai(key: ENV["KEY"])
res = llm.files.create file: "/documents/haiku.txt"

Parameters:

  • file (File, LLM::File, String) —

    The file

  • purpose (String) (defaults to: "assistants") —

    The purpose of the file (see OpenAI docs)

  • params (Hash) —

    Other parameters (see OpenAI docs)

Returns:

See Also:



61
62
63
64
65
66
67
68
69
70
 
# File 'lib/llm/providers/openai/files.rb', line 61

def create(file:, purpose: "assistants", **params)
  multi = LLM::Multipart.new(params.merge!(file: LLM.File(file), purpose:))
  req = LLM::Transport::Request.post(path("/files"), headers)
  req["content-type"] = multi.content_type
  transport.set_body_stream(req, multi.body)
  res, span, tracer, request_id = execute(request: req, operation: "request")
  res = ResponseAdapter.adapt(res, type: :file)
  tracer.on_request_finish(operation: "request", res:, span:, request_id:)
  res
end

#get(file:, **params) ⇒ LLM::Response

Get a file

Examples:

llm = LLM.openai(key: ENV["KEY"])
res = llm.files.get(file: "file-1234567890")
print "id: ", res.id, "\n"

Parameters:

  • file (#id, #to_s) —

    The file ID

  • params (Hash) —

    Other parameters (see OpenAI docs)

Returns:

See Also:



83
84
85
86
87
88
89
90
91
 
# File 'lib/llm/providers/openai/files.rb', line 83

def get(file:, **params)
  file_id = file.respond_to?(:id) ? file.id : file
  query = URI.encode_www_form(params)
  req = LLM::Transport::Request.get(path("/files/#{file_id}?#{query}"), headers)
  res, span, tracer, request_id = execute(request: req, operation: "request")
  res = ResponseAdapter.adapt(res, type: :file)
  tracer.on_request_finish(operation: "request", res:, span:, request_id:)
  res
end

#download(file:, **params) ⇒ LLM::Response

Download the content of a file

Examples:

llm = LLM.openai(key: ENV["KEY"])
res = llm.files.download(file: "file-1234567890")
File.binwrite "haiku1.txt", res.file.read
print res.file.read, "\n"

Parameters:

  • file (#id, #to_s) —

    The file ID

  • params (Hash) —

    Other parameters (see OpenAI docs)

Returns:

See Also:



105
106
107
108
109
110
111
112
113
114
 
# File 'lib/llm/providers/openai/files.rb', line 105

def download(file:, **params)
  query = URI.encode_www_form(params)
  file_id = file.respond_to?(:id) ? file.id : file
  req = LLM::Transport::Request.get(path("/files/#{file_id}/content?#{query}"), headers)
  io = StringIO.new("".b)
  res, span, tracer, request_id = execute(request: req, operation: "request") { |res| res.read_body { |chunk| io << chunk } }
  res = LLM::Response.new(res).tap { _1.define_singleton_method(:file) { io } }
  tracer.on_request_finish(operation: "request", res:, span:, request_id:)
  res
end

#delete(file:) ⇒ LLM::Response

Delete a file

Examples:

llm = LLM.openai(key: ENV["KEY"])
res = llm.files.delete(file: "file-1234567890")
print res.deleted, "\n"

Parameters:

  • file (#id, #to_s) —

    The file ID

Returns:

See Also:



126
127
128
129
130
131
132
133
 
# File 'lib/llm/providers/openai/files.rb', line 126

def delete(file:)
  file_id = file.respond_to?(:id) ? file.id : file
  req = LLM::Transport::Request.delete(path("/files/#{file_id}"), headers)
  res, span, tracer, request_id = execute(request: req, operation: "request")
  res = LLM::Response.new(res)
  tracer.on_request_finish(operation: "request", res:, span:, request_id:)
  res
end