CosmosDBIndex interface

Package:

@azure/ai-projects

CosmosDB Vector Store Index Definition

Extends

@azure/ai-projects.Index

Properties

connectionName	Name of connection to CosmosDB
containerName	Name of CosmosDB Container
databaseName	Name of the CosmosDB Database
embeddingConfiguration	Embedding model configuration
fieldMapping	Field mapping configuration
type	Type of index

Inherited Properties

description	The asset description text.
id	Asset ID, a unique identifier for the asset
name	The name of the resource
tags	Tag dictionary. Tags can be added, removed, and updated.
version	The version of the resource

Property Details

connectionName

Name of connection to CosmosDB

connectionName: string

Property Value

string

containerName

Name of CosmosDB Container

containerName: string

Property Value

string

databaseName

Name of the CosmosDB Database

databaseName: string

Property Value

string

embeddingConfiguration

Embedding model configuration

embeddingConfiguration: EmbeddingConfiguration

Property Value

EmbeddingConfiguration

fieldMapping

Field mapping configuration

fieldMapping: FieldMapping

Property Value

FieldMapping

type

Type of index

type: "CosmosDBNoSqlVectorStore"

Property Value

"CosmosDBNoSqlVectorStore"

Inherited Property Details

description

The asset description text.

description?: string

Property Value

string

Inherited From Index.description

id

Asset ID, a unique identifier for the asset

id?: string

Property Value

string

Inherited From Index.id

name

The name of the resource

name: string

Property Value

string

Inherited From Index.name

tags

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

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From Index.tags

version

The version of the resource

version: string

Property Value

string

Inherited From Index.version