在 Spanner Studio 中测试 QueryData

本文档介绍了如何测试 QueryData 和更新上下文集文件。您可以测试 QueryData 从自然语言问题生成 SQL 查询的能力。如果生成的查询不准确,您可以更新上下文集文件。

如需了解上下文集,请参阅上下文集概览。

准备工作

确保已创建上下文集,并且上下文集文件已上传到 QueryData 代理。如需了解详情,请参阅在 Spanner Studio 中管理上下文集。

测试 QueryData

如需测试 QueryData,请执行以下步骤:

  1. 在 Google Cloud 控制台中,前往 Spanner 页面。

    前往 Spanner

  2. 从列表中选择一个实例,然后选择一个数据库。

  3. 在导航菜单中,点击 Spanner Studio 。

  4. 在探索器窗格中,点击您使用的上下文集旁边的查看操作。

  5. 点击测试上下文集 。

  6. 在查询编辑器中,点击 Generate SQL 以打开 帮我编码 面板。

  7. 在编辑器中输入自然语言问题以生成 SQL 查询,然后点击 Generate 。

  8. 检查 SQL 查询的准确性。

下载和更新上下文集

如果您对针对自然语言问题生成的 SQL 查询不满意,请下载现有的上下文集文件。然后,您可以查看和更新查询模板,并将更新后的上下文的描述文件重新上传到代理。

如需下载和更新上下文集,请执行以下步骤:

  1. 在探索器窗格 中,点击查看操作 。
  2. 点击下载上下文的描述文件 。
  3. 按照使用上下文工程代理构建上下文集中的步骤,使用其他查询对更新上下文。
  4. 在探索器窗格中,点击您使用的上下文集旁边的查看操作。
  5. 点击修改上下文集 。
  6. 在上传上下文集文件 部分中,点击浏览 ,然后选择更新后的上下文集文件。
  7. 点击保存 以更新上下文集。

对响应的准确性感到满意后,您可以使用 QueryData 端点将应用连接到上下文集。

查找上下文集 ID

如需将数据应用连接到 QueryData 代理,您需要上下文集的 ID。

  1. 在 Google Cloud 控制台中,前往 Spanner 页面。

    前往 Spanner

  2. 从列表中选择一个实例,然后选择一个数据库。

  3. 在导航菜单中,点击 Spanner Studio 。

  4. 在探索器窗格中,点击您使用的上下文集旁边的查看操作。

  5. 点击修改上下文集 。

  6. 记下上下文集 ID 中的上下文 ID。上下文集 ID 的格式类似于 projects/data-agents-project/locations/us-east1/contextSets/bdf_pg_all_templates。

将 QueryData 连接到应用

在 QueryData 方法调用中设置上下文集 ID,以便为数据库数据源(例如 AlloyDB、Spanner、Cloud SQL 和 Cloud SQL for PostgreSQL)提供编写的上下文。如需了解详情,请参阅为数据库数据源定义数据代理上下文

测试上下文集后,您可以在 QueryData 调用中引用数据库数据源。

包含编写的上下文的 QueryData 请求示例

以下示例展示了使用 spanner_reference 数据库数据源的 QueryData 请求。agent_context_reference.context_set_id 字段用于链接到数据库中存储的预先编写的上下文。

{
  "parent": "projects/context-set-project/locations/us-central1",
  "prompt": "How many accounts in the Prague region are eligible for loans? A3 contains the data of region.",
  "context": {
    "datasource_references": [
      {
        "spanner_reference" {
          "database_reference" {
            "engine": "GOOGLE_SQL"
            "project_id": "context-set-project"
            "region": "us-central1"
            "instance_id": "evalbench"
            "database_id": "financial"
          },
          "agent_context_reference": {
            "context_set_id": "projects/context-set-project/locations/us-east1/contextSets/bdf_pg_all_templates"
          }
        }
      }
    ]
  },
  "generation_options": {
    "generate_query_result": true,
    "generate_natural_language_answer": true,
    "generate_disambiguation_question": true,
    "generate_explanation": true
  }
}

请求正文包含以下字段:

  • prompt:最终用户的自然语言问题。
  • context:包含有关数据源的信息。
    • datasource_references:指定数据源类型。
      • spanner_reference:查询数据库时是必需的。此字段会根据您查询的数据库而变化。
        • database_reference:指定与数据库实例相关的信息。
          • engine:数据库的 SQL 方言。对于 Spanner 数据库,应设置为 GOOGLE_SQL。
          • project_id:数据库实例的项目 ID。
          • region:Spanner 实例的区域。
          • instance_id:Spanner 实例的实例 ID。
          • database_id:数据库的 ID。
        • agent_context_reference:链接到数据库中编写的上下文。
          • context_set_id:数据库中存储的上下文的完整上下文集 ID。例如,projects/context-set-project/locations/us-east1/contextSets/bdf_gsql_gemini_all_templates。
  • generationOptions:配置要生成的输出类型。
    • generate_query_result:设置为 true 可生成并返回查询结果。
    • generate_natural_language_answer:可选。如果设置为 true,则生成自然语言答案。
    • generate_explanation:可选。如果设置为 true,则生成 SQL 查询的说明。
    • generate_disambiguation_question:可选。如果设置为 true,则在查询不明确时生成消歧问题。

QueryData 响应示例

以下是 QueryData 调用的成功响应示例:

{
  "generated_query": "-- Count the number of accounts in Prague that are eligible for loans\nSELECT\n  COUNT(DISTINCT \"loans\".\"account_id\")\nFROM \"loans\"\nJOIN \"district\" -- Join based on district ID\n  ON \"loans\".\"district_id\" = \"district\".\"district_id\"\nWHERE\n  \"district\".\"A3\" = 'Prague'; -- Filter for the Prague region",
  "intent_explanation": "The question asks for the number of accounts eligible for loans in the Prague region. I need to join the `district` table with the `loans` table to filter by region and count the distinct accounts. The `A3` column in the `district` table contains the region information, and I'll filter for 'Prague'. The `loans` table contains information about loans, including the `account_id` and `district_id`. I will join these two tables on their respective district IDs.",
  "query_result": {
    "columns": [
      {
        "name": "count"
      }
    ],
    "rows": [
      {
        "values": [
          {
            "value": "2"
          }
        ]
      }
    ],
    "total_row_count": 1
  },
  "natural_language_answer": "There are 2 accounts in Prague that are eligible for loans."
}

后续步骤