以编程方式使用文档

>Stardog 是一个企业知识图谱平台，使组织能够统一、查询和分析其数据。 > 此集成包提供 langchain 工具和可运行对象，用于与 Stardog Voicebox 交互，Voicebox 是一个自然语言问答代理，可从您的企业数据中提供无幻觉的洞察。

概述

Stardog LangChain 集成包提供以下工具，用于处理 Stardog Voicebox： - VoiceboxAskTool - 提问并获取自然语言回答 - VoiceboxGenerateQueryTool - 从自然语言生成 SPARQL 查询 - VoiceboxSettingsTool - 检索 Voicebox 应用程序设置

所有工具都支持同步和异步执行模式，使其适用于各种应用程序架构。

有关完整详情，请参阅 GitHub 仓库.

设置

安装

pip install langchain-stardog

前提条件

  • - A Stardog Cloud 账户
  • - 配置了您的数据的 Voicebox 应用程序
  • - Voicebox API 令牌

获取您的 API 令牌

  1. 登录到 Stardog Cloud
  2. 点击您的个人资料图标并选择 **管理 API 密钥**.
  3. 创建新应用程序并生成密钥。
  4. 复制 API 令牌并妥善保管。
  5. 有关更多详情，请参阅 Stardog Voicebox API 访问。

凭证

将您的 API 令牌设置为环境变量：

if not os.environ.get("SD_VOICEBOX_API_TOKEN"):
    os.environ["SD_VOICEBOX_API_TOKEN"] = getpass.getpass("Enter your Voicebox API token: ")

可选环境变量：

os.environ["SD_VOICEBOX_CLIENT_ID"] = "my-app"  # Client identifier (default: VBX-LANGCHAIN)
os.environ["SD_CLOUD_ENDPOINT"] = "https://cloud.stardog.com/api"  # Custom endpoint (optional)

实例化和示例

VoiceboxAskTool

针对配置了您的 API 令牌的知识图谱提出自然语言问题，并接收无幻觉的回答。

from langchain_stardog.voicebox import VoiceboxAskTool

# Tools automatically load credentials from environment variables
ask_tool = VoiceboxAskTool()

# Ask a question
result = ask_tool.invoke({"question": "What are all flights from San Francisco to New York?"})
print(result)
# Returns: Natural language answer

VoiceboxSettingsTool

检索 Voicebox 应用程序配置和元数据。

from langchain_stardog.voicebox import VoiceboxSettingsTool

settings_tool = VoiceboxSettingsTool()

# Get application settings
settings = settings_tool.invoke({})
print(settings)
# Returns: Configuration details like data sources, schema info, and capabilities

VoiceboxGenerateQueryTool

从自然语言问题生成 SPARQL 查询，但不执行它们。

from langchain_stardog.voicebox import VoiceboxGenerateQueryTool

query_tool = VoiceboxGenerateQueryTool()

# Generate a SPARQL query
query = query_tool.invoke({"question": "Which flights are delayed by more than 30 minutes?"})
print(query)
# Returns: Generated SPARQL query without executing it

请参阅 示例 部分，了解使用这些工具和可运行对象的不同方式。

类参考

有关更多详情，请参阅 类参考

可用类：

  • - VoiceboxAskTool - 提问并获取回答
  • - VoiceboxSettingsTool - 检索应用程序设置
  • - VoiceboxGenerateQueryTool - 生成 SPARQL 查询
  • - VoiceboxAskRunnable - 用于提问自然语言问题的可运行对象
  • - VoiceboxSettingsRunnable - 设置检索可运行对象
  • - VoiceboxGenerateQueryRunnable 查询生成运行程序
  • - VoiceboxClient Voicebox API 的核心客户端

了解更多