Mention the experimental /chat API interacts with OpenAI's API

This commit is contained in:
Debanjum Singh Solanky 2022-01-28 23:56:47 -05:00
parent 6ed667aed0
commit 2bc2780501

View file

@ -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]]