https://github.com/devscast/lugha
Lugha is a PHP Generative AI Framework to build chatbot, RAG systems and AI-powered applications
https://github.com/devscast/lugha
artificial-intelligence framework generative-ai symfony
Last synced: 11 months ago
JSON representation
Lugha is a PHP Generative AI Framework to build chatbot, RAG systems and AI-powered applications
- Host: GitHub
- URL: https://github.com/devscast/lugha
- Owner: devscast
- License: mit
- Created: 2024-06-02T03:59:18.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-06T04:28:36.000Z (about 1 year ago)
- Last Synced: 2025-03-24T17:52:51.788Z (12 months ago)
- Topics: artificial-intelligence, framework, generative-ai, symfony
- Language: PHP
- Homepage:
- Size: 170 KB
- Stars: 27
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-php-ai - **Lugha** - Lugha is a PHP Generative AI Framework to build chatbot, RAG systems and AI-powered applications (Libraries / Natural Language Processing)
README
# Lugha - yet another PHP Generative AI Framework
[](https://packagist.org/packages/devscast/lugha)
[](https://packagist.org/packages/devscast/lugha)
[](https://packagist.org/packages/devscast/lugha)
> [!NOTE]
> Work in progress.
Lugha from Swahili meaning "Language" is a PHP Generative AI Framework that provides a simple and easy way to interact with various AI providers.
The main idea is to provide a unified provider-agnostic API for AI models, making it easier to switch between providers.
This project is highly inspired by [LangChain](https://www.langchain.com/) and [LLPhant](https://github.com/theodo-group/LLPhant/), designed
for Chatbot, RAG (Retrieval-Augmented Generation) based applications with integration of Embeddings, Completion and Reranking models.
*supported providers:*
| Provider | Link | Features |
|------------|-----------------------------------------------------|------------------------|
| OpenAI | [openai.com](https://openai.com) | Completion, Embeddings |
| Mistral | [mistral.ai](https://mistral.ai/) | Completion, Embeddings |
| Google | [ai.google](https://ai.google/) | Completion, Embeddings |
| GitHub | [github.com](https://github.com/marketplace/models) | Completion, Embeddings |
| Anthropic | [anthropic.com](https://www.anthropic.com/) | Completion |
| Voyager.ai | [voyageai.com](https://www.voyageai.com/) | Embeddings, Reranking |
| Ollama | [ollama.com](https://ollama.com/) | Completion, Embeddings |
| Deepseek | [deepseek.com](https://deepseek.com) | completion |
## Installation
```bash
composer require devscast/lugha
```
## Usage
### Embeddings
Embeddings are a type of word representation that allows words with similar meaning to have a similar representation.
they can be used to find the similarity between words, phrases, or sentences.
useful for document classification, clustering, and information retrieval.
```php
$client = ClientFactory::create(Provider::GOOGLE);
$embeddings = $client->embeddings(
prompt: 'Hello, world!',
config: new EmbeddingsConfig(
model: 'text-embedding-004',
dimensions: 512
)
)->embedding;
```
### Completion
Completion models are designed to generate human-like text based on the input prompt.
```php
$client = ClientFactory::create(Provider::OPENAI);
```
- completion from a single prompt
```php
$completion = $client->completion(
input: 'Hello, world!',
config: new CompletionConfig(
model: 'gpt-3.5-turbo',
temperature: 0.5,
maxTokens: 100,
frequencyPenalty: 0.5,
presencePenalty: 0.5
)
)->completion;
```
- completion from a chat history (conversation)
```php
$completion = $client->chat(
input: History::fromMessages([
new Message('You are a chatbot, expert in philosophy', Role::SYSTEM),
new Message('what is the meaning of life ?', Role::USER)
]),
config: new ChatConfig(model: 'gpt-4-turbo')
)->completion;
```
- completion with tool calling
```php
#[ToolDefinition(
name: 'get_weather',
description: 'Get the weather for a location on a specific date.',
parameters: [
new ToolParameter('location', 'string', 'The location to get the weather for.', required: true),
new ToolParameter('date', 'string', 'The date to get the weather for.', required: true),
],
strict: true
)]
class WeatherProvider
{
public function __invoke(string $location, string $date): string
{
return "The weather in $location on $date is sunny.";
}
}
$completion = $client->completion(
input: 'What is the weather in Lubumbashi on January 16th ?',
config: new CompletionConfig(model: 'gpt-4-turbo'),
tools: [new WeatherProvider()]
)->completion;
```
### Reranking
Reranking models are designed to re-rank a list of documents based on the input prompt.
useful for search engines, recommendation systems, and information retrieval.
```php
$client = ClientFactory::create(Provider::VOYAGER);
$reRankedDocuments = $client->reranking(
prompt: 'What is the meaning of life ?',
documents: [
new Document('The best way to predict the future is to create it.'),
new Document('The only way to do great work is to love what you do.'),
new Document('Life is short, smile while you still have teeth.'),
new Document('The best time to plant a tree was 20 years ago. The second best time is now.')
],
config: new RerankingConfig(model: 'voyager-1.0', topK: 3)
)->documents;
```
## Contributors
