Especificação da análise¶

Especifica todas as informações que os executores de análise precisam para executar uma análise, incluindo qual modelo usar, quais tabelas passar para o modelo e quaisquer valores de variáveis utilizados por um modelo. Se não estiver usando o SQL de formato livre para consultar dados, qualquer executor de análise que deseje executar uma análise usará esta especificação para definir o modelo e os dados de entrada.

Esquema:

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

A versão da API do Collaboration utilizada. Deve ser 2.0.0.

spec_type

Identificador do tipo de especificação. Deve ser analysis.

template: template_id

O ID do modelo a ser utilizado para esta análise. Deve ser o ID do modelo obtido quando ele foi registrado, não o nome do modelo.

name (opcional)

Um nome exclusivo e amigável para esta análise. Deve seguir as regras do identificador do Snowflake com um máximo de 75 caracteres e ser exclusivo na conta de sala limpa de dados do Snowflake.

version (opcional)

Um identificador de versão para esta especificação de análise (máximo de 20 caracteres). Deve seguir as Regras do identificador do Snowflake e ser único em sua conta para esse nome de análise. Um bom formato para usar é YYYY_MM_DD_V#. Por exemplo: 2025_10_22_V1.

description (opcional)

Uma descrição de alto nível do que esta análise faz (máximo de 1.000 caracteres).

template_configuration (opcional)

Valores utilizados ao executar o modelo especificado.

view_mappings (opcional)

Mapeamento de nomes de argumentos para nomes de exibição de modelo para ofertas de dados compartilhadas.

source_tables (opcional): Lista de nomes de exibição para preencher a variável de modelo source_table. Use os aliases de tabela especificados na especificação da oferta de dados. Você pode obter uma lista de exibições disponíveis chamando VIEW_DATA_OFFERINGS. Use os nomes de exibição da coluna TEMPLATE_VIEW_NAME. O formato de cada entrada é collaborator_alias.data_offering_ID.dataset_alias.
argument_name: view_name: Mapeamento personalizado de um nome de argumento para um nome de exibição de modelo (máximo de 255 caracteres cada).

local_view_mappings (opcional)

Mapeamento de nomes de argumentos para nomes de exibição de modelo locais para conjuntos de dados privados.

my_tables (opcional): Lista de nomes de tabelas para preencher a variável de modelo my_table. Isso está disponível apenas para conjuntos de dados privados que você vinculou chamando LINK_LOCAL_DATA_OFFERING. O formato de cada entrada é collaborator_alias.data_offering_ID.dataset_alias.
argument_name: view_name: Mapeamento personalizado de um nome de argumento para um nome de exibição de modelo local (máximo de 255 caracteres cada).

arguments (opcional)

Argumentos de modelo como pares chave-valor. Os valores dos argumentos podem ser cadeias de caracteres, números, booleanos, matrizes ou objetos, dependendo dos requisitos do modelo.

activation (obrigatório para modelos de ativação)

Configuração específica de ativação necessária ao executar modelos de ativação.

snowflake_collaborator: Alias do colaborador para o destino da ativação (máximo de 25 caracteres). Deve corresponder a um alias definido na seção collaborator_identifier_aliases da especificação de colaboração, e o colaborador deve estar listado na seção activation_destinations.
segment_name: Nome de segmento exclusivo para esta ativação (máximo de 255 caracteres). Utilizado para identificar e rastrear os resultados da ativação. Deve seguir as regras do identificador do Snowflake.