VectorStoreFile Class

Reference

Definition

Namespace:: Azure.AI.Projects

Assembly:: Azure.AI.Projects.dll

Package:: Azure.AI.Projects v1.0.0-beta.1

Source:: VectorStoreFile.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Description of a file attached to a vector store.

public class VectorStoreFile : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.VectorStoreFile>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.VectorStoreFile>

type VectorStoreFile = class
    interface IJsonModel<VectorStoreFile>
    interface IPersistableModel<VectorStoreFile>

Public Class VectorStoreFile
Implements IJsonModel(Of VectorStoreFile), IPersistableModel(Of VectorStoreFile)

Inheritance: Object
VectorStoreFile

Implements: IJsonModel<VectorStoreFile> IPersistableModel<VectorStoreFile> IPersistableModel<T>

Properties

ChunkingStrategy	The strategy used to chunk the file. Please note VectorStoreChunkingStrategyResponse is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include VectorStoreAutoChunkingStrategyResponse and VectorStoreStaticChunkingStrategyResponse.
CreatedAt	The Unix timestamp (in seconds) for when the vector store file was created.
Id	The identifier, which can be referenced in API endpoints.
LastError	The last error associated with this vector store file. Will be `null` if there are no errors.
Object	The object type, which is always `vector_store.file`.
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.
UsageBytes	The total vector store usage in bytes. Note that this may be different from the original file size.
VectorStoreId	The ID of the vector store that the file is attached to.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<VectorStoreFile>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<VectorStoreFile>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<VectorStoreFile>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<VectorStoreFile>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<VectorStoreFile>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to

Share via