ArangoGraph#

class langchain_community.graphs.arangodb_graph.ArangoGraph(db: Any)[来源]#

用于图操作的ArangoDB封装器。

Security note: Make sure that the database connection uses credentials

这些权限范围狭窄,仅包含必要的权限。 未能这样做可能会导致数据损坏或丢失,因为调用代码可能会尝试执行导致数据删除、变异的命令,如果被适当提示,或者读取敏感数据,如果这些数据存在于数据库中。 防止这种负面结果的最佳方法是(适当地)限制授予与此工具一起使用的凭据的权限。

查看 https://python.langchain.com/docs/security 获取更多信息。

创建一个新的ArangoDB图包装器实例。

属性

db

schema

方法

__init__(db)

创建一个新的ArangoDB图包装器实例。

from_db_credentials([url, dbname, username, ...])

方便的构造函数,用于从凭据构建Arango DB。

generate_schema([sample_ratio])

生成ArangoDB数据库的模式并返回。用户可以指定一个sample_ratio(0到1之间)来确定用于呈现每个集合模式的文档/边的比例(相对于集合大小)。

query(query[, top_k])

查询ArangoDB数据库。

set_db(db)

set_schema([schema])

设置ArangoDB数据库的模式。

Parameters:

db (任意)

__init__(db: Any) None[源代码]#

创建一个新的ArangoDB图包装器实例。

Parameters:

db (任意)

Return type:

classmethod from_db_credentials(url: str | None = None, dbname: str | None = None, username: str | None = None, password: str | None = None) Any[source]#

方便的构造函数,用于从凭据构建Arango DB。

Parameters:
  • url (str | None) – Arango DB 的 URL。可以作为命名参数传递或设置为环境变量 ARANGODB_URL。默认为“http://localhost:8529”。

  • dbname (str | None) – Arango 数据库名称。可以作为命名参数传递或设置为环境变量 ARANGODB_DBNAME。默认为“_system”。

  • username (str | None) – 可以作为命名参数传入或设置为环境变量 ARANGODB_USERNAME。默认为“root”。

  • password (str | None) – 可以作为命名参数传递或设置为环境变量 ARANGODB_PASSWORD。默认为“”。

Returns:

一个 arango.database.StandardDatabase。

Return type:

任何

generate_schema(sample_ratio: float = 0) Dict[str, List[Dict[str, Any]]][source]#

生成ArangoDB数据库的模式并返回它 用户可以指定一个sample_ratio(0到1)来确定 用于呈现每个集合模式的文档/边的比例(相对于集合大小)。

Parameters:

sample_ratio (float)

Return type:

Dict[str, List[Dict[str, Any]]]

query(query: str, top_k: int | None = None, **kwargs: Any) List[Dict[str, Any]][source]#

查询ArangoDB数据库。

Parameters:
  • query (str)

  • top_k (int | None)

  • kwargs (Any)

Return type:

列表[字典[str, 任意]]

set_db(db: Any) None[source]#
Parameters:

db (任意)

Return type:

set_schema(schema: Dict[str, Any] | None = None) None[source]#

设置ArangoDB数据库的模式。 如果schema为None,则自动生成模式。

Parameters:

schema (Dict[str, Any] | None)

Return type:

使用ArangoGraph的示例