Interagir com o SQL generativo do Amazon Q - Amazon Redshift

Interagir com o SQL generativo do Amazon Q

nota

No momento, o SQL generativo do Amazon Q é oferecido somente nas seguintes Regiões da AWS:

  • Região Leste dos EUA (Norte da Virgínia) (us-east-1)

  • Região Oeste dos EUA (Oregon) (us-west-2)

  • Região Ásia-Pacífico (Mumbai) (ap-south-1)

  • Região da Ásia-Pacífico (Singapura) (ap-southeast-1)

  • Região da Ásia-Pacífico (Sydney) (ap-southeast-2)

  • Região Ásia-Pacífico (Tóquio) (ap-northeast-1)

  • Região Europa (Frankfurt) (eu-central-1)

  • Região da Europa (Paris) (eu-west-3)

  • Região da Europa (Irlanda) (eu-west-1)

É possível interagir com o recurso SQL generativo do Amazon Q no editor de consultas do Amazon Redshift v2. Trata-se de um assistente de codificação que gera instruções SQL com base nos prompts e no esquema do banco de dados. Esse assistente de codificação está disponível enquanto você cria um notebook no editor de consultas v2. O SQL gerado destina-se ao banco de dados ao qual seu caderno está conectado.

Ao interagir com o SQL generativo do Amazon Q, faça perguntas específicas, itere quando tiver solicitações complexas e verifique se as respostas estão corretas.

Ao fornecer solicitações de análise em linguagem natural, tente usar o máximo de especificidade para ajudar o assistente de codificação a compreender exatamente aquilo de que você precisa. Em vez de perguntar "encontre os espaços que mais venderam ingressos", dê mais detalhes como "encontre nomes/IDs dos três espaços que mais venderam ingressos em 2008". Use nomes consistentes e específicos de objeto no banco de dados quando os conhecer. Como nomes de esquema, tabela e coluna, conforme definido no banco de dados, em vez de se referir ao mesmo objeto de maneiras diferentes, o que pode confundir o assistente.

Divida solicitações complexas em várias declarações simples que sejam mais fáceis do assistente interpretar. Faça perguntas de acompanhamento de maneira iterativa para obter uma análise mais detalhada do assistente. Por exemplo, pergunte primeiro "qual estado tem mais espaços?" Em seguida, com base na resposta, pergunte "qual é o espaço mais conhecido desse estado?".

Revise o SQL gerado antes de executá-lo para garantir a precisão. Se a consulta SQL gerada tiver erros ou não corresponder à intenção, dê instruções ao assistente sobre como corrigi-la, em vez de reformular a solicitação inteira. Por exemplo, se a consulta não tiver uma cláusula de predicado no ano, peça "Dê locais do ano de 2008".

Envie o texto dos erros que você recebe ao executar o SQL gerado de volta como prompts para o SQL generativo do Amazon Q. Ele aprende com esses erros para produzir um SQL melhor.

Adicione o esquema ao caminho de pesquisa SQL para sinalizar que o esquema deve ser usado. Por exemplo, adicione o esquema tickit quando os dados estiverem no esquema tickit em vez de no esquema público.

set search_path to '$user', tickit;

Considerações ao interagir com o SQL generativo do Amazon Q

Considere o seguinte ao trabalhar no painel de chat:

  • O administrador do editor de consultas v2 da conta deve ter ativado o recurso de chat na página Configurações do SQL generativo.

  • Para usar o SQL generativo do Amazon Q, você precisa da permissão sqlworkbench:GetQSqlRecommendations na política do IAM, além de outras permissões especificadas na política gerenciada pela AWS do Editor de Consultas V2. Para obter mais informações sobre políticas gerenciadas pela AWS, consulte Acessar o editor de consultas v2.

  • As perguntas devem ser escritas em inglês.

  • As perguntas devem fazer referência ao banco de dados conectado no cluster ou no grupo de trabalho. Para evitar erros de estado vazio, deve haver pelo menos uma tabela e alguns dados no banco de dados.

  • As perguntas devem fazer referência aos dados armazenados no banco de dados conectado. Eles não podem fazer referência a um esquema externo. Para obter mais informações sobre os esquemas compatíveis, consulte Create schema no Guia do desenvolvedor de banco de dados do Amazon Redshift.

  • Qualquer dúvida que resulte em um SQL que altere o banco de dados conectado pode resultar em um aviso.

  • A tecnologia de IA generativa é nova e pode haver erros, às vezes chamados de alucinações, nas respostas. Teste e analise todo o código em busca de erros e vulnerabilidades antes de usá-lo no ambiente ou no workload.

  • Você pode melhorar as recomendações compartilhando as consultas SQL executadas por outros usuários na conta. O administrador da conta pode executar os seguintes comandos SQL para permitir o acesso ao histórico de consultas da conta.

    GRANT ROLE SYS:MONITOR to "IAMR:role-name"; GRANT ROLE SYS:MONITOR to "IAM:user-name"; GRANT ROLE SYS:MONITOR to "database-username";

    Para obter mais informações sobre SYS:MONITOR, consulte Amazon Redshift system-defined roles no Guia do desenvolvedor de banco de dados do Amazon Redshift.

  • Os dados são seguros e privados. Os dados não são compartilhados entre contas. As consultas, os dados e os esquemas de banco de dados não são usados para treinar um modelo de base (FM) de IA generativa. A entrada é usada como solicitações contextuais para o FM responder apenas às consultas.

Contexto personalizado

O administrador do Editor de Consultas V2 pode especificar um contexto personalizado para adaptar o SQL gerado ao seu ambiente. Um contexto personalizado fornece conhecimentos de domínio e preferências para oferecer controle refinado sobre a geração de SQL. Ele é definido em um arquivo JSON que pode ser carregado pelo administrador do Editor de Consultas V2 no SQL generativo do Amazon Q.

As chaves JSON usadas para personalizar o SQL gerado para um data warehouse são apresentadas a seguir.

Todas as referências de tabela precisam seguir a notação de três partes database.schema.table.

Recursos

Um recurso especifica o escopo ou a parte de um ativo de dados ao qual o contexto personalizado é aplicado.

ResourceId

Especifica um identificador único do recurso. Para um cluster do Amazon Redshift, especifique o cluster id. Para um grupo de trabalho do Redshift sem servidor, especifique o workgroup name.

ResourceType

Valor válido: REDSHIFT_WAREHOUSE.

TablesToInclude

Especifica um conjunto de tabelas que são consideradas para geração de SQL. Esse campo é essencial quando você quer limitar o escopo das consultas SQL a um subconjunto definido de tabelas disponíveis. Ele pode ajudar a otimizar o processo de geração reduzindo as referências de tabela desnecessárias. Você pode combinar esse campo com TablesToExclude para obter um controle mais preciso sobre a geração de consultas.

TablesToExclude

Especifica o conjunto de tabelas que são excluídas da geração de SQL. Use-o quando determinadas tabelas forem irrelevantes ou não precisarem ser consideradas no processo de geração de consultas.

TableAnnotations

Fornece metadados ou informações complementares sobre as tabelas em uso. Essas anotações podem incluir descrições de tabela, notas de uso ou quaisquer outros atributos que ajudem o SQL generativo do Amazon Q a entender melhor o contexto ou a estrutura da tabela. Isso é importante para aumentar a precisão da geração de SQL por meio de definições de tabela mais claras.

ColumnsToInclude

Define quais colunas das tabelas especificadas são incluídas ao gerar consultas SQL. Esse campo ajuda o SQL generativo do Amazon Q a se concentrar nas colunas relevantes e melhora o desempenho ao restringir o escopo da recuperação de dados. Ele garante que o SQL generativo do Amazon Q extraia apenas os dados necessários ao contexto de consulta específico.

ColumnsToExclude

Especifica as colunas que não são consideradas na geração de SQL. Isso pode ser usado quando determinadas colunas contêm dados irrelevantes ou redundantes que não devem ser considerados pelo SQL generativo do Amazon Q. Ao gerenciar a inclusão e exclusão de colunas, é possível refinar os resultados e manter o controle sobre os dados recuperados.

ColumnAnnotations

Semelhante a TableAnnotations, esse campo fornece anotações ou metadados específicos para colunas individuais. Essas anotações podem oferecer informações sobre as definições de coluna ou instruções especiais sobre como usá-las. Essas informações são úteis para orientar o processo de geração de SQL e garantir que as colunas sejam usadas adequadamente nas consultas.

CuratedQueries

Um conjunto de exemplos de perguntas e respostas predefinidas, em que a pergunta é escrita em linguagem natural (NLQ) e a resposta é a consulta SQL correspondente. Esses exemplos ajudam o SQL generativo do Amazon Q a entender os tipos de consulta que se espera que ele gere. Eles servem como pontos de referência para melhorar a precisão e a relevância das saídas do SQL generativo do Amazon Q.

CustomDocuments

Informações ou dicas adicionais fornecidas ao SQL generativo do Amazon Q, como definições, conhecimentos de um domínio específico ou explicações. Por exemplo, se sua unidade de negócios usa uma forma exclusiva para calcular um valor (por ex., “na divisão de fabricação, o total de vendas é preço * receita”), isso pode ser documentado neste campo. Por fornecerem contexto adicional, esses documentos ajudam o SQL generativo do Amazon Q a interpretar melhor as entradas em linguagem natural.

AdditionalTables

Especifica todas as tabelas adicionais que devem ser consideradas para geração de SQL e que não fazem parte dos dados armazenados no data warehouse. Isso permite que o SQL generativo do Amazon Q integre fontes de dados externas à sua lógica de geração de SQL, ampliando sua capacidade de lidar com ambientes de dados complexos.

AppendToPrompt

Instruções ou diretrizes adicionais fornecidas ao SQL generativo do Amazon Q para orientar o processo de geração de SQL. Isso pode incluir diretivas específicas sobre como estruturar a consulta, preferências por determinados constructos de SQL ou qualquer outra instrução abrangente que melhore a qualidade da saída do SQL generativo do Amazon Q.

O exemplo de contexto personalizado apresentado abaixo mostra o formato do arquivo JSON e define o seguinte:

  • Um contexto personalizado para o data warehouse do Amazon Redshift referente ao cluster mycluster.

  • Tabelas e colunas específicas a serem incluídas e excluídas para ajudar a otimizar o processo de geração de SQL.

  • Anotações para as tabelas e colunas solicitadas para inclusão.

  • Exemplos de consultas com curadoria para uso do SQL generativo do Amazon Q.

  • Documentos e barreiras de proteção personalizados a serem usados ao gerar SQL.

  • A linguagem de definição de dados (DDL) para tabelas adicionais usarem ao gerar SQL.

{ "resources": [ { "ResourceId": "mycluster", "ResourceType": "REDSHIFT_WAREHOUSE", "TablesToInclude": [ "database.schema.table1", "database.schema.table2" ], "TablesToExclude": [ "database.schema.table3", "database.schema.table4" ], "ColumnsToInclude": { "database.schema.table1": [ "col1", "col2" ], "database.schema.table2": [ "col1", "col2" ] }, "ColumnsToExclude": { "database.schema.table5": [ "col1", "col2" ], "database.schema.table6": [ "col1", "col2" ] }, "TableAnnotations": { "database.schema.table1": "table1 refers to Q3 sales", "database.schema.table2": "table2 refers to Q4 sales" }, "ColumnAnnotations": { "database.schema.table1": { "col1": "col1 refers to Q3 sale total", "col2": "col2 refers to sale location" }, "database.schema.table2": { "col1": "col2 refers to Q4 sale total", "col2": "col2 refers to sale location" } }, "CuratedQueries": [ { "Question": "what is the sales data for Q3", "Answer": "SELECT * FROM table1" }, { "Question": "what is the sales data for Q4", "Answer": "SELECT * FROM table2" } ], "CustomDocuments": [ "in manufacturing division total sales is price * revenue", "in research division total sales is price * revenue" ], "AdditionalTables": { "database.schema.table8": "create table database.schema.table8(col1 int)", "database.schema.table9": "create table database.schema.table9(col1 int)" }, "AppendToPrompt": "Apply these guardrails: Queries should never return the secretId field of a user." } ] }