Cube 语义层
本笔记本演示了以适合作为嵌入传递给LLMs的格式检索Cube数据模型元数据的过程,从而增强上下文信息。
关于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密钥生成的身份验证令牌。请参考Cube文档以获取生成JSON Web令牌(JWT)的说明。
输入参数(可选)
-
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 Reference: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",
}