Skip to main content

Advanced Text-to-SQL library with AI features

Project description

AI Prishtina - Text2SQL-LTM: a Professional Text-to-SQL Library

PyPI version Total Downloads Monthly Downloads Weekly Downloads PyPI Downloads Python 3.8+ License: Commercial Tests Coverage

๐Ÿ“Š Download Statistics

Total Downloads Monthly Downloads

Growing adoption by developers worldwide! ๐ŸŒ

โ˜• Support This Project

If you find this project helpful, please consider supporting it:

Donate

AI PRISHTINA - Text2SQL-LTM is a comprehensive Text-to-SQL library, featuring cutting-edge AI capabilities. Built with production-ready architecture and to push the boundaries of what's possible in natural language to SQL conversion.

๐ŸŒŸ Revolutionary Features

๐Ÿง  RAG-Enhanced Query Generation

  • Vector-based knowledge retrieval with semantic search
  • Schema-aware context augmentation for intelligent SQL generation
  • Query pattern learning from successful executions
  • Adaptive retrieval strategies that improve over time
  • Knowledge fusion across different data sources

๐Ÿ” AI-Powered SQL Validation & Auto-Correction

  • Intelligent syntax validation with automatic error fixing
  • Security vulnerability detection and prevention
  • Performance optimization suggestions with impact analysis
  • Cross-platform compatibility checking
  • Best practice enforcement with educational feedback

๐ŸŽ“ Intelligent Query Explanation & Teaching System

  • Step-by-step query breakdown with visual execution flow
  • Adaptive explanations based on user expertise level
  • Interactive learning modes with guided practice
  • Personalized learning paths with progress tracking
  • Real-time teaching assistance for SQL education

๐Ÿ” Automated Schema Discovery & Documentation

  • AI-powered relationship inference between tables
  • Column purpose detection using pattern recognition
  • Data quality assessment with improvement suggestions
  • Auto-generated documentation in multiple formats
  • Business rule extraction from data patterns

๐Ÿ”’ Advanced Security Analysis

  • SQL injection detection with real-time prevention
  • Privilege escalation monitoring and alerts
  • Data exposure analysis with compliance checking (GDPR, PCI DSS, SOX)
  • Vulnerability scanning with remediation guidance
  • Security best practice validation

๐ŸŒ Cross-Platform Query Translation

  • Intelligent dialect conversion between 8+ database platforms
  • Syntax optimization for target platforms
  • Compatibility analysis with migration guidance
  • Performance tuning for specific database engines
  • Feature mapping across different SQL dialects

๐Ÿงช Automated Test Case Generation

  • Comprehensive test suite creation for SQL queries
  • Edge case detection and test generation
  • Performance test automation with benchmarking
  • Security test scenarios for vulnerability assessment
  • Data validation testing with constraint checking

๐Ÿš€ Quick Start

Installation

pip install ai-prishtina-text2sql-ltm

30-Second Setup

import asyncio
from text2sql_ltm import create_simple_agent, Text2SQLSession

async def main():
    # Just provide your API key - everything else uses smart defaults
    agent = create_simple_agent(api_key="your_openai_key")
    
    async with Text2SQLSession(agent) as session:
        result = await session.query(
            "Show me the top 10 customers by revenue this year",
            user_id="user123"
        )
        
        print(f"Generated SQL: {result.sql}")
        print(f"Confidence: {result.confidence}")
        print(f"Explanation: {result.explanation}")

asyncio.run(main())

Feature-Rich Setup

# Enable advanced features with simple flags
agent = create_simple_agent(
    api_key="your_openai_key",
    enable_rag=True,                    # Vector-enhanced generation
    enable_security_analysis=True,      # Security scanning
    enable_explanation=True,            # AI teaching
    enable_test_generation=True         # Automated testing
)

Production Configuration

from text2sql_ltm import create_integrated_agent

# Load from configuration file
agent = create_integrated_agent(config_file="config/production.yaml")

# Or use configuration dictionary
agent = create_integrated_agent(config_dict={
    "memory": {
        "storage_backend": "postgresql",
        "storage_url": "postgresql://user:pass@localhost/db"
    },
    "agent": {
        "llm_provider": "openai",
        "llm_model": "gpt-4",
        "llm_api_key": "your_api_key"
    },
    "ai_features": {
        "enable_rag": True,
        "enable_validation": True,
        "enable_multimodal": True,
        "enable_security_analysis": True
    }
})

๐ŸŽฏ Advanced Examples

Security Analysis

# Comprehensive security analysis
security_result = await agent.security_analyzer.analyze_security(
    query="SELECT * FROM users WHERE id = ?",
    user_id="user123",
    context={"user_input": True}
)

print(f"Security Score: {security_result.risk_score}/10")
print(f"Vulnerabilities: {len(security_result.vulnerabilities)}")
print(f"Compliance: {security_result.compliance_status}")

Cross-Platform Translation

# Translate between database dialects
translation_result = await agent.query_translator.translate_query(
    query="SELECT TOP 10 * FROM users",
    source_dialect="sqlserver",
    target_dialect="postgresql",
    optimize_for_target=True
)

print(f"Original: {translation_result.original_query}")
print(f"Translated: {translation_result.translated_query}")
print(f"Compatibility: {translation_result.compatibility}")

Automated Testing

# Generate comprehensive test suite
test_suite = await agent.test_generator.generate_test_suite(
    query="SELECT name, COUNT(*) FROM users GROUP BY name",
    schema=schema_info,
    test_types=["functional", "edge_case", "performance", "security"]
)

print(f"Generated {len(test_suite.test_cases)} test cases")

๐Ÿ—๏ธ Architecture

Text2SQL-LTM features a modular, production-ready architecture:

text2sql_ltm/
โ”œโ”€โ”€ core/                 # Core engine and interfaces
โ”œโ”€โ”€ memory/              # Long-term memory system
โ”œโ”€โ”€ rag/                 # RAG components
โ”‚   โ”œโ”€โ”€ retriever.py     # Main RAG retriever
โ”‚   โ”œโ”€โ”€ schema_rag.py    # Schema-specific RAG
โ”‚   โ”œโ”€โ”€ query_rag.py     # Query pattern RAG
โ”‚   โ””โ”€โ”€ adaptive_rag.py  # Self-improving RAG
โ”œโ”€โ”€ ai_features/         # Advanced AI features
โ”‚   โ”œโ”€โ”€ sql_validator.py      # AI-powered validation

โ”‚   โ”œโ”€โ”€ explainer.py          # Intelligent explanation
โ”‚   โ”œโ”€โ”€ schema_discovery.py   # Schema analysis
โ”‚   โ”œโ”€โ”€ query_translator.py   # Cross-platform translation
โ”‚   โ”œโ”€โ”€ security_analyzer.py  # Security analysis
โ”‚   โ””โ”€โ”€ test_generator.py     # Test automation
โ””โ”€โ”€ integrations/        # External integrations

๐Ÿ”ง Configuration

YAML Configuration

# config/production.yaml
memory:
  storage_backend: "postgresql"
  storage_url: "${DATABASE_URL}"

agent:
  llm_provider: "openai"
  llm_model: "gpt-4"
  llm_api_key: "${OPENAI_API_KEY}"

ai_features:
  enable_rag: true
  enable_validation: true
  enable_multimodal: true
  enable_security_analysis: true
  
  rag:
    vector_store:
      provider: "pinecone"
      api_key: "${PINECONE_API_KEY}"
    embedding:
      provider: "openai"
      api_key: "${OPENAI_API_KEY}"

security:
  require_authentication: true
  rate_limiting_enabled: true

Environment Variables

# Core API Keys
OPENAI_API_KEY=your_openai_key
DATABASE_URL=postgresql://user:pass@localhost/db

# Optional Services
PINECONE_API_KEY=your_pinecone_key
GOOGLE_VISION_API_KEY=your_google_key
REDIS_URL=redis://localhost:6379

๐Ÿงช Testing

Run the comprehensive test suite:

# Install with test dependencies
pip install text2sql-ltm[test]

# Run all tests
pytest tests/ -v

# Run with coverage
pytest tests/ --cov=text2sql_ltm --cov-report=html

# Run specific test categories
pytest tests/test_rag_system.py -v
pytest tests/test_multimodal.py -v
pytest tests/test_security.py -v

๐Ÿ“š Examples

Comprehensive examples are available in the examples/ directory:

๐Ÿค Support & Licensing

Commercial License

Text2SQL-LTM is a commercial product with advanced enterprise features.

For licensing, pricing, and enterprise support, contact:

Alban Maxhuni, PhD ๐Ÿ“ง Email: info@albanmaxhuni.com
๐ŸŒ Website: albanmaxhuni.com

License Options

  • Individual License: For personal and small team use
  • Enterprise License: For large organizations with advanced features
  • Custom License: Tailored solutions for specific requirements

What's Included

  • โœ… Full source code access
  • โœ… Priority technical support
  • โœ… Regular updates and new features
  • โœ… Custom integration assistance
  • โœ… Training and consultation
  • โœ… SLA guarantees for enterprise

๐Ÿ“ž Getting Started

  1. Install: pip install ai-prishtina-text2sql-ltm
  2. Contact: info@albanmaxhuni.com for licensing
  3. Configure: Set up your API keys and configuration
  4. Deploy: Use our production-ready templates
  5. Scale: Leverage enterprise features for your organization

AI-Prishtina-Text2SQL-LTM: Revolutionizing database interaction through advanced AI. ๐Ÿš€

ยฉ 2024 AI Prishtina, Inc. All rights reserved.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

ai_prishtina_text2sql_ltm-1.0.9-py3-none-any.whl (222.3 kB view details)

Uploaded Python 3

File details

Details for the file ai_prishtina_text2sql_ltm-1.0.9-py3-none-any.whl.

File metadata

File hashes

Hashes for ai_prishtina_text2sql_ltm-1.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 17d4075e658598648122c5d2ee75daae3cd466a4882b62723c42876bb3ef0850
MD5 f4af1528f55d3647e79ee8853aee5ac9
BLAKE2b-256 70fc51bb17255835c234a60c73810ecd3ed0cfd6e145b636a765ad18b460cb36

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