Skip to content

docs(env): add .env.example documenting Cohere API and runtime configuration #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ravimahatonp wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(env): add .env.example documenting Cohere API and runtime configuration #19

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# ==============================================================================
# ChainLearn AI - Environment Configuration Template
# ==============================================================================
# Copy this file to `.env` in the repository root and fill in your values.

# ------------------------------------------------------------------------------
# Cohere API Configuration (REQUIRED)
# ------------------------------------------------------------------------------
# Obtain your API key from Cohere Dashboard: https://dashboard.cohere.com/api-keys
COHERE_API_KEY=your_cohere_api_key_here

# Cohere model identifiers
COHERE_EMBED_MODEL=embed-english-v3.0
COHERE_GENERATE_MODEL=command-nightly

# ------------------------------------------------------------------------------
# Application Configuration
# ------------------------------------------------------------------------------
APP_NAME=chainlearn-ai
DEBUG=False
LOG_LEVEL=INFO

# ------------------------------------------------------------------------------
# Knowledge Base & Embeddings
# ------------------------------------------------------------------------------
CHUNK_SIZE=500
CHUNK_OVERLAP=50
EMBEDDING_DIMENSIONS=1024
INDEX_PATH=src/knowledge/data/index.json

# ------------------------------------------------------------------------------
# Text Generation Defaults
# ------------------------------------------------------------------------------
DEFAULT_MAX_TOKENS=2048
DEFAULT_TEMPERATURE=0.7

# ------------------------------------------------------------------------------
# CORS Origins (JSON list or comma-separated URLs)
# ------------------------------------------------------------------------------
CORS_ORIGINS=["http://localhost:3000", "http://localhost:5173"]