仪表板
本笔记本提供了快速入门 Tableau 的概览。
概览
Tableau 的 VizQL 数据服务(简称 VDS)为开发者提供了对其已发布 Tableau 数据源的编程访问能力,使其能够针对任何自定义工作负载或应用程序(包括 AI 代理)扩展业务语义。simple_datasource_qa 工具将 VDS 集成到了 LangChain 框架中。本笔记本展示了如何利用该工具构建基于企业语义模型来回答分析问题的智能代理。
关注 tableau-langchain 项目,获取更多即将推出的工具!
设置
请确保您正在运行并可访问:
- Python 3.12.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 数据源进行分析性问答。
此初始化函数:
- 使用 Tableau 的已连接应用框架进行基于 JWT 的身份验证,以完成对 Tableau 的认证。所有必需的变量必须在运行时定义或作为环境变量设置。
- 异步查询 datasource_luid 变量中指定的目标数据源的字段元数据。
- 基于目标数据源的元数据,将自然语言问题转换为发起 VDS 查询数据源请求所需的 JSON 格式查询负载。
- 向 VDS 执行 POST 请求。
- 以结构化响应格式返回结果。
# 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
链式调用
TODO.
API 参考
TODO.