CosmosDBIndex Class

CosmosDB Vector Store Index Definition.

Constructor

CosmosDBIndex(*args: Any, **kwargs: Any)

Variables

Name	Description
id	str Asset ID, a unique identifier for the asset.
name	str The name of the resource. Required.
version	str The version of the resource. Required.
description	str The asset description text.
tags	dict[str, str] Tag dictionary. Tags can be added, removed, and updated.
type	str or <xref:azure.ai.projects.models.COSMOS_DB> Type of index. Required. CosmosDB
connection_name	str Name of connection to CosmosDB. Required.
database_name	str Name of the CosmosDB Database. Required.
container_name	str Name of CosmosDB Container. Required.
embedding_configuration	EmbeddingConfiguration Embedding model configuration. Required.
field_mapping	FieldMapping Field mapping configuration. Required.

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from D.
copy
get	Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
items
keys
pop	Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
popitem	Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
setdefault	Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
update	Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy

copy() -> Model

get

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type	Description
ItemsView	set-like object providing a view on D's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on D's keys

pop

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

popitem

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> Tuple[str, Any]

setdefault

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name	Description
key Required
default

update

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values

values() -> ValuesView[Any]

Returns

Type	Description
ValuesView	an object providing a view on D's values

Attributes

connection_name

Name of connection to CosmosDB. Required.

connection_name: str

container_name

Name of CosmosDB Container. Required.

container_name: str

database_name

Name of the CosmosDB Database. Required.

database_name: str

description

The asset description text.

description: str | None

embedding_configuration

Embedding model configuration. Required.

embedding_configuration: _models.EmbeddingConfiguration

field_mapping

Field mapping configuration. Required.

field_mapping: _models.FieldMapping

id

Asset ID, a unique identifier for the asset.

id: str | None

name

The name of the resource. Required.

name: str

tags

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

tags: Dict[str, str] | None

type

Type of index. Required. CosmosDB

type: COSMOS_DB: 'CosmosDBNoSqlVectorStore'>]

version

The version of the resource. Required.

version: str