langchain_community.cache.AstraDBCache

class langchain_community.cache.AstraDBCache(*, collection_name: str = 'langchain_astradb_cache', token: Optional[str] = None, api_endpoint: Optional[str] = None, astra_db_client: Optional[AstraDB] = None, async_astra_db_client: Optional[AsyncAstraDB] = None, namespace: Optional[str] = None, pre_delete_collection: bool = False, setup_mode: AstraSetupMode = SetupMode.SYNC)[source]

[Deprecated]

Notes

Deprecated since version 0.0.28.

将Astra DB用作后端的缓存。

它使用单个集合作为kv存储 组合在文档的_id中的查找键是:

  • prompt,一个字符串

  • llm_string,模型参数的确定性str表示。 (用于防止相同提示不同模型的碰撞)

参数:

collection_name:要创建/使用的Astra DB集合的名称。 token:用于Astra DB使用的API令牌。 api_endpoint:API端点的完整URL,

例如`https://<DB-ID>-us-east1.apps.astra.datastax.com`。

astra_db_client:token+api_endpoint的替代方法

您可以传递一个已创建的’astrapy.db.AstraDB’实例。

async_astra_db_client:token+api_endpoint的替代方法

您可以传递一个已创建的’astrapy.db.AsyncAstraDB’实例。

namespace:创建集合的命名空间(又名键空间)。

默认为数据库的“默认命名空间”。

setup_mode:用于创建Astra DB集合的模式(SYNC、ASYNC或OFF)。 pre_delete_collection:是否在创建集合之前删除集合。

如果为False且集合已经存在,则将使用现有集合。

Methods

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

将Astra DB用作后端的缓存。

aclear(**kwargs)

清除可以接受额外关键字参数的缓存。

adelete(prompt, llm_string)

如果存在条目,则从缓存中驱逐。

adelete_through_llm(prompt, llm[, stop])

一个围绕`adelete`的包装器,LLM被传递。如果llm.invoke(prompt)调用有一个`stop`参数,你应该在这里传递它。

alookup(prompt, llm_string)

根据提示和llm_string进行查找。

aupdate(prompt, llm_string, return_val)

根据提示和llm_string更新缓存。

clear(**kwargs)

清除可以接受额外关键字参数的缓存。

delete(prompt, llm_string)

如果存在条目,则从缓存中驱逐。

delete_through_llm(prompt, llm[, stop])

一个围绕LLM传递的`delete`的包装器。 如果llm.invoke(prompt)调用有一个`stop`参数,你应该在这里传递它。

lookup(prompt, llm_string)

根据提示和llm_string进行查找。

update(prompt, llm_string, return_val)

根据提示和llm_string更新缓存。

Parameters
  • collection_name (str) –

  • token (Optional[str]) –

  • api_endpoint (Optional[str]) –

  • astra_db_client (Optional[AstraDB]) –

  • async_astra_db_client (Optional[AsyncAstraDB]) –

  • namespace (Optional[str]) –

  • pre_delete_collection (bool) –

  • setup_mode (AstraSetupMode) –

__init__(*, collection_name: str = 'langchain_astradb_cache', token: Optional[str] = None, api_endpoint: Optional[str] = None, astra_db_client: Optional[AstraDB] = None, async_astra_db_client: Optional[AsyncAstraDB] = None, namespace: Optional[str] = None, pre_delete_collection: bool = False, setup_mode: AstraSetupMode = SetupMode.SYNC)[source]

将Astra DB用作后端的缓存。

它使用单个集合作为kv存储 组合在文档的_id中的查找键是:

  • prompt,一个字符串

  • llm_string,模型参数的确定性str表示。 (用于防止相同提示不同模型的碰撞)

参数:

collection_name:要创建/使用的Astra DB集合的名称。 token:用于Astra DB使用的API令牌。 api_endpoint:API端点的完整URL,

例如`https://<DB-ID>-us-east1.apps.astra.datastax.com`。

astra_db_client:token+api_endpoint的替代方法

您可以传递一个已创建的’astrapy.db.AstraDB’实例。

async_astra_db_client:token+api_endpoint的替代方法

您可以传递一个已创建的’astrapy.db.AsyncAstraDB’实例。

namespace:创建集合的命名空间(又名键空间)。

默认为数据库的“默认命名空间”。

setup_mode:用于创建Astra DB集合的模式(SYNC、ASYNC或OFF)。 pre_delete_collection:是否在创建集合之前删除集合。

如果为False且集合已经存在,则将使用现有集合。

Parameters
  • collection_name (str) –

  • token (Optional[str]) –

  • api_endpoint (Optional[str]) –

  • astra_db_client (Optional[AstraDB]) –

  • async_astra_db_client (Optional[AsyncAstraDB]) –

  • namespace (Optional[str]) –

  • pre_delete_collection (bool) –

  • setup_mode (AstraSetupMode) –

async aclear(**kwargs: Any) None[source]

清除可以接受额外关键字参数的缓存。

Parameters

kwargs (Any) –

Return type

None

async adelete(prompt: str, llm_string: str) None[source]

如果存在条目,则从缓存中驱逐。

Parameters
  • prompt (str) –

  • llm_string (str) –

Return type

None

async adelete_through_llm(prompt: str, llm: LLM, stop: Optional[List[str]] = None) None[source]

一个围绕`adelete`的包装器,LLM被传递。如果llm.invoke(prompt)调用有一个`stop`参数,你应该在这里传递它。

Parameters
  • prompt (str) –

  • llm (LLM) –

  • stop (Optional[List[str]]) –

Return type

None

async alookup(prompt: str, llm_string: str) Optional[Sequence[Generation]][source]

根据提示和llm_string进行查找。

期望缓存实现从提示和llm_string的2元组中生成一个键(例如,通过使用分隔符将它们连接起来)。

参数:
prompt:提示的字符串表示。

对于Chat模型,提示是将提示序列化为语言模型的非平凡表示。

llm_string:LLM配置的字符串表示。

这用于捕获LLM的调用参数 (例如,模型名称、温度、停止标记、最大标记等)。 这些调用参数被序列化为字符串表示。

返回:

在缓存未命中时,返回None。在缓存命中时,返回缓存的值。 缓存的值是Generations(或子类)的列表。

Parameters
  • prompt (str) –

  • llm_string (str) –

Return type

Optional[Sequence[Generation]]

async aupdate(prompt: str, llm_string: str, return_val: Sequence[Generation]) None[source]

根据提示和llm_string更新缓存。

提示和llm_string用于生成缓存的键。 键应该与查找方法的键匹配。

参数:
prompt:提示的字符串表示。

对于Chat模型,提示是将提示序列化为语言模型的非平凡表示。

llm_string:LLM配置的字符串表示。

这用于捕获LLM的调用参数 (例如,模型名称、温度、停止标记、最大标记等)。 这些调用参数被序列化为字符串表示。

return_val:要缓存的值。该值是Generations的列表(或子类)。

Parameters
  • prompt (str) –

  • llm_string (str) –

  • return_val (Sequence[Generation]) –

Return type

None

clear(**kwargs: Any) None[source]

清除可以接受额外关键字参数的缓存。

Parameters

kwargs (Any) –

Return type

None

delete(prompt: str, llm_string: str) None[source]

如果存在条目,则从缓存中驱逐。

Parameters
  • prompt (str) –

  • llm_string (str) –

Return type

None

delete_through_llm(prompt: str, llm: LLM, stop: Optional[List[str]] = None) None[source]

一个围绕LLM传递的`delete`的包装器。 如果llm.invoke(prompt)调用有一个`stop`参数,你应该在这里传递它。

Parameters
  • prompt (str) –

  • llm (LLM) –

  • stop (Optional[List[str]]) –

Return type

None

lookup(prompt: str, llm_string: str) Optional[Sequence[Generation]][source]

根据提示和llm_string进行查找。

期望缓存实现从提示和llm_string的2元组中生成一个键(例如,通过使用分隔符将它们连接起来)。

参数:
prompt:提示的字符串表示。

对于Chat模型,提示是将提示序列化为语言模型的非平凡表示。

llm_string:LLM配置的字符串表示。

这用于捕获LLM的调用参数 (例如,模型名称、温度、停止标记、最大标记等)。 这些调用参数被序列化为字符串表示。

返回:

在缓存未命中时,返回None。在缓存命中时,返回缓存的值。 缓存的值是Generations(或子类)的列表。

Parameters
  • prompt (str) –

  • llm_string (str) –

Return type

Optional[Sequence[Generation]]

update(prompt: str, llm_string: str, return_val: Sequence[Generation]) None[source]

根据提示和llm_string更新缓存。

提示和llm_string用于生成缓存的键。 键应该与查找方法的键匹配。

参数:
prompt:提示的字符串表示。

对于Chat模型,提示是将提示序列化为语言模型的非平凡表示。

llm_string:LLM配置的字符串表示。

这用于捕获LLM的调用参数 (例如,模型名称、温度、停止标记、最大标记等)。 这些调用参数被序列化为字符串表示。

return_val:要缓存的值。该值是Generations的列表(或子类)。

Parameters
  • prompt (str) –

  • llm_string (str) –

  • return_val (Sequence[Generation]) –

Return type

None

Examples using AstraDBCache