AstraDBStore#

class langchain_astradb.storage.AstraDBStore(collection_name: str, *, token: str | TokenProvider | None = None, api_endpoint: str | None = None, namespace: str | None = None, environment: str | None = None, pre_delete_collection: bool = False, setup_mode: SetupMode = SetupMode.SYNC, ext_callers: list[tuple[str | None, str | None] | str | None] | None = None, astra_db_client: AstraDB | None = None, async_astra_db_client: AsyncAstraDB | None = None)[来源]#

使用DataStax AstraDB作为底层存储的BaseStore实现。

值类型可以是任何可由json.dumps序列化的类型。 可用于与CacheBackedEmbeddings一起存储嵌入。

AstraDB集合中的文档将具有以下格式

{
  "_id": "<key>",
  "value": <value>
}
Parameters:

  • collection_name (str) – 要创建/使用的Astra DB集合的名称。

  • token (str | TokenProvider | None) – 用于Astra DB的API令牌，可以是字符串形式，也可以是astrapy.authentication.TokenProvider的子类。如果未提供，则会检查环境变量ASTRA_DB_APPLICATION_TOKEN。

  • api_endpoint (str | None) – API端点的完整URL，例如 https://-us-east1.apps.astra.datastax.com。如果未提供， 则检查环境变量 ASTRA_DB_API_ENDPOINT。

  • namespace (str | None) – 创建集合的命名空间（也称为keyspace）。 如果未提供，则检查环境变量 ASTRA_DB_KEYSPACE。 默认为数据库的“默认命名空间”。

  • environment (str | None) – 一个字符串，指定目标数据API的环境。 如果省略，默认为“prod”（Astra DB生产环境）。 其他值在astrapy.constants.Environment枚举类中。

  • setup_mode (SetupMode) – 用于创建Astra DB集合的模式（SYNC、ASYNC或OFF）。

  • pre_delete_collection (bool) – 是否在创建集合之前删除它。如果为False且集合已经存在，则直接使用该集合。

  • ext_callers (list[tuple[str | None, str | None] | str | None] | None) – 一个或多个调用者身份，用于在User-Agent头中标识Data API调用。这是一个（名称，版本）对的列表，如果没有提供版本信息，则只是字符串，如果提供，将成为与此组件相关的所有API请求中User-Agent字符串的前导部分。

  • astra_db_client (AstraDB | None) – 从版本0.3.5开始已弃用。 请使用‘token’、‘api_endpoint’以及可选的‘environment’。 你可以传递一个已经创建的‘astrapy.db.AstraDB’实例 （作为‘token’、‘api_endpoint’和‘environment’的替代方案）。

  • async_astra_db_client (AsyncAstraDB | None) – 从版本0.3.5开始已弃用。 请使用‘token’、‘api_endpoint’和可选的‘environment’。 你可以传递一个已经创建的‘astrapy.db.AsyncAstraDB’实例 （作为‘token’、‘api_endpoint’和‘environment’的替代）。

方法

__init__(collection_name, *[, token, ...])

使用DataStax AstraDB作为底层存储的BaseStore实现。

amdelete(keys)

异步删除给定的键及其关联的值。

amget(keys)

异步获取与给定键关联的值。

amset(key_value_pairs)

异步设置给定键的值。

ayield_keys(*[, prefix])

异步获取一个迭代器，用于匹配给定前缀的键。

decode_value(value)

从Astra DB解码值。

encode_value(value)

为Astra DB编码值。

mdelete(keys)

删除给定的键及其关联的值。

mget(keys)

获取与给定键关联的值。

mset(key_value_pairs)

设置给定键的值。

yield_keys(*[, prefix])

获取一个迭代器，用于遍历与给定前缀匹配的键。
__init__(collection_name: str, *, token: str | TokenProvider | None = None, api_endpoint: str | None = None, namespace: str | None = None, environment: str | None = None, pre_delete_collection: bool = False, setup_mode: SetupMode = SetupMode.SYNC, ext_callers: list[tuple[str | None, str | None] | str | None] | None = None, astra_db_client: AstraDB | None = None, async_astra_db_client: AsyncAstraDB | None = None) → None[来源]#

使用DataStax AstraDB作为底层存储的BaseStore实现。

值类型可以是任何可由json.dumps序列化的类型。 可用于与CacheBackedEmbeddings一起存储嵌入。

AstraDB集合中的文档将具有以下格式

{
  "_id": "<key>",
  "value": <value>
}
Parameters:

  • collection_name (str) – 要创建/使用的Astra DB集合的名称。

  • token (str | TokenProvider | None) – 用于Astra DB的API令牌，可以是字符串形式，也可以是astrapy.authentication.TokenProvider的子类。如果未提供，则会检查环境变量ASTRA_DB_APPLICATION_TOKEN。

  • api_endpoint (str | None) – API端点的完整URL，例如 https://-us-east1.apps.astra.datastax.com。如果未提供， 则检查环境变量 ASTRA_DB_API_ENDPOINT。

  • namespace (str | None) – 创建集合的命名空间（也称为keyspace）。 如果未提供，则检查环境变量 ASTRA_DB_KEYSPACE。 默认为数据库的“默认命名空间”。

  • environment (str | None) – 一个字符串，指定目标数据API的环境。 如果省略，默认为“prod”（Astra DB生产环境）。 其他值在astrapy.constants.Environment枚举类中。

  • setup_mode (SetupMode) – 用于创建Astra DB集合的模式（SYNC、ASYNC或OFF）。

  • pre_delete_collection (bool) – 是否在创建集合之前删除它。如果为False且集合已存在，则直接使用该集合。

  • ext_callers (list[tuple[str | None, str | None] | str | None] | None) – 一个或多个调用者身份，用于在User-Agent头中标识Data API调用。这是一个（名称，版本）对的列表，如果没有提供版本信息，则只是字符串，如果提供，将成为与此组件相关的所有API请求中User-Agent字符串的前导部分。

  • astra_db_client (AstraDB | None) – 从版本0.3.5开始已弃用。 请使用‘token’、‘api_endpoint’以及可选的‘environment’。 你可以传递一个已经创建的‘astrapy.db.AstraDB’实例 （作为‘token’、‘api_endpoint’和‘environment’的替代方案）。

  • async_astra_db_client (AsyncAstraDB | None) – 从版本0.3.5开始已弃用。 请使用‘token’、‘api_endpoint’和可选的‘environment’。 你可以传递一个已经创建的‘astrapy.db.AsyncAstraDB’实例 （作为‘token’、‘api_endpoint’和‘environment’的替代）。

Return type:

无

async amdelete(keys: Sequence[str]) → None#

异步删除给定的键及其关联的值。

Parameters:

keys (Sequence[K]) – 要删除的键序列。

Return type:

无

async amget(keys: Sequence[str]) → list[V | None]#

异步获取与给定键关联的值。

Parameters:

keys (Sequence[K]) – 一个键的序列。

Returns:

与键相关联的一系列可选值。 如果未找到键，则对应的值将为None。

Return type:

列表[V | 无]

async amset(key_value_pairs: Sequence[tuple[str, V]]) → None#

异步设置给定键的值。

Parameters:

key_value_pairs (Sequence[Tuple[K, V]]) – 一个键值对的序列。

Return type:

无

async ayield_keys(*, prefix: str | None = None) → AsyncIterator[str]#

异步获取一个迭代器，用于遍历与给定前缀匹配的键。

Parameters:

prefix (str) – 要匹配的前缀。

Yields:

Iterator[K | str] – 一个遍历与给定前缀匹配的键的迭代器。 此方法允许返回一个遍历 K 或 str 的迭代器，具体取决于给定存储的更有意义的方式。

Return type:

AsyncIterator[str]

decode_value(value: Any) → Any[来源]#

从Astra DB解码值。

Parameters:

值 (任意类型)

Return type:

任何

encode_value(value: Any) → Any[来源]#

为Astra DB编码值。

Parameters:

值 (任意类型)

Return type:

任何

mdelete(keys: Sequence[str]) → None#

删除给定的键及其关联的值。

Parameters:

keys (Sequence[K]) – 要删除的键序列。

Return type:

无

mget(keys: Sequence[str]) → list[V | None]#

获取与给定键关联的值。

Parameters:

keys (Sequence[K]) – 一个键的序列。

Returns:

与键相关联的一系列可选值。 如果未找到键，则对应的值将为None。

Return type:

列表[V | 无]

mset(key_value_pairs: Sequence[tuple[str, V]]) → None#

为给定的键设置值。

Parameters:

key_value_pairs (Sequence[Tuple[K, V]]) – 一个键值对的序列。

Return type:

无

yield_keys(*, prefix: str | None = None) → Iterator[str]#

获取一个迭代器，用于遍历与给定前缀匹配的键。

Parameters:

prefix (str) – 要匹配的前缀。

Yields:

Iterator[K | str] – 一个遍历与给定前缀匹配的键的迭代器。 此方法允许返回一个遍历 K 或 str 的迭代器，具体取决于给定存储的更有意义的方式。

Return type:

迭代器[str]