langchain_community.graphs.arangodb_graph.ArangoGraph

class langchain_community.graphs.arangodb_graph.ArangoGraph(db: Any)[source]

ArangoDB 图操作封装。

安全提示:确保数据库连接使用凭证。

仅包含必要权限的窄范围权限。不这样做可能会导致数据损坏或丢失,因为调用代码可能会尝试执行导致删除、数据变更(如果得到适当提示)或读取敏感数据的命令。避免此类负面结果的最佳方法是(根据适用情况)限制与此工具一起使用的凭证授予的权限。

更多详细信息,请参阅https://python.langchain.ac.cn/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 数据库的模式。

参数

db (Any) –

__init__(db: Any) None[source]

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

参数

db (Any) –

返回类型

None

classmethod 从数据库凭据(url: Optional[str] = None, dbname: Optional[str] = None, username: Optional[str] = None, password: Optional[str] = None) Any[源码]

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

参数
  • url (可选[str]) – Arango DB URL。可以作为命名参数传入,也可以设置为环境变量 ARANGODB_URL。默认为“http://localhost:8529”。

  • dbname (可选[str]) – Arango DB 名称。可以作为命名参数传入,也可以设置为环境变量 ARANGODB_DBNAME。默认为“_system”。

  • username (可选[str]) – 可以作为命名参数传入,也可以设置为环境变量 ARANGODB_USERNAME。默认为“root”。

  • password (可选[str]) – 可以作为命名参数传入,也可以设置为环境变量 ARANGODB_PASSWORD。默认为空字符串。

返回

一个 arango.database.StandardDatabase 对象。

返回类型

Any

generate_schema(sample_ratio: float = 0) Dict[str, List[Dict[str, Any]]][源码]

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

参数

sample_ratio (float) –

返回类型

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

查询(query: str, top_k: Optional[int] = None, **kwargs: Any) List[Dict[str, Any]][source]

查询 ArangoDB 数据库。

参数
  • 查询 (str) –

  • top_k (Optional[int]) –

  • kwargs (Any) –

返回类型

List[Dict[str, Any]]

set_db(db: Any) None[source]
参数

db (Any) –

返回类型

None

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

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

参数

schema (Optional[Dict[str, Any]]) –

返回类型

None

使用 ArangoGraph 的示例