CosmosDBIndex Class

Definition

Namespace:: Azure.AI.Projects

Assembly:: Azure.AI.Projects.dll

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

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

CosmosDB Vector Store Index Definition.

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

type CosmosDBIndex = class
    inherit Index
    interface IJsonModel<CosmosDBIndex>
    interface IPersistableModel<CosmosDBIndex>

Public Class CosmosDBIndex
Inherits Index
Implements IJsonModel(Of CosmosDBIndex), IPersistableModel(Of CosmosDBIndex)

Inheritance: Object

Index
CosmosDBIndex

Implements: IJsonModel<CosmosDBIndex> IPersistableModel<CosmosDBIndex> IPersistableModel<T>

Constructors

CosmosDBIndex(String, String, String, EmbeddingConfiguration, FieldMapping)

Initializes a new instance of CosmosDBIndex.

Properties

ConnectionName	Name of connection to CosmosDB.
ContainerName	Name of CosmosDB Container.
DatabaseName	Name of the CosmosDB Database.
Description	The asset description text. (Inherited from Index)
EmbeddingConfiguration	Embedding model configuration.
FieldMapping	Field mapping configuration.
Id	Asset ID, a unique identifier for the asset. (Inherited from Index)
Name	The name of the resource. (Inherited from Index)
Tags	Tag dictionary. Tags can be added, removed, and updated. (Inherited from Index)
Version	The version of the resource. (Inherited from Index)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

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

Applies to

Share via