Updating readme

This commit is contained in:
MervinPraison committed 2024-07-15 10:19:13 +01:00
1 parent 8985715b55
commit 241b94aadb
4 files changed
+36 -14

No files matched your search

+9
View File
@@ -95,6 +95,15 @@ praisonai --auto create a movie script about Dog in Moon
## User Interface
## PraisonAI User Interfaces:
| Interface | Description | URL |
|---|---|---|
| **UI** | Multi Agents such as CrewAI or AutoGen | [https://docs.praisonai.com/ui/ui](https://docs.praison.ai/ui/ui) |
| **Chat** | Chat with 100+ LLMs, single AI Agent | [https://docs.praisonai.com/ui/chat](https://docs.praison.ai/ui/chat) |
| **Code** | Chat with entire Codebase, single AI Agent | [https://docs.praisonai.com/ui/code](https://docs.praison.ai/ui/code) |
```bash
pip install -U "praisonai[ui]"
export OPENAI_API_KEY="Enter your API key"
+9 -4
View File
@@ -17,7 +17,9 @@ export OPENAI_API_KEY=xxxxxxxx
praisonai code
```
4. Set Model name to be gpt-3.5-turbo in the settings
4. Username and Password will be asked for the first time. `admin` is the default username and password.
5. Set Model name to be gpt-3.5-turbo in the settings
## Other Models
@@ -58,9 +60,10 @@ code:
* Create a .env file in the root folder of the project
* Add below Variables and required Ignore Files
* ```
PRAISONAI_IGNORE_FILES=".*,*.pyc,__pycache__,.git,.gitignore,.vscode,.idea,.DS_Store,*.lock,.env,docs,tests,test,tmp,temp,*.txt,*.md,*.json,*.csv,*.tsv,public,*.sql,*.sqlite,*.db,*.db3,*.sqlite3,*.log,*.zip,*.gz,*.tar,*.rar,*.7z,*.pdf,*.jpg,*.jpeg,*.png,*.gif,*.svg,cookbooks,assets,dist,build,node_modules,venv,crewAI,.cache,*.__pycache__,*chroma.sqlite3,test/,dist/,praisonAI.egg-info,test.yaml,db,praisonai_prompt.txt,watch.sh,docs.sh,other,output,*.chainlit,.files,site,flagged,*public,threads.db,trained_agents_data.pkl,.pytest_cache"
```
```bash
PRAISONAI_IGNORE_FILES=".*,*.pyc,__pycache__,.git,.gitignore,.vscode,.idea,.DS_Store,*.lock,.env,docs,tests,test,tmp,temp,*.txt,*.md,*.json,*.csv,*.tsv,public,*.sql,*.sqlite,*.db,*.db3,*.sqlite3,*.log,*.zip,*.gz,*.tar,*.rar,*.7z,*.pdf,*.jpg,*.jpeg,*.png,*.gif,*.svg,cookbooks,assets,dist,build,node_modules,venv,crewAI,.cache,*.__pycache__,*chroma.sqlite3,test/,dist/,praisonAI.egg-info,test.yaml,db,praisonai_prompt.txt,watch.sh,docs.sh,other,output,*.chainlit,.files,site,flagged,*public,threads.db,trained_agents_data.pkl,.pytest_cache"
```
### Using Environment Variables in the Terminal
@@ -70,6 +73,8 @@ export PRAISONAI_IGNORE_FILES=".*,*.pyc,__pycache__,.git,.gitignore,.vscode,.ide
## Set Max Tokens
Note: By Default Max Tokens set is 128,000
```bash
export PRAISONAI_MAX_TOKENS=200000
```
+8
View File
@@ -1,5 +1,13 @@
# PraisonAI User Interface (UI)
## Different User Interfaces:
| Interface | Description | URL |
|---|---|---|
| **UI** | Multi Agents such as CrewAI or AutoGen | [https://docs.praisonai.com/ui/ui](https://docs.praison.ai/ui/ui) |
| **Chat** | Chat with 100+ LLMs, single AI Agent | [https://docs.praisonai.com/ui/chat](https://docs.praison.ai/ui/chat) |
| **Code** | Chat with entire Codebase, single AI Agent | [https://docs.praisonai.com/ui/code](https://docs.praison.ai/ui/code) |
## Chainlit
```bash
pip install -U "praisonai[ui]"
+10 -10
View File
@@ -1,12 +1,12 @@
# tools.py
from duckduckgo_search import DDGS
from praisonai_tools import BaseTool
# # tools.py
# from duckduckgo_search import DDGS
# from praisonai_tools import BaseTool
class InternetSearchTool(BaseTool):
name: str = "InternetSearchTool"
description: str = "Search Internet for relevant information based on a query or latest news"
# class InternetSearchTool(BaseTool):
# name: str = "InternetSearchTool"
# description: str = "Search Internet for relevant information based on a query or latest news"
def _run(self, query: str):
ddgs = DDGS()
results = ddgs.text(keywords=query, region='wt-wt', safesearch='moderate', max_results=5)
return results
# def _run(self, query: str):
# ddgs = DDGS()
# results = ddgs.text(keywords=query, region='wt-wt', safesearch='moderate', max_results=5)
# return results