Skip to content

Commit 9347a0e

Browse files
authored
docs: update readme with form (#40)
1 parent 38edd94 commit 9347a0e

1 file changed

Lines changed: 16 additions & 5 deletions

File tree

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,30 @@
66
Developers can effortlessly connect, interact, and generate data insights with [BigQuery](https://cloud.google.com/bigquery/docs) datasets and data using natural language commands.
77

88
Learn more about [Gemini CLI Extensions](https://github.com/google-gemini/gemini-cli/blob/main/docs/extensions/index.md).
9+
> [!IMPORTANT]
10+
> **We Want Your Feedback!**
11+
> Please share your thoughts with us by filling out our feedback [form][form].
12+
> Your input is invaluable and helps us improve the project for everyone.
13+
14+
[form]: https://docs.google.com/forms/d/e/1FAIpQLSfEGmLR46iipyNTgwTmIDJqzkAwDPXxbocpXpUbHXydiN1RTw/viewform?usp=pp_url&entry.157487=bigquery-conversational-analytics
915

1016
## **Why Use the BigQuery Conversational Analytics Extension?**
1117

1218
* **Natural Language to insights :** Ask a variety of questions from your BigQuery data and generate intelligent insights.
1319
* **Seamless Workflow:** Stay in your CLI. No need to constantly switch contexts to the GCP console for generating analytics insights. .
1420
* **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)
1521

16-
## **Prerequisites**
22+
23+
24+
25+
## Prerequisites
1726

1827
Before you begin, ensure you have the following:
1928

2029
* [Gemini CLI](https://github.com/google-gemini/gemini-cli) installed with version **+v0.6.0**.
30+
* Setup Gemini CLI [Authentication](https://github.com/google-gemini/gemini-cli/tree/main?tab=readme-ov-file#-authentication-options).
2131
* A Google Cloud project with the **Data Analytics API with Gemini**, **Gemini for Google Cloud API** and **BigQuery API** enabled.
32+
* Ensure [Application Default Credentials](https://cloud.google.com/docs/authentication/gcloud) are available in your environment.
2233
* IAM Roles:
2334
* BigQuery User (`roles/bigquery.user`) (for executing queries and view metadata)
2435
* Gemini for Google Cloud (`roles/cloudaicompanion.user`) (to use the conversational analytics API)
@@ -35,11 +46,11 @@ gemini extensions install https://github.com/gemini-cli-extensions/bigquery-conv
3546

3647
### Configuration
3748

38-
Set the following environment variables before starting the Gemini CLI:
49+
Set the following environment variables before starting the Gemini CLI. These variables can be loaded from a `.env` file.
3950

40-
* `BIGQUERY_PROJECT`: The GCP project ID.
41-
* `BIGQUERY_LOCATION`: (Optional) The dataset location.
42-
* `BIGQUERY_USE_CLIENT_OAUTH`: (Optional) Set to `true` to use client-side OAuth for authorization.
51+
* `BIGQUERY_PROJECT`: The GCP project ID.
52+
* `BIGQUERY_LOCATION`: (Optional) The dataset location.
53+
* `BIGQUERY_USE_CLIENT_OAUTH`: (Optional) Set to `true` to use client-side OAuth for authorization.
4354

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

0 commit comments

Comments
 (0)