Skip to content

Commit 5296d5c

Browse files
authored
chore: Update README.md (#8)
1 parent 8737591 commit 5296d5c

1 file changed

Lines changed: 18 additions & 26 deletions

File tree

README.md

Lines changed: 18 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,21 @@ Developers can effortlessly connect, interact, and generate data insights with [
77

88
Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini-cli/blob/main/docs/extension.md).
99

10-
## Why Use the BigQuery Conversational Analytics Extension?
10+
## **Why Use the BigQuery Conversational Analytics Extension?**
1111

12-
* **Natural Language Management:** Stop wrestling with complex commands. Explore schemas and query data by describing what you want in plain English.
13-
* **Seamless Workflow:** Stay in your CLI. No need to constantly switch contexts to the GCP console for common database tasks.
14-
* **Code Generation:** Accelerate development by asking Gemini to generate data classes and other code snippets based on your table schemas.
12+
* **Natural Language to insights :** Ask a variety of questions from your BigQuery data and generate intelligent insights.
13+
* **Seamless Workflow:** Stay in your CLI. No need to constantly switch contexts to the GCP console for generating analytics insights. .
14+
* **Leverage prebuilt agent :** Access to advanced insights offered by a built-in agent behind [Conversational Analytics API](https://cloud.google.com/gemini/docs/conversational-analytics-api/overview)
1515

16-
## Prerequisites
16+
## **Prerequisites**
1717

1818
Before you begin, ensure you have the following:
1919

20-
* [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed with version +v0.6.0.
21-
* A Google Cloud project with the **Data Analytics API with Gemini**, **Gemini for Google Cloud API** and **BigQuery API** enabled.
22-
* IAM Permissions:
23-
* BigQuery User (`roles/bigquery.user`) (for executing queries and view
24-
metadata)
25-
* BigQuery Metadata Viewer (`roles/bigquery.metadataViewer`) (for viewing all datasets)
26-
* BigQuery Data Editor (`roles/bigquery.dataEditor`) (for creating or modify datasets and tables)
27-
* Gemini for Google Cloud (`roles/cloudaicompanion.user`) (to use the conversational analytics API)
20+
* [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed with version +v0.6.0.
21+
* A Google Cloud project with the **Data Analytics API with Gemini**, **Gemini for Google Cloud API** and **BigQuery API** enabled.
22+
* IAM Roles:
23+
* BigQuery User (`roles/bigquery.user`) (for executing queries and view metadata)
24+
* Gemini for Google Cloud (`roles/cloudaicompanion.user`) (to use the conversational analytics API)
2825

2926
## Installation
3027

@@ -36,33 +33,28 @@ gemini extensions install github.com/gemini-cli-extensions/bigquery-conversation
3633

3734
## Configuration
3835

36+
Set the following environment variables before starting the Gemini CLI:
37+
3938
* `BIGQUERY_PROJECT`: The GCP project ID.
4039
* `BIGQUERY_LOCATION`: (Optional) The dataset location.
4140
* `BIGQUERY_USE_CLIENT_OAUTH`: (Optional) Set to `true` to use client-side OAuth for authorization.
4241

4342
Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
4443

45-
## Usage Examples
44+
## **Usage Examples**
4645

4746
Interact with BigQuery using natural language right from your IDE:
4847

49-
* **Explore Schemas and Data:**
50-
* "Show me all tables in the 'orders' dataset."
51-
* "What is the schema for the 'products' table?"
52-
* "How many orders were placed in the last 30 days, and what were the top 5 most purchased items?"
48+
* **Ask for insights**
5349

54-
* **Generate Code:**
55-
* "Generate a Python dataclass to represent the 'customers' table."
50+
* Using the tables under bigquery-public-data.google\_analytics\_sample , tell me the channels I should focus on and why?
5651

57-
## Supported Tools
52+
## **Supported Tools**
5853

5954
This extension provides a comprehensive set of tools:
6055

61-
* `ask_data_insights`: Executes a SQL query.
62-
* `get_dataset_info`: Get dataset metadata.
63-
* `get_table_info`: Get table metadata.
64-
* `list_dataset_ids`: Lists dataset ids in the database.
65-
* `list_table_ids`: Lists table ids in the database.
56+
* `ask_data_insights`: Executes a SQL query.
57+
* `search_catalog`: Find BigQuery tables relevant to users, natural language query.
6658

6759
## Additional Extensions
6860

0 commit comments

Comments
 (0)