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: REST API端点。

使用您的Cube部署的REST API。 请在此处查找更多信息: https://cube.dev/docs/http-api/rest#configuration-base-path

cube_api_token: Cube API令牌。

认证令牌是基于您的Cube API密钥生成的。 请在此处查找更多信息: https://cube.dev/docs/security#generating-json-web-tokens-jwt

load_dimension_values: 是否加载每个字符串维度的维度值。 dimension_values_limit: 要加载的维度值的最大数量。 dimension_values_max_retries: 加载维度值的最大重试次数。 dimension_values_retry_delay: 加载维度值的重试之间的延迟。

Methods

__init__(cube_api_url, cube_api_token[, ...])
alazy_load()	一个用于文档的惰性加载器。
aload()	将数据加载到文档对象中。
lazy_load()	调用Cube的REST API元数据端点。
load()	将数据加载到文档对象中。
load_and_split([text_splitter])	加载文档并分割成块。块作为文档返回。

Parameters

• 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) –

__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)

Parameters

• 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]

一个用于文档的惰性加载器。

Return type

AsyncIterator[Document]

async aload() → List[Document]

将数据加载到文档对象中。

Return type

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

Return type

Iterator[Document]

load() → List[Document]

将数据加载到文档对象中。

Return type

List[Document]

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

加载文档并分割成块。块作为文档返回。

不要覆盖此方法。应该被视为已弃用！

参数：

text_splitter: 用于分割文档的TextSplitter实例。

默认为RecursiveCharacterTextSplitter。

返回：

文档列表。

Parameters

text_splitter (Optional[TextSplitter]) –

Return type

List[Document]

Examples using CubeSemanticLoader

• Cube

• Read more about security context here: https://cube.dev/docs/security