Adicionar descrições de objetos de esquema a um agente de dados (pré-visualização)

As descrições de objetos de esquema dão ao agente de dados contexto de negócio sobre tabelas, colunas e outros elementos num esquema de fonte de dados. Este contexto ajuda o agente a distinguir entre objetos com nomes semelhantes ou ambíguos, a compreender o propósito de cada objeto e a gerar consultas mais precisas. As descrições são especialmente úteis para esquemas grandes onde os nomes dos objetos sozinhos não transmitem claramente o seu significado.

As descrições de objetos de esquema são suportadas em fontes de dados SQL, incluindo lakehouses, warehouses, bases de dados Fabric SQL e bases de dados espelhadas.

Observação

As descrições dos objetos do esquema estão atualmente em pré-visualização pública.

Observação

As descrições dos objetos do esquema estão disponíveis apenas quando o seu agente de dados utiliza o tempo de execução de pré-visualização.

Adicione ou edite uma descrição

Por defeito, o agente de dados herda as descrições disponíveis da fonte de dados e atualiza-as automaticamente. Quando editas uma descrição herdada no agente de dados, a alteração aplica-se apenas ao agente de dados. Não sobrescreve a descrição na fonte, e esse objeto já não recebe atualizações da descrição da fonte.

  1. Abra o seu agente de dados e depois selecione Configurar.
  2. Na fonte de dados, selecione Descrições de objetos de esquema.
  3. Expande o esquema para encontrar o objeto que queres descrever.
  4. Selecione o ícone Editar ao lado do objeto.
  5. Introduza uma descrição e depois selecione Feito.

Captura de ecrã da edição de uma descrição de tabela no painel de descrições de objetos Schema de um agente de dados.

Adicione uma descrição com o SDK Python

Use o Fabric Data Agent Python SDK para gerir as descrições dos objetos do esquema de forma programática. O exemplo seguinte define uma tabela na primeira fonte de dados de um agente de dados existente:

from fabric.dataagent.client import FabricDataAgentManagement

agent = FabricDataAgentManagement("<data-agent-name>")
datasource = agent.get_datasources()[0]

table_path = ("Schemas", "dbo", "Tables", "adoptions")
datasource.update_description({
    table_path: "Contains one row for each pet adoption transaction."
})

A tupla identifica o elemento do esquema pelo seu caminho na fonte de dados. Para descrever uma coluna, adicione o seu nome ao caminho da tabela. Por exemplo, use table_path + ("adoption_date",). Os nomes dos caminhos são sensíveis a maiúsculas e minúsculas e devem corresponder à hierarquia apresentada para a fonte de dados.

Escrever descrições eficazes

Use descrições para explicar o significado empresarial que não seja evidente no nome de um objeto. Mantenha cada descrição concisa e específica.

  • Para as tabelas, descreva as entidades empresariais ou eventos representados, o nível de detalhe da tabela e o seu objetivo principal.
  • Para as colunas, defina o significado de negócio do valor, formato, unidade ou valores esperados quando possam não ser claros.
  • Para outros elementos de esquema, explique o seu papel e quando o agente de dados deve usá-los.
  • Esclarecer abreviaturas, terminologia interna e objetos com nomes semelhantes.
  • Inclua contexto que ajude o agente a selecionar os objetos e relações corretos ao gerar uma consulta.

Conteúdo relacionado

  • Last updated on