Skip to content

Commit f5de518

Browse files
authored
Update Readme.md
1 parent 5d9da84 commit f5de518

File tree

1 file changed

+82
-7
lines changed

1 file changed

+82
-7
lines changed

Softwareai_Package/Readme.md

Lines changed: 82 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,82 @@
1-
# 👥 Specialized AI Agents for Every Coding Task
2-
### Boost your development workflow with AI assistants trained specifically for code documentation, refactoring, reviews, and more.
3-
![Version](https://img.shields.io/badge/version-1.0.19-blue)
4-
![Status](https://img.shields.io/badge/status-RC-yellow)
5-
![License](https://img.shields.io/badge/license-Apache-green)
6-
# 📜 Table of Contents
7-
- [📖 SoftwareAI](https://github.com/SoftwareAI-Company/SoftwareAI)
1+
2+
# softwareai-pip-library
3+
4+
[![Version](https://img.shields.io/badge/version-1.0.23-blue)]
5+
[![Status](https://img.shields.io/badge/status-Stable-green)]
6+
[![License](https://img.shields.io/badge/license-Apache_2.0-green)]
7+
8+
Biblioteca Python para criação e orquestração de agentes de IA especializados em tarefas de desenvolvimento de software:
9+
10+
- Autenticação e gerenciamento de agentes
11+
- Chat com histórico de conversas e streaming de respostas
12+
- Ferramentas integradas (busca em arquivos, interpretador de código, vetores semânticos, funções Python)
13+
- Armazenamento de metadados e histórico em Firebase
14+
- Destilação de respostas (salva inputs, outputs e instruções em JSON/JSONL)
15+
- Envio de resultados para webhooks
16+
- Cálculo de custo de tokens de entrada/saída
17+
18+
## Índice
19+
20+
- [Recursos](#recursos)
21+
- [Instalação](#instalação)
22+
- [Exemplo rápido](#exemplo-rápido)
23+
- [Documentação](#documentação)
24+
- [Contribuição](#contribuição)
25+
- [Licença](#licença)
26+
27+
## Recursos
28+
29+
- Inicializa e autentica agentes de IA junto à API OpenAI
30+
- Gerencia vetor stores e arquivos (upload, atualização, listagem)
31+
- Cria sessões de chat com ferramentas (arquivo, interpretador, vetores, funções)
32+
- Processa respostas em streaming e armazena histórico
33+
- Envia eventos de workflow para webhooks
34+
- Modula cálculo de custo por tokens
35+
36+
## Instalação
37+
38+
```bash
39+
pip install softwareai-engine-library
40+
````
41+
42+
Requisitos: Python ≥ 3.7
43+
44+
## Exemplo rápido
45+
46+
```python
47+
from softwareai_engine_library.Handler.OpenAIKeysinit import OpenAIKeysinit
48+
from softwareai_engine_library.Handler.FirebaseKeysinit import FirebaseKeysinit
49+
from softwareai_engine_library.AutenticateAgent.AuthAgent import AutenticateAgent
50+
from softwareai_engine_library.Chat.session.create_or_auth_AI import create_or_auth_AI
51+
from softwareai_engine_library.Chat.stream.process_stream import process_stream
52+
import asyncio
53+
54+
# 1) Inicializa clientes
55+
openai_client = OpenAIKeysinit._init_client_("SEU_OPENAI_API_KEY")
56+
57+
# 2) Cria ou autentica um agente de IA
58+
assistant_id, _, _, _ = create_or_auth_AI(
59+
appcompany=firebase_app,
60+
client=openai_client,
61+
key="usuario123",
62+
instructionsassistant="Você é um assistente especializado em refatoração de código.",
63+
nameassistant="RefactorBot",
64+
model_select="gpt-4o-mini-2024-07-18",
65+
tools=[{"type": "file_search"}, {"type": "code_interpreter"}]
66+
)
67+
68+
```
69+
70+
## Documentação
71+
72+
* Detalhes de todos os módulos e funções: [MODULES\_DETAILS.md](./MODULES_DETAILS.md)
73+
* Informações extras: [MODULES\_DETAILS2.md](./MODULES_DETAILS2.md)
74+
75+
## Contribuição
76+
77+
Pull requests e issues são muito bem-vindos!
78+
Por favor, siga as diretrizes de estilo e adicione testes quando possível.
79+
80+
## Licença
81+
82+
Este projeto está sob a licença Apache 2.0. Veja [LICENSE.txt](LICENSE.txt).

0 commit comments

Comments
 (0)