Share via


CosmosDBIndex Class

Definition

CosmosDB Vector Store Index Definition.

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

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

Embedding model configuration.

FieldMapping

Field mapping configuration.

Id

Asset ID, a unique identifier for the asset.

(Inherited from DatasetIndex)
Name

The name of the resource.

(Inherited from DatasetIndex)
Tags

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

(Inherited from DatasetIndex)
Version

The version of the resource.

(Inherited from DatasetIndex)

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<DatasetIndex>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from DatasetIndex)
IJsonModel<DatasetIndex>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from DatasetIndex)
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<DatasetIndex>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from DatasetIndex)
IPersistableModel<DatasetIndex>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from DatasetIndex)
IPersistableModel<DatasetIndex>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from DatasetIndex)

Applies to