From 7efc35dcc0081266af5356e0390b512fd0ef193c Mon Sep 17 00:00:00 2001 From: Christoph Thiede <38782922+LinqLover@users.noreply.github.com> Date: Sun, 27 Aug 2023 23:17:16 +0200 Subject: [PATCH] Update README.md --- README.md | 113 +++++++++++++++++++++++++--- assets/ChatGPT.png | Bin 0 -> 31036 bytes assets/HelpSystemSearch.png | Bin 0 -> 46471 bytes assets/SIT-similarConversations.png | Bin 0 -> 39065 bytes assets/expenseWatcher.png | Bin 0 -> 8495 bytes 5 files changed, 102 insertions(+), 11 deletions(-) create mode 100644 assets/ChatGPT.png create mode 100644 assets/HelpSystemSearch.png create mode 100644 assets/SIT-similarConversations.png create mode 100644 assets/expenseWatcher.png diff --git a/README.md b/README.md index fc2762b..a1467c2 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,73 @@ -# squeak-chatgpt +# Squeak-SemanticText -Connects [Squeak](https://squeak.org) to [OpenAI's Chat API](https://platform.openai.com/docs/api-reference/chat). +> ChatGPT, embedding search, and retrieval-augmented generation for Squeak/Smalltalk -Very simple and incomplete prototype yet. More might follow. Contributions welcome! +*Semantics* (from ancient Greek *sēmantikós*) refers to the significance or meaning of information. While the normal `String` and `Text` classes in Squeak take a syntactic view on text as a sequence of characters and formatting instructions, `SemanticText` focuses on the sense and understanding of text. With the advent of NLP (natural language processing) and LMMs (large language models), the availability of text interpretability in computing systems is expanding substantially. This package aims to make semantic context accessible in [Squeak/Smalltalk](https://squeak.org) by providing the following features: + +- **[OpenAI API](https://platform.openai.com/docs/api-reference) client:** Currently supports chat completions and embeddings. Includes tools for managing rate limits, tracking expenses, and estimating prices for queries. +- **SemanticConversation:** Framework for conversational agents like ChatGPT. +- **ChatGPT:** Conversational GUI for Squeak. Supports streaming responses, editing conversations, and defining system messages. +- **SemanticCorpus:** Framework for semantic search, similarity search, and retrieval-augmented generation (RAG, aka "chat with your data") through the power of text embeddings. +- **Experimental tools** such as an integration of semantic search and RAG into Squeak's Help Browser or Squeak's mailing list. + +For more details, install the package and dive into the class comments, or read below. + +
+ + ChatGPT + + + + |
+
+ + Help Browser Integration: Semantic Search and Retrieval Augmented Generation (RAG) + + ++ Squeak Inbox Talk Integration: Similar Conversation Search + + + |
+
atd6ktssA=>MdOzAqBiL<+2{NgEF@T4NF!Pq=Hb#syuh@vAK=d43!&^
z&?b=aVJ6J