diff options
| author | sigoden <sigoden@gmail.com> | 2024-06-05 04:37:08 +0000 |
|---|---|---|
| committer | sigoden <sigoden@gmail.com> | 2024-06-05 04:37:08 +0000 |
| commit | eacc88f04a1129c74ab3c0ad56ae3ec0159a486e (patch) | |
| tree | 51f573869c01a5157b21aaafe7ab2eef1ec576d7 /README.md | |
| parent | a732291f3321f2feb31fb7b1105e223e2fa33976 (diff) | |
| download | aichat-eacc88f04a1129c74ab3c0ad56ae3ec0159a486e.tar.gz | |
chore: update readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 27 |
1 files changed, 16 insertions, 11 deletions
@@ -4,27 +4,27 @@ [](https://crates.io/crates/aichat) [](https://discord.gg/mr3ZZUB9hG) -AIChat is an all-in-one AI CLI tool that accesses 100+ LLMs across 20+ AI platforms, with features including a chat REPL, custom roles, unlimited sessions, function calling, execute commands in natural language, a local api server, an LLM playground/arena, and more. +AIChat is an all-in-one AI CLI tool featuring chat REPL, RAG, function calling, and more.   -## Features +## Key Features -- **Unified CLI**: Access 100+ LLMs across 20+ AI platforms effortlessly. -- **Chat-REPL**: Powerful and feature-rich interactive chat interface. -- **Custom Roles**: Tailor LLM behavior with customizable roles. -- **Unlimited Sessions**: Automatic message compression for endless conversations. -- **RAG Retrieval**: Get answer enhanced by your knowledge base.. +- **Unified LLM Client**: Access 100+ LLMs across 20+ AI platforms effortlessly. +- **RAG Retrieval**: Get answer enhanced by your documents and knowledge bases. - **Function Calling**: Connect LLMs to external tools seamlessly. - **Execute Commands**: Use natural language to run shell commands. +- **Chat REPL**: Powerful and feature-rich interactive chat interface. +- **Useful Roles**: Tailor LLM behavior with customizable roles. +- **Unlimited Sessions**: Automatic message compression for endless conversations. - **Shell Auto-Completion**: AI-based auto-completion for shell commands. - **Highly Customizable**: Customize configurations and themes to your preferences. - **Local API Server**: Host a local server with OpenAI-compatible API. - **LLM Playground/Arena**: Experiment and compete LLMs in WebUI. -## Supported AI Platforms +## Supported LLMs - OpenAI GPT-3.5/GPT-4 (paid, vision, embedding, function-calling) - Gemini: Gemini-1.0/Gemini-1.5 (free, paid, vision, embedding, function-calling) @@ -94,6 +94,11 @@ prelude: null # Set a default role or session to start with ( # if unset fallback to $EDITOR and $VISUAL buffer_editor: null +# Specifies the embedding model to use +embedding_model: null +# Determines how many relevant documents are retrieved +rag_top_k: 4 + # Compress session when token count reaches or exceeds this threshold (must be at least 1000) compress_threshold: 4000 @@ -366,7 +371,7 @@ The author mainly focused on writing and programming growing up ... .set dry_run true ``` -## Server +## Local Server AIChat comes with a built-in lightweight web server. @@ -397,13 +402,13 @@ curl -X POST -H "Content-Type: application/json" -d '{ The LLM Playground is a webapp that allows you to interact with any LLM supported by AIChat directly in your browser. - + ### LLM Arena The LLM Arena is a web-based platform where you can compare different LLMs side-by-side. - + ## Function Calling |
