Share via


AIProjectCosmosDBIndex Class

Definition

CosmosDB Vector Store Index Definition.

public class AIProjectCosmosDBIndex : Azure.AI.Projects.AIProjectIndex, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.AIProjectCosmosDBIndex>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.AIProjectCosmosDBIndex>
type AIProjectCosmosDBIndex = class
    inherit AIProjectIndex
    interface IJsonModel<AIProjectCosmosDBIndex>
    interface IPersistableModel<AIProjectCosmosDBIndex>
Public Class AIProjectCosmosDBIndex
Inherits AIProjectIndex
Implements IJsonModel(Of AIProjectCosmosDBIndex), IPersistableModel(Of AIProjectCosmosDBIndex)
Inheritance
AIProjectCosmosDBIndex
Implements

Constructors

AIProjectCosmosDBIndex(String, String, String, EmbeddingConfiguration, AIProjectIndexFieldMapping)

Initializes a new instance of AIProjectCosmosDBIndex.

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 AIProjectIndex)
EmbeddingConfiguration

Embedding model configuration.

FieldMapping

Field mapping configuration.

Id

Asset ID, a unique identifier for the asset.

(Inherited from AIProjectIndex)
Name

The name of the resource.

(Inherited from AIProjectIndex)
Tags

Tag dictionary. Tags can be added, removed, and updated.

(Inherited from AIProjectIndex)
Version

The version of the resource.

(Inherited from AIProjectIndex)

Methods

JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<AIProjectCosmosDBIndex>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<AIProjectCosmosDBIndex>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<AIProjectIndex>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from AIProjectIndex)
IJsonModel<AIProjectIndex>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from AIProjectIndex)
IPersistableModel<AIProjectCosmosDBIndex>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<AIProjectCosmosDBIndex>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<AIProjectCosmosDBIndex>.Write(ModelReaderWriterOptions)
IPersistableModel<AIProjectIndex>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from AIProjectIndex)
IPersistableModel<AIProjectIndex>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from AIProjectIndex)
IPersistableModel<AIProjectIndex>.Write(ModelReaderWriterOptions) (Inherited from AIProjectIndex)

Applies to