Skip to content

Commit 28012f9

Browse files
oravioravi
committed
Update unstructured data tests documentation with platform-specific setup guides
1 parent 7c41abb commit 28012f9

7 files changed

Lines changed: 22 additions & 18 deletions

File tree

docs/data-tests/unstructured-data-tests/bigquery-setup.mdx renamed to docs/data-tests/unstructured-data-tests/bigquery.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "BigQuery setup"
2+
title: "BigQuery Vertex AI"
33
description: "Learn how to configure BigQuery to use Vertex AI models for unstructured data validation tests"
44
---
55

docs/data-tests/unstructured-data-tests/data-lakes-setup.mdx renamed to docs/data-tests/unstructured-data-tests/data-lakes.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Data lakes setup"
2+
title: "Data lakes"
33
---
44

55
Currently, you can apply Elementary's unstructured data validation tests on data lakes using Snowflake, Databricks, or BigQuery external object tables.

docs/data-tests/unstructured-data-tests/databricks-setup.mdx renamed to docs/data-tests/unstructured-data-tests/databricks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Databricks setup"
2+
title: "Databricks AI Functions"
33
---
44

55
# Setting Up Databricks AI Functions

‎docs/data-tests/unstructured-data-tests/quickstart.mdx‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
title: "Quickstart"
33
---
44

5+
<Note type="warning">
6+
**Beta Feature**: Unstructured data validation tests is currently in beta. The functionality and interface may change in future releases.
7+
</Note>
8+
59
# Validating Unstructured Data with Elementary
610

711
## What is Unstructured Data Validation?
@@ -25,24 +29,24 @@ Before you can use Elementary's unstructured data validations, you need to set u
2529
### Snowflake
2630
- **Prerequisite**: Enable Snowflake Cortex AI LLM functions
2731
- **Recommended Model**: `claude-3-5-sonnet`
28-
- [View Detailed Snowflake Setup Guide](/data-tests/unstructured-data-tests/snowflake-setup.mdx)
32+
- [View Snowflake's Guide](/data-tests/unstructured-data-tests/snowflake)
2933

3034
### Databricks
3135
- **Prerequisite**: Ensure Databricks AI Functions are available
3236
- **Recommended Model**: `databricks-meta-llama-3-3-70b-instruct`
33-
- [View Detailed Databricks Setup Guide](/data-tests/unstructured-data-tests/databricks-setup.mdx)
37+
- [View Databrick's Setup Guide](/data-tests/unstructured-data-tests/databricks)
3438

3539
### BigQuery
3640
- **Prerequisite**: Configure BigQuery to use Vertex AI models
3741
- **Recommended Model**: `gemini-1.5-pro`
38-
- [View Detailed BigQuery Setup Guide](/data-tests/unstructured-data-tests/bigquery-setup.mdx)
42+
- [View BigQuery's Setup Guide](/data-tests/unstructured-data-tests/bigquery)
3943

4044
### Redshift
4145
- Support coming soon
4246

4347
### Data Lakes
4448
- Currently supported through Snowflake, Databricks, or BigQuery external object tables
45-
- [View Data Lakes Information](/data-tests/unstructured-data-tests/data-lakes-setup.mdx)
49+
- [View Data Lakes Information](/data-tests/unstructured-data-tests/data-lakes)
4650

4751

4852
## Using the Validation Test

docs/data-tests/unstructured-data-tests/redshift-setup.mdx renamed to docs/data-tests/unstructured-data-tests/redshift.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Redshift setup"
2+
title: "Redshift"
33
---
44

55
Elementary's unstructured data validation tests do not currently support Redshift.

docs/data-tests/unstructured-data-tests/snowflake-setup.mdx renamed to docs/data-tests/unstructured-data-tests/snowflake.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
title: "Snowflake setup"
2+
title: "Snowflake Cortex AI"
33
---
44

5-
# Setting Up Snowflake Cortex AI LLM Functions
5+
# Snowflake Cortex AI LLM Functions
66

77
This guide provides instructions on how to enable Snowflake Cortex AI LLM functions, which is a prerequisite for running Elementary unstructured data validation tests on Snowflake.
88

99
## What is Snowflake Cortex?
1010

1111
Snowflake Cortex is a fully managed service that brings cutting-edge AI and ML solutions directly into your Snowflake environment. It allows you to leverage the power of large language models (LLMs) without any complex setup or external dependencies.
12-
Snowflake provides LLMs that are fully hosted and managed by Snowflake, using them requires no setup and your data stays within Snowflake.
12+
Snowflake provides LLMs that are fully hosted and managed by Snowflake, using them requires no setup and your data stays within Snowflake.
1313

1414

1515
## Cross-Region Model Usage
@@ -67,4 +67,4 @@ GRANT ROLE cortex_user_role TO USER <username>;
6767

6868
-- Optionally, grant warehouse access to the role
6969
GRANT USAGE ON WAREHOUSE <warehouse_name> TO ROLE cortex_user_role;
70-
```
70+
```

‎docs/mint.json‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -347,14 +347,14 @@
347347
]
348348
},
349349
{
350-
"group": "Unstructured Data Tests",
350+
"group": "Unstructured Data Tests (Beta)",
351351
"pages": [
352352
"data-tests/unstructured-data-tests/quickstart",
353-
"data-tests/unstructured-data-tests/snowflake-setup",
354-
"data-tests/unstructured-data-tests/databricks-setup",
355-
"data-tests/unstructured-data-tests/bigquery-setup",
356-
"data-tests/unstructured-data-tests/redshift-setup",
357-
"data-tests/unstructured-data-tests/data-lakes-setup"
353+
"data-tests/unstructured-data-tests/snowflake",
354+
"data-tests/unstructured-data-tests/databricks",
355+
"data-tests/unstructured-data-tests/bigquery",
356+
"data-tests/unstructured-data-tests/redshift",
357+
"data-tests/unstructured-data-tests/data-lakes"
358358
]
359359
},
360360
{

0 commit comments

Comments
 (0)