Class: LLM::Gemini::Files

Inherits:
Object
  • Object
show all
Includes:
Utils
Defined in:
lib/llm/providers/gemini/files.rb

Overview

The LLM::Gemini::Files class provides a files object for interacting with [Gemini’s Files API](ai.google.dev/gemini-api/docs/files). The files API allows a client to reference media files in prompts where they can be referenced by their URL.

The files API is intended to preserve bandwidth and latency, especially for large files but it can be helpful for smaller files as well because it does not require the client to include a file in the prompt over and over again (which could be the case in a multi-turn conversation).

Examples:

example #1

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

llm = LLM.gemini(ENV["KEY"])
bot = LLM::Bot.new(llm)
file = llm.files.create file: "/audio/haiku.mp3"
bot.chat(file)
bot.chat("Describe the audio file I sent to you")
bot.chat("The audio file is the first message I sent to you.")
bot.messages.select(&:assistant?).each { print "[#{_1.role}]", _1.content, "\n" }

example #2

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

llm = LLM.gemini(ENV["KEY"])
bot = LLM::Bot.new(llm)
file = llm.files.create file: "/audio/haiku.mp3"
bot.chat(["Describe the audio file I sent to you", file])
bot.messages.select(&:assistant?).each { print "[#{_1.role}]", _1.content, "\n" }

Instance Method Summary collapse

Methods included from Utils

#camelcase, #snakecase

Constructor Details

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

Returns a new Files object

Parameters:



44
45
46
 
# File 'lib/llm/providers/gemini/files.rb', line 44

def initialize(provider)
  @provider = provider
end

Instance Method Details

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

List all files

Examples:

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

Parameters:

  • params (Hash) —

    Other parameters (see Gemini docs)

Returns:

See Also:



60
61
62
63
64
65
 
# File 'lib/llm/providers/gemini/files.rb', line 60

def all(**params)
  query = URI.encode_www_form(params.merge!(key: key))
  req = Net::HTTP::Get.new("/v1beta/files?#{query}", headers)
  res = execute(request: req)
  LLM::Response.new(res)
end

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

Create a file

Examples:

llm = LLM.gemini(ENV["KEY"])
res = llm.files.create file: "/audio/haiku.mp3"

Parameters:

  • file (String, LLM::File) —

    The file

  • params (Hash) —

    Other parameters (see Gemini docs)

Returns:

See Also:



77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/llm/providers/gemini/files.rb', line 77

def create(file:, **params)
  file = LLM.File(file)
  req = Net::HTTP::Post.new(request_upload_url(file:), {})
  req["content-length"] = file.bytesize
  req["X-Goog-Upload-Offset"] = 0
  req["X-Goog-Upload-Command"] = "upload, finalize"
  file.with_io do |io|
    set_body_stream(req, io)
    res = execute(request: req)
    LLM::Response.new(res).extend(LLM::Gemini::Response::File)
  end
end

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

Delete a file

Examples:

llm = LLM.gemini(ENV["KEY"])
res = llm.files.delete(file: "files/1234567890")

Parameters:

  • file (#name, String) —

    The file to delete

  • params (Hash) —

    Other parameters (see Gemini docs)

Returns:

See Also:



119
120
121
122
123
124
125
 
# File 'lib/llm/providers/gemini/files.rb', line 119

def delete(file:, **params)
  file_id = file.respond_to?(:name) ? file.name : file.to_s
  query = URI.encode_www_form(params.merge!(key: key))
  req = Net::HTTP::Delete.new("/v1beta/#{file_id}?#{query}", headers)
  res = execute(request: req)
  LLM::Response.new(res)
end

#download ⇒ Object

Raises:

  • (NotImplementedError) —

    This method is not implemented by Gemini



130
131
132
 
# File 'lib/llm/providers/gemini/files.rb', line 130

def download
  raise NotImplementedError
end

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

Get a file

Examples:

llm = LLM.gemini(ENV["KEY"])
res = llm.files.get(file: "files/1234567890")
print "name: ", res.name, "\n"

Parameters:

  • file (#name, String) —

    The file to get

  • params (Hash) —

    Other parameters (see Gemini docs)

Returns:

See Also:



101
102
103
104
105
106
107
 
# File 'lib/llm/providers/gemini/files.rb', line 101

def get(file:, **params)
  file_id = file.respond_to?(:name) ? file.name : file.to_s
  query = URI.encode_www_form(params.merge!(key: key))
  req = Net::HTTP::Get.new("/v1beta/#{file_id}?#{query}", headers)
  res = execute(request: req)
  LLM::Response.new(res).extend(LLM::Gemini::Response::File)
end