Skip to content

Commit

Permalink
Merge pull request stitionai#258 from nalaso/main
Browse files Browse the repository at this point in the history
Created documentation for changing web_search methods and google search api
  • Loading branch information
mufeedvh authored Mar 30, 2024
2 parents cb0ad08 + 2f1b9c2 commit f0f33b2
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,13 +153,29 @@ Devika requires certain configuration settings and API keys to function properly
- `PROJECTS_DIR`: The directory where Devika's projects will be stored.
- `LOGS_DIR`: The directory where Devika's logs will be stored.
- `REPOS_DIR`: The directory where Git repositories cloned by Devika will be stored.
- `WEB_SEARCH`: This determines the default web search method for browsing the web. Accepted values are: google, bing, or ddgs.
- `BING`: Your Bing Search API key for web searching capabilities.
- `GOOGLE_SEARCH`: Your Google Search API key for web searching capabilities.
- `GOOGLE_SEARCH_ENGINE_ID`: Your Google Search Engine Id for web searching using google.
- `CLAUDE`: Your Anthropic API key for accessing Claude models.
- `NETLIFY`: Your Netlify API key for deploying and managing web projects.
- `OPENAI`: Your OpenAI API key for accessing GPT models.

Make sure to keep your API keys secure and do not share them publicly.

### Configuring web search method

Devika currently supports Bing, Google, and DuckDuckGo for web searches. You can configure the web search method using the following options:

1. **Using config.toml**: Modify the value of WEB_SEARCH in config.toml to your preferred method.
2. **Using CLI**: Change the web search method using the command line interface by specifying the --websearch attribute when starting the server.
```bash
python devika.py --websearch bing
```
3. **Using rest api**: Change the web search method through the REST API. Simply include the web_search parameter in the /api/execute-agent endpoint.

Accepted values are `bing`,`google` and `ddgs`.

## Under The Hood

Let's dive deeper into some of the key components and techniques used in Devika:
Expand Down

0 comments on commit f0f33b2

Please sign in to comment.