Spécification de l’analyse¶

Spécifie toutes les informations dont les gestionnaires d’analyses ont besoin pour exécuter une analyse, y compris le modèle à utiliser, les tables à transmettre au modèle et toutes les valeurs des variables utilisées par un modèle. Si vous n’utilisez pas de SQL de forme libre pour interroger des données, tous les gestionnaires d’analyses qui souhaitent effectuer une analyse utilisent cette spécification pour définir le modèle et les données d’entrée.

Schéma :

api_version: 2.0.0              # Required: Must be "2.0.0"
spec_type: analysis             # Required: Must be "analysis"
template: <template_id>         # Required: ID of the template to use
name: <analysis_name>           # Optional: Unique name (max 75 chars)
version: <version_string>       # Optional: Version identifier (max 20 chars)
description: <analysis_description>  # Optional: Description (max 1,000 chars)

template_configuration:         # Optional: Values used when running the template
  view_mappings:                # Optional: Mappings for shared data
    source_tables:              # Optional: Tables from data offerings. Populates the source_table array variable.
      - <source_table_name>     # One or more source table names from the TEMPLATE_VIEW_NAME column...
    <argument_name>: <view_name>  # Custom argument to template view name mapping
  local_view_mappings:          # Optional: Mappings for local data
    my_tables:                  # Optional: Tables from local data offerings. Populates the my_table array variable.
      - <my_table_name>         # One or more local table names...
    <argument_name>: <view_name>  # Custom argument to local template view name mapping
  arguments:                    # Optional: Template arguments as key-value pairs
    <argument_name>: <argument_value>  # One or more argument key-value pairs...
  activation:                   # Required for activation templates
    snowflake_collaborator: <alias>  # Collaborator alias for activation destination
    segment_name: <segment_name>     # Unique segment name for this activation

api_version

Version de l’API de collaboration utilisée. Doit être 2.0.0.

spec_type

Identificateur du type de spécification. Doit être analysis.

template: template_id

L’ID du modèle à utiliser pour cette analyse. Il doit s’agir de l’ID de modèle obtenu lorsque le modèle a été enregistré, et non le nom du modèle.

name (Facultatif)

Nom unique et convivial pour cette analyse. Doit suivre les règles des identificateurs Snowflake avec un maximum de 75 caractères et être unique au sein de votre compte de salles blanches de données Snowflake.

version (Facultatif)

Identificateur de version pour cette spécification d’analyse (maximum 20 caractères). Doit suivre les règles des identificateurs Snowflake et être unique au sein de votre compte pour ce nom d’analyse. Un bon format à utiliser est YYYY_MM_DD_V#. Par exemple : 2025_10_22_V1.

description (Facultatif)

Description de haut niveau de ce que fait cette analyse (maximum 1 000 caractères).

template_configuration (Facultatif)

Valeurs utilisées lors de l’exécution du modèle spécifié.

view_mappings (Facultatif)

Mappage des noms des arguments avec les noms des vues des modèles pour les offres de données partagées.

source_tables (Facultatif): Liste des noms de vues à utiliser pour renseigner la variable de modèle source_table. Utilisez les alias de tables spécifiés dans la spécification de l’offre de données. Vous pouvez obtenir une liste des vues disponibles en appelant VIEW_DATA_OFFERINGS. Utilisez les noms de vues à partir de la colonne TEMPLATE_VIEW_NAME. Le format de chaque entrée est collaborator_alias.data_offering_ID.dataset_alias.
argument_name: view_name: Mappage personnalisé d’un nom d’argument vers un nom de vue de modèle (maximum 255 caractères chacun).

local_view_mappings (Facultatif)

Mappage des noms des arguments avec les noms des vues des modèles locaux pour les ensembles de données privés.

my_tables (Facultatif): Liste des noms de tables à utiliser pour remplir la variable de modèle my_table. Celle-ci n’est disponible que pour les ensembles de données privés que vous avez liés en appelant LINK_LOCAL_DATA_OFFERING. Le format de chaque entrée est collaborator_alias.data_offering_ID.dataset_alias.
argument_name: view_name: Mappage personnalisé d’un nom d’argument vers un nom de vue de modèle local (maximum 255 caractères chacun).

arguments (Facultatif)

Arguments du modèle sous forme de paires clé-valeur. Les valeurs des arguments peuvent être des chaînes, des nombres, des booléens, des tableaux ou des objets, en fonction des exigences du modèle.

activation (Requis pour les modèles d’activation)

Configuration spécifique à l’activation requise lors de l’exécution de modèles d’activation.

snowflake_collaborator: Alias de collaborateur pour la destination de l’activation (maximum 25 caractères). Doit correspondre à un alias défini dans la section collaborator_identifier_aliases de la spécification de collaboration, et le collaborateur doit être répertorié dans la section activation_destinations.
segment_name: Nom de segment unique pour cette activation (maximum 255 caractères). Utilisé pour identifier et suivre les résultats de l’activation. Doit suivre les règles des identificateurs Snowflake.