From 9b557ae1f5f0996e1149ef8d0099876cfe754d57 Mon Sep 17 00:00:00 2001 From: sigoden Date: Sat, 13 Jul 2024 00:41:46 +0000 Subject: chore: update readme --- README.md | 6 ++++-- agents/demo/README.md | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8cd73d2..ad45e49 100644 --- a/README.md +++ b/README.md @@ -111,7 +111,7 @@ def main(code: str): ``` -## Writing Agents +## Writing Your Own Agents Agent = Prompt + Tools (Function Callings) + Knowndge (RAG). It's also known as OpenAI's GPTs. @@ -135,7 +135,9 @@ instructions: You are a test ai agent to ... conversation_starters: - What can you do? documents: - - files/doc.pdf + - local-file.txt + - local-dir/ + - https://example.com/remote-file.txt ``` Refer to `./agents/todo-{sh,js,py}` for examples of how to implement a agent. diff --git a/agents/demo/README.md b/agents/demo/README.md index 888b236..d430477 100644 --- a/agents/demo/README.md +++ b/agents/demo/README.md @@ -36,9 +36,11 @@ instructions: | ### documents -Documents are used for RAG. +Documents are used for RAG, supporting local files/dirs and remote URLs. ```yaml documents: - - https://raw.githubusercontent.com/sigoden/llm-functions/main/README.md + - local-file.txt + - local-dir/ + - https://example.com/remote-file.txt ``` \ No newline at end of file -- cgit v1.2.3