maestro/src/modules/catalog/prompts/ai-documentation.prompt.ts

/**

 */
export const AI_DOCUMENTATION_PROMPT = `crie uma documentação em Portugues, Ingles e Espanhol seguindo essas instruções 
1. Persona: como profissional de governança e engenharia de dados
2. Tarefa: ao receber as informações da tabela criar uma documentação com o seguinte escopo 
**A primeira linha do documento tem que conter a seguinte informação: ## Document languages: EN / BR / ES
**A segunda linha tem que obrigatoriamente conter a escrita Table: nome da tabela
**A terceira linha tem que obrigatoriamente conter a escrita Table Schema: nome do table schema
**DIRETRIZ CRUCIAL DE CONSISTÊNCIA E COMPLETUDE DE SCHEMA:**
**1. Fonte Exclusiva de Metadados:** O 'Table Schema' definido na linha acima é a ÚNICA fonte de verdade para o schema dos dados a serem documentados. TODAS as informações subsequentes, especialmente na seção 'Estrutura da Tabela' (incluindo a lista de colunas, seus nomes, tipos de dados, descrições e exemplos) DEVEM ser extraídas EXCLUSIVAMENTE de metadados que correspondem a ESTE 'Table Schema'. Se os dados de entrada que você recebeu contiverem informações para a mesma tabela ou colunas mas de schemas diferentes (ex: um schema 'bronze' e um 'silver'), você DEVE IGNORAR TOTALMENTE as informações dos schemas divergentes para esta tarefa de documentação e utilizar APENAS as do 'Table Schema' aqui especificado.
**2. Listagem Completa de Colunas:** Sua principal tarefa na seção 'Estrutura da Tabela' é identificar e listar TODAS as colunas que pertencem ao 'Table Schema' especificado. Verifique nos dados de entrada fornecidos se há uma indicação explícita do número total de colunas para esta tabela neste schema (por exemplo, um campo como 'Num_columns' ou similar nos metadados da tabela). Você deve se esforçar para listar exatamente essa quantidade de colunas. Se essa contagem não estiver disponível, liste todas as colunas que você puder identificar como pertencentes exclusivamente a este 'Table Schema'. A completude em relação ao schema especificado é essencial.

**Depois de "Estrutura da tablea", incluir a mensagem "Este documento foi gerado por IA", traduzida corretamente para cada idioma.**
**Obrigatoriamente:Após finalizar a versão em Inglês, começar a versão em Português** **Após finalizar a versão em Português, começar a versão em Espanhol** **Antes de começar cada versão, colocar um título como:** - \`## English Version\` (para inglês)  
  - \`## Versão em Português\` (para português)  
  - \`## Versión en Español\` (para espanhol)  
 - Descrição: fornece uma visão geral do ativo de dados, 
 destacando seu propósito e principal funcionalidade. 
 Esta sessão resume o conteúdo e o objetivo do ativo, ajudando os usuários a entender rapidamente o que o ativo representa 
 e como pode ser utilizado em suas análises e decisões.
 - Sugestão de Domínio de Dados:
 Analise cuidadosamente os dados da tabela e sugira o domínio mais apropriado. Inclua:
 - Domínio Sugerido: [Nome do domínio]
 - Motivo: [Explicação breve sobre porque a tabela pertence a este domínio]
 - Observações: [Qualquer observação adicional relevante]
 
 Exemplos de Domínios de Dados para referência:
 - Financeiro: Dados sobre transações, receitas, despesas, etc.
 - Recursos Humanos: Dados sobre funcionários, cargos, salários, etc.
 - Produtos: Dados sobre produtos, categorias, preços, etc.
 - Fornecedores: Dados sobre fornecedores, produtos fornecidos, localizações, etc.
 - Marketing: Dados sobre campanhas, leads, conversões, etc.
 - Vendas: Dados sobre vendas, clientes, produtos vendidos, etc.
 - Operações: Dados sobre processos, logística, produção, etc.
 - Clientes: Dados sobre clientes, interações, histórico, etc.
   -Tags Sugeridas:
          A IA deve gerar tags relevantes **com base nos dados da tabela**.  
        - **IMPORTANTE: Analise cuidadosamente os dados de preview da tabela (PREVIEW DATA) para encontrar países. Procure em todas as colunas por nomes de países, cidades ou regiões.**
        - **Garanta que as tags estejam separadas por espaços vazios, todas na mesma linha, exemplo: #marketing #sales #australia #canada, limitar até 3 países que mais aparecem** - **Os países DEVEM ser extraídos dos dados de preview da tabela. Procure em colunas como City, Country, Region, Location, etc.** - Por que esta tabela é interessante:
 Nesta sessão, é destacada a importância do ativo, explicando como ele pode ser útil para os usuários. 
 São abordadas as formas como o ativo pode melhorar a tomada de decisões, identificar padrões relevantes ou fornecer insights valiosos. 
 O objetivo é ressaltar a utilidade prática e o impacto positivo que o ativo pode ter em suas atividades.
 - Análises potencialmente úteis feitas com esses dados:
 Aqui são listadas algumas das análises que podem ser realizadas com o ativo de dados. Inclui sugestões de dashboards, 
 relatórios ou outros tipos de análises que aproveitam as informações fornecidas pelo ativo. 
 O objetivo é oferecer maneiras de utilizar os dados para obter insights valiosos e apoiar a tomada de decisões informadas.
 - Links Úteis:
 Os Links Úteis oferecem recursos adicionais relacionados ao ativo de dados, incluindo guias, 
 artigos ou outras fontes de informação que podem ajudar os usuários a compreender melhor o ativo e suas aplicações. Além disso, 
 inclui um link rápido dentro da Dadosfera para ativos relacionados diretamente com o ativo em questão, facilitando a navegação entre os ativos.
 - Estrutura da Tabela:
 A Estrutura da Tabela detalha TODAS as colunas e os dados disponíveis no ativo, conforme pertencentes ao 'Table Schema' principal definido no início deste documento.
 **Instrução Detalhada para Estrutura da Tabela:**
 Siga rigorosamente estes passos:
 1. Identifique nos dados de entrada (metadados da tabela e das colunas) todas as colunas que pertencem EXCLUSIVAMENTE ao 'Table Schema' especificado no cabeçalho deste documento. Se houver uma contagem de colunas (ex: 'Num_columns') para este schema específico, assegure-se de listar essa quantidade.
 2. Para CADA uma dessas colunas identificadas, formate a saída da seguinte maneira, **SEM utilizar NENHUM marcador de lista (como traços ou asteriscos) no início de cada entrada de coluna**. Cada coluna deve ser apresentada como um bloco de texto. Inclua uma linha em branco entre a documentação de cada coluna para separação visual.
   - Apresente o NOME_DA_COLUNA em maiúsculas, seguido pelo (TIPO_DE_DADO_EXTRAÍDO_DOS_METADADOS_DO_SCHEMA_CORRETO) entre parênteses.
   - O **NOME_DA_COLUNA (TIPO_DE_DADO_EXTRAÍDO_DOS_METADADOS_DO_SCHEMA_CORRETO)** deve estar na primeira linha do bloco da coluna e **inteiramente em negrito**.
   - Na linha seguinte, a etiqueta "**Descrição:**" deve estar **em negrito**, seguida pelo texto da descrição da coluna.
   - Na linha seguinte à descrição, a etiqueta "**Exemplo:**" deve estar **em negrito**, seguida pelo valor do exemplo. Se o exemplo for um valor literal ou código, formate-o entre crases (\`) se apropriado.
   - Se houver informações adicionais relevantes (como "Valores Possíveis:", "Observações:", etc.), coloque a etiqueta correspondente **em negrito** em uma nova linha, seguida pelo seu texto.
   
 Este documento foi gerado por IA.

 NOME_COLUNA_1 (TIPO_DADO_SCHEMA_CORRETO_1):
   Descrição: [Descrição da coluna 1, do schema correto]
   Exemplo: \`[Exemplo de valor para coluna 1, do schema correto]\`

 NOME_COLUNA_2 (TIPO_DADO_SCHEMA_CORRETO_2):
   Descrição: [Descrição da coluna 2, do schema correto]
   Exemplo: \`[Exemplo de valor para coluna 2, do schema correto]\`

 (continue este formato com início de cada coluna para TODAS as colunas do 'Table Schema' especificado, garanta com que NUNCA tenha TRAÇO OU PONTO no inicio)

 3. Contexto : O usuário ira cadastrar um ativo de dados na nossa plataforma e para ter um bom catalogo ele ira querer gerar a documentação padronizada mas explicativa e
 automática 
 4. Restrições : A documentação deve seguir obrigatoriamente o mesmo padrão principalmente na parte de estrutura de dados
 5. Objetivo: O principal objetivo é gerar uma documentação acessível, clara, 
 automática e padronizada para os usuários que desejem cadastrar um ativo de dados na plataforma`;

/**
 * Configurações para a geração de documentação com IA
 */
export const AI_DOCUMENTATION_CONFIG = {
  FETCH_K: 250,
  K: 100,
} as const;