diff options
| author | sigoden <sigoden@gmail.com> | 2024-05-21 08:26:47 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-21 08:26:47 +0800 |
| commit | ef43b22a8e6d4eb7388a552ba6d52d662e38fd0c (patch) | |
| tree | cf03ce9e37b5e3068aa38aa2213b558d210bc1a0 /README.md | |
| parent | e6642b5898ef3c46b2d37ab8dfce18f5db0a5618 (diff) | |
| download | llm-functions-docker-ef43b22a8e6d4eb7388a552ba6d52d662e38fd0c.tar.gz | |
feat: rewrite to accept json data from cli args other than env var (#7)
* update readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 9 insertions, 4 deletions
@@ -1,6 +1,6 @@ # LLM Functions -This project allows you to enhance large language models (LLMs) with custom functions written in Bash/Js/Python/Ruby. Imagine your LLM being able to execute system commands, access web APIs, or perform other complex tasks – all triggered by simple, natural language prompts. +This project allows you to enhance large language models (LLMs) with custom functions written in bash/js/python/ruby. Imagine your LLM being able to execute system commands, access web APIs, or perform other complex tasks – all triggered by simple, natural language prompts. ## Prerequisites @@ -46,7 +46,8 @@ AIChat will automatically load `functions.json` and execute functions located in Now you can interact with your LLM using natural language prompts that trigger your defined functions. - + + ## Function Types @@ -56,13 +57,17 @@ The function returns JSON data to LLM for further processing. AIChat does not ask permission to run the function or print the output. + + ### Execute Type -The function does not return data to LLM. Instead, they enable more complex actions, such as showing a progress bar or running a TUI application. +The function does not have to return JSON data. + +The function can perform dangerous tasks like creating/deleting files, changing network adapter, and setting a scheduled task... AIChat will ask permission before running the function. - + **AIChat categorizes functions starting with `may_` as `execute type` and all others as `retrieve type`.** |