forked from HAL9000/cleveragents-core
44 lines
1.5 KiB
ReStructuredText
44 lines
1.5 KiB
ReStructuredText
============
|
|
CleverAgents
|
|
============
|
|
|
|
A powerful, flexible Agent Based LLM tool for creating and managing networks of AI agents.
|
|
|
|
.. image:: https://img.shields.io/pypi/v/cleveragents.svg
|
|
:target: https://pypi.org/project/cleveragents/
|
|
:alt: PyPI Package
|
|
|
|
.. image:: https://img.shields.io/travis/cleverthis/cleveragents.svg
|
|
:target: https://travis-ci.org/cleverthis/cleveragents
|
|
:alt: Travis-CI Build Status
|
|
|
|
API Key Configuration
|
|
---------------------
|
|
|
|
CleverAgents requires API keys for certain agents and tools (e.g., LLM providers, web search). Keys can be configured in two ways, with the agent-specific configuration taking precedence.
|
|
|
|
1. **In Agent Configuration**:
|
|
Set the ``api_key`` field directly in the agent or tool definition within your YAML configuration file. If this key is present and not empty, it will always be used.
|
|
|
|
.. code-block:: yaml
|
|
|
|
agents:
|
|
- name: my_openai_agent
|
|
type: llm
|
|
config:
|
|
provider: openai
|
|
model: gpt-4
|
|
api_key: "sk-your-key-from-config"
|
|
|
|
2. **Via Environment Variables**:
|
|
If ``api_key`` is not set or is an empty string in the configuration, the application will look for a corresponding environment variable.
|
|
|
|
- **OpenAI**: ``OPENAI_API_KEY``
|
|
- **Anthropic**: ``ANTHROPIC_API_KEY``
|
|
- **Google Gemini**: ``GOOGLE_GEMINI_API_KEY``
|
|
- **Google Search Tool**: ``GOOGLE_SEARCH_API_KEY``
|
|
|
|
If a required API key is not found in either location, the application will raise a ``ConfigurationError``.
|
|
|
|
Overview
|