Cube 语义层
本笔记本演示了如何检索 Cube 的数据模型元数据,并将其转换为适合作为嵌入传递给 LLM 的格式,从而增强上下文信息。
关于 Cube
Cube 是用于构建数据应用的语义层。它帮助数据工程师和应用程序开发人员访问现代数据存储中的数据,将其组织成一致的定义,并将其交付给每个应用程序。
Cube 的数据模型提供了结构和定义,这些结构和定义用作 LLM 理解数据并生成正确查询的上下文。LLM 不需要浏览复杂的连接和指标计算,因为 Cube 抽象了这些,并提供了一个在业务级别的术语上操作的简单接口,而不是 SQL 表和列名。这种简化有助于 LLM 减少错误并避免幻觉。
示例
输入参数(必需)
Cube Semantic Loader
需要 2 个参数
-
cube_api_url
:您的 Cube 部署 REST API 的 URL。有关配置基本路径的更多信息,请参阅 Cube 文档。 -
cube_api_token
:根据您的 Cube API 密钥生成的身份验证令牌。有关生成 JSON Web 令牌 (JWT) 的说明,请参阅 Cube 文档。
输入参数(可选)
-
load_dimension_values
:是否为每个字符串维度加载维度值。 -
dimension_values_limit
:要加载的最大维度值数量。 -
dimension_values_max_retries
:加载维度值的最大重试次数。 -
dimension_values_retry_delay
:加载维度值时重试之间的延迟。
import jwt
from langchain_community.document_loaders import CubeSemanticLoader
api_url = "https://api-example.gcp-us-central1.cubecloudapp.dev/cubejs-api/v1/meta"
cubejs_api_secret = "api-secret-here"
security_context = {}
# Read more about security context here: https://cube.dev/docs/security
api_token = jwt.encode(security_context, cubejs_api_secret, algorithm="HS256")
loader = CubeSemanticLoader(api_url, api_token)
documents = loader.load()
API 参考:CubeSemanticLoader
返回具有以下属性的文档列表
page_content
metadata
table_name
column_name
column_data_type
column_title
column_description
column_values
cube_data_obj_type
# Given string containing page content
page_content = "Users View City, None"
# Given dictionary containing metadata
metadata = {
"table_name": "users_view",
"column_name": "users_view.city",
"column_data_type": "string",
"column_title": "Users View City",
"column_description": "None",
"column_member_type": "dimension",
"column_values": [
"Austin",
"Chicago",
"Los Angeles",
"Mountain View",
"New York",
"Palo Alto",
"San Francisco",
"Seattle",
],
"cube_data_obj_type": "view",
}