Prueba de QueryData

En este documento, se describe cómo probar QueryData y actualizar el archivo del conjunto de contextos. Puedes probar la capacidad de QueryData para generar consultas en SQL a partir de preguntas en lenguaje natural. Si una consulta generada no es precisa, puedes actualizar el archivo del conjunto de contextos.

Para obtener información sobre los conjuntos de contextos, consulta Descripción general de los conjuntos de contextos.

Antes de comenzar

Asegúrate de que ya se haya creado un conjunto de contextos y que el archivo del conjunto de contextos se haya subido al agente de QueryData. Para obtener más información, consulta Administra conjuntos de contextos en AlloyDB Studio.

Para descargar, actualizar y subir archivos del conjunto de contextos, asegúrate de que el usuario de IAM tenga el rol Editor de Catalog de Dataplex (roles/dataplex.catalogEditor) o Administrador de Catalog de Dataplex (roles/dataplex.catalogAdmin) en el proyecto. Para obtener más información, consulta Permisos de conjuntos de contextos.

Prueba QueryData

Para probar un QueryData, sigue estos pasos:

  1. En la Google Cloud consola, ve a la página de AlloyDB.

    Ir a AlloyDB

  2. Selecciona un clúster de la lista.

  3. En el menú de navegación, haz clic en AlloyDB Studio.

  4. Accede a Studio con la autenticación de Identity and Access Management.

  5. En el panel Explorador, haz clic en Ver acciones junto al conjunto de contextos que usas.

  6. Haz clic en Probar conjunto de contextos.

  7. En el editor de consultas, haz clic en Generar SQL para abrir el panel Ayúdame a programar.

  8. Ingresa una pregunta en lenguaje natural en el editor para generar una consulta en SQL y haz clic en Generar.

  9. Revisa la consulta en SQL para verificar su precisión.

Descarga y actualiza un conjunto de contextos

Si no estás satisfecho con la consulta en SQL generada para una pregunta en lenguaje natural, descarga el archivo del conjunto de contextos existente. Luego, puedes revisar y actualizar la plantilla de consulta, y volver a subir el archivo de contexto actualizado al agente.

Para descargar y actualizar un conjunto de contextos, sigue estos pasos:

  1. En el panel Explorador, haz clic en Ver acciones.
  2. Haz clic en Descargar archivo de contexto.
  3. Sigue los pasos en Crea conjuntos de contextos con el agente de ingeniería de contexto para actualizar el contexto con pares de consultas adicionales.
  4. En el panel Explorador, haz clic en Ver acciones junto al conjunto de contextos que usas.
  5. Haz clic en Editar conjunto de contextos.
  6. Haz clic en Explorar en la sección Subir archivo del conjunto de contextos y selecciona el archivo del conjunto de contextos actualizado.
  7. Haz clic en Guardar para actualizar el conjunto de contextos.

Después de que estés satisfecho con la precisión de tus respuestas, puedes usar el extremo QueryData para conectar tu aplicación al conjunto de contextos.

Encuentra el ID del conjunto de contextos

Para conectar una aplicación de datos al agente de QueryData, necesitas el ID del conjunto de contextos.

  1. En la Google Cloud consola, ve a la página de AlloyDB.

    Ir a AlloyDB

  2. Selecciona un clúster de la lista.

  3. En el menú de navegación, haz clic en AlloyDB Studio.

  4. Accede a Studio con la autenticación de Identity and Access Management.

  5. En el panel Explorador, haz clic en Ver acciones junto al conjunto de contextos que usas.

  6. Haz clic en Editar conjunto de contextos.

  7. Toma nota del ID de contexto en ID del conjunto de contextos. El formato del ID del conjunto de contextos es similar a projects/data-agents-project/locations/us-central1/contextSets/bdf_pg_all_templates.

Conecta QueryData a la aplicación

Configura el ID del conjunto de contextos en la llamada de método QueryData para proporcionar contexto creado para fuentes de datos de bases de datos, como AlloyDB, Spanner, Cloud SQL, Cloud SQL para PostgreSQL y Firestore. Para obtener más información, consulta Define el contexto del agente de datos para fuentes de datos de bases de datos.

Después de probar el conjunto de contextos, puedes hacer referencia a la fuente de datos de la base de datos en tu llamada a QueryData.

Ejemplo de solicitud QueryData con contexto creado

En el siguiente ejemplo, se muestra una solicitud QueryData con la fuente de datos de la base de datos alloydb. El campo agent_context_reference.context_set_id se usa para vincular al contexto creado almacenado en la base de datos.

{
  "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": [
      {
        "alloydb": {
          "database_reference": {
            "project_id": "context-set-project",
            "region": "us-central1",
            "cluster_id": "sqlgen-magic",
            "instance_id": "context-set-primary",
            "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
  }
}

El cuerpo de la solicitud contiene los siguientes campos:

  • prompt: Es la pregunta en lenguaje natural del usuario final.
  • context: Contiene información sobre las fuentes de datos.
    • datasource_references: Especifica el tipo de fuente de datos.
      • alloydb: Es obligatorio cuando se consulta la base de datos. Este campo cambia según la base de datos que consultas.
        • database_reference: Especifica la información relacionada con tu instancia de base de datos.
          • cluster_id: Es el ID del clúster de la instancia de base de datos.
          • project_id: Es el ID del proyecto de la instancia de base de datos.
          • region: Es la región de la instancia de AlloyDB.
          • instance_id: Es el ID de la instancia de AlloyDB.
          • database_id: Es el ID de la base de datos.
        • agent_context_reference: Se vincula al contexto creado en la base de datos.
          • context_set_id: Es el ID completo del conjunto de contextos del contexto almacenado en la base de datos. Por ejemplo, projects/context-set-project/locations/us-central1/contextSets/bdf_gsql_gemini_all_templates.
  • generationOptions: Configura el tipo de resultado que se generará.
    • generate_query_result: Se establece en verdadero para generar y mostrar los resultados de la consulta.
    • generate_natural_language_answer: Es opcional. Si se establece en verdadero, genera una respuesta en lenguaje natural.
    • generate_explanation: Es opcional. Si se establece en verdadero, genera una explicación de la consulta en SQL.
    • generate_disambiguation_question: Es opcional. Si se establece en verdadero, genera preguntas de desambiguación si la consulta es ambigua.

Ejemplo de respuesta QueryData

Este es un ejemplo de una respuesta correcta de una llamada a 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."
}

¿Qué sigue?