Synchronize Snowflake Cortex AI
Synchronizing Snowflake Cortex AI is the process of integrating metadata from Snowflake Cortex AI and making the data available in Collibra Platform.
You can synchronize manually or automate it by adding a synchronization schedule.
Prerequisites
In your Collibra environment
- You have created a Snowflake connection.
- You have added the Snowflake capability to the Azure connection.
- You created a System asset which presents the Snowflake connection.
- You have a resource role with the Configure external system resource permission, for example, Owner.
- You have a global role with the Catalog global permission, for example, Catalog Author.
- You have a global role with the View Edge connections and capabilities global permission, for example, Edge integration engineer. For example, Edge integration engineer.
In your Snowflake Cortex AI environment
Your Snowflake Cortex AI integration role must have the following permissions:
- Permissions are granted to roles, not individual users.
- Both
USAGE ON DATABASEandUSAGE ON SCHEMApermissions on the integration role are required. Only models and agents that the Snowflake Cortex AI integration role has visibility to are ingested. Models and agents that aren't visible to this role, but are included in any path pattern provided below, are skipped. You can check what models and agents the role has visibility to by runningSHOW <MODELS/AGENTS> IN ACCOUNTin Snowflake. If you have a secondary role, addUSE SECONDARY ROLE NONEto exclude any models or agents only your secondary role has access to.
USAGEpermission on:- The database containing the models or agents.
- The schema containing the models or agents.
- The models or agents you want to ingest. You can scope this to a specific mode or agent, or to all models or agents in a database.
- If you plan to ingest Snowflake-provided foundational (
CORTEX_BASE) models, grant the Snowflake-managed application role for the foundational models you want to ingest to your Snowflake Cortex AI integration role. For example:- Access to all foundational models:
GRANT APPLICATION ROLE SNOWFLAKE."CORTEX-MODEL-ROLE-ALL" TO ROLE <your_integration_role>; - Access to specific foundation models:
GRANT APPLICATION ROLE SNOWFLAKE."CORTEX-MODEL-ROLE-CLAUDE-HAIKU-4-5" TO ROLE <your_integration_role>;
- Access to all foundational models:
For more information on granting permissions to Snowflake roles, go to the Snowflake Cortex AI documentation.
Steps
-
On the main toolbar, click
→
Catalog.
The Catalog homepage opens. - Click Integrations.
The Integrations page opens. - Click the Integration configuration tab.
- In the Connection name column, locate the Snowflake connection that you used when you added the Snowflake capability and click the link in the Capabilities column.
The Synchronization page opens. - In the Synchronization Configuration section, click Add Configuration.
- Complete the fields as needed.
- Click Add Custom AI Metrics Mappings.
- In Metric, select the custom metric from the list of available Snowflake Cortex AI metrics.
- In Attribute, select the attribute in which you want to see the value.
Make sure to select an attribute that is included in the Snowflake Cortex AI Model asset type assignment. - Soft: Assets are archived and can be restored if the model reappears. This is the recommended mode.
- Hard: Assets are permanently deleted and cannot be recovered.
- Click Save.
- Click Synchronize.
A notification indicates the synchronization has started.
| Field | Action |
|---|---|
| System asset | Go to the General settings tab and add the System asset that represents your Snowflake connection. This asset is used by the Snowflake Cortex AI workflow for run tracking. Important If this asset doesn't exist yet, you must create it before synchronizing your Snowflake Cortex AI integration. |
| Updated: <timestamp> (Optional) |
Click Updated: <timestamp> next to Synchronization Configuration, where timestamp indicates the last time when the data was loaded from Snowflake Cortex AI. If the Updated: <timestamp> is green, you don't need to refresh as the data is up to date. If it is red, refresh the data. If you don't see the option, the metadata hasn't been refreshed yet. As metadata is refreshed daily, try checking again later or tomorrow. |
| Domain mappings | Go to the Cortex AI tab. In Domain mappings, map Snowflake models to Collibra domains using path patterns in the following format: DATABASE > SCHEMA > MODEL. |
| Exclude patterns |
In Exclude patterns, add path patterns that contain models you want the synchronization to skip in the following format: Excluded patterns are always considered first, regardless of what is added in the Domain mappings field. |
| Fallback domain | In Fallback domain, select the default domain for models that don't match any path pattern added in Domain mappings. If you don't select a Fallback domain, unmatched models are skipped. Fallback domain is required if you haven't added a Domain mapping. Both can be used simultaneously to ensure no models are skipped. |
| Custom AI Metrics Mappings |
Optionally, in Custom AI Metrics Mappings, define the custom Snowflake Cortex AI model metrics that you want to integrate. You can do this by adding the mapping between the custom metric and Collibra attribute. The attribute list contains all attribute types that are assigned to the Snowflake Cortex AI Model asset type. After you synchronize the capability, the specified custom Snowflake Cortex AI Model metrics are mapped to the corresponding attributes. Important
If you use this feature, add any custom attributes/characteristics, as needed, to the asset type assignment. To add a custom AI metric mapping: |
| Asset deletion mode | Optionally, expand Advanced settings and set the Asset deletion mode. |
-
On the main toolbar, click
→
Catalog.
The Catalog homepage opens. - Click Integrations.
The Integrations page opens. - Click the Integration configuration tab.
- In the Connection name column, locate the Snowflake connection that you used when you added the Snowflake capability and click the link in the Capabilities column.
The Synchronization page opens. - In the Synchronization Configuration section, click Add Configuration.
- Complete the fields as needed.
Field Action System asset Go to the General settings tab and add the System asset that represents your Snowflake connection. This asset is used by the Snowflake Cortex AI workflow for run tracking. Important If this asset doesn't exist yet, you must create it before synchronizing your Snowflake Cortex AI integration.Updated: <timestamp> (Optional) Click Updated: <timestamp> next to Synchronization Configuration, where timestamp indicates the last time when the data was loaded from Snowflake Cortex AI.
If the Updated: <timestamp> is green, you don't need to refresh as the data is up to date. If it is red, refresh the data. If you don't see the option, the metadata hasn't been refreshed yet. As metadata is refreshed daily, try checking again later or tomorrow.
Domain mappings Go to the Cortex AI tab. In Domain mappings, map Snowflake models to Collibra domains using path patterns in the following format: DATABASE > SCHEMA > MODEL.Exclude patterns In Exclude patterns, add path patterns that contain models you want the synchronization to skip in the following format:
DATABASE > SCHEMA > MODEL.Excluded patterns are always considered first, regardless of what is added in the Domain mappings field.
Fallback domain In Fallback domain, select the default domain for models that don't match any path pattern added in Domain mappings. If you don't select a Fallback domain, unmatched models are skipped. Fallback domain is required if you haven't added a Domain mapping. Both can be used simultaneously to ensure no models are skipped.
Custom AI Metrics Mappings Optionally, in Custom AI Metrics Mappings, define the custom Snowflake Cortex AI model metrics that you want to integrate. You can do this by adding the mapping between the custom metric and Collibra attribute. The attribute list contains all attribute types that are assigned to the Snowflake Cortex AI Model asset type.
After you synchronize the capability, the specified custom Snowflake Cortex AI Model metrics are mapped to the corresponding attributes.
ImportantIf you use this feature, add any custom attributes/characteristics, as needed, to the asset type assignment.
To add a custom AI metric mapping:
- Click Add Custom AI Metrics Mappings.
- In Metric, select the custom metric from the list of available Snowflake Cortex AI metrics.
- In Attribute, select the attribute in which you want to see the value.
Make sure to select an attribute that is included in the Snowflake Cortex AI Model asset type assignment.
Asset deletion mode Optionally, expand Advanced settings and set the Asset deletion mode. - Soft: Assets are archived and can be restored if the model reappears. This is the recommended mode.
- Hard: Assets are permanently deleted and cannot be recovered.
- Click Save.
- In the Synchronization Schedule section, click Add schedule.
- Enter the required information and click Save:
Field Description Repeat The interval when you want to synchronize automatically. The possible values are: Daily, Weekly, Monthly, and Cron expression. CronThe Quartz Cron expression that determines when the synchronization takes place.
This field is only visible if you select
Cron expressionin the Repeat field.EveryThe day on which you want to synchronize, for example, Sunday.
This field is only visible if you select
Weeklyin the Repeat field.Every firstThe day of the month on which you want to synchronize, for example, Tuesday.
This field is only visible if you select
Monthlyin the Repeat field.At
The time at which you want to synchronize automatically, for example, 14:00.
- You can only schedule on the hour. For example, you can add a synchronization schedule at 8:00, but not at 8:45.
- This field is only visible if you select
Daily,Weekly, orMonthlyin the Repeat field.
Time zone The time zone for the schedule.
The synchronization job synchronizes the Snowflake Cortex AI data.
After the synchronization:
- You can view a summary of the results from the Activities list.
- The resulting assets get a relation to the Domain that you selected.
For information on the integrated data, go to Synchronized Snowflake Cortex AI data.