跳到主要内容
Open In ColabOpen on GitHub

Tableau

本笔记提供了 Tableau 入门的快速概览。

概述​

Tableau 的 VizQL 数据服务（又称 VDS）为开发者提供了对其 Tableau 发布数据源的程序化访问，允许他们将其业务语义扩展到任何自定义工作负载或应用程序，包括 AI 代理。simple_datasource_qa 工具将 VDS 添加到 Langchain 框架。本笔记将展示如何使用它来构建代理，回答基于企业语义模型的分析问题。

请关注 tableau-langchain 项目，更多工具即将推出！

设置​

请确保您正在运行并能够访问：

  1. Python 版本 3.12.2 或更高
  2. 至少包含一个已发布数据源的 Tableau Cloud 或 Server 环境

通过安装和/或导入所需包开始

# %pip install langchain-openai
# %pip install langgraph
# %pip install langchain-tableau --upgrade
Requirement already satisfied: regex>=2022.1.18 in /Users/joe.constantino/.pyenv/versions/3.12.2/lib/python3.12/site-packages (from tiktoken<1,>=0.7->langchain-openai->langchain-tableau) (2024.11.6)
Requirement already satisfied: httpcore==1.* in /Users/joe.constantino/.pyenv/versions/3.12.2/lib/python3.12/site-packages (from httpx>=0.25.2->langgraph-sdk<0.2.0,>=0.1.42->langgraph->langchain-tableau) (1.0.7)
Requirement already satisfied: h11<0.15,>=0.13 in /Users/joe.constantino/.pyenv/versions/3.12.2/lib/python3.12/site-packages (from httpcore==1.*->httpx>=0.25.2->langgraph-sdk<0.2.0,>=0.1.42->langgraph->langchain-tableau) (0.14.0)

请注意，您可能需要重启内核才能使用更新后的包

凭证​

您可以像本文档中所示的几个示例那样显式声明您的环境变量。但是，如果未提供这些参数，simple_datasource_qa 工具将尝试自动从环境变量中读取它们。

对于您选择查询的数据源，请确保已在 Tableau 中更新 VizqlDataApiAccess 权限，以允许 VDS API 通过 REST 访问该数据源。更多信息请参见此处。

# langchain package imports
from langchain_openai import ChatOpenAI

# langchain_tableau and langgraph imports
from langchain_tableau.tools.simple_datasource_qa import initialize_simple_datasource_qa
from langgraph.prebuilt import create_react_agent

身份验证变量​

您可以像本教程中所示的几个示例那样显式声明您的环境变量。但是，如果未提供这些参数，simple_datasource_qa 工具将尝试自动从环境变量中读取它们。

对于您选择的数据源，请确保已在 Tableau 中更新 VizqlDataApiAccess 权限，以允许 VDS API 通过 REST 访问该数据源。更多信息请参见此处。

import os

from dotenv import load_dotenv

load_dotenv()

tableau_server = "https://stage-dataplane2.tableau.sfdc-shbmgi.svc.sfdcfc.net/"  # replace with your Tableau server name
tableau_site = "vizqldataservicestage02"  # replace with your Tableau site
tableau_jwt_client_id = os.getenv(
    "TABLEAU_JWT_CLIENT_ID"
)  # a JWT client ID (obtained through Tableau's admin UI)
tableau_jwt_secret_id = os.getenv(
    "TABLEAU_JWT_SECRET_ID"
)  # a JWT secret ID (obtained through Tableau's admin UI)
tableau_jwt_secret = os.getenv(
    "TABLEAU_JWT_SECRET"
)  # a JWT secret ID (obtained through Tableau's admin UI)
tableau_api_version = "3.21"  # the current Tableau REST API Version
tableau_user = "joe.constantino@salesforce.com"  # enter the username querying the target Tableau Data Source

# For this cookbook we are connecting to the Superstore dataset that comes by default with every Tableau server
datasource_luid = (
    "0965e61b-a072-43cf-994c-8c6cf526940d"  # the target data source for this Tool
)
model_provider = "openai"  # the name of the model provider you are using for your Agent
# Add variables to control LLM models for the Agent and Tools
os.environ["OPENAI_API_KEY"]  # set an your model API key as an environment variable
tooling_llm_model = "gpt-4o-mini"

实例化​

initialize_simple_datasource_qa 初始化名为 simple_datasource_qa 的 Langgraph 工具，该工具可用于 Tableau 数据源上的分析问题和答案。

此初始化函数

  1. 使用 Tableau 的连接应用程序框架进行基于 JWT 的身份验证以连接到 Tableau。所有必需的变量必须在运行时或作为环境变量定义。
  2. 异步查询 datasource_luid 变量中指定的目标数据源的字段元数据。
  3. 基于目标数据源的元数据，将自然语言问题转换为进行 VDS 查询-数据源请求所需的 JSON 格式查询负载。
  4. 执行对 VDS 的 POST 请求。
  5. 格式化结果并以结构化响应返回。
# Initialize simple_datasource_qa for querying Tableau Datasources through VDS
analyze_datasource = initialize_simple_datasource_qa(
    domain=tableau_server,
    site=tableau_site,
    jwt_client_id=tableau_jwt_client_id,
    jwt_secret_id=tableau_jwt_secret_id,
    jwt_secret=tableau_jwt_secret,
    tableau_api_version=tableau_api_version,
    tableau_user=tableau_user,
    datasource_luid=datasource_luid,
    tooling_llm_model=tooling_llm_model,
    model_provider=model_provider,
)

# load the List of Tools to be used by the Agent. In this case we will just load our data source Q&A tool.
tools = [analyze_datasource]

调用 - Langgraph 示例​

首先，我们将初始化我们选择的 LLM。然后，我们使用 langgraph 代理构造函数类定义一个代理，并使用与目标数据源相关的查询来调用它。

from IPython.display import Markdown, display

model = ChatOpenAI(model="gpt-4o", temperature=0)

tableauAgent = create_react_agent(model, tools)

# Run the agent
messages = tableauAgent.invoke(
    {
        "messages": [
            (
                "human",
                "what's going on with table sales?",
            )
        ]
    }
)
messages
# display(Markdown(messages['messages'][3].content)) #display a nicely formatted answer for successful generations

链式调用​

待办事项。

API 参考​

待办事项。