Adicionar comentários a dados e ativos de IA

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 catalogs, esquemas, tables, volumes, modelos de IA e muito mais. Você também pode adicionar comentários a tablecolumns.

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 tables e tablecolumns. Consulte Adicionar comentários gerados por IA a objetos do Unity Catalog.

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

Antes de começar

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

• Para adicionar ou editar comentários sobre um catalog, schema, volume, modelo, compartilhamento, destinatário, provedor, credencial de armazenamento, local externo ou conexão, você deve ser o proprietário do objeto ou ter o privilégio de MANAGE no objeto.
• Para adicionar ou editar comentários em um table ou column, você deve ser o proprietário ou ter os seguintes privilégios:
  • MODIFY e SELECT no table.
  • USE CATALOG e USE SCHEMA no catalog pai e schema.
• Você deve usar um SQL warehouse ou outro computador 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 objetos do Unity Catalog.

Adicionar e editar comentários

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

Catalog Explorer

1. Na barra lateral do espaço de trabalho, clique Catalog para abrir o Catalog Explorer.

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

   Os dados e os objetos de IA são listados e pesquisáveis no painel Catalog. Shares, credentialsde armazenamento, locais externos e connections podem ser acedidos através do menu que é aberto quando você clica no ícone de engrenagem ícone de engrenagem.

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

   • Para adicionar um comentário a um table usando comentários gerados por IA, veja o Comentário Sugerido pela IA no painel direito da aba Visão Geral. Pode demorar alguns segundos para aparecer. Aceite-o como está ou Edite-o e salve-o.
   • Para adicionar um comentário a um tablecolumn usando comentários gerados por IA, clique no botão AI generate acima do columnlist. Databricks gera comentários para cada column. 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 um tablecolumn sem usar comentários gerados por IA, clique no ícone ícone Adicionar comentário na linha column.
   • 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 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 objetos do Unity Catalog.

SQL

Você pode usar um comando SQL para adicionar um literal de texto como um comentário a qualquer objeto segurável no Unity Catalog e ao tables gerido no metastore legado 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 update um comentário para qualquer objeto protegível existente, exceto tablecolumns, use o comando COMMENT ON. Ver COMMENT ON.

  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 update um comentário column a um tableexistente, use o comando ALTER TABLE com a cláusula ALTER COLUMN e a opção COMMENT no column. Ver ALTER TABLE e ALTER TABLE ... COLUMN cláusula.

• 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.