monadic-chat 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ee0dcb302392e3e503b2f26a777953956a998244634c5935fc5be3e2316dc28
-  data.tar.gz: 1a42d5a6c02552ee676f89e338a8f7ff550b1905497cce42d0ba55e54c28038d
+  metadata.gz: c6c1eec7b2ccb702d089ea8c9a149598d9849ed65b6cc86bd973eb7b89f9ccc0
+  data.tar.gz: df870526831d8585a4dba437e0258626eafc1046e128866e6d32858455b4867a
 SHA512:
-  metadata.gz: 1bca191c52aad2d0b2fd0de6dad2a806046e57546e038b9905d19a78e58047c3cd2e44dbc9fed69b88e648e3970290130d4350ec3fb94aa59b28baf8b07fbe46
-  data.tar.gz: 7e9e8a1752c11ff3a50de51ab20ab7f77c4a85b46c15134e253b42f6522b30be15b4cbb8cb8bb9ed52c96588a36d9c409cfb75cc14f28f686279324f468d1ded
+  metadata.gz: a8d55eaae3d54fa3278d10d0690336854c1c3b014f73e4a55816ff23e0e2c6e60cc7c26e2f9cde10351d70a430dbe5df26aaf182f5713953b1e3578eeee8637d
+  data.tar.gz: 0f6435e95973154d0afbd97414701b0e3d0b743d2dc375b91e333d1d41e2f2d1cfda48b8343dfb62791bf2d59ccc2d357453cfb4dc31304a9a479dda04ae7a2a

data/CHANGELOG.md

@@ -13,3 +13,7 @@
 
 - Research mode architecture changed
 - Stability improvement
+
+## [0.2.1] - 2023-03-21
+
+- GPT-4 models supported (experimental)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    monadic-chat (0.2.0)
+    monadic-chat (0.2.1)
       http
       kramdown
       launchy
@@ -21,13 +21,9 @@ GEM
   specs:
     addressable (2.8.1)
       public_suffix (>= 2.0.2, < 6.0)
-    ast (2.4.2)
-    backport (1.2.0)
-    benchmark (0.2.1)
     diff-lcs (1.5.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    e2mmap (0.1.0)
     ffi (1.15.5)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
@@ -40,32 +36,19 @@ GEM
     http-cookie (1.0.5)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
-    jaro_winkler (1.5.4)
-    json (2.6.3)
     kramdown (2.4.0)
       rexml
-    kramdown-parser-gfm (1.1.0)
-      kramdown (~> 2.0)
     launchy (2.5.2)
       addressable (~> 2.8)
     llhttp-ffi (0.4.0)
       ffi-compiler (~> 1.0)
       rake (~> 13.0)
-    nokogiri (1.14.2-x86_64-darwin)
-      racc (~> 1.4)
     oj (3.14.2)
     parallel (1.22.1)
-    parser (3.2.1.1)
-      ast (~> 2.4.1)
     pastel (0.8.0)
       tty-color (~> 0.5)
     public_suffix (5.0.1)
-    racc (1.6.2)
-    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.7.0)
-    reverse_markdown (2.1.1)
-      nokogiri
     rexml (3.2.5)
     rouge (4.1.0)
     rspec (3.12.0)
@@ -81,41 +64,11 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.48.0)
-      json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.2.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.27.0)
-      parser (>= 3.2.1.0)
-    ruby-progressbar (1.13.0)
-    solargraph (0.48.0)
-      backport (~> 1.2)
-      benchmark
-      bundler (>= 1.17.2)
-      diff-lcs (~> 1.4)
-      e2mmap
-      jaro_winkler (~> 1.5)
-      kramdown (~> 2.3)
-      kramdown-parser-gfm (~> 1.1)
-      parser (~> 3.0)
-      reverse_markdown (>= 1.0.5, < 3)
-      rubocop (>= 0.52)
-      thor (~> 1.0)
-      tilt (~> 2.0)
-      yard (~> 0.9, >= 0.9.24)
     strings (0.2.1)
       strings-ansi (~> 0.2)
       unicode-display_width (>= 1.5, < 3.0)
       unicode_utils (~> 1.4)
     strings-ansi (0.2.0)
-    thor (1.2.1)
-    tilt (2.1.0)
     tty-box (0.7.0)
       pastel (~> 0.8)
       strings (~> 0.2.0)
@@ -147,12 +100,10 @@ GEM
     unf_ext (0.0.8.2)
     unicode-display_width (2.4.2)
     unicode_utils (1.4.0)
-    webrick (1.7.0)
     wisper (2.0.1)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
 
 PLATFORMS
+  ruby
   x86_64-darwin-22
 
 DEPENDENCIES
@@ -160,7 +111,6 @@ DEPENDENCIES
   monadic-chat!
   rake
   rspec
-  solargraph
 
 BUNDLED WITH
-   2.4.1
+   2.4.8

data/README.md

@@ -3,14 +3,20 @@
 <p align="center"><b>Highly configurable CLI client app for OpenAI chat/text-completion API</b></p>
 
 <p align="center">
-<img src="https://user-images.githubusercontent.com/18207/224493072-9720b341-c70d-43b9-b996-ba7e9a7a6806.gif" width="900" />
+<kbd><img src="https://user-images.githubusercontent.com/18207/224493072-9720b341-c70d-43b9-b996-ba7e9a7a6806.gif" width="800" /></kbd>
+</p>
+
+<p align="center">
+<kbd><img src="https://user-images.githubusercontent.com/18207/225505520-53e6f2c4-84a8-4128-a005-3fe980ec2449.gif" width="800" /></kbd>
 </p>
 
 > **Warning**  
 > This software is ***under active development***. It may be unstable, and the latest version may behave slightly differently than this document. Also, specifications may change in the future.
 
-** Change Log**
+**Change Log**
 
+- [March 21, 2023] GPT-4 models supported (experimental)
+- [March 20, 2023] Text and figure in "How the research mode workds" section updated
 - [March 13, 2023] Text on the architecture of the `research` mode updated in accordance with Version 0.2.0
 
 ## Table of Contents
@@ -42,8 +48,8 @@
 * [Creating New App](#creating-new-app)
     * [File Structure](#file-structure)
     * [Reducer Code](#reducer-code)
-    * [Template for `Normal` Mode](#template-for-normal-mode)
-    * [Template for `Research` Mode](#template-for-research-mode)
+    * [Monadic Chat Template](#monadic-chat-template)
+    * [Extra Template for `Research` Mode](#extra-template-for-research-mode)
 * [What is Monadic about Monadic Chat?](#what-is-monadic-about-monadic-chat)
     * [Unit, Map, and Join](#unit-map-and-join)
     * [Discourse Management Object](#discourse-management-object)
@@ -58,11 +64,11 @@
 
 ## Introduction
 
-**Monadic Chat** is a command-line client application program that uses OpenAI's Text Completion API and Chat API to enable chat-style conversations with OpenAI's artificial intelligence system in a ChatGPT-like style.
+**Monadic Chat** is a user-friendly command-line client application that utilizes OpenAI’s Text Completion API and Chat API to facilitate ChatGPT-style conversations with OpenAI’s large language models (LLM) on any terminal application of your choice.
 
-The conversation with the AI can be saved in a JSON file, and the saved JSON file can be loaded later to continue the conversation. The conversation data can also be converted to HTML and displayed in a web browser.
+The conversation history can be saved in a JSON file, which can be loaded later to continue the conversation. Additionally, the conversation data can be converted to HTML and viewed in a web browser for easy accessibility.
 
-Monadic Chat comes with four apps (`Chat`, `Code`, `Novel`, and `Translate`). Each can generate a different kind of text through interactive conversation between the user and OpenAI's large-scale language model. Users can also create new apps.
+Monadic Chat includes four pre-built apps (`Chat`, `Code`, `Novel`, and `Translate`) that are designed to generate different types of discourse through interactive conversation with the LLM. Users also have the option to create their own apps by writing new templates.
 
 ## Dependencies
 
@@ -132,7 +138,7 @@ When you start Monadic Chat with the `monadic-chat` command for the first time,
 
 <br />
 
-<kbd><img src="./doc/img/input-acess-token.png" width="700px" style="border: thin solid darkgray;"/></kbd>
+<kbd><img src="./doc/img/input-acess-token.png" width="700px" /></kbd>
 
 <br />
 
@@ -150,7 +156,7 @@ Selecting `readme` will take you to the README on the GitHub repository (the doc
 
 <br />
 
-<kbd><img src="./doc/img/select-app-menu.png" width="700px" style="border: thin solid darkgray;"/></kbd>
+<kbd><img src="./doc/img/select-app-menu.png" width="700px" /></kbd>
 
 <br />
 
@@ -170,7 +176,7 @@ You can call up the function menu anytime. To invoke the function menu, type `he
 
 <br />
 
-<kbd><img src="./doc/img/select-feature-menu.png" width="700px" style="border: thin solid darkgray;"/></kbd>
+<kbd><img src="./doc/img/select-feature-menu.png" width="700px" /></kbd>
 
 <br />
 
@@ -335,15 +341,6 @@ The following is a schematic of the process flow in the `research` mode.
 
 <br />
 
-Terms in bold in it may require more explanation.
-
-- **Input** is a string entered by the user on the command line. The input is filled in the `{{NEW PROMPT}}` placeholder in the template and is sent to the API. 
-- The **template** contains conversation data in JSON format and instructions on how the text-completion API should update this data. More details are given in the [Creating New Apps]("#creating-new-apps") section below.
-- The term **prompt** can be used in two ways: in one sense, it means text input from the user. In the figure above, however, "prompt" refers to the contents of the template as a whole, which is sent to the API.
-- The response to the user’s input is referred to as **output**. Input and output are in the returned JSON object, structured according to the instruction specified in the template.
-- The JSON object contains a list of the conversation history, referred to as the **accum** (accumulator) in the figure. Each turn of the conversation increases the messages stored in the accumulator.
-- A Monadic Chat app must define a **reducer** to prevent the accumulator from growing excessively.
-
 ### Accumulator
 
 `Normal` mode uses OpenAI's chat API, where the following basic structure is used for conversation history management.
@@ -400,7 +397,8 @@ The specifications for Monadic Chat's command-line user interface for this app a
 
 > **Note**  
 > The use of square brackets (instead of parentheses) in the notation of syntactic analysis here is to conform to the format of [RSyntaxTree](https://yohasebe.com/rsyntaxtree), a tree-drawing program for linguistic research developed by the author of Monadic Chat.
-> <img src="./doc/img/syntree-sample.png" width="300px" />
+>
+> <img src="./doc/img/syntree-sample.png" width="280px" />
 
 The sample app we create in this section is stored in the [`sample_app`](https://github.com/yohasebe/monadic-chat/tree/main/sample_app) folder in the repository.
 
@@ -408,7 +406,7 @@ Below is a sample HTML displaying the conversation (sentence and its syntactic s
 
 <br />
 
-<kbd><img src="./doc/img/linguistic-html.png" width="700px" style="border: thin solid darkgray;"/></kbd>
+<kbd><img src="./doc/img/linguistic-html.png" width="700px" /></kbd>
 
 <br />
 
@@ -460,7 +458,7 @@ Template files with a name beginning with `_` are also ignored. If a folder has
 
 We do not need to make the reducer do anything special for the current purposes. So, let's copy the code from the default `chat` app and make a minor modification, such as changing the class name and the app name so that it matches the app name. We save it as `apps/linguistic/linguistic.rb`.
 
-### Template for `Normal` Mode
+### Monadic Chat Template
 
 In `normal` mode, achieving all the necessary functions shown earlier is impossible or very tough, to say the least. All we do here is display the results of syntactic analysis and define a user interface. Create a JSON file `apps/linguistic/linguistic.rb` and save it with the following contents:
 
@@ -479,9 +477,11 @@ In `normal` mode, achieving all the necessary functions shown earlier is impossi
 
 The data structure here is no different from that specified in [OpenAI Chat API](https://platform.openai.com/docs/guides/chat). The `normal` mode of Monadic Chat is just a client application that uses this API to achieve ChatGPT-like functionality on the command line.
 
-### Template for `Research` Mode
+### Extra Template for `Research` Mode
+
+In the `research` mode, you can obtain metadata at each turn as you progress through an interactive conversation with GPT. Compressing and modifying the conversation history based on the metadata (or any other data) is also possible. However, you must create an extra template besides the `normal` mode JSON template.
 
-The template in `research` mode is a Markdown file consisting of five sections. The role and content of each section are shown in the following figure.
+This extra template for `research` mode is a Markdown file comprising six sections. The role and content of each section are shown in the following figure.
 
 <br />
 
@@ -537,18 +537,11 @@ This is the core of the `research` mode template.
 
 Note that the entire `research` mode template is written in Markdown format, so the above JSON object is actually separated from the rest of the template by a code fence, as shown below.
 
-```json
- ```json
- {
-   "prompt": ...
-   "response": ...
-   "mode": ...
-   "tokens": ...
-   "turns": ...
-   ...
- }
- ```
-```
+<br />
+
+<kbd><img src="./doc/img/extra-template-json.png" width="900px" /></kbd>
+
+<br />
 
 The required properties of this JSON object are `prompt`, `response`, `mode`, and `tokens`. Other properties are optional. The `mode` property is used to check the app name when saving the conversation data or loading from an external file. The `tokens` property is used in the reducer mechanism to check the approximate size of the current JSON object. The `turns` property is also used in the reducer mechanism.
 

data/apps/chat/chat.rb

@@ -22,10 +22,10 @@ class Chat < MonadicApp
     }
     method = OpenAI.model_to_method(params["model"])
     case method
-    when "completions"
+    when RESEARCH_MODE
       tjson = TEMPLATES["normal/chat"]
       tmarkdown = TEMPLATES["research/chat"]
-    when "chat/completions"
+    when NORMAL_MODE
       tjson = TEMPLATES["normal/chat"]
       tmarkdown = nil
     end
@@ -37,7 +37,7 @@ class Chat < MonadicApp
           prop_newdata: "response",
           update_proc: proc do
             case method
-            when "completions"
+            when RESEARCH_MODE
               ############################################################
               # Research mode reduder defined here                       #
               # @messages: messages to this point                        #
@@ -51,7 +51,7 @@ class Chat < MonadicApp
 
               @metadata["turns"] = @metadata["turns"].to_i - 1 if conditions.all?
 
-            when "chat/completions"
+            when NORMAL_MODE
               ############################################################
               # Normal mode recuder defined here                         #
               # @messages: messages to this point                        #

data/apps/code/code.rb

@@ -22,10 +22,10 @@ class Code < MonadicApp
     }
     method = OpenAI.model_to_method(params["model"])
     case method
-    when "completions"
+    when RESEARCH_MODE
       tjson = TEMPLATES["normal/code"]
       tmarkdown = TEMPLATES["research/code"]
-    when "chat/completions"
+    when NORMAL_MODE
       tjson = TEMPLATES["normal/code"]
       tmarkdown = nil
     end
@@ -37,7 +37,7 @@ class Code < MonadicApp
           prop_newdata: "response",
           update_proc: proc do
             case method
-            when "completions"
+            when RESEARCH_MODE
               ############################################################
               # Research mode reduder defined here                       #
               # @messages: messages to this point                        #
@@ -51,7 +51,7 @@ class Code < MonadicApp
 
               @metadata["turns"] = @metadata["turns"].to_i - 1 if conditions.all?
 
-            when "chat/completions"
+            when NORMAL_MODE
               ############################################################
               # Normal mode recuder defined here                         #
               # @messages: messages to this point                        #

data/apps/linguistic/linguistic.rb

@@ -3,7 +3,7 @@
 require_relative "../../lib/monadic_app"
 
 class Linguistic < MonadicApp
-  DESC = "Syntatic/Semantic/Pragmatic Analyzer"
+  DESC = "Linguistic Analysis App (experimental)"
   COLOR = "red"
 
   attr_accessor :template, :config, :params, :completion
@@ -22,10 +22,10 @@ class Linguistic < MonadicApp
     }
     method = OpenAI.model_to_method(params["model"])
     case method
-    when "completions"
+    when RESEARCH_MODE
       tjson = TEMPLATES["normal/linguistic"]
       tmarkdown = TEMPLATES["research/linguistic"]
-    when "chat/completions"
+    when NORMAL_MODE
       tjson = TEMPLATES["normal/linguistic"]
       tmarkdown = nil
     end
@@ -37,7 +37,7 @@ class Linguistic < MonadicApp
           prop_newdata: "response",
           update_proc: proc do
             case method
-            when "completions"
+            when RESEARCH_MODE
               ############################################################
               # Research mode reduder defined here                       #
               # @messages: messages to this point                        #
@@ -51,7 +51,7 @@ class Linguistic < MonadicApp
 
               @metadata["turns"] = @metadata["turns"].to_i - 1 if conditions.all?
 
-            when "chat/completions"
+            when NORMAL_MODE
               ############################################################
               # Normal mode recuder defined here                         #
               # @messages: messages to this point                        #

data/apps/novel/novel.rb

@@ -22,10 +22,10 @@ class Novel < MonadicApp
     }
     method = OpenAI.model_to_method(params["model"])
     case method
-    when "completions"
+    when RESEARCH_MODE
       tjson = TEMPLATES["normal/novel"]
       tmarkdown = TEMPLATES["research/novel"]
-    when "chat/completions"
+    when NORMAL_MODE
       tjson = TEMPLATES["normal/novel"]
       tmarkdown = nil
     end
@@ -37,7 +37,7 @@ class Novel < MonadicApp
           prop_newdata: "response",
           update_proc: proc do
             case method
-            when "completions"
+            when RESEARCH_MODE
               ############################################################
               # Research mode reduder defined here                       #
               # @messages: messages to this point                        #
@@ -51,7 +51,7 @@ class Novel < MonadicApp
 
               @metadata["turns"] = @metadata["turns"].to_i - 1 if conditions.all?
 
-            when "chat/completions"
+            when NORMAL_MODE
               ############################################################
               # Normal mode recuder defined here                         #
               # @messages: messages to this point                        #

data/apps/translate/translate.rb

@@ -26,10 +26,10 @@ class Translate < MonadicApp
     }
     method = OpenAI.model_to_method(params["model"])
     case method
-    when "completions"
+    when RESEARCH_MODE
       tjson = TEMPLATES["normal/translate"]
       tmarkdown = TEMPLATES["research/translate"]
-    when "chat/completions"
+    when NORMAL_MODE
       tjson = TEMPLATES["normal/translate"]
       tmarkdown = nil
     end
@@ -41,7 +41,7 @@ class Translate < MonadicApp
           prop_newdata: "response",
           update_proc: proc do
             case method
-            when "completions"
+            when RESEARCH_MODE
               ############################################################
               # Research mode reduder defined here                       #
               # @messages: messages to this point                        #
@@ -55,7 +55,7 @@ class Translate < MonadicApp
 
               @metadata["turns"] = @metadata["turns"].to_i - 1 if conditions.all?
 
-            when "chat/completions"
+            when NORMAL_MODE
               ############################################################
               # Normal mode recuder defined here                         #
               # @messages: messages to this point                        #