Skip to main content
Open In ColabOpen on GitHub

Cube 语义层

本笔记本演示了如何以适合传递给 LLM 作为嵌入（embeddings）的格式检索 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 Tokens (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",
}