From ef43b22a8e6d4eb7388a552ba6d52d662e38fd0c Mon Sep 17 00:00:00 2001 From: sigoden Date: Tue, 21 May 2024 08:26:47 +0800 Subject: feat: rewrite to accept json data from cli args other than env var (#7) * update readme --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index bdd545b..6223976 100644 --- a/README.md +++ b/README.md @@ -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. -![image](https://github.com/sigoden/llm-functions/assets/4012553/867b7b2a-25fb-4c74-9b66-3701eaabbd1f) +![function-showcase](https://github.com/sigoden/llm-functions/assets/4012553/391867dd-577c-4aaa-9ff2-c9e67fb0f3a3) + ## 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. +![retrieve-type-showcase](https://github.com/sigoden/llm-functions/assets/4012553/7e628834-9863-444a-bad8-7b51bfb18dff) + ### 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. -![image](https://github.com/sigoden/aichat/assets/4012553/711067b8-dd23-443d-840a-5556697ab075) +![execute-type-showcase](https://github.com/sigoden/llm-functions/assets/4012553/1dbc345f-daf9-4d65-a49f-3df8c7df1727) **AIChat categorizes functions starting with `may_` as `execute type` and all others as `retrieve type`.** -- cgit v1.2.3