Skip to content

Commit 1c68bee

Browse files
authored
Update README and env examples (#72)
* chore: Update .env.template with new API keys and tool configurations - Added new environment variables for LLM provider and model, Mapbox access token, and various API keys for Messari, Thirdweb, CoinMarketCap, Air Quality, and Depin Ninja. - Updated tool selection instructions to clarify usage of specialty tools. - Enhanced documentation within the .env.template for better guidance on API key usage and tool availability. * docs: Update README.md for improved clarity and accuracy - Enhanced the LLM Integration section to specify supported LLM providers, including OpenAI, Anthropic, and DeepSeek. - Updated the architecture diagram to reflect the new ElizoOS Stack and Quicksilver System structure. - Clarified the configuration structure and instance management instructions for better user guidance. - Improved the available tools section by adding new tools and their parameters, ensuring comprehensive documentation. * docs: Update README.md to enhance API reference and clarity - Added API reference section detailing REST endpoints for interacting with the Sentient AI system, including base URL, authentication, and endpoint descriptions. - Improved clarity in the available tools section by standardizing quotes and ensuring consistent formatting throughout the document. - Expanded on the integration of DePIN network and custom tools, inviting contributors to enhance the project further. * docs: Add Table of Contents to README.md for improved navigation - Introduced a comprehensive Table of Contents section to enhance user navigation through the README. - Organized links to key sections including Features, Architecture, Getting Started, API Reference, and Contributing, ensuring better accessibility to important information. * docs: Update README.md architecture diagram for clarity - Refined the architecture diagram by simplifying node labels for better readability. - Removed unnecessary emojis and standardized names to enhance clarity and maintainability. * docs: Revise README.md for improved structure and clarity - Updated the Table of Contents for better navigation, reorganizing sections for logical flow. - Enhanced the API Reference section with detailed endpoint descriptions and examples. - Added new sections for Integrations and Future Development to invite community contributions and outline potential growth areas. - Improved formatting and consistency throughout the document to enhance readability and maintainability. * docs: Simplify response structure in README.md - Updated the API response example to clarify the format of tool-specific response data. - Removed unnecessary comments to enhance readability and maintainability of the documentation.
1 parent ed61bc7 commit 1c68bee

File tree

2 files changed

+270
-135
lines changed

2 files changed

+270
-135
lines changed

.env.template

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,28 @@
1+
LLM_PROVIDER=your_llm_provider # openai, anthropic, deepseek
2+
LLM_MODEL=your_llm_model # gpt-4o, gpt-4o-mini, claude-3-5-sonnet-latest, deepseek-chat...
3+
14
DEEPSEEK_API_KEY=your_deepseek_api_key
25
ANTHROPIC_API_KEY=your_anthropic_api_key
36
OPENAI_API_KEY=your_openai_api_key
47

5-
FAST_LLM_MODEL=your_llm_model
6-
LLM_MODEL=your_llm_model
7-
88
API_V2_KEY=your_api_v2_key # for iotex l1 data
99

1010
# Tool Selection
11-
# Available tools: news, weather-current, weather-forecast, depin-metrics, depin-projects, l1data, dimo, nuclear
12-
ENABLED_TOOLS=news,weather-current,weather-forecast,depin-metrics,depin-projects,l1data,dimo,nuclear
11+
# Available tools: choose one specialty tool or use ask_specialty to let the LLM to choose the best tool
12+
# full list of tools in src/registry/toolNames.ts
13+
ENABLED_TOOLS=ask_specialty
1314

1415
# NUBILA
1516
NUBILA_API_KEY=
1617

1718
# NEWSAPI
1819
NEWSAPI_API_KEY=
1920

20-
# DEPIN
21-
DEPIN_API_KEY=
21+
# MAPBOX
22+
MAPBOX_ACCESS_TOKEN=
23+
24+
# IoTeX Analytics API
25+
# How to get API_V2_KEY: https://docs.iotex.io/builders/web3-development/chain-indexing/iotex-analytics-api
2226
API_V2_KEY=
2327

2428
# DIMO
@@ -30,5 +34,25 @@ PRIVILEGED_ADDRESS=
3034
# GOV
3135
EIA_API_KEY=
3236

37+
# Messari
38+
MESSARI_API_KEY=
39+
40+
# Thirdweb
41+
THIRDWEB_SECRET_KEY=
42+
THIRDWEB_SESSION_ID=
43+
44+
# CoinMarketCap
45+
CMC_API_KEY=
46+
47+
# Air Quality
48+
AIRVISUAL_API_KEY=
49+
50+
# Depin Ninja
51+
DEPINNINJA_API_KEY=
52+
3353
# Server Configuration
34-
PORT=8000
54+
PORT=8000
55+
56+
# Directives for the LLM
57+
# Default: "You're a helpful assistant that can answer questions and help with tasks. You are also able to use tools to get information."
58+
SYSTEM_PROMPT=

0 commit comments

Comments
 (0)