Smarter Documentation

Table of Contents

  • Platform Administration Guide
    • Quick Start Guide
      • 1. Install Docker Desktop.
      • 2. Clone the Repository.
      • 3. Prepare Your Environment File.
      • 4. Initialize the Application.
      • 5. Start the Application.
      • 6. Log In.
      • 7. Download the Smarter Command-Line Interface.
    • Production Deployment
      • I. Infrastructure
      • II. ReactJS Component
      • III. Smarter Platform Application
      • Trouble Shooting
    • Prerequisites
    • Trouble Shooting & FAQ
    • Cloud Infrastructure
      • Usage
      • Resources Created
    • Installation
    • Django Admin
    • URL Patterns
      • Example URL Patterns
    • Account Management
      • Creating Accounts
    • User Management
    • Smarter CLI
    • API Keys
      • Creating API Keys
      • Managing API Keys
      • Configuration Options
      • Using API Keys
        • Smarter Chat React Component
        • Smarter Command-line Interface
    • How-To: Adding an LLM Provider to Smarter
      • Goal
      • Supported Providers
      • Prerequisites
      • Setup
        • Step 1: Get an API Key
        • Step 2: Add the Key to Smarter
      • Concept Overview
      • Step-by-Step: Create and Apply a Provider Manifest
        • Step 3: Generate a Starting Template
        • Step 4: Write the Provider Manifests
        • Step 5: Apply Both Manifests
        • Step 6: Confirm Both Providers are Active
      • Proof of Concept
      • Troubleshooting
    • Cost Accounting
    • Smarter Journal
      • Enabling the Smarter Journal
      • Django Log
      • Application Logs
    • Configuration
      • 1. AWS Infrastructure Configuration
      • 2. Django Settings
      • 3. Asynchronous Task Queue Configuration
      • 4. Beat Scheduler Configuration
      • 5. Helm Chart Configuration
      • 6. Dockerfile Configuration
      • 7. GitHub Actions Secrets Configuration
      • 8. Secrets Management
      • 9. Logging Configuration
      • 10. Database Configuration
      • 11. Email/Notification Configuration
      • 1. Static & Media Files Configuration
      • 13. Smarter Settings Class Reference
    • Security
      • Firewall
      • Application Security
        • Proprietary Security Features
        • Django Security Features
      • Secure Remote Access
        • Smarter Authentication
      • Audit Logging
      • Malware Protection
      • User management
      • Data Encryption
      • Security Updates
    • Backup and Restore
    • Updates
    • Trouble Shooting
      • Where to go for Help
    • Security FAQ
  • Smarter AI Resource Reference
    • Smarter Account
      • Overview
      • Usage
      • Technical Reference
        • API Reference
        • Const
        • Django ORM
        • Receivers
        • Smarter Resources - Account
        • Smarter API Manifests (SAM)
        • DRF Serializers
        • Signals
        • Asynchronous Tasks
        • Views
        • Utils
    • Smarter Chatbot
      • Overview
      • Usage
      • Example Manifest
      • Technical Reference
        • API Reference
        • Django ORM
        • Smarter API Manifests (SAM)
        • DRF Serializers
        • React UI
        • Helper Class
        • Kubernetes Ingress
        • Management Commands
        • Security middleware
        • Tasks
        • Signals
        • URL Schemes
      • Sandbox Mode
      • Deploying
      • Updating
      • Deleting
      • Testing
      • Monitoring
      • Scaling
      • Trouble Shooting
    • Smarter Connection
      • Overview
      • Example Manifest
      • Technical Reference
        • API Reference
        • Django ORM
        • DRF Serializers
        • Const
        • Receivers
        • SAM Resources
        • Signals
        • SAM (Smarter API Manifest)
        • Asynchronous Tasks
        • Views
    • Smarter Provider
      • Overview
      • Technical Reference
        • API Reference
        • Django ORM
        • Smarter API Manifests (SAM)
        • DRF Serializers
        • Const
        • Management Commands
        • Signals
        • Asynchronous Tasks
        • Utils
        • Verification
    • Smarter Plugin
      • Overview
      • Usage
      • Example Manifest
      • Technical Reference
        • Plugin Reference
        • How it Works
        • How LLM Tool Calling Works
        • API Reference
        • Django ORM
        • Smarter API Manifests (SAM)
        • DRF Serializers
        • Const
        • Natural Language Processing (NLP)
        • Signals
        • Receivers
        • Asynchronous Tasks
        • Utils
        • Views
    • Smarter Prompt
      • Overview
      • Usage
      • Technical Reference
        • Example Prompt Configuration
        • Example Prompt Request
        • Example Prompt Response
        • API Reference
        • Django ORM
        • Smarter API Manifests (SAM)
        • Const
        • Smarter Prompt Functions
        • Providers
        • Signals
        • Asynchronous Tasks
        • Urls
        • Views
    • Smarter Secret
      • Overview
      • Technical Reference
        • API Reference
        • Const
        • Django ORM
        • Receivers
        • Secret Resources
        • Smarter API Manifests (SAM)
        • DRF Serializers
        • Signals
        • Asynchronous Tasks
        • Views
    • Smarter VectorStore
      • Vectorstore Backends
        • Vectorstore Backend Base Class
        • Vectorstore Pinecone Backend
        • Vectorstore Qdrant Backend
        • Vectorstore Weaviate Backend
      • Vectorstor ORM Models
        • EmbeddingsInterface
        • IndexModelInterface
        • VectorestoreMeta
        • VectorstoreBackendKind
        • VectorstoreInterface
        • VectorstoreStatus
      • Vectorstore Receivers
        • account_post_delete()
        • account_post_save()
        • handle_load_failed()
        • handle_load_started()
        • handle_load_success()
        • should_log()
      • Vectorstore Serializers
        • VectorstoreSerializer
      • Vectorstore Services
        • VectorstoreService
      • Vectorstore Signals
        • connected
        • load_failed
        • load_started
        • load_success
      • Vectorstore Asynchronous Tasks
        • should_log()
  • Smarter Development Framework
    • Getting Started
    • Smarter API Manifests (SAM)
      • Example SAM Manifest
      • SAM Enumerations Classes
      • SAM Pydantic Base Classes
        • AbstractSAMBase
        • AbstractSAMMetadataBase
        • AbstractSAMSpecBase
        • AbstractSAMStatusBase
        • SmarterBasePydanticModel
        • VALID_ANNOTATION_VALUE_TYPES_SET
      • SAMLoader Class
        • SAMLoader
        • SAMLoaderError
        • validate_key()
      • SAM AbstractController Class
        • AbstractController
      • SAM Broker Model
        • AbstractBroker
        • SAMBrokerError
        • SAMBrokerErrorNotFound
        • SAMBrokerErrorNotImplemented
        • SAMBrokerErrorNotReady
        • SAMBrokerInternalError
        • SAMBrokerReadOnlyError
      • SAM Error Handling
        • SAMBadRequestError
        • SAMExceptionBase
        • SAMValidationError
      • SAM Validation Strategy
        • Validation Strategy
    • Developer Guides
      • Contributing
        • How to Contribute
        • Developer Getting Started
        • Good Coding Best Practices
        • Repository Setup
        • Docker Setup
        • Python Setup
        • Keen Bootstrap Theme Setup
        • AWS Cloud Infrastructure
      • New Feature Checklist
        • Django Checklist
        • Smarter / SAM Checklist
        • Style Guide Checklist
      • Documentation Style Guide & Technical Reference
        • Style Guide
        • Tips for Writing Good Documentation
        • Documentation Build Process
      • 12-Factor App
      • Code of Conduct
        • 1. Purpose
        • 2. Open Source Citizenship
        • 3. Expected Behavior
        • 4. Unacceptable Behavior
        • 5. Enforcement
        • 6. Scope
        • 7. Our Responsibilities
        • Attribution
      • Developer Guidelines
        • New Feature Checklist
        • Unit Testing
        • Pydantic
        • Automations
        • Linters and Formatters
      • Semantic Versioning Guide
        • Commit Message format
      • OpenAI
      • OpenAI JSON Examples
        • Environment Variables
        • Logging
        • event dump
      • Claude Code
        • Getting Started with Claude Code on Smarter
        • Getting Started with Claude-Powered Coding in Smarter
        • Getting Started with Claude Code on the Smarter Platform
        • NAPL Grid Maintenance Assistant
        • Tutorial
        • Getting Started with Claude Code in Smarter
        • Claude Code with Smarter: Adding Anthropic and Getting Started
        • Part 1 — Adding Anthropic as an LLM Provider
        • Part 2 — Getting Started: Claude Code for NAPL Programmers
        • Smarter & Claude is Jean-Claude Van Damme - Getting Started Guide
        • How-To: Add Anthropic as an LLM Provider in Smarter
        • Getting Started with Claude Code in Smarter
        • Adding an Anthropic Provider to Smarter
        • Getting Started: Using Claude Code with Smarter at NAPL
        • Smarter Claude Code Plugin
        • How-To: Adding Anthropic as an LLM Provider to Smarter
        • Getting Started with Claude Code as a Coding Assistant
    • Amazon Web Services (AWS)
      • Terraform
      • AWS Helper Classes
        • Helper Overview for AWS
        • Smarter AWS Base Helper Class
        • Smarter AWS Route53 Helper
        • Smarter AWS ACM Helper
        • Smarter AWS EKS Helper
        • Smarter AWS IAM Helper
        • Smarter AWS RDS Helper
        • Smarter AWS S3 Helper
    • Docker
      • What is Docker?
      • Why Use Docker?
      • Smarter and Docker
        • Optimized Builds
        • Other Key Elements
        • Smarter’s Dockerfile
      • Getting Started with Docker
      • Key Docker Concepts
      • Basic Commands
      • Next Steps
    • Kubernetes
      • Kubernetes Helper Classes
        • Kubernetes Helper Class Reference
      • Helm Chart
        • Installation
        • Examples
        • Links
        • Configuration
    • Python
      • Coding Style
      • Type Hinting
      • Documentation
      • Dependencies
        • Base PyPi Package Requirements
        • PyPi Package Constraints
        • Docker PyPi Package Requirements
        • Local PyPi Package Requirements
      • Dependabot Configuration for Python Dependencies
    • Django
      • Django Hosts
        • Web Console Hosts
        • API Subdomain Hosts
        • Named ChatBot Hosts
      • HTTP Shortcuts
        • SmarterHttpErrorResponse
        • SmarterHttpResponse
        • SmarterHttpResponseBadRequest
        • SmarterHttpResponseForbidden
        • SmarterHttpResponseNotFound
        • SmarterHttpResponseServerError
      • Management Commands
        • Example
      • Middleware
        • Excessive 404 Middleware
        • CORS Middleware
        • CSRF Middleware
        • JSON Middleware
        • Security Middleware
        • Sensitive Files Middleware
      • Models
        • TimestampedModel
      • Serializers
        • HttpAnonymousRequestSerializer
        • HttpAuthenticatedRequestSerializer
        • UserSerializer
      • Django Settings
        • Base Settings
      • Django Signals
        • Basic Usage
      • Asynchronous Tasks
        • Basic Usage
      • Django Templates
        • Vendor Notes
      • ExpiringTokenGenerator
        • ExpiringTokenGenerator
        • SmarterTokenConversionError
        • SmarterTokenError
        • SmarterTokenExpiredError
        • SmarterTokenIntegrityError
        • SmarterTokenParseError
      • View Helpers
        • Smarter View
        • SmarterWebHtmlView
        • SmarterNeverCachedWebView
        • SmarterAuthenticatedWebView
        • SmarterAuthenticatedCachedWebView
        • SmarterAuthenticatedNeverCachedWebView
        • SmarterAdminWebView
      • Validators
        • SmarterValidator
    • Django Rest Framework
      • Smarter Token Authentication
        • Smarter Token Authentication
        • SmarterAuthToken Django ORM
        • SmarterTokenAuthenticationMiddleware
        • Smarter Authenticated List API View
        • Smarter Authenticated API View
      • Parsers
        • YAMLParser
      • Serializers
        • SmarterCamelCaseSerializer
        • is_sphinx_build()
      • Signals
      • Template Tags
        • unescape_unicode()
      • View Helpers
        • SmarterAuthenticatedPermissionClass
        • SmarterUnauthenticatedAPIListView
        • SmarterUnauthenticatedAPIView
        • UnauthenticatedPermissionClass
    • Pydantic
    • SMTP Email Support
      • Configuration
      • Basic Usage
      • Technical Reference
        • EmailHelper
    • Smarter API
      • API Documentation
      • CLI URLs
        • Endpoints
        • URL Patterns
        • Base Class Reference
      • Prompt (Chat) URLS
        • Endpoints
        • URL Patterns
        • ChatConfigView Class Reference
        • DefaultChatbotApiView Class Reference
      • Authentication
      • CLI Error Handling
      • Logging
      • Rate Limiting
      • Journal
      • Class Reference
        • CLI
        • Management Commands
        • Enumerations
        • Signals
        • URLS
    • Smarter Caching
      • @cache_results() Decorator
      • Caching Invalidators
        • Decorated functions
        • Django signals
        • SAM Broker
      • Smarter LazyCache
      • Class-Based Caching
    • Smarter CLI
      • Installation
      • Usage
      • Commands
      • Related API endpoints
      • Manifest Spec
        • Kind
        • Broker Model
        • Controller Model
    • Smarter Web Dashboard
      • Django ORM
        • EmailContactList
      • Const
      • Context Processors
        • smarter.apps.dashboard.context_processors
        • base()
        • branding()
        • cache_buster()
        • cache_invalidations()
        • file_drop_zone()
        • footer()
        • get_api_keys()
        • get_chatbots()
        • get_connections()
        • get_custom_domains()
        • get_pending_deployments()
        • get_plugins()
        • get_providers()
        • get_secrets()
        • prompt_list_context()
      • Signals
      • Urls
      • Views
        • ChangeLogView
        • ComingSoon
        • DashboardView
        • EmailAdded
        • NotificationsView
    • Smarter Enumeration Classes
      • SmarterEnumAbstract
        • SmarterEnumAbstract.all()
        • SmarterEnumAbstract.all_slugs()
        • SmarterEnumAbstract.from_url()
        • SmarterEnumAbstract.list_all()
        • SmarterEnumAbstract.plural_slugs()
        • SmarterEnumAbstract.singular_slugs()
    • Smarter Devops Guide
      • Build
        • Local
        • Production
        • Docker Hub
      • Test
        • Local Testing
        • Coverage Report
        • Conventions
      • Deploy
        • Local
        • Production
        • Kubernetes
      • CI/CD
        • GitHub Actions for Smarter
    • Smarter Journal
      • Journal Technical References
        • Journal Enumerations
        • SAMJournal
        • SmarterJournaledJsonResponse
        • SmarterJournaledJsonErrorResponse
    • Smarter Logging
      • Logging Technical References
        • Smarter Logging Style Guide
        • Waffle-Switched Logging
        • Redis-based Streaming Log Handler
        • File-based Streaming Log Handler
    • Smarter Mixins
      • Smarter Helper Mixin
        • SmarterHelperMixin
      • Smarter Account Mixin
        • AccountMixin
      • Smarter Request Mixin
        • SmarterRequestMixin
      • Smarter Middleware Mixin
        • SmarterMiddlewareMixin
    • Smarter React UI
      • Integration Steps
        • 1. Review your smarter_settings values
        • 2. Clone the web-integration-example repository
        • 3. Deploy the Smarter React Chat Component
        • 4. Check your work
        • 5. Integrate the Chat Component into your Web Page
        • 1. See the Chat Component in Action
      • See Also
    • Smarter Settings
      • Settings
        • Settings.anthropic_api_key
        • Settings.api_description
        • Settings.api_name
        • Settings.aws_access_key_id
        • Settings.aws_db_instance_identifier
        • Settings.aws_eks_cluster_name
        • Settings.aws_profile
        • Settings.aws_region
        • Settings.aws_regions
        • Settings.aws_secret_access_key
        • Settings.branding_address1
        • Settings.branding_address2
        • Settings.branding_city
        • Settings.branding_contact_url
        • Settings.branding_corporate_name
        • Settings.branding_country
        • Settings.branding_currency
        • Settings.branding_postal_code
        • Settings.branding_state
        • Settings.branding_support_email
        • Settings.branding_support_hours
        • Settings.branding_support_phone_number
        • Settings.branding_timezone
        • Settings.branding_url_facebook
        • Settings.branding_url_linkedin
        • Settings.branding_url_twitter
        • Settings.cache_expiration
        • Settings.chat_cache_expiration
        • Settings.chatbot_cache_expiration
        • Settings.chatbot_max_returned_history
        • Settings.chatbot_tasks_celery_max_retries
        • Settings.chatbot_tasks_celery_retry_backoff
        • Settings.chatbot_tasks_celery_task_queue
        • Settings.chatbot_tasks_create_dns_record
        • Settings.chatbot_tasks_create_ingress_manifest
        • Settings.chatbot_tasks_default_ttl
        • Settings.debug_mode
        • Settings.default_missing_value
        • Settings.developer_mode
        • Settings.django_default_file_storage
        • Settings.dump_defaults
        • Settings.email_admin
        • Settings.environment
        • Settings.fernet_encryption_key
        • Settings.file_drop_zone_enabled
        • Settings.gemini_api_key
        • Settings.google_maps_api_key
        • Settings.google_service_account
        • Settings.init_info
        • Settings.internal_ip_prefixes
        • Settings.langchain_memory_key
        • Settings.llama_api_key
        • Settings.llm_default_max_tokens
        • Settings.llm_default_model
        • Settings.llm_default_provider
        • Settings.llm_default_system_role
        • Settings.llm_default_temperature
        • Settings.local_hosts
        • Settings.log_level
        • Settings.logo
        • Settings.mailchimp_api_key
        • Settings.mailchimp_list_id
        • Settings.marketing_site_url
        • Settings.openai_api_key
        • Settings.openai_api_organization
        • Settings.openai_endpoint_image_n
        • Settings.openai_endpoint_image_size
        • Settings.pinecone_api_key
        • Settings.platform_subdomain
        • Settings.plugin_max_data_results
        • Settings.root_domain
        • Settings.secret_key
        • Settings.sensitive_files_amnesty_patterns
        • Settings.settings_output
        • Settings.shared_resource_identifier
        • Settings.smarter_mysql_test_database_password
        • Settings.smarter_mysql_test_database_secret_name
        • Settings.smarter_reactjs_app_loader_path
        • Settings.smtp_password
        • Settings.smtp_port
        • Settings.smtp_sender
        • Settings.smtp_use_ssl
        • Settings.smtp_use_tls
        • Settings.smtp_username
        • Settings.social_auth_github_key
        • Settings.social_auth_github_secret
        • Settings.social_auth_google_oauth2_key
        • Settings.social_auth_google_oauth2_secret
        • Settings.social_auth_linkedin_oauth2_key
        • Settings.social_auth_linkedin_oauth2_secret
        • Settings.stripe_live_secret_key
        • Settings.stripe_test_secret_key
        • Settings.verbose_logging
        • Settings.parse_cache_expiration
        • Settings.parse_chat_cache_expiration
        • Settings.parse_chatbot_cache_expiration
        • Settings.parse_chatbot_max_returned_history
        • Settings.parse_chatbot_tasks_celery_max_retries
        • Settings.parse_chatbot_tasks_celery_retry_backoff
        • Settings.parse_chatbot_tasks_create_dns_record
        • Settings.parse_chatbot_tasks_create_ingress_manifest
        • Settings.parse_chatbot_tasks_default_ttl
        • Settings.parse_debug_mode
        • Settings.parse_developer_mode
        • Settings.parse_dump_defaults
        • Settings.parse_plugin_max_data_results
        • Settings.parse_sensitive_files_amnesty_patterns
        • Settings.validate_anthropic_api_key
        • Settings.validate_api_description
        • Settings.validate_api_name
        • Settings.validate_aws_access_key_id
        • Settings.validate_aws_db_instance_identifier
        • Settings.validate_aws_eks_cluster_name
        • Settings.validate_aws_profile
        • Settings.validate_aws_region
        • Settings.validate_aws_secret_access_key
        • Settings.validate_branding_address
        • Settings.validate_branding_address2
        • Settings.validate_branding_city
        • Settings.validate_branding_contact_url
        • Settings.validate_branding_corporate_name
        • Settings.validate_branding_country
        • Settings.validate_branding_currency
        • Settings.validate_branding_postal_code
        • Settings.validate_branding_state
        • Settings.validate_branding_support_email
        • Settings.validate_branding_support_hours
        • Settings.validate_branding_support_phone_number
        • Settings.validate_branding_timezone
        • Settings.validate_branding_url_facebook
        • Settings.validate_branding_url_linkedin
        • Settings.validate_branding_url_twitter
        • Settings.validate_chatbot_tasks_celery_task_queue
        • Settings.validate_email_admin
        • Settings.validate_environment
        • Settings.validate_fernet_encryption_key
        • Settings.validate_gemini_api_key
        • Settings.validate_google_maps_api_key
        • Settings.validate_google_service_account
        • Settings.validate_internal_ip_prefixes
        • Settings.validate_langchain_memory_key
        • Settings.validate_llama_api_key
        • Settings.validate_llm_default_model
        • Settings.validate_llm_default_provider
        • Settings.validate_llm_default_system_role
        • Settings.validate_local_hosts
        • Settings.validate_logo
        • Settings.validate_mailchimp_api_key
        • Settings.validate_mailchimp_list_id
        • Settings.validate_marketing_site_url
        • Settings.validate_openai_api_key
        • Settings.validate_openai_api_organization
        • Settings.validate_openai_default_max_completion_tokens
        • Settings.validate_openai_default_temperature
        • Settings.validate_openai_endpoint_image_n
        • Settings.validate_openai_endpoint_image_size
        • Settings.validate_pinecone_api_key
        • Settings.validate_root_domain
        • Settings.validate_secret_key
        • Settings.validate_settings_output
        • Settings.validate_shared_resource_identifier
        • Settings.validate_smarter_reactjs_app_loader_path
        • Settings.validate_smtp_password
        • Settings.validate_smtp_port
        • Settings.validate_smtp_sender
        • Settings.validate_smtp_use_ssl
        • Settings.validate_smtp_use_tls
        • Settings.validate_smtp_username
        • Settings.validate_social_auth_github_key
        • Settings.validate_social_auth_github_secret
        • Settings.validate_social_auth_google_oauth2_key
        • Settings.validate_social_auth_google_oauth2_secret
        • Settings.validate_social_auth_linkedin_oauth2_key
        • Settings.validate_social_auth_linkedin_oauth2_secret
        • Settings.validate_stripe_live_secret_key
        • Settings.validate_stripe_test_secret_key
    • Smarter Waffle
      • smarter.lib.django.waffle
      • SmarterSwitchAdmin
        • SmarterSwitchAdmin.has_module_permission()
        • SmarterSwitchAdmin.media
        • SmarterSwitchAdmin.ordering
      • SmarterWaffleSwitch
        • SmarterWaffleSwitch.__init__()
        • SmarterWaffleSwitch.comment
        • SmarterWaffleSwitch.default
        • SmarterWaffleSwitch.name
        • SmarterWaffleSwitch.to_json()
      • SmarterWaffleSwitches
        • SmarterWaffleSwitches.ACCOUNT_LOGGING
        • SmarterWaffleSwitches.ACCOUNT_MIXIN_LOGGING
        • SmarterWaffleSwitches.ALLOW_API_GET
        • SmarterWaffleSwitches.API_LOGGING
        • SmarterWaffleSwitches.CACHE_LOGGING
        • SmarterWaffleSwitches.CHATAPP_LOGGING
        • SmarterWaffleSwitches.CHATBOT_HELPER_LOGGING
        • SmarterWaffleSwitches.CHATBOT_LOGGING
        • SmarterWaffleSwitches.CONNECTION_LOGGING
        • SmarterWaffleSwitches.CSRF_SUPPRESS_FOR_CHATBOTS
        • SmarterWaffleSwitches.ENABLE_ACCOUNT_REGISTRATION
        • SmarterWaffleSwitches.ENABLE_DEBUG_MODE
        • SmarterWaffleSwitches.ENABLE_JOURNAL
        • SmarterWaffleSwitches.ENABLE_LOGIN_FOOTER_LINKS
        • SmarterWaffleSwitches.ENABLE_LOG_VIEW_IN_BROWSER
        • SmarterWaffleSwitches.ENABLE_MIDDLEWARE_CORS
        • SmarterWaffleSwitches.ENABLE_MIDDLEWARE_EXCESSIVE_404
        • SmarterWaffleSwitches.ENABLE_MIDDLEWARE_SECURITY
        • SmarterWaffleSwitches.ENABLE_MIDDLEWARE_SENSITIVE_FILES
        • SmarterWaffleSwitches.ENABLE_MULTITENANT_AUTHENTICATION
        • SmarterWaffleSwitches.ENABLE_NEW_USER_PASSWORD_EMAIL
        • SmarterWaffleSwitches.ENABLE_OAUTH2
        • SmarterWaffleSwitches.ENABLE_REACTAPP_DEBUG_MODE
        • SmarterWaffleSwitches.ENABLE_SMARTER_PAGE_CACHING
        • SmarterWaffleSwitches.ENABLE_VECTORSTORE
        • SmarterWaffleSwitches.MANIFEST_LOGGING
        • SmarterWaffleSwitches.MIDDLEWARE_LOGGING
        • SmarterWaffleSwitches.PLUGIN_LOGGING
        • SmarterWaffleSwitches.PROMPT_LOGGING
        • SmarterWaffleSwitches.PROVIDER_LOGGING
        • SmarterWaffleSwitches.RECEIVER_LOGGING
        • SmarterWaffleSwitches.REQUEST_MIXIN_LOGGING
        • SmarterWaffleSwitches.SECRET_LOGGING
        • SmarterWaffleSwitches.TASK_LOGGING
        • SmarterWaffleSwitches.VALIDATOR_LOGGING
        • SmarterWaffleSwitches.VECTORSTORE_LOGGING
        • SmarterWaffleSwitches.VIEW_LOGGING
        • SmarterWaffleSwitches.all
        • SmarterWaffleSwitches.switches
      • smarter_waffle_switches
      • switch_is_active()
    • Smarter Utils
      • bool_environment_variable()
      • camel_case_object_name()
      • camel_to_snake()
      • camel_to_snake_dict()
      • dict_is_contained_in()
      • dict_is_subset()
      • generate_fernet_encryption_key()
      • get_diagnostics()
      • get_readonly_csv_file()
      • get_readonly_yaml_file()
      • get_semantic_version()
      • hash_factory()
      • is_authenticated_request()
      • mask_string()
      • pascal_to_snake()
      • recursive_sort_dict()
      • rfc1034_compliant_str()
      • rfc1034_compliant_to_snake()
      • smarter_build_absolute_uri()
      • snake_case()
      • snake_to_camel()
    • VS Code Extension
      • Features
      • Getting Started
      • Configuration
      • JSON Schemas
  • ADR
    • ADR Introduction
      • Guidelines for Writing ADRs
    • ADR-001: Django
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-002: Docker
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-003: Kubernetes
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-004: 12-Factor App
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-005: Manifests
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-006: Rest API
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-007: Settings
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-008: Function Calling
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-009: Async Tasks
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-010: Management Commands
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-011: Logging
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-012: Error Handling
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-013: Testing
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-014: CI/CD
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-015: Dependency Management
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-016: Security
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-017: Database
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-018: Caching
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-019: React
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-020: Semantic Versioning
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-021: Internationalization
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-022: Feature Flags
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-023: API Versioning
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-024: Broker Model
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-025: Django Templates
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-026: Keen Bootstrap
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-027: Python Annotations
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR-028: Code Quality
      • Status
      • Context
      • Decision
      • Alternatives Considered
      • Consequences
      • Related ADRs
    • ADR 029: Docstring Style
      • Context
      • Alternatives Considered
      • Decision
      • Consequences
      • References

External Resources

  • Support Smarter!
  • Swagger API Documentation
  • Smarter Manifest Examples
  • Smarter Json Schemas
  • Smarter on YouTube
Smarter Documentation
  • Smarter AI Resource Reference
  • Smarter Prompt
  • Providers
  • Provider Classes
  • Base Classes
  • View page source

Base Classes

Prompt Functions

  • Chat Provider Base
  • Mixins
  • Protocols
  • OpenAI Compatible Chat Provider
Previous Next

© Copyright 2026 Lawrence P. McDaniel. The Smarter Project. Revision 033db0b94. Last updated on 2026-04-23.

Built with Sphinx using a theme provided by Read the Docs.