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.7.tar.gz (21.1 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.7-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django_ai_validator-0.1.7.tar.gz
  • Upload date:
  • Size: 21.1 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.7.tar.gz
Algorithm Hash digest
SHA256 be73289522d62831c8d890113745fd3984912286c6d71f2b3c1e501f78c4da07
MD5 285ed38ecd2ebad03027e9e4a43bd392
BLAKE2b-256 153ac04b37b84a0c5019e3b60bc65729fba5575975fefa0195d43ae8e75eb37f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_ai_validator-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 abab922a121c232f6d1800dc7a64361a051fddcc1de6bb9e78b7ecf6c3888fd3
MD5 29a7defa8c711811a61a29b442f798aa
BLAKE2b-256 0b71c87ad4484e27e32b90b42dfbfbe59b59ba1be23e791b2ce41b50531e417d

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