Class: OpenAI::Models::VectorStores::VectorStoreFile

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/vector_stores/vector_store_file.rb

Overview

See Also:

Defined Under Namespace

Modules: Attribute, Status Classes: LastError

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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, 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(id: , created_at: , last_error: , status: , usage_bytes: , vector_store_id: , attributes: nil, chunking_strategy: nil, object: :"vector_store.file") ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::VectorStores::VectorStoreFile for more details.

A list of files attached to a vector store.

Parameters:




# File 'lib/openai/models/vector_stores/vector_store_file.rb', line 77

Instance Attribute Details

#attributes ⇒ Hash{Symbol=>String, Float, Boolean}?

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters, booleans, or numbers.

Returns:

  • (Hash{Symbol=>String, Float, Boolean}, nil) 


65
66
67
68
69
 
# File 'lib/openai/models/vector_stores/vector_store_file.rb', line 65

optional :attributes,
-> {
  OpenAI::Internal::Type::HashOf[union: OpenAI::VectorStores::VectorStoreFile::Attribute]
},
nil?: true

#chunking_strategy ⇒ OpenAI::Models::StaticFileChunkingStrategyObject, ...

The strategy used to chunk the file.

Returns:



75
 
# File 'lib/openai/models/vector_stores/vector_store_file.rb', line 75

optional :chunking_strategy, union: -> { OpenAI::FileChunkingStrategy }

#created_at ⇒ Integer

The Unix timestamp (in seconds) for when the vector store file was created.

Returns:

  • (Integer) 


18
 
# File 'lib/openai/models/vector_stores/vector_store_file.rb', line 18

required :created_at, Integer

#id ⇒ String

The identifier, which can be referenced in API endpoints.

Returns:

  • (String) 


12
 
# File 'lib/openai/models/vector_stores/vector_store_file.rb', line 12

required :id, String

#last_error ⇒ OpenAI::Models::VectorStores::VectorStoreFile::LastError?

The last error associated with this vector store file. Will be ‘null` if there are no errors.

Returns:



25
 
# File 'lib/openai/models/vector_stores/vector_store_file.rb', line 25

required :last_error, -> { OpenAI::VectorStores::VectorStoreFile::LastError }, nil?: true

#object ⇒ Symbol, :"vector_store.file"

The object type, which is always ‘vector_store.file`.

Returns:

  • (Symbol, :"vector_store.file") 


31
 
# File 'lib/openai/models/vector_stores/vector_store_file.rb', line 31

required :object, const: :"vector_store.file"

#status ⇒ Symbol, OpenAI::Models::VectorStores::VectorStoreFile::Status

The status of the vector store file, which can be either ‘in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use.

Returns:



39
 
# File 'lib/openai/models/vector_stores/vector_store_file.rb', line 39

required :status, enum: -> { OpenAI::VectorStores::VectorStoreFile::Status }

#usage_bytes ⇒ Integer

The total vector store usage in bytes. Note that this may be different from the original file size.

Returns:

  • (Integer) 


46
 
# File 'lib/openai/models/vector_stores/vector_store_file.rb', line 46

required :usage_bytes, Integer

#vector_store_id ⇒ String

The ID of the [vector store](platform.openai.com/docs/api-reference/vector-stores/object) that the [File](platform.openai.com/docs/api-reference/files) is attached to.

Returns:

  • (String) 


55
 
# File 'lib/openai/models/vector_stores/vector_store_file.rb', line 55

required :vector_store_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/openai/models/vector_stores/vector_store_file.rb', line 133