Skip to main content

A Django library for AI-powered data validation and cleaning.

Project description

Django AI Validator

PyPI version License: MIT codecov Documentation

Documentation: https://mazafard.github.io/django-ai-validator/

A Django library for AI-powered data validation and cleaning.

Features

  • Semantic Validation: Validate data based on meaning using LLMs.
  • Automated Cleaning: Automatically clean and normalize data.
  • Admin Integration: Bulk actions and status indicators in Django Admin.
  • Asynchronous Support: Offload LLM calls to Celery tasks.
  • Multiple Providers: Support for OpenAI, Anthropic, Gemini, and Ollama.

Installation

pip install django-ai-validator

Configuration

Add to INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    'django_ai_validator',
]

Set your API key:

# Defaults to OpenAIClient
AI_CLEANER_LLM_CLIENT = 'django_ai_validator.llm.client.OpenAIClient'
OPENAI_API_KEY = "your-api-key"

Usage

Semantic Validation

from django.db import models
from django_ai_validator.validators import AISemanticValidator

class Product(models.Model):
    description = models.TextField(
        validators=[
            AISemanticValidator(
                prompt_template="Ensure the description is marketing-friendly and contains no offensive language."
            )
        ]
    )

Automatic Cleaning

from django_ai_validator.fields import AICleanedField

class UserProfile(models.Model):
    bio = AICleanedField(
        cleaning_prompt="Fix grammar and remove personal contact info."
    )

Admin Integration

from django.contrib import admin
from django_ai_validator.admin import AIAdminMixin
from .models import MyModel

@admin.register(MyModel)
class MyModelAdmin(AIAdminMixin, admin.ModelAdmin):
    list_display = ['content', 'is_dirty']
    actions = ['run_ai_cleanup_on_selected']

Manual Validation

To check if user input contains bad words:

from django_ai_validator.validators import AISemanticValidator

class Comment(models.Model):
    text = models.TextField(
        validators=[
            AISemanticValidator(
                prompt_template="Check if this text contains bad words. Return VALID if not."
            )
        ]
    )

Asynchronous Cleaning

To automatically remove personal information:

from django_ai_validator.fields import AICleanedField

class Feedback(models.Model):
    message = AICleanedField(
        cleaning_prompt="Remove PII.",
    )

Star History

Star History Chart

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_ai_validator-0.1.4.tar.gz (22.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_ai_validator-0.1.4-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

Details for the file django_ai_validator-0.1.4.tar.gz.

File metadata

  • Download URL: django_ai_validator-0.1.4.tar.gz
  • Upload date:
  • Size: 22.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for django_ai_validator-0.1.4.tar.gz
Algorithm Hash digest
SHA256 d14b6786b81b0db29eb723e34d0fe440567597d99bc9837025669779a51800b9
MD5 294da8a4747c1a743a40768258a433d6
BLAKE2b-256 88030e999baffb6b223cf634e7878bf5f922a1859b6008dbd00358f80c2a6961

See more details on using hashes here.

File details

Details for the file django_ai_validator-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for django_ai_validator-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b038207a7de2c90c63e5618d0e52ba12f0c9dbba406585f5e3f13f5143bd8809
MD5 cea4faf0ec695faf9a9a42457159b3d9
BLAKE2b-256 9d3a71836703177fa727b39859f49e486c4a9c9a4530d70446cb9fece79d159a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page