Class: Anthropic::Models::FileUploadParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/anthropic/models/file_upload_params.rb,
sig/anthropic/models/file_upload_params.rbs

Overview

See Also:

  • Anthropic::Resources::Files#upload

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Anthropic

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(file:, expires_in_seconds: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Anthropic::Models::FileUploadParams for more details.

Parameters:

  • file (Pathname, StringIO, IO, String, Anthropic::FilePart) —

    The file to upload

  • expires_in_seconds (Integer) (defaults to: nil) —

    Seconds from upload until the file expires and its bytes become permanently unav

  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/anthropic/models/file_upload_params.rb', line 23

Instance Attribute Details

#expires_in_seconds ⇒ Integer?

Seconds from upload until the file expires and its bytes become permanently unavailable. Must be between 3600 (one hour) and 7776000 (ninety days).

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


21
 
# File 'lib/anthropic/models/file_upload_params.rb', line 21

optional :expires_in_seconds, Integer

#file ⇒ Pathname, ...

The file to upload

Parameters:

  • value (Anthropic::Internal::file_input)

Returns:



14
 
# File 'lib/anthropic/models/file_upload_params.rb', line 14

required :file, Anthropic::Internal::Type::FileInput

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


23
 
# File 'sig/anthropic/models/file_upload_params.rbs', line 23

def to_hash: -> {