Class: LLM::Gemini::Files

Inherits:
Object
  • Object
show all
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. 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(key: ENV["KEY"])
ses = LLM::Session.new(llm)
file = llm.files.create(file: "/audio/haiku.mp3")
ses.talk ["Tell me about this file", file]
ses.messages.select(&:assistant?).each { print "[#{_1.role}]", _1.content, "\n" }

Instance Method Summary collapse

Constructor Details

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

Returns a new Files object

Parameters:



30
31
32
 
# File 'lib/llm/providers/gemini/files.rb', line 30

def initialize(provider)
  @provider = provider
end

Instance Method Details

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

List all files

Examples:

llm = LLM.gemini(key: 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:



46
47
48
49
50
51
52
 
# File 'lib/llm/providers/gemini/files.rb', line 46

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

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

Create a file

Examples:

llm = LLM.gemini(key: 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:



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/llm/providers/gemini/files.rb', line 64

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, span = execute(request: req, operation: "request")
    res = ResponseAdapter.adapt(res, type: :file)
    finish_trace(operation: "request", res:, span:)
  end
end

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

Get a file

Examples:

llm = LLM.gemini(key: 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:



89
90
91
92
93
94
95
96
 
# File 'lib/llm/providers/gemini/files.rb', line 89

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, span = execute(request: req, operation: "request")
  res = ResponseAdapter.adapt(res, type: :file)
  finish_trace(operation: "request", res:, span:)
end

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

Delete a file

Examples:

llm = LLM.gemini(key: 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:



108
109
110
111
112
113
114
115
 
# File 'lib/llm/providers/gemini/files.rb', line 108

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, span = execute(request: req, operation: "request")
  res = LLM::Response.new(res)
  finish_trace(operation: "request", res:, span:)
end

#download ⇒ Object

Raises:

  • (NotImplementedError) —

    This method is not implemented by Gemini



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

def download
  raise NotImplementedError
end