From 2bc27805014c374d5c855509853a8b7899896227 Mon Sep 17 00:00:00 2001 From: Debanjum Singh Solanky Date: Fri, 28 Jan 2022 23:56:47 -0500 Subject: [PATCH] Mention the experimental /chat API interacts with OpenAI's API --- README.org | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.org b/README.org index eb025743..20f3301a 100644 --- a/README.org +++ b/README.org @@ -3,7 +3,7 @@ * Semantic Search /Allow natural language search on user content like notes, images, transactions using transformer based models/ - All data is processed locally. User can interface with semantic-search app via [[./src/interface/emacs/semantic-search.el][Emacs]], API or Commandline + All search is done locally. User can interface with semantic-search app via [[./src/interface/emacs/semantic-search.el][Emacs]], API or Commandline ** Setup @@ -89,6 +89,11 @@ conda activate semantic-search #+end_src +** Miscellaneous + - The experimental /chat API endpoint uses the [[https://openai.com/api/][OpenAI API]] + - It is disabled by default + - To use it add your ~openai-api-key~ to config.yml + ** Acknowledgments - [[https://huggingface.co/sentence-transformers/msmarco-MiniLM-L-6-v3][MiniLM Model]] for Asymmetric Text Search. See [[https://www.sbert.net/examples/applications/retrieve_rerank/README.html][SBert Documentation]] - [[https://github.com/openai/CLIP][OpenAI CLIP Model]] for Image Search. See [[https://www.sbert.net/examples/applications/image-search/README.html][SBert Documentation]]