Adicionar comentários a dados e ativos de IA

  • Artigo

Este artigo apresenta comentários para dados e ativos de IA e explica como adicioná-los. Os comentários podem ajudar você e outros usuários a encontrar e gerenciar os dados e ativos de IA de que você precisa.

Os comentários fornecem um campo de metadados para anotar seus objetos protegíveis. Você pode adicionar comentários a qualquer objeto protegível no Unity Catalog, como catálogos, esquemas, tabelas, volumes, modelos de IA e muito mais. Você também pode adicionar comentários às colunas da tabela.

Você pode adicionar comentários manualmente ou pode permitir que o Databricks crie comentários gerados por IA para você. Comentários gerados por IA (também conhecidos como documentação gerada por IA) estão disponíveis para tabelas e colunas de tabelas. Consulte Adicionar comentários gerados por IA a uma tabela.

Quando você modifica comentários para uma tabela do Catálogo Unity (ou uma tabela Delta Lake no metastore herdado do Hive), uma SET TBLPROPERTIES operação no histórico da tabela registra a consulta SQL que foi usada para definir o comentário da tabela.

Antes de começar

Você deve atender aos seguintes requisitos para adicionar ou editar comentários:

  • Para adicionar ou editar comentários em um catálogo, esquema, volume, modelo, compartilhamento, destinatário, provedor, credencial de armazenamento, local externo ou conexão, você deve ser o proprietário do objeto.
  • Para adicionar ou editar comentários em uma tabela ou coluna, você deve ser o proprietário ou ter os seguintes privilégios:
    • MODIFY e SELECT em cima da mesa.
    • USE CATALOG e USE SCHEMA no catálogo pai e no esquema.
  • Você deve usar um SQL warehouse ou outra computação que ofereça suporte ao Unity Catalog (computação compartilhada ou de usuário único).
  • Para usar comentários gerados por IA, seu espaço de trabalho deve estar habilitado para recursos de assistência à IA. Consulte Adicionar comentários gerados por IA a uma tabela.

Adicionar e editar comentários

Você pode adicionar comentários a objetos protegíveis ou editá-los usando comandos SQL ou o Catalog Explorer.

Explorador de Catálogos

  1. Na barra lateral do espaço de trabalho, clique em Ícone do catálogo Catálogo para abrir o Gerenciador de Catálogos.

  2. Procure e selecione o objeto sobre o qual deseja comentar.

    Os dados e os objetos de IA são listados e pesquisáveis no painel Catálogo . Compartilhamentos, credenciais de armazenamento, locais externos e conexões podem ser acessados usando o menu que se abre quando você clica no ícone de Ícone de engrenagem engrenagem.

  3. Adicione um comentário ou edite um comentário existente.

    • Para adicionar um comentário a uma tabela usando comentários gerados por IA, exiba o Comentário Sugerido pela IA no painel direito da guia Visão geral . Pode demorar alguns segundos a aparecer. Aceite-o como está ou Edite-o e salve-o.
    • Para adicionar um comentário a uma coluna de tabela usando comentários gerados por IA, clique no botão AI generate acima da lista de colunas. Databricks gera comentários para cada coluna. Aceite-os como estão ou edite-os. Clique na marca de seleção para salvar o comentário.
    • Para adicionar um comentário a um objeto que não suporta comentários gerados por IA, clique em Adicionar comentário para adicionar um comentário.
    • Para adicionar um comentário a uma coluna de tabela sem usar comentários gerados por IA, clique no Ícone para adicionar uma etiqueta de coluna ou comentário ícone Adicionar comentário na linha da coluna.
    • Se um comentário já existir, ele aparecerá no painel direito na guia Visão geral ou abaixo do nome do objeto. Se não for gerado por IA, clique no Ícone Editar ícone de edição para editá-lo.

Você pode usar Markdown básico para estilizar comentários na interface do usuário do Catalog Explorer. O estilo Markdown não é renderizado quando retornado por DESCRIBE instruções. Toda a sintaxe básica é suportada no Catalog Explorer, exceto imagens, e apenas dois níveis de título são renderizados. Para obter mais informações, consulte Sintaxe básica.

Para obter mais informações sobre comentários gerados por IA, consulte Adicionar comentários gerados por IA a uma tabela.

SQL

Você pode usar um comando SQL para adicionar uma cadeia de caracteres literal como um comentário a qualquer objeto protegível no Unity Catalog e a tabelas gerenciadas no metastore herdado do Hive. O comando SQL que você usa depende do objeto para o qual você deseja adicionar ou editar o comentário:

  • Para adicionar ou atualizar um comentário para qualquer objeto protegível existente, exceto colunas de tabela, use o COMMENT ON comando. Ver COMENTÁRIO SOBRE.

    Você também pode usar a COMMENT opção com o ALTER <object> comando para o objeto (por exemplo, ALTER TABLE). Consulte o artigo de referência SQL para o ALTER <object> comando.

  • Para adicionar ou atualizar um comentário de coluna para uma tabela existente, use o ALTER TABLE comando com a ALTER COLUMN cláusula e a COMMENT opção na coluna. Veja ALTER TABLE e ALTER TABLE ... Cláusula COLUMN.

  • Para adicionar um comentário ao criar um objeto, use a COMMENT opção com o CREATE <object> comando. Consulte o artigo de referência SQL para o CREATE <object> comando que você deseja usar.