diff --git a/README.md b/README.md index b3be385..b59b957 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ ## How to query information? Simply use the `query` parameter to retrieve relevant informations. You can use the `--limit` parameter to indicate how many of most relevant entries you want to retrieve. ``` -./kdb --query "What is life meaning?" --top 1 +./kdb query "What is life meaning?" --limit 1 ``` as you can see it doesn't return anything, because it doesn't have any knowledge yet. @@ -12,7 +12,7 @@ as you can see it doesn't return anything, because it doesn't have any knowledge ## How to add knowledge? You can use the `embed` paramter to pass a piece of knowledge to the database. ``` -./kdb --embed "Here is a sample piece of information that will be remembed forever!" +./kdb embed "Here is a sample piece of information that will be remembed forever!" ``` There is a script in the `test_content` directory which you can use to add some sample knowledge. ``` @@ -23,7 +23,7 @@ chmod +x ./train.sh This will add a bunch of sample knowledge. You can now ask questions about it: ``` -./kdb --query "how many times Alpha is smaller than Gamma?" --top 3 +./kdb query "how many times Alpha is smaller than Gamma?" --top 3 ``` and it returns the revelant piece of informations. @@ -39,19 +39,19 @@ one-sixth of Gamma. Therefore, Alpha is six times smaller than Gamma. ``` Or you can make your own prompt for it: ``` -echo "Answer to the question by following the given context. IF you don't know the answer simply say you don't know. Do not do yapping. The Context: $(./kdb --query "What is the meaning of life?" --top 3)" | ollama run llama3 +echo "Answer to the question by following the given context. IF you don't know the answer simply say you don't know. Do not do yapping. The Context: $(./kdb query "What is the meaning of life?" --limit 3)" | ollama run llama3 ``` ## How to list all entries? -You can do this by using `list` parameter and entering the max number of entries to be listed. +You can do this by using `list` parameter and pass the max number of entries to be listed as `--limit`. ``` -./kdb --list 100 +./kdb --list --limit 100 ``` ## How to delete an entry? You can simply use the `delete` option: ``` -./kdb --delete "b1827d5a-16d2-4f74-acfa-29864434859a" +./kdb delete "b1827d5a-16d2-4f74-acfa-29864434859a" ``` ## Need the list of parameters?