Skip to content

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

Open
ravimahatonp wants to merge 1 commit into
ChainLearnOfficial:mainfrom
ravimahatonp:add-env-example-template
Open

ravimahatonp wants to merge 1 commit into
ChainLearnOfficial:mainfrom
ravimahatonp:add-env-example-template

Conversation

@ravimahatonp

Copy link
Copy Markdown

Summary

Closes #16

Adds .env.example to the repository root documenting the required Cohere API key and configuration settings from src/config.py.

Contents

  • Cohere API Key (COHERE_API_KEY): Highlighted as required with direct link to Cohere developer dashboard.
  • Model identifiers: COHERE_EMBED_MODEL and COHERE_GENERATE_MODEL.
  • Knowledge Base Settings: CHUNK_SIZE, CHUNK_OVERLAP, EMBEDDING_DIMENSIONS, and INDEX_PATH.
  • Generation Defaults & CORS: DEFAULT_MAX_TOKENS, DEFAULT_TEMPERATURE, and CORS_ORIGINS.

…uration

- Document required COHERE_API_KEY with link to Cohere developer dashboard
- Provide configuration defaults for models, knowledge base chunking, and index path
- Document CORS origins and generation temperature/token limits matching Settings

Closes ChainLearnOfficial#16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add .env.example documenting Cohere API configuration

1 participant