PHPackages                             hayderhatem/filament-natural-language-filter - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. hayderhatem/filament-natural-language-filter

ActiveLibrary[Utility & Helpers](/categories/utility)

hayderhatem/filament-natural-language-filter
============================================

Natural language filtering for Filament tables and forms

v0.0.1(11mo ago)131933[1 issues](https://github.com/HayderHatem/filament-natural-language-filter/issues)MITPHPPHP ^8.2

Since Jun 2Pushed 11mo ago2 watchersCompare

[ Source](https://github.com/HayderHatem/filament-natural-language-filter)[ Packagist](https://packagist.org/packages/hayderhatem/filament-natural-language-filter)[ RSS](/packages/hayderhatem-filament-natural-language-filter/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (10)Versions (2)Used By (0)

Filament Natural Language Filter
================================

[](#filament-natural-language-filter)

A simple Filament filter that converts natural language text into database queries using AI.

Installation
------------

[](#installation)

```
composer require hayderhatem/filament-natural-language-filter
```

Configuration
-------------

[](#configuration)

1. Publish the config file:

```
php artisan vendor:publish --tag="filament-natural-language-filter-config"
```

2. Add your OpenAI API key to your `.env` file:

```
OPENAI_API_KEY=your-openai-api-key-here
```

Usage
-----

[](#usage)

Add the filter to your Filament table:

```
use HayderHatem\FilamentNaturalLanguageFilter\Filters\NaturalLanguageFilter;

public function table(Table $table): Table
{
    return $table
        ->columns([
            // your columns
        ])
        ->filters([
            NaturalLanguageFilter::make()
                ->availableColumns([
                    'id',
                    'name',
                    'email',
                    'status',
                    'created_at',
                    'updated_at'
                ])
        ]);
}
```

### Search Modes

[](#search-modes)

You can configure how the filter triggers searches:

#### Submit Mode (Default) - Search on Enter key

[](#submit-mode-default---search-on-enter-key)

```
NaturalLanguageFilter::make()
    ->availableColumns(['name', 'email', 'status'])
    ->submitSearch() // Users press Enter to search
```

#### Live Mode - Search as you type

[](#live-mode---search-as-you-type)

```
NaturalLanguageFilter::make()
    ->availableColumns(['name', 'email', 'status'])
    ->liveSearch() // Search happens automatically as user types
```

#### Manual Mode Configuration

[](#manual-mode-configuration)

```
NaturalLanguageFilter::make()
    ->availableColumns(['name', 'email', 'status'])
    ->searchMode('live') // or 'submit'
```

### When to Use Each Mode

[](#when-to-use-each-mode)

**Submit Mode (Default)** - Best for:

- Large datasets where live search might be slow
- Complex queries that users want to perfect before searching
- Reducing API calls to OpenAI (only search when user is ready)

**Live Mode** - Best for:

- Instant feedback and better user experience
- Smaller datasets where performance isn't a concern
- Users who prefer immediate results as they type

How it works
------------

[](#how-it-works)

1. **User enters natural language**: "show users named john created after 2023"
2. **AI processes the text**: Converts it to structured filters based on your available columns
3. **Database query is built**: `WHERE name LIKE '%john%' AND created_at > '2023-01-01'`
4. **Results are filtered**: Table shows matching records

Examples
--------

[](#examples)

- "users named john" → `WHERE name LIKE '%john%'`
- "active users" → `WHERE status = 'active'`
- "created after 2023" → `WHERE created_at > '2023-01-01'`
- "email contains gmail" → `WHERE email LIKE '%gmail%'`

Universal Language Support 🌍
----------------------------

[](#universal-language-support-)

The filter supports **ANY language** with automatic AI translation and understanding:

### Multi-Language Examples

[](#multi-language-examples)

**English:**

- "show users named john" → `WHERE name LIKE '%john%'`
- "created after 2023" → `WHERE created_at > '2023-01-01'`

**Arabic (العربية):**

- "الاسم يحتوي على أحمد" → `WHERE name LIKE '%أحمد%'`
- "أنشئ بعد 2023" → `WHERE created_at > '2023-01-01'`

**Spanish (Español):**

- "usuarios con nombre juan" → `WHERE name LIKE '%juan%'`
- "creado después de 2023" → `WHERE created_at > '2023-01-01'`

**French (Français):**

- "nom contient marie" → `WHERE name LIKE '%marie%'`
- "créé après 2023" → `WHERE created_at > '2023-01-01'`

**German (Deutsch):**

- "benutzer mit namen hans" → `WHERE name LIKE '%hans%'`
- "erstellt nach 2023" → `WHERE created_at > '2023-01-01'`

**Chinese (中文):**

- "姓名包含张三" → `WHERE name LIKE '%张三%'`
- "2023年后创建" → `WHERE created_at > '2023-01-01'`

**Japanese (日本語):**

- "田中という名前のユーザー" → `WHERE name LIKE '%田中%'`
- "2023年以降に作成" → `WHERE created_at > '2023-01-01'`

### How It Works

[](#how-it-works-1)

1. **AI Language Detection**: Automatically detects the input language
2. **Natural Understanding**: Maps language-specific keywords to operators
3. **Value Preservation**: Keeps original values in their native language/script
4. **Mixed Language**: Handles mixed-language queries seamlessly

### Mixed Language Queries

[](#mixed-language-queries)

The AI can handle mixed-language queries naturally:

- "name يحتوي على john" ✅
- "usuario con email gmail.com" ✅
- "姓名 contains 张三" ✅

Configuration Options
---------------------

[](#configuration-options)

```
// config/filament-natural-language-filter.php
return [
    'model' => 'gpt-3.5-turbo', // OpenAI model
    'openai' => [
        'api_key' => env('OPENAI_API_KEY'),
        'max_tokens' => 500,
        'temperature' => 0.1,
    ],
    'cache' => [
        'enabled' => true,
        'ttl' => 3600, // 1 hour
    ],
    'languages' => [
        'universal_support' => true,
        'auto_detect_direction' => true,
        'preserve_original_values' => true,
    ],
];
```

### Environment Variables

[](#environment-variables)

```
OPENAI_API_KEY=your-openai-api-key-here
FILAMENT_NL_FILTER_UNIVERSAL_SUPPORT=true
FILAMENT_NL_FILTER_AUTO_DETECT_DIRECTION=true
FILAMENT_NL_FILTER_PRESERVE_ORIGINAL_VALUES=true
```

Requirements
------------

[](#requirements)

- PHP 8.1+
- Laravel 10+
- Filament 3+
- OpenAI API key

License
-------

[](#license)

MIT

###  Health Score

32

—

LowBetter than 72% of packages

Maintenance50

Moderate activity, may be stable

Popularity22

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity39

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

345d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/747a8cc9aa7af352419e64524e8de0910a562a5c48790539b5794cbc1d3cf7f8?d=identicon)[HayderHatem](/maintainers/HayderHatem)

---

Top Contributors

[![HayderHatem](https://avatars.githubusercontent.com/u/35098833?v=4)](https://github.com/HayderHatem "HayderHatem (3 commits)")

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/hayderhatem-filament-natural-language-filter/health.svg)

```
[![Health](https://phpackages.com/badges/hayderhatem-filament-natural-language-filter/health.svg)](https://phpackages.com/packages/hayderhatem-filament-natural-language-filter)
```

###  Alternatives

[bezhansalleh/filament-google-analytics

Google Analytics integration for FilamentPHP

205144.8k5](/packages/bezhansalleh-filament-google-analytics)[kirschbaum-development/commentions

A package to allow you to create comments, tag users and more

12369.2k](/packages/kirschbaum-development-commentions)[jiten14/jitone-ai

jitone-ai is a powerful FilamentPHP plugin that integrates AI-powered features directly into your Filament forms.

213.1k](/packages/jiten14-jitone-ai)[tomshaw/electricgrid

A feature-rich Livewire package designed for projects that require dynamic, interactive data tables.

116.6k](/packages/tomshaw-electricgrid)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

245.2k](/packages/aedart-athenaeum)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)