Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs for worksheets NLQ Feature #1653

Open
wants to merge 3 commits into
base: gh-pages-v2m7m0
Choose a base branch
from
Open

Docs for worksheets NLQ Feature #1653

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ee7d738
Docs for worksheets NLQ Feature
noah-paige Oct 21, 2024
554b016
merge latest gh pages v2m7m0
noah-paige Oct 23, 2024
6e194dc
Change config paths
noah-paige Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion pages/deploy/deploy_aws.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -522,7 +522,13 @@ the different configuration options.
}
},
"worksheets": {
"active": true
"active": true,
"features": {
"nlq": {
"active": true,
"max_count_per_day": 25
}
}
},
"dashboards": {
"active": true
Expand Down Expand Up @@ -600,6 +606,8 @@ In the example config.json, the feature that enables file upload from data.all U
| auto_approval_for_confidentiality_level | s3_datasets | Specify if auto-approval for share requests should be enabled for each confidentiality level in data.all |
| show_stack_logs | s3_datasets | Enable / Disable showing stack logs to users or only allow admins to view stack logs. When "Enabled", users who have access to stack can view the logs. With "admin-only", only Data.all admins can view the stack logs and when "Disabled", no user can see the stack logs. Please check out the config.json in step 7 for more details |
| show_share_logs | shares_base | Enable / Disable showing share logs to users or only allow admins to view share logs. When "Enabled", users who have access to those shares can view the logs. With "admin-only", only Data.all admins can view the share logs and when "Disabled", no user can see the share logs. Please check out the config.json in step 7 for more details |
| nlq.active | worksheets | Disable / Enable natural language querying powered by genAI in worksheets (experimental feature - default: False) |


### Customizing Module Features

Expand All @@ -622,6 +630,7 @@ In addition to disabling / enabling, some module features allow for additional c
| **Customization** | **Module** | **Description** |
|--------------------------------|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| custom_confidentiality_mapping | s3_datasets | Provides custom confidentiality mapping json which maps your custom confidentiality levels to existing data.all confidentiality <br/> For e.g. ```custom_confidentiality_mapping : { "Public" : "Unclassified", "Private" : "Official", "Confidential" : "Secret", "Very Highly Confidential" : "Secret"}```<br/> This will display confidentiality levels - Public, Private, Confidential & Very Highly Confidential - in the confidentiality drop down and maps it existing confidentiality levels in data.all - Unclassified, Official and Secret |
| nlq.max_count_per_day | worksheets | Set a limit of number of invocations allowed per user per day for the genAI NLQ worksheets feature (default: 10) |


### Disable and customize core features
Expand Down Expand Up @@ -649,6 +658,19 @@ disable or modify the bahavior any other core feature.
| log_query_period_days | global | Specify the time frame for querying the log history. This log history is used for Stacks view and shared log views. |
| show_stack_logs | environments | Enable / Disable showing stack logs to users or only allow admins to view stack logs. When "Enabled", users who have access to stack can view the logs. With "admin-only", only Data.all admins can view the stack logs and when "Disabled", no user can see the stack logs. Please check out the config.json in step 7 for more details |

### (Optional) Additional Set Up For Worksheets GenAI Natural Language Query (NLQ) Features

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: your. data.all

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: must enable

To use these features, your. data.all admin team must enabled access to the Claude 3.5 Sonnet Model hosted in Amazon Bedrock in the Deployment Account of data.all. To do so, the data.all admin team can follow the steps:

1. Navigate to Amazon Bedrock Console and Select Model Access in left navigation pane
2. Chose Modify Model Access and select the Claude 3.5 Sonnet model
1. Be sure to review the End User License Agreement (EULA) for terms and conditions of using the model before requesting access to it
3. Select Next, Review any additional terms documents, and when ready Submit the request
4. If the request is successful the Access status changes to Access granted or Available to request (this may take a few minutes)

For more information about enabling foundation model access in Amazon Bedrock, please refer to [AWS Documentation](https://docs.aws.amazon.com/bedrock/latest/userguide/model-access-modify.html).


## 8. Run CDK synth and check cdk.context.json <a name="context"></a>
Run `cdk synth` to create the template that will be later deployed to CloudFormation.
With this command, CDK will create a **cdk.context.json** file with key-value pairs that are checked at
Expand Down