Adiciona documentação e melhora a configuração do Groq Laravel

Inclui um arquivo de changelog e contribuições, além de documentar instalação, configuração, tratamento de erros e exemplos práticos. Essas melhorias visam facilitar a integração do pacote com aplicações Laravel, promovendo uma experiência de uso mais intuitiva e permitindo que desenvolvedores contribuam de maneira mais eficiente. A implementação de testes abrangentes também assegura a confiabilidade do pacote.

Author: lucianotonet

CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+Todas as mudanças notáveis neste projeto serão documentadas neste arquivo.
+
+O formato é baseado em [Keep a Changelog](https://keepachangelog.com/pt-BR/1.0.0/),
+e este projeto adere ao [Versionamento Semântico](https://semver.org/lang/pt-BR/).
+
+## [0.0.8] - 2024-03-XX
+
+### Adicionado
+- Novo arquivo `.env.example` com exemplos de configuração da API Groq.
+- Suporte para configuração de múltiplas instâncias da API Groq.
+- Novos métodos de validação em requisições para facilitar a integração da API.
+- Implementação de controle de taxa para evitar abusos da API.
+- Adição de testes abrangentes, incluindo testes de integração, unitários e de configuração.
+- Novo middleware `GroqRateLimiter` para limitar requisições à API.
+- Arquivos de linguagem para suporte a internacionalização de mensagens de erro.
+
+### Alterado
+- Atualização do README.md com documentação simplificada e exemplos práticos de uso.
+- Refatoração do código para melhorar a legibilidade e manutenibilidade.
+- Expansão da configuração com variáveis para ajuste de modelo e limites de taxa.
+- Atualização da fachada Groq para acesso simplificado aos métodos da biblioteca GroqPHP.
+- Melhoria na flexibilidade de configuração da integração com a API Groq.
+
+### Corrigido
+- Correção de problemas de compatibilidade com diferentes versões do Laravel.
+
+### Segurança
+- Implementação de melhores práticas de segurança na manipulação de chaves de API.
+
+## [0.0.7] - 2024-XX-XX
+
+### Adicionado
+- Versão inicial do pacote Groq Laravel.
+- Integração básica com a API Groq.
+- Configuração inicial do pacote.
+
+[0.0.8]: https://github.com/lucianotonet/groq-laravel/compare/v0.0.7...v0.0.8
+[0.0.7]: https://github.com/lucianotonet/groq-laravel/releases/tag/v0.0.7

CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Contribuindo para o Groq Laravel
+
+Agradeço seu interesse em contribuir para o Groq Laravel! Para garantir que suas contribuições sejam aceitas e integradas de forma eficiente, siga estas diretrizes:
+
+## Como Contribuir
+
+1. **Fork o repositório**: Crie uma cópia do repositório em sua conta do GitHub.
+2. **Crie uma nova branch**: Antes de fazer alterações, crie uma nova branch para suas modificações. Use um nome descritivo para a branch, como `feature/nova-funcionalidade` ou `bugfix/corrigir-erro`.
+   ```bash
+   git checkout -b minha-nova-funcionalidade
+   ```
+3. **Faça suas alterações**: Realize as modificações necessárias no código. Certifique-se de seguir o estilo de codificação do projeto e adicionar comentários onde necessário.
+4. **Teste suas alterações**: Execute os testes existentes e adicione novos testes, se aplicável, para garantir que suas alterações não quebrem a funcionalidade existente.
+   ```bash
+   vendor/bin/phpunit
+   ```
+5. **Envie um Pull Request**: Após concluir suas alterações, envie um Pull Request para o repositório original. Descreva suas alterações de forma clara e explique o motivo das modificações.
+
+## Diretrizes de Código
+
+- **Consistência**: Mantenha a consistência com o estilo de codificação existente.
+- **Documentação**: Adicione ou atualize a documentação conforme necessário.
+- **Testes**: Sempre inclua testes para novas funcionalidades ou correções de bugs.
+
+## Relatar Problemas
+
+Se você encontrar um bug ou tiver uma sugestão de melhoria, sinta-se à vontade para abrir uma nova issue no repositório. Forneça o máximo de detalhes possível para que eu possa entender e reproduzir o problema.
+
+Agradeço novamente por sua contribuição e por ajudar a melhorar o Groq Laravel!

README.md

@@ -1,68 +1,104 @@
 # Groq Laravel
 
-Groq Laravel is a powerful package that provides seamless integration between Laravel applications and the Groq API, enabling you to leverage the capabilities of language models (LLMs) like LLaMa directly within your PHP projects.
+Groq Laravel é um pacote poderoso que fornece integração perfeita entre aplicações Laravel e a API Groq, permitindo que você aproveite a velocidade ultra-rápida de inferência de IA com alguns dos LLMs abertos mais populares, como o Llama3.1 ou Mixtral, em seus projetos PHP.
 
 ## Features
 
-- **Simple and Intuitive Interface:** Interact with the Groq API using the `Groq` facade, simplifying access to chat, audio, and model functionalities.
-- **Robust Error Handling:** Efficiently handle communication errors and Groq API responses by capturing specific exceptions and providing informative messages.
-- **Flexible Configuration:** Define multiple Groq API instances, customize request timeouts, configure cache options, and adjust the package behavior to your needs.
-- **Detailed Practical Examples:** Explore code examples that demonstrate how to use the Groq Laravel package in real scenarios, including chatbots, audio transcription, and more.
-- **Comprehensive Testing:** Ensure the package's quality and reliability with a suite of tests covering integration, unit testing, and configuration aspects.
+- **Interface Simples e Intuitiva:** Interaja com a API Groq usando a facade `Groq`, simplificando o acesso às funcionalidades de chat, tradução e transcrição de áudio e chamadas à funções.
+- **Tratamento Robusto de Erros:** Gerencie eficientemente erros de comunicação e respostas da API Groq, capturando exceções específicas e fornecendo mensagens informativas.
+- **Configuração Flexível:** Defina várias instâncias da API Groq, personalize timeouts de requisição, configure opções de cache e ajuste o comportamento do pacote conforme suas necessidades.
+- **Exemplos Práticos Detalhados:** Explore exemplos de código que demonstram como usar o pacote Groq Laravel em cenários reais, incluindo chatbots, transcrição de áudio e muito mais.
+- **Testes Abrangentes:** Garanta a qualidade e confiabilidade do pacote com um conjunto de testes que cobrem aspectos de integração, testes unitários e configuração.
 
-## Installation
+## Instalação
 
-1. Install the package via Composer:
+1. Instale o pacote via Composer:
 
-```bash
-composer require lucianotonet/groq-laravel
-```
+   ```bash
+   composer require lucianotonet/groq-laravel
+   ```
 
-2. Publish the configuration file:
+2. Publique o arquivo de configuração:
 
-```bash
-php artisan vendor:publish --provider="LucianoTonet\GroqLaravel\GroqServiceProvider"
-```
+   ```bash
+   php artisan vendor:publish --provider="LucianoTonet\GroqLaravel\GroqServiceProvider"
+   ```
 
-3. Configure your Groq API credentials in the `.env` file:
+3. Configure suas credenciais da API Groq no arquivo `.env`:
 
-```
-GROQ_API_KEY=your_api_key_here
-GROQ_API_BASE=https://api.groq.com/openai/v1
-```
+   ```
+   GROQ_API_KEY=your_api_key_here
+   GROQ_API_BASE=https://api.groq.com/openai/v1
+   ```
 
-4. (Optional) Configure caching by defining the following environment variables in the `.env` file:
+4. (Opcional) Configure o cache definindo as seguintes variáveis de ambiente no arquivo `.env`:
 
-```
-GROQ_CACHE_DRIVER=file
-GROQ_CACHE_TTL=3600
-```
+   ```
+   GROQ_CACHE_DRIVER=file
+   GROQ_CACHE_TTL=3600
+   ```
 
-5. Import the `Groq` facade in your classes:
+5. Importe a facade `Groq` em suas classes:
 
-```php
-use LucianoTonet\GroqLaravel\Facades\Groq;
-```
+   ```php
+   use LucianoTonet\GroqLaravel\Facades\Groq;
+   ```
 
-## Usage
+## Uso
 
-Here's a simple example of creating a chat completion:
+Aqui está um exemplo simples de como criar uma conclusão de chat:
 
 ```php
-$response = Groq::chat()->completion()->create([
+$response = Groq::chat()->completions()->create([
     'model' => 'llama-3.1-8b-instant',
     'messages' => [
-        ['role' => 'user', 'content' => 'Hello, how are you?'],
+        ['role' => 'user', 'content' => 'Olá, como você está?'],
     ],
 ]);
 ```
 
-Refer to the [documentation](docs/index.md) for more detailed information on available methods, configuration options, and practical examples.
+## Tratamento de Erros
+
+O pacote Groq Laravel facilita o tratamento de erros que podem ocorrer ao interagir com a API Groq. Use um bloco `try-catch` para capturar e gerenciar exceções:
+
+```php
+try {
+    $response = Groq::chat()->completions()->create([
+        'model' => 'llama-3.1-8b-instant',
+        // ...
+    ]);
+} catch (GroqException $e) {
+    Log::error('Erro na API Groq: ' . $e->getMessage());
+    abort(500, 'Erro ao processar sua solicitação.');
+}
+```
+
+## Testes
+
+Os testes são uma parte essencial do desenvolvimento de software de qualidade. O pacote Groq Laravel inclui uma suíte de testes que cobre integração, unidade e configuração. Para executar os testes, siga os passos abaixo:
+
+1. **Instale as dependências do projeto:**
+
+   ```bash
+   composer install
+   ```
+
+2. **Execute os testes:**
+
+   ```bash
+   vendor/bin/phpunit ./tests/Feature
+   ```
+
+   ou individualmente:
+
+   ```bash
+   vendor/bin/phpunit ./tests/Feature/FacadeTest.php
+   ```
 
-## Contributing
+## Contribuindo
 
-Contributions are welcome! Please follow the guidelines outlined in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
+Contribuições são bem-vindas! Siga as diretrizes descritas no arquivo [CONTRIBUTING.md](CONTRIBUTING.md).
 
-## License
+## Licença
 
-This package is open-source software licensed under the [MIT license](LICENSE).
+Este pacote é um software de código aberto licenciado sob a [licença MIT](LICENSE).

docs/configuration.md

@@ -0,0 +1,69 @@
+---
+title: "Configuration"
+---
+
+# Configuration
+
+The Groq Laravel package offers various configuration options to customize its operation.
+
+## Configuration File
+
+After publishing the configuration file (`config/groq.php`), you can customize it:
+
+```php
+return [
+    'api_key' => env('GROQ_API_KEY'),
+    'api_base' => env('GROQ_API_BASE', 'https://api.groq.com/openai/v1'),
+    'timeout' => env('GROQ_TIMEOUT', 30), // Request timeout in seconds
+    'instances' => [
+        'default' => [
+            'api_key' => env('GROQ_API_KEY'),
+            'api_base' => env('GROQ_API_BASE', 'https://api.groq.com/openai/v1'),
+        ],
+        // ... other instances
+    ],
+    'cache' => [
+        'driver' => env('GROQ_CACHE_DRIVER', 'file'),
+        'ttl' => env('GROQ_CACHE_TTL', 3600),
+    ],
+];
+```
+
+## Environment Variables
+
+You can use environment variables in the `.env` file to configure the package:
+
+* `GROQ_API_KEY`: Your Groq API key.
+* `GROQ_API_BASE`: Base URL of the Groq API.
+* `GROQ_TIMEOUT`: Timeout for API requests in seconds.
+* `GROQ_CACHE_DRIVER`: Cache driver (e.g., `file`, `redis`).
+* `GROQ_CACHE_TTL`: Cache time-to-live in seconds.
+
+## Multiple Instances
+
+To configure multiple instances of the Groq API, add new entries to the `instances` array in the `config/groq.php` file:
+
+```php
+'instances' => [
+    'default' => [
+        'api_key' => env('GROQ_API_KEY'),
+        'api_base' => env('GROQ_API_BASE'),
+    ],
+    'custom' => [
+        'api_key' => env('GROQ_CUSTOM_API_KEY'),
+        'api_base' => env('GROQ_CUSTOM_API_BASE'),
+    ],
+],
+```
+
+To use a specific instance, use the `instance()` method of the `Groq` facade:
+
+```php
+$response = Groq::instance('custom')->chat()->completions()->create([
+    // ...
+]);
+```
+
+## Cache
+
+The Groq Laravel package offers support for caching API responses. You can configure the driver and cache lifetime in the configuration file or via environment variables.

docs/error-handling.md

@@ -0,0 +1,54 @@
+---
+title: "Error Handling"
+---
+
+# Error Handling
+
+The Groq Laravel package facilitates error handling that may occur when interacting with the Groq API.
+
+## Exceptions
+
+All methods of the `Groq` facade can throw an `\Exception` in case of an error in communication with the API. This includes:
+
+* Network errors (e.g., connection refused)
+* Authentication errors (e.g., invalid API key)
+* API response errors (e.g., unavailable model)
+
+## Handling Errors
+
+Use a `try-catch` block to capture and handle exceptions:
+
+```php
+try {
+    $response = Groq::chat()->completions()->create([
+        // ...
+    ]);
+} catch (\Exception $e) {
+    // Logic to handle the error.
+    Log::error('Error in Groq API: ' . $e->getMessage());
+
+    // Return an error response to the user.
+    abort(500, 'Error processing your request.');
+}
+```
+
+## Detailed Error Messages
+
+Analyze the error message returned by the exception (`$e->getMessage()`) to obtain more detailed information about the cause of the problem.
+
+## Error Logging
+
+Use Laravel's logging system to record errors and facilitate debugging:
+
+```php
+Log::error('Error in Groq API:', [
+    'exception' => $e,
+    'request' => $request->all(), 
+]);
+```
+
+## Best Practices
+
+* **Display user-friendly error messages to the end user**, avoiding exposing technical details of the exception.
+* **Implement fallback logic** to handle errors and ensure the continuity of your application.
+* **Monitor error logs** to quickly identify and resolve issues.