langchain_community.document_loaders.cube_semantic.CubeSemanticLoader

class langchain_community.document_loaders.cube_semantic.CubeSemanticLoader(cube_api_url: str, cube_api_token: str, load_dimension_values: bool = True, dimension_values_limit: int = 10000, dimension_values_max_retries: int = 10, dimension_values_retry_delay: int = 3)

加载Cube语义层元数据。

参数

• cube_api_url (str) – REST API端点。使用您的Cube部署的REST API。请在此处了解更多信息：https://cube.dev/docs/http-api/rest#configuration-base-path

• cube_api_token (str) – Cube API令牌。基于您的Cube API密钥生成身份验证令牌。请在此处了解更多信息：https://cube.dev/docs/security#generating-json-web-tokens-jwt

• load_dimension_values (bool) – 是否加载每个字符串维度的维度值。

• dimension_values_limit (int) – 要加载的最大维度值数量。

• dimension_values_max_retries (int) – 加载维度值的最多次数。

• dimension_values_retry_delay (int) – 加载维度值重试之间的延迟。

方法

__init__(cube_api_url, cube_api_token[, ...])
alazy_load()	Documents的懒加载器。
aload()	将数据加载到Document对象中。
lazy_load()	调用Cube的REST API元数据端点。
load()	将数据加载到Document对象中。
load_and_split([text_splitter])	加载Documents并分割成块。

__init__(cube_api_url: str, cube_api_token: str, load_dimension_values: bool = True, dimension_values_limit: int = 10000, dimension_values_max_retries: int = 10, dimension_values_retry_delay: int = 3)

参数

• cube_api_url (str) –

• cube_api_token (str) –

• load_dimension_values (bool) –

• dimension_values_limit (int) –

• dimension_values_max_retries (int) –

• dimension_values_retry_delay (int) –

async alazy_load() → AsyncIterator[Document]

Documents的懒加载器。

返回类型

AsyncIterator[Document]

async aload() → List[Document]

将数据加载到Document对象中。

返回类型

List[Document]

lazy_load() → Iterator[Document]

调用 Cube 的 REST API 元数据端点。

返回

• page_content=column_title + column_description

• metadata

  • table_name

  • column_name

  • column_data_type

  • column_member_type

  • column_title

  • column_description

  • column_values

  • cube_data_obj_type

返回类型

带有属性的一组文档列表

load() → List[Document]

将数据加载到Document对象中。

返回类型

List[Document]

load_and_split(text_splitter: Optional[TextSplitter] = None) → List[Document]

加载文档并将其拆分成块。块以Document的形式返回。

不要重写此方法。应考虑将其弃用！

参数

text_splitter (可选[TextSplitter]) – 用于拆分文档的TextSplitter实例。默认为RecursiveCharacterTextSplitter。

返回

文档列表。

返回类型

列表[Document]

CubeSemanticLoader使用的示例

• Cube

• Cube语义层