QueryData in Spanner Studio testen

In diesem Dokument wird beschrieben, wie Sie QueryData testen und die Kontextsetdatei aktualisieren. Sie können testen, ob QueryData SQL-Abfragen aus Fragen in natürlicher Sprache generieren kann. Wenn eine generierte Abfrage nicht korrekt ist, können Sie die Kontextsetdatei aktualisieren.

Weitere Informationen zu Kontextsets finden Sie in der Übersicht zu Kontextsets.

Hinweis

Prüfen Sie, ob ein Kontextset bereits erstellt und die Kontextsetdatei in den QueryData-Agenten hochgeladen wurde. Weitere Informationen finden Sie unter Kontextsets in Spanner Studio verwalten.

Wenn Sie Kontextsetdateien herunterladen, aktualisieren und hochladen möchten, muss der IAM-Nutzer die Rolle „Dataplex Catalog-Bearbeiter“ (roles/dataplex.catalogEditor) oder „Dataplex Catalog-Administrator“ (roles/dataplex.catalogAdmin) für das Projekt haben. Weitere Informationen finden Sie unter Berechtigungen für Kontextsets.

QueryData testen

So testen Sie QueryData:

  1. Rufen Sie in der Google Cloud Console die Seite „Spanner“ auf.

    Zu Spanner

  2. Wählen Sie eine Instanz aus der Liste und dann eine Datenbank aus.

  3. Klicken Sie im Navigationsmenü auf Spanner Studio.

  4. Klicken Sie im Bereich Explorer neben dem verwendeten Kontextset auf Aktionen ansehen.

  5. Klicken Sie auf Kontextset testen.

  6. Klicken Sie im Abfrageeditor auf SQL generieren, um den Bereich Hilfe bei der Programmierung zu öffnen.

  7. Geben Sie im Editor eine Frage in natürlicher Sprache ein, um eine SQL-Abfrage zu generieren, und klicken Sie auf Generieren.

  8. Prüfen Sie die SQL-Abfrage auf Richtigkeit.

Kontextset herunterladen und aktualisieren

Wenn Sie mit der generierten SQL-Abfrage für eine Frage in natürlicher Sprache nicht zufrieden sind, laden Sie die vorhandene Kontextsetdatei herunter. Anschließend können Sie die Abfragevorlage überprüfen und aktualisieren und die aktualisierte Kontextdatei wieder in den Agenten hochladen.

So laden Sie ein Kontextset herunter und aktualisieren es:

  1. Klicken Sie im Bereich Explorer auf Aktionen ansehen.
  2. Klicken Sie auf Kontextdatei herunterladen.
  3. Folgen Sie der Anleitung unter Kontextsets mit dem Context-Engineering-Agenten erstellen, um den Kontext mit zusätzlichen Abfragepaaren zu aktualisieren.
  4. Klicken Sie im Bereich Explorer neben dem verwendeten Kontextset auf Aktionen ansehen.
  5. Klicken Sie auf Kontextset bearbeiten.
  6. Klicken Sie im Bereich Kontextsetdatei hochladen auf Durchsuchen und wählen Sie die aktualisierte Kontextsetdatei aus.
  7. Klicken Sie auf Speichern , um das Kontextset zu aktualisieren.

Wenn Sie mit der Genauigkeit Ihrer Antworten zufrieden sind, können Sie den QueryData-Endpunkt verwenden, um Ihre Anwendung mit dem Kontextset zu verbinden.

Kontextset-ID finden

Wenn Sie eine Datenanwendung mit dem QueryData-Agenten verbinden möchten, benötigen Sie die ID des Kontextsets.

  1. Rufen Sie in der Google Cloud Console die Seite „Spanner“ auf.

    Zu Spanner

  2. Wählen Sie eine Instanz aus der Liste und dann eine Datenbank aus.

  3. Klicken Sie im Navigationsmenü auf Spanner Studio.

  4. Klicken Sie im Bereich Explorer neben dem verwendeten Kontextset auf Aktionen ansehen.

  5. Klicken Sie auf Kontextset bearbeiten.

  6. Notieren Sie sich die Kontext-ID unter Kontextset-ID. Das Format der Kontextset-ID ähnelt projects/data-agents-project/locations/us-central1/contextSets/bdf_pg_all_templates.

QueryData mit Anwendung verbinden

Legen Sie die Kontextset-ID im QueryData-Methodenaufruf fest, um einen erstellten Kontext für Datenbankdatenquellen wie AlloyDB, Spanner, Cloud SQL, Cloud SQL for PostgreSQL und Firestore bereitzustellen. Weitere Informationen finden Sie unter Kontext für KI-Datenagenten für Datenbankdatenquellen definieren.

Nachdem Sie das Kontextset getestet haben, können Sie im QueryData-Aufruf auf die Datenbankdatenquelle verweisen.

Beispiel für eine QueryData-Anfrage mit erstellt Kontext

Das folgende Beispiel zeigt eine QueryData-Anfrage mit der Datenbankdatenquelle spanner_reference. Das Feld agent_context_reference.context_set_id wird verwendet, um auf einen vorab erstellten Kontext zu verweisen, der in der Datenbank gespeichert ist.

{
  "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-central1/contextSets/bdf_pg_all_templates"
          }
        }
      }
    ]
  },
  "generation_options": {
    "generate_query_result": true,
    "generate_natural_language_answer": true,
    "generate_disambiguation_question": true,
    "generate_explanation": true
  }
}

Der Anfragetext enthält die folgenden Felder:

  • prompt: Die Frage des Endnutzers in natürlicher Sprache.
  • context: Enthält Informationen zu den Datenquellen.
    • datasource_references: Gibt den Datenquellentyp an.
      • spanner_reference: Ist erforderlich, wenn die Datenbank abgefragt wird. Dieses Feld ändert sich je nach der Datenbank, die Sie abfragen.
        • database_reference: Gibt Informationen zur Datenbankinstanz an.
          • engine: Der SQL-Dialekt der Datenbank. Legen Sie für Spanner-Datenbanken GOOGLE_SQL fest.
          • project_id: Die Projekt-ID der Datenbankinstanz.
          • region: Die Region der Spanner-Instanz.
          • instance_id: Die Instanz-ID der Spanner-Instanz.
          • database_id: Die ID der Datenbank.
        • agent_context_reference: Verweist auf den erstellten Kontext in der Datenbank.
          • context_set_id: Die vollständige Kontextset-ID des in der Datenbank gespeicherten Kontexts. Beispiel: projects/context-set-project/locations/us-central1/contextSets/bdf_gsql_gemini_all_templates.
  • generationOptions: Konfiguriert den Typ der zu generierenden Ausgabe.
    • generate_query_result: Legen Sie diesen Wert auf „true“ fest, um die Abfrageergebnisse zu generieren und zurückzugeben.
    • generate_natural_language_answer: Optional. Wenn dieser Wert auf „true“ festgelegt ist, wird eine Antwort in natürlicher Sprache generiert.
    • generate_explanation: Optional. Wenn dieser Wert auf „true“ festgelegt ist, wird eine Erklärung der SQL-Abfrage generiert.
    • generate_disambiguation_question: Optional. Wenn dieser Wert auf „true“ festgelegt ist, werden Fragen zur Mehrdeutigkeitsauflösung generiert, wenn die Abfrage mehrdeutig ist.

Beispiel für eine QueryData-Antwort

Hier ist ein Beispiel für eine erfolgreiche Antwort von einem QueryData-Aufruf:

{
  "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."
}

Nächste Schritte