Struct VectorStoreFileObject

pub struct VectorStoreFileObject {
    pub id: String,
    pub usage_bytes: u64,
    pub created_at: u64,
    pub vector_store_id: String,
    pub status: VectorStoreFileObjectStatus,
    pub last_error: Option<VectorStoreFileObjectLastError>,
    pub chunking_strategy: Option<ChunkingStrategyResponse>,
    pub attributes: Option<VectorStoreFileAttributes>,
}

A list of files attached to a vector store.

Fields

id: String

The identifier, which can be referenced in API endpoints.

usage_bytes: u64

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

created_at: u64

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

vector_store_id: String

The ID of the vector store that the File is attached to.

status: VectorStoreFileObjectStatus

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.

last_error: Option<VectorStoreFileObjectLastError>

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

chunking_strategy: Option<ChunkingStrategyResponse>

attributes: Option<VectorStoreFileAttributes>

Implementations

impl VectorStoreFileObject

pub fn builder() -> VectorStoreFileObjectBuilder<((), (), (), (), (), (), (), ())>

Create a builder for building VectorStoreFileObject. On the builder, call .id(...), .usage_bytes(...), .created_at(...), .vector_store_id(...), .status(...), .last_error(...)(optional), .chunking_strategy(...)(optional), .attributes(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of VectorStoreFileObject.

Trait Implementations

impl Clone for VectorStoreFileObject

fn clone(&self) -> VectorStoreFileObject

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VectorStoreFileObject

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VectorStoreFileObject

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for VectorStoreFileObject

fn eq(&self, other: &VectorStoreFileObject) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for VectorStoreFileObject

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for VectorStoreFileObject