Class: Vellum::UploadedFilesClient

Inherits:
Object
  • Object
show all
Defined in:
lib/vellum_ai/uploaded_files/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Vellum::UploadedFilesClient

Parameters:



18
19
20
 
# File 'lib/vellum_ai/uploaded_files/client.rb', line 18

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Vellum::RequestClient (readonly)

Returns:



13
14
15
 
# File 'lib/vellum_ai/uploaded_files/client.rb', line 13

def request_client
  @request_client
end

Instance Method Details

#create(file:, request_options: nil) ⇒ Vellum::UploadedFileRead

Parameters:

Returns:



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/vellum_ai/uploaded_files/client.rb', line 26

def create(file:, request_options: nil)
  response = @request_client.conn.post do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  req.body = { **(request_options&.additional_body_parameters || {}), file: Vellum::FileUtilities.as_faraday_multipart(file_like: file) }.compact
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/uploaded-files"
end
  Vellum::UploadedFileRead.from_json(json_object: response.body)
end

#retrieve(id:, expiry_seconds: nil, request_options: nil) ⇒ Object

api.uploaded_files.retrieve(id: "id")



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/vellum_ai/uploaded_files/client.rb', line 63

def retrieve(id:, expiry_seconds: nil, request_options: nil)
  response = @request_client.conn.get do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  req.params = { **(request_options&.additional_query_parameters || {}), "expiry_seconds": expiry_seconds }.compact
  unless request_options.nil? || request_options&.additional_body_parameters.nil?
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
  end
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/uploaded-files/#{id}"
end
  Vellum::UploadedFileRead.from_json(json_object: response.body)
end

#update(id:, file:, request_options: nil) ⇒ Vellum::UploadedFileRead

Parameters:

  • id (String) —

    A UUID string identifying this uploaded file.

  • file (String, IO)
  • request_options (Vellum::RequestOptions) (defaults to: nil)

Returns:



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/vellum_ai/uploaded_files/client.rb', line 91

def update(id:, file:, request_options: nil)
  response = @request_client.conn.put do | req |
  unless request_options&.timeout_in_seconds.nil?
req.options.timeout = request_options.timeout_in_seconds
  end
  unless request_options&.api_key.nil?
req.headers["X-API-KEY"] = request_options.api_key
  end
  unless request_options&.api_version.nil?
req.headers["X-API-Version"] = request_options.api_version
  else
req.headers["X-API-Version"] = "2025-07-30"
  end
  req.headers = { **(req.headers || {}), **@request_client.get_headers, **(request_options&.additional_headers || {}) }.compact
  unless request_options.nil? || request_options&.additional_query_parameters.nil?
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
  end
  req.body = { **(request_options&.additional_body_parameters || {}), file: Vellum::FileUtilities.as_faraday_multipart(file_like: file) }.compact
  req.url "#{@request_client.get_url(environment: Default, request_options: request_options)}/v1/uploaded-files/#{id}"
end
  Vellum::UploadedFileRead.from_json(json_object: response.body)
end