Skip to content

Commit

Permalink
[DOCS] AI-recommended Expectations (#10913)
Browse files Browse the repository at this point in the history
  • Loading branch information
klavavej authored Feb 11, 2025
1 parent 5c60408 commit bdafdf6
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 1 deletion.
3 changes: 3 additions & 0 deletions docs/docusaurus/docs/cloud/deploy/deploy_gx_agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ The GX Agent serves as an intermediary between GX Cloud and your organization's

A local deployment of the GX Agent will allow you to test GX Cloud setup or processes from a single machine before moving to a shared production deployment. Alternatively, you can run the GX Agent in your deployment environment and leverage GX Cloud while connecting to Data Sources using your organization's environment and infrastructure, for enhanced control and security.

## Limitations

Agent-enabled deployments do not support [ExpectAI](/cloud/expectations/manage_expectations.md#generate-expectations-with-expectai-beta). To be able to generate AI-recommended Expectations, use a [fully-hosted deployment](/cloud/deploy/deployment_patterns.md).

## Prerequisites

Expand Down
15 changes: 15 additions & 0 deletions docs/docusaurus/docs/cloud/expectations/manage_expectations.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,21 @@ To clear the Expectation condition, click the clear button located on the right-
When you [create a new Data Asset](/cloud/data_assets/manage_data_assets.md#add-a-data-asset-from-an-existing-data-source), you can choose to automatically generate Expectations that detect column changes in that Data Asset.
:::

## Generate Expectations with ExpectAI (BETA)

To accelerate test coverage, you can use ExpectAI to generate recommended Expectations for a Data Asset. These will be personalized based on an analysis of a sample of your data.

Keep the following requirements and limitations in mind when working with ExpectAI:
- Only [Snowflake Data Sources](/cloud/connect/connect_snowflake.md) are supported at this time.
- Your organization must be using a [fully-hosted deployment](/cloud/deploy/deployment_patterns.md).

To add AI-recommended Expectations:
1. In GX Cloud, click **Data Assets**.
2. In the **Data Assets** list, click the Data Asset name.
3. Click **Generate Expectations**.
4. Optional. Run a Validation. See [Run a Validation](/cloud/validations/manage_validations.md#run-a-validation).
5. Optional. [Edit](#edit-an-expectation) or [delete](#delete-an-expectation) AI-generated Expectations based on the insights you get from running a Validation and your data quality needs.


## Optional. Define a Batch

Expand Down
2 changes: 1 addition & 1 deletion docs/docusaurus/docs/cloud/schedules/manage_schedules.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: 'Manage schedules'
description: Create and manage schedules for Validations in GX Cloud.
---

Use a schedule to automate data quality checks with GX-managed Expectations. When you add your first Expectation in the GX Cloud UI for a Data Asset, including when you choose to auto-generate Expectations to detect schema changes, we enable a default schedule for that Asset's GX-managed Expectations. By default, GX-managed Expectations are scheduled to run every 24 hours. The first run will be at the start of the next hour after you add your first Expectation in the Cloud UI. You can keep the default schedule, edit it, or disable it.
Use a schedule to automate data quality checks with GX-managed Expectations. When you add your first Expectation in the GX Cloud UI for a Data Asset, including when you choose to auto-generate Expectations, we enable a default schedule for that Asset's GX-managed Expectations. By default, GX-managed Expectations are scheduled to run every 24 hours. The first run will be at the start of the next hour after you add your first Expectation in the Cloud UI. You can keep the default schedule, edit it, or disable it.

:::note Schedules are for GX-managed Expectations only
To automate data quality checks for [API-managed Expectations](/cloud/expectations/manage_expectations.md#gx-managed-vs-api-managed-expectations), use an [orchestrator](/cloud/connect/connect_airflow.md).
Expand Down
5 changes: 5 additions & 0 deletions docs/docusaurus/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,11 @@ module.exports = {
label: 'Add an Expectation',
href: '/docs/cloud/expectations/manage_expectations#add-an-expectation',
},
{
type: 'link',
label: 'Generate Expectations with ExpectAI (BETA)',
href: '/docs/cloud/expectations/manage_expectations#generate-expectations-with-expectai-beta',
},
{
type: 'link',
label: 'Optional. Define a Batch',
Expand Down

0 comments on commit bdafdf6

Please sign in to comment.