Class VectorStoreFileBatch
-
- All Implemented Interfaces:
public final class VectorStoreFileBatch
A batch of files attached to a vector store.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
VectorStoreFileBatch.Builder
A builder for VectorStoreFileBatch.
public final class
VectorStoreFileBatch.FileCounts
public final class
VectorStoreFileBatch.Status
The status of the vector store files batch, which can be either
in_progress
,completed
,cancelled
orfailed
.
-
Method Summary
Modifier and Type Method Description final String
id()
The identifier, which can be referenced in API endpoints. final Long
createdAt()
The Unix timestamp (in seconds) for when the vector store files batch was created. final VectorStoreFileBatch.FileCounts
fileCounts()
final JsonValue
_object_()
The object type, which is always vector_store.file_batch
.final VectorStoreFileBatch.Status
status()
The status of the vector store files batch, which can be either in_progress
,completed
,cancelled
orfailed
.final String
vectorStoreId()
The ID of the vector store that the File is attached to. final JsonField<String>
_id()
Returns the raw JSON value of id. final JsonField<Long>
_createdAt()
Returns the raw JSON value of createdAt. final JsonField<VectorStoreFileBatch.FileCounts>
_fileCounts()
Returns the raw JSON value of fileCounts. final JsonField<VectorStoreFileBatch.Status>
_status()
Returns the raw JSON value of status. final JsonField<String>
_vectorStoreId()
Returns the raw JSON value of vectorStoreId. final Map<String, JsonValue>
_additionalProperties()
final VectorStoreFileBatch.Builder
toBuilder()
final VectorStoreFileBatch
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static VectorStoreFileBatch.Builder
builder()
Returns a mutable builder for constructing an instance of VectorStoreFileBatch. -
-
Method Detail
-
createdAt
final Long createdAt()
The Unix timestamp (in seconds) for when the vector store files batch was created.
-
fileCounts
final VectorStoreFileBatch.FileCounts fileCounts()
-
_object_
final JsonValue _object_()
The object type, which is always
vector_store.file_batch
.Expected to always return the following:
JsonValue.from("vector_store.files_batch")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
status
final VectorStoreFileBatch.Status status()
The status of the vector store files batch, which can be either
in_progress
,completed
,cancelled
orfailed
.
-
vectorStoreId
final String vectorStoreId()
The ID of the vector store that the File is attached to.
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_createdAt
final JsonField<Long> _createdAt()
Returns the raw JSON value of createdAt.
Unlike createdAt, this method doesn't throw if the JSON field has an unexpected type.
-
_fileCounts
final JsonField<VectorStoreFileBatch.FileCounts> _fileCounts()
Returns the raw JSON value of fileCounts.
Unlike fileCounts, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<VectorStoreFileBatch.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_vectorStoreId
final JsonField<String> _vectorStoreId()
Returns the raw JSON value of vectorStoreId.
Unlike vectorStoreId, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final VectorStoreFileBatch.Builder toBuilder()
-
validate
final VectorStoreFileBatch validate()
-
builder
final static VectorStoreFileBatch.Builder builder()
Returns a mutable builder for constructing an instance of VectorStoreFileBatch.
The following fields are required:
.id() .createdAt() .fileCounts() .status() .vectorStoreId()
-
-
-
-