VectorStore Class

Reference

Definition

Namespace:: Azure.AI.Projects

Assembly:: Azure.AI.Projects.dll

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

Source:: VectorStore.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.

A vector store is a collection of processed files can be used by the file_search tool.

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

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

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

Inheritance: Object
VectorStore

Implements: IJsonModel<VectorStore> IPersistableModel<VectorStore> IPersistableModel<T>

Properties

CreatedAt	The Unix timestamp (in seconds) for when the vector store was created.
ExpiresAfter	Details on when this vector store expires.
ExpiresAt	The Unix timestamp (in seconds) for when the vector store will expire.
FileCounts	Files count grouped by status processed or being processed by this vector store.
Id	The identifier, which can be referenced in API endpoints.
LastActiveAt	The Unix timestamp (in seconds) for when the vector store was last active.
Metadata	A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
Name	The name of the vector store.
Object	The object type, which is always `vector_store`.
Status	The status of the vector store, which can be either `expired`, `in_progress`, or `completed`. A status of `completed` indicates that the vector store is ready for use.
UsageBytes	The total number of bytes used by the files in the vector store.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

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

Applies to

Share via