Dark-Alex-17/llm-functions
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: update readme

Browse Source
This commit is contained in:
sigoden
2024-07-13 00:25:17 +00:00
parent 2f938034c3
commit 20c74db7b8
1 changed files with 17 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+16 -17
View File
@@ -14,34 +14,35 @@ Make sure you have the following tools installed:
- [argc](https://github.com/sigoden/argc): A bash command-line framewrok and command runner - [argc](https://github.com/sigoden/argc): A bash command-line framewrok and command runner
- [jq](https://github.com/jqlang/jq): A JSON processor - [jq](https://github.com/jqlang/jq): A JSON processor
## Getting Started with AIChat ## Getting Started with [AIChat](https://github.com/sigoden/aichat)
**1. Clone the repository:** ### 1. Clone the repository:
```sh ```sh
git clone https://github.com/sigoden/llm-functions git clone https://github.com/sigoden/llm-functions
``` ```
**2. Build tools and agents:** ### 2. Build tools and agents:
- Create a `./tools.txt` file with each tool filename on a new line. **I. Create a `./tools.txt` file with each tool filename on a new line.**
``` ```
get_current_weather.sh get_current_weather.sh
#execute_command.sh
execute_py_code.py execute_py_code.py
search_tavily.sh search_tavily.sh
``` ```
- Create a `./agents.txt` file with each agent name on a new line. **II. Create a `./agents.txt` file with each agent name on a new line.**
``` ```
coder coder
todo todo
``` ```
- Run `argc build` to build tools and agents **III. Run `argc build` to build tools and agents.**
**3. Configure your AIChat:** ### 3. Install to AIChat:
Symlink this repo directory to AIChat **functions_dir**: Symlink this repo directory to AIChat **functions_dir**:
@@ -51,17 +52,15 @@ ln -s "$(pwd)" "$(aichat --info | grep -w functions_dir | awk '{print $2}')"
argc install argc install
``` ```
**4. Start using your functions:** ### 4. Start using the functions:
Now you can interact with your LLM using natural language prompts that trigger your defined functions. Done! You can experience the magic of `llm-functions` in AIChat.
## Writing Your Own Tools ## Writing Your Own Tools
Writing tools is super easy, you only need to write functions with comments. Building tools for our platform is remarkably straightforward. You can leverage your existing programming knowledge, as tools are essentially just functions written in your preferred language.
`llm-functions` will automatically generate binaries, function declarations, and so on LLM Functions automatically generates the JSON declarations for the tools based on **comments**. Refer to `./tools/demo_tool.{sh,js,py}` for examples of how to use comments for autogeneration of declarations.
Refer to `./tools/demo_tool.{sh,js,py}` for examples of how to use comments for autogeneration of declarations.
### Bash ### Bash
@@ -120,10 +119,10 @@ The agent has the following folder structure:
``` ```
└── agents └── agents
└── myagent └── myagent
├── functions.json # Function declarations file (Auto-generated) ├── functions.json # Function JSON declarations (Auto-generated)
├── index.yaml # Agent definition file ├── index.yaml # Agent definition
├── tools.txt # Reuse tools ├── tools.txt # Shared tools from ./tools
└── tools.{sh,js,py} # Agent tools script └── tools.{sh,js,py} # Agent tools
``` ```
The agent definition file (`index.yaml`) defines crucial aspects of your agent: The agent definition file (`index.yaml`) defines crucial aspects of your agent: