adrianoL commited on
Commit
a6bf3c5
·
verified ·
1 Parent(s): f183f89

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -119
README.md CHANGED
@@ -13,123 +13,4 @@ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-
13
 
14
  ---
15
 
16
- ```markdown
17
- # Assistente de IA para Banco de Dados de E-commerce
18
-
19
- Este projeto é um assistente de IA projetado para facilitar consultas em bancos de dados de e-commerce. Ele permite que os usuários façam perguntas em linguagem natural e obtenham respostas precisas com base nos dados armazenados.
20
-
21
- ## Demonstração
22
-
23
- Experimente o app diretamente no Hugging Face Spaces. 🚀
24
-
25
- ---
26
-
27
- ## Funcionalidades
28
- - **Geração Automática de Descrições de Tabelas**: O assistente analisa o banco de dados `ecommerce.db` e descreve as tabelas e colunas disponíveis.
29
- - **Conversão de Perguntas em Consultas SQL**: Usuários podem fazer perguntas em linguagem natural, e o modelo gera a consulta SQL correspondente.
30
- - **Execução e Retorno de Resultados**: As consultas SQL geradas são executadas diretamente no banco de dados, retornando os resultados para o usuário.
31
-
32
- ---
33
-
34
- ## Configuração
35
-
36
- ### Banco de Dados
37
- - O arquivo `ecommerce.db` deve estar localizado no diretório raiz do projeto. Ele contém os dados de exemplo utilizados para geração das consultas.
38
-
39
- ### Variáveis de Ambiente
40
- - **`GROQ_API`**: Adicione sua chave de API para o modelo de linguagem no ambiente do Space:
41
- ```bash
42
- export GROQ_API=your_api_key
43
- ```
44
-
45
- ### Dependências
46
- Certifique-se de que as bibliotecas abaixo estão instaladas. No Hugging Face Spaces, o arquivo `requirements.txt` cuida disso automaticamente.
47
- ```plaintext
48
- sqlalchemy
49
- pandas
50
- llama-index
51
- huggingface-hub
52
- ```
53
-
54
- ### Instalação Local
55
- Se desejar rodar o projeto localmente:
56
- 1. Clone o repositório:
57
- ```bash
58
- git clone https://huggingface.co/spaces/adrianoL/Assistente-IA-Para-Banco-de-Dados_ecommerce_Zoop
59
- cd Assistente-IA-Para-Banco-de-Dados_ecommerce_Zoop
60
- ```
61
- 2. Instale as dependências:
62
- ```bash
63
- pip install -r requirements.txt
64
- ```
65
- 3. Execute o script principal:
66
- ```bash
67
- python app.py
68
- ```
69
-
70
- ---
71
-
72
- ## Exemplos
73
-
74
- ### Pergunta
75
- ```
76
- Quais são os cinco produtos mais vendidos?
77
- ```
78
-
79
- ### Saída
80
- **Consulta SQL Gerada**:
81
- ```sql
82
- SELECT nome_produto, SUM(quantidade_vendida) AS total
83
- FROM vendas
84
- GROUP BY nome_produto
85
- ORDER BY total DESC
86
- LIMIT 5;
87
- ```
88
-
89
- **Resultados**:
90
- | nome_produto | total |
91
- |--------------|-------|
92
- | Produto A | 150 |
93
- | Produto B | 120 |
94
-
95
- ---
96
-
97
- ## Contribuindo
98
- Contribuições são bem-vindas! Para colaborar:
99
- 1. Faça um fork do repositório.
100
- 2. Crie um branch para suas alterações:
101
- ```bash
102
- git checkout -b minha-melhoria
103
- ```
104
- 3. Faça um commit das alterações:
105
- ```bash
106
- git commit -m "Descrição clara das alterações"
107
- ```
108
- 4. Envie as alterações para seu fork:
109
- ```bash
110
- git push origin minha-melhoria
111
- ```
112
- 5. Abra um Pull Request.
113
-
114
- ---
115
-
116
- ## Licença
117
- Este projeto está licenciado sob a [MIT License](LICENSE).
118
-
119
- ---
120
-
121
- Explore mais no [Hugging Face Spaces](https://huggingface.co/spaces).
122
- ```
123
-
124
- ---
125
-
126
- ### Como Adicionar ao Hugging Face
127
- 1. Acesse o seu Space no **Hugging Face**.
128
- 2. Vá para **Files and versions** > **Add file** > **Create new file**.
129
- 3. Nomeie como `README.md`.
130
- 4. Cole o conteúdo acima e salve.
131
-
132
- Se precisar de mais ajustes ou tiver dúvidas, é só avisar! 😊
133
-
134
-
135
 
 
13
 
14
  ---
15
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
16