.env.example

# Copy this file to .env and customize your settings
# Note: These environment variables will override config.json settings

# =============================================================================
# API CREDENTIALS (Required - choose one or more providers)
# =============================================================================

# X.AI API Key (get from https://console.x.ai/)
# XAI_API_KEY=your_xai_api_key_here

# Anthropic Claude API Key (get from https://console.anthropic.com/)
# ANTHROPIC_API_KEY=your_anthropic_api_key_here

# OpenAI API Key (get from https://platform.openai.com/)
# OPENAI_API_KEY=your_openai_api_key_here

# Google Gemini API Key (get from https://aistudio.google.com/app/apikey)
# Required for PDF upload functionality with Gemini models
# GOOGLE_API_KEY=your_google_api_key_here

# =============================================================================
# LLM CONFIGURATION
# =============================================================================

# LLM Provider selection (override config.json)
# LLM_PROVIDER=xai
# Available options: xai, anthropic, openai, google

# Model selection (override config.json)
# LLM_MODEL=grok-4-0709
# Examples by provider (models with * support PDF uploads):
#   X.AI: grok-4-0709*, grok-3, grok-3-mini, grok-beta, grok-vision-beta*
#   Anthropic: claude-opus-4-20250514*, claude-sonnet-4-20250514*, claude-3-7-sonnet-20250219*, claude-3-5-sonnet-20241022*, claude-3-5-haiku-20241022
#   OpenAI: gpt-4.1, gpt-4.1-mini, gpt-4.1-nano, o3*, o4-mini, gpt-4o*, gpt-4o-mini*
#   Google: gemini-2.5-pro*, gemini-2.5-flash*, gemini-2.5-flash-lite*, gemini-2.0-flash, gemini-2.0-flash-lite

# LLM behavior settings
# LLM_MAX_TOKENS=1000  # Can also be overridden with --tokens command line flag
# LLM_TEMPERATURE=0.3

# =============================================================================
# PDF PROCESSING
# =============================================================================

# Maximum pages before extracting first N pages for analysis
# PDF_MAX_PAGES_BEFORE_EXTRACTION=3

# Number of pages to extract for large documents
# PDF_EXTRACTION_PAGES=3

# =============================================================================
# GOOGLE DRIVE CONFIGURATION
# =============================================================================

# Google Drive OAuth files (relative to project directory)
# GOOGLE_DRIVE_CREDENTIALS_FILE=credentials.json
# GOOGLE_DRIVE_TOKEN_FILE=token.json

# =============================================================================
# LOGGING CONFIGURATION
# =============================================================================

# Log level: DEBUG, INFO, WARNING, ERROR, CRITICAL
# LOG_LEVEL=INFO

# Log format
# LOG_FORMAT=%(asctime)s - %(levelname)s - %(message)s

# Log date format (RFC3339/ISO8601 with milliseconds)
# LOG_DATE_FORMAT=%Y-%m-%dT%H:%M:%S.%f%z

# Log file path
# LOG_FILE=scan_namer.log

# =============================================================================
# OCR CONFIGURATION
# =============================================================================

# Enable OCR embedding for image-only PDFs (creates searchable PDFs)
# OCR_ENABLE_EMBEDDING=false

# Minimum text characters per page to consider a PDF as text-based (vs image-only)
# OCR_MIN_TEXT_PER_PAGE=50

# OCR language code (eng, fra, deu, spa, etc.)
# OCR_LANGUAGE=eng

# DPI for converting PDFs to images for OCR
# OCR_DPI=300

# =============================================================================
# APPLICATION BEHAVIOR
# =============================================================================

# Generic filename patterns to look for (comma-separated)
# GENERIC_FILENAME_PATTERNS=raven_scan,scan_,document_,img_,file_

# Maximum filename length for generated names
# MAX_FILENAME_LENGTH=100

# Default folder selection behavior
# AUTO_SELECT_FIRST_FOLDER=false