monadic-chat 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e590d4e06e923e510110868aaf97e6d00d94452de3711183a44453b5899af59f
-  data.tar.gz: 67e2e4ed103bc0ca06842ad6cd544558a8e0332782b4c2f07468effb6435074f
+  metadata.gz: 5ee0dcb302392e3e503b2f26a777953956a998244634c5935fc5be3e2316dc28
+  data.tar.gz: 1a42d5a6c02552ee676f89e338a8f7ff550b1905497cce42d0ba55e54c28038d
 SHA512:
-  metadata.gz: 39c32bbd0728520af652727f0c2d0ef8f0773bee409967bed7071e75dda4b8bff42c8d2eaf4e1ddb777374ef37ab1366e4584cda1ab56472144b6a2a48c7a874
-  data.tar.gz: 7a577baef5a59d20c98ec7978cd7aeb7aed8947c2b3f1b9b8f6dc4b1b91d1acc246b17e13cb8008fc0122d1c29b8660825214642640c3470b2fa449bc3b33ccf
+  metadata.gz: 1bca191c52aad2d0b2fd0de6dad2a806046e57546e038b9905d19a78e58047c3cd2e44dbc9fed69b88e648e3970290130d4350ec3fb94aa59b28baf8b07fbe46
+  data.tar.gz: 7e9e8a1752c11ff3a50de51ab20ab7f77c4a85b46c15134e253b42f6522b30be15b4cbb8cb8bb9ed52c96588a36d9c409cfb75cc14f28f686279324f468d1ded

data/CHANGELOG.md

@@ -8,3 +8,8 @@
 
 - Public release
 - Authentication problem fixed
+
+## [0.2.0] - 2023-03-13
+
+- Research mode architecture changed
+- Stability improvement

data/Gemfile.lock

@@ -0,0 +1,166 @@
+PATH
+  remote: .
+  specs:
+    monadic-chat (0.2.0)
+      http
+      kramdown
+      launchy
+      oj
+      parallel
+      pastel
+      rouge
+      tty-box
+      tty-cursor
+      tty-markdown
+      tty-progressbar
+      tty-prompt
+      tty-screen
+
+GEM
+  remote: https://rubygems.org/
+  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)
+      rake
+    http (5.1.1)
+      addressable (~> 2.8)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.4.0)
+    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)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.4)
+      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)
+      tty-cursor (~> 0.7)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-markdown (0.7.2)
+      kramdown (>= 1.16.2, < 3.0)
+      pastel (~> 0.8)
+      rouge (>= 3.14, < 5.0)
+      strings (~> 0.2.0)
+      tty-color (~> 0.5)
+      tty-screen (~> 0.8)
+    tty-progressbar (0.18.2)
+      strings-ansi (~> 0.2)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      unicode-display_width (>= 1.6, < 3.0)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    unf (0.1.4)
+      unf_ext
+    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
+  x86_64-darwin-22
+
+DEPENDENCIES
+  bundler
+  monadic-chat!
+  rake
+  rspec
+  solargraph
+
+BUNDLED WITH
+   2.4.1

data/README.md

@@ -7,7 +7,11 @@
 </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.
+> 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**
+
+- [March 13, 2023] Text on the architecture of the `research` mode updated in accordance with Version 0.2.0
 
 ## Table of Contents
 
@@ -80,7 +84,12 @@ Execute the following command in an environment where Ruby 2.6.10 or higher is i
 gem install monadic-chat
 ```
 
-To update the `monadic-chat` gem installed:
+Then run the command to start the app:
+```text
+monadic-chat
+```
+
+To update:
 
 ```text
 gem update monadic-chat
@@ -190,13 +199,7 @@ In `research` mode, it may take a while (usually several seconds) after the `dat
 
 All the information retrievable by running the `data/context` function can be presented in HTML. The HTML file is automatically opened in the default web browser.
 
-<br />
-
-<kbd><img src="./doc/img/linguistic-html.png" width="700px" style="border: thin solid darkgray;"/></kbd>
-
-<br />
-
-The generated HTML is saved in the user's home directory (`$HOME`) with the file name `monadic_chat.html`. The file contents does not automatically updated. Run `html` command every time when you need it. HTML data is written to this file regardless of the app.
+The generated HTML will be saved in the user’s home directory (`$HOME`) with the file `monadic_chat.html`. Once the `html` command is executed, the file contents will continue to be updated until you `reset` or quit the running app. Reload the browser tab or rerun the `html` command to show the latest data. HTML data is written to this file regardless of the app.
 
 In `research` mode, it may take several seconds to several minutes after the `html` command is executed before the acutual HTML is displayed. This is because in `research` mode, even after displaying a direct response to user input, there may be a process running in the background that retrieves and reconstructs the context data, requiring the system to wait for it to finish.
 
@@ -283,13 +286,13 @@ Sometimes, however, problematic translations are created. The user can "save" th
 
 ## Modes
 
-Monadic Chat has two modes. The `normal` mode utilizes OpenAI's chat API to achieve ChatGPT-like functionality. It is suitable for using a large language model as a competent companion for various pragmatic purposes. On the other hand, the `research` mode utilizes OpenAI's text-completion API. This mode allows for acquiring metadata in the background while receiving the primary response at each conversation turn. It may be especially useful for researchers exploring the possibilities of large-scale language models and their applications.
+Monadic Chat has two modes. The `normal` mode utilizes OpenAI's chat API to achieve ChatGPT-like functionality. It is suitable for using a large language model as a competent companion for various pragmatic purposes. On the other hand, the `research` mode utilizes OpenAI's text-completion API. This mode allows for acquiring **metadata** in the background while receiving the primary response at each conversation turn. It may be especially useful for researchers exploring the possibilities of large-scale language models and their applications.
 
 ### Normal Mode
 
 The default language model for `normal` mode is `gpt-3.5-turbo`.
 
-In the default configuration, the dialogue messages are reduced after ten turns by deleting the oldest ones (but not the messages that the `system` role gave as instructions).
+In the default configuration, the dialogue messages are reduced after ten turns by deleting the oldest ones (but not the messages that the `system` role has given as instructions).
 
 ### Research Mode
 
@@ -353,7 +356,9 @@ Terms in bold in it may require more explanation.
 ]}
 ```
 
-The accumulator in `research` mode also looks like this.
+The accumulator in `research` mode also looks like this. 
+
+The conversation history is kept entirely in memory until the running app is terminated or reset. The part of the conversation history sent through the API along with new input sentences is referred to here as the accumulator.
 
 ### Reducer
 
@@ -395,11 +400,20 @@ 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="300px" />
 
 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.
 
+Below is a sample HTML displaying the conversation (sentence and its syntactic structure notation pairs) and metadata.
+
+<br />
+
+<kbd><img src="./doc/img/linguistic-html.png" width="700px" style="border: thin solid darkgray;"/></kbd>
+
+<br />
+
+
+
 ### File Structure
 
 New Monadic Chat apps must be placed inside the `apps` folder. The folders and files for default apps `chat`, `code`, `novel`, and `translate` are also in this folder.
@@ -437,16 +451,14 @@ apps
 The purpose of each file is as follows.
 
 - `linguistic.rb`: Ruby code to define the "reducer"
-- `linguistic.json`: JSON template describing GPT behavior in `normal` mode
-- `linguistic.md`: Markdown template describing GPT behavior in `research` mode
-
-The `.rb` file is required, but you may create both `.json` and `.md` files, or only one of them.
+- `linguistic.json`: JSON template describing GPT behavior in `normal` and `research` modes
+- `linguistic.md`: Markdown template describing GPT behavior in addition to the `json` file above in `research` mode
 
 Template files with a name beginning with `_` are also ignored. If a folder has a name beginning with `_`, all its contents are ignored. 
 
 ### Reducer Code
 
-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 so that it matches the app name. We save it as `apps/linguistic/linguistic.rb`.
+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
 
@@ -481,10 +493,13 @@ Below we will look at the `research` mode template for the `linguistic` app, sec
 
 **Main Section**
 
-<div style="highlight highlight-source-gfm"><pre style="white-space : pre-wrap !important;">You are a natural language syntactic/semantic/pragmatic analyzer. Analyze the new prompt from the user below and execute a syntactic parsing. Give your response in a variation of the penn treebank format, but use brackets [ ] instead of parentheses ( ). Also, give your response in a markdown code span. The sentence must always be parsed if the user's input sentence is enclosed in double quotes. Create a response to the following new prompt from the user and set your response to the "response" property of the JSON object below. All prompts by "user" in the "messages" property are continuous in content.
-</pre></div>
+<div style="highlight highlight-source-gfm"><pre style="white-space : pre-wrap !important;">{{SYSTEM}
+
+All prompts by "user" in the "messages" property are continuous in content.You are an English syntactic/semantic/pragmatic analyzer. Analyze the new prompt from the user below and execute a syntactic parsing. Give your response in a variation of the penn treebank format, but use brackets [ ] instead of parentheses ( ). Also, give your response in a markdown code span. The sentence must always be parsed if the user's input sentence is enclosed in double quotes. Let the user know if parsing the sentence is difficult or the input must be enclosed in double quotes. 
 
-The text here is the same as the text in the template for the `normal` mode in an instruction message by the `system`. However, note that it contains an instruction that the response from GPT should be presented in the form of a JSON object, as shown in one of the following sections. 
+Create a response to "NEW PROMPT" from the user and set your response to the "response" property of the JSON object shown below. The preceding conversation is stored in "PAST MESSAGES". In "PAST MESSAGES", "assistant" refers to you.</pre></div>
+
+Some of the text here is the same as the text of the directive message by `system` in the template in `normal` mode; Monadic Chat automatically replaces `{{SYSTEM}}} with the `system` directive text when the template is sent via API. However, the above text also includes a few additional paragpraphs, including the one instructing the response from GPT to be presented as a JSON object.
 
 **New Prompt**
 
@@ -492,7 +507,16 @@ The text here is the same as the text in the template for the `normal` mode in a
 NEW PROMPT: {{PROMPT}}
 ```
 
-Monadic Chat replaces `{{PROMPT}}` with input from the user when sending templates through the API.
+Monadic Chat replaces `{{PROMPT}}` with input from the user when sending the template through the API.
+
+**Past Messages**
+
+```markdown
+PAST MESSAGES:
+{{MESSAGES}}
+```
+
+Monadic Chat replaces `{{MESSAGES}}` with messages from past conversations when sending the template. Note that not all the past messages have to be copied here: the reducer mechanism could select, modify, or even "generate" messages and include them instead.
 
 **JSON Object**
 
@@ -501,15 +525,11 @@ Monadic Chat replaces `{{PROMPT}}` with input from the user when sending templat
   "prompt": "\"We didn't have a camera.\"",
   "response": "`[S [NP We] [VP [V didn't] [VP [V have] [NP [Det a] [N camera] ] ] ] ] ]`\n\n###\n\n",
   "mode": "linguistic",
-  "turns": 2,
+  "tokens": 351
+  "turns": 3,
   "sentence_type": ["declarative"],
   "sentiment": ["sad"],
   "summary": "The user saw a beautiful sunset, but did not take a picture because the user did not have a camera.",
-  "tokens": 351,
-  "messages": [{"user": "\"We saw a beautiful sunset.\"", "assistant": "`[S [NP He] [VP [V saw] [NP [det a] [N' [Adj beautiful] [N sunset] ] ] ] ]`\n\n###\n\n" },
-               {"user": "\"We didn't take a picture.\"", "assistant": "`[S [NP We] [IP [I didn't] [VP [V take] [NP [Det a] [N picture] ] ] ] ] ]`\n\n###\n\n" },
-               {"user": "\"We didn't have a camera.\"", "assistant": "`[S [NP We] [IP [I didn't] [VP [V have] [NP [Det a] [N camera] ] ] ] ] ]`\n\n###\n\n" }
-              ]
 }
 ```
 
@@ -517,15 +537,20 @@ 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
-    {
-      "prompt": ...
-      ...
-      "messages": ...
-    }
-    ```
+```json
+ ```json
+ {
+   "prompt": ...
+   "response": ...
+   "mode": ...
+   "tokens": ...
+   "turns": ...
+   ...
+ }
+ ```
+```
 
-The required properties of this JSON object are `prompt`, `response`, and `messages`. Other properties are optional. The format of the `messages` property is similar to that of the `normal` mode (i.e., OpenAI's chat API. The only difference is that it is structured as a list of objects whose keys are user and assistant to make it easier to describe.)
+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.
 
 The JSON object in the `research` mode template is saved in the user’s home directory (`$HOME`) with the file `monadic_chat.json`. The content is overwritten every time the JSON object is updated. Note that this JSON file is created for logging purposes (so the data is not pretty printed). Modifying its content does not affect the processes carried out by the app.
 
@@ -536,13 +561,12 @@ Make sure the following content requirements are all fulfilled:
 
 - keep the value of the "mode" property at "linguistic"
 - set the new prompt to the "prompt" property
-- create your response to the new prompt in accordance with the "messages" and set it to "response"
-- insert both the new prompt and the response after all the existing items in the "messages"
+- create your response to the new prompt based on "PAST MESSAGES" and set it to "response"
 - analyze the new prompt's sentence type and set a sentence type value such as "interrogative", "imperative", "exclamatory", or "declarative" to the "sentence_type" property
 - analyze the new prompt's sentiment and set one or more sentiment types such as "happy", "excited", "troubled", "upset", or "sad" to the "sentiment" property
-- summarize the user's messages so far and update the "summary" property with a text of fewer than 100 words.
+- summarize the user's messages so far and update the "summary" property with a text of fewer than 100 words using as many discourse markers such as "because", "therefore", "but", and "so" to show the logical connection between the events.
 - update the value of "tokens" with the number of tokens of the resulting JSON object"
-- increment the value of "turns" by 1 and update the property so that the value of "turns" equals the number of the items in the "messages" of the resulting JSON object
+- increment the value of "turns" by 1
 ```
 
 Note that all the properties of the JSON object above are mentioned so that GPT can update them accordingly.
@@ -554,6 +578,7 @@ Make sure the following formal requirements are all fulfilled:
 
 - do not use invalid characters in the JSON object
 - escape double quotes and other special characters in the text values in the resulting JSON object
+- check the validity of the generated JSON object and correct any possible parsing problems before returning it 
 
 Add "\n\n###\n\n" at the end of the "response" value.
 

data/apps/chat/chat.json

@@ -1,4 +1,4 @@
 {"messages": [
   {"role": "system",
-   "content": "You are a friendly but professional consultant who answers various questions, write computer program code, make decent suggestions, give helpful advice in response to a prompt from the user. If the prompt is not clear enough, ask the user to rephrase it. You are able to empathize with the user; insert an emoji (displayable on the terminal screen) that you deem appropriate for the user's input at the beginning of your response. If the user input is sentimentally neutral, pick up any emoji that matchs the topic."}
+   "content": "You are a friendly but professional consultant who answers various questions, writes computer program code, makes decent suggestions, and gives helpful advice in response to a prompt from the user. If the prompt is not clear enough, ask the user to rephrase it. You are able to empathize with the user; insert an emoji (displayable on the terminal screen) that you deem appropriate for the user's input at the beginning of your response. If the user input is sentimentally neutral, pick up any emoji that matches the topic."}
 ]}

data/apps/chat/chat.md

@@ -1,19 +1,24 @@
-You are a friendly but professional AI assistant capable of answering various questions, writing computer program code, making decent suggestions, and giving helpful advice in response to a new prompt from the user. If the prompt is not clear enough, ask the user to rephrase it. You are able to empathize with the user; insert a unicode emoji (one that is displayable on the terminal screen) that you deem appropriate for the user's input at the beginning of your response. If the user input is sentimentally neutral, pick up any emoji that matchs the topic. Create a response to the following new prompt from the user and set your response to the "response" property of the JSON object shown below. The preceding conversation is stored in the value of the "conversation" property.
+{{SYSTEM}}
 
-Make your response as detailed as possible.
+Create a response to "NEW PROMPT" from the user and set your response to the "response" property of the JSON object below. The preceding conversation is stored in "PAST MESSAGES".
+ The preceding conversation is stored in "PAST MESSAGES". In "PAST MESSAGES", "assistant" refers to you. Make your response as detailed as possible.
 
 NEW PROMPT: {{PROMPT}}
 
+PAST MESSAGES:
+{{MESSAGES}}
+
+JSON:
+
 ```json
 {
   "prompt": "Can I ask something?",
   "response": "Sure!\n\n###\n\n",
   "mode": "chat",
-  "turns": 1,
+  "turns": 0,
   "language": "English",
   "topics": [],
-  "tokens": 109,
-  "messages": [{"user": "Can I ask something?", "assistant": "Sure!\n\n###\n\n"}]
+  "tokens": 109
 }
 ```
 
@@ -21,12 +26,11 @@ Make sure the following content requirements are all fulfilled:
 
 - keep the value of the "mode" property at "chat"
 - set the new prompt to the "prompt" property
-- create your response to the new prompt in accordance with the "messages" and set it to "response"
-- insert both the new prompt and the response after all the existing items in the "messages"
+- create your response to the new prompt based on the PAST MESSAGES and set it to "response"
 - if the new prompt is in a language other than the current value of "language", set the name of the new prompt language to "language" and make sure that "response" is in that language
 - make your response in the same language as the new prompt
 - analyze the topic of the new prompt and insert it at the end of the value list of the "topics" property
-- avoid giving a response that is the same or similar to one of the previous responses in "messages"
+- avoid giving a response that is the same or similar to one of the previous responses in PAST MESSAGES
 - program code in the response must be embedded in a code block in the markdown text
 - update the value of "tokens" with the number of tokens of the resulting JSON object"
 
@@ -34,9 +38,8 @@ Make sure the following formal requirements are all fulfilled:
 
 - do not use invalid characters in the JSON object
 - escape double quotes and other special characters in the text values in the resulting JSON object
-- increment the value of "turns" by 1 and update the property so that the value of "turns" equals the number of the items in the "messages" of the resulting JSON object
+- increment the value of "turns" by 1
 - check the validity of the generated JSON object and correct any possible parsing problems before returning it 
-
 Add "\n\n###\n\n" at the end of the "response" value.
 
 Wrap the JSON object with "<JSON>\n" and "\n</JSON>".

data/apps/chat/chat.rb

@@ -21,56 +21,54 @@ class Chat < MonadicApp
       "stop" => nil
     }
     method = OpenAI.model_to_method(params["model"])
-    template = case method
-               when "completions"
-                 TEMPLATES["research/chat"]
-               when "chat/completions"
-                 TEMPLATES["normal/chat"]
-               end
-    super(params,
-          template,
-          {},
-          "messages",
-          "response",
-          proc do |res|
+    case method
+    when "completions"
+      tjson = TEMPLATES["normal/chat"]
+      tmarkdown = TEMPLATES["research/chat"]
+    when "chat/completions"
+      tjson = TEMPLATES["normal/chat"]
+      tmarkdown = nil
+    end
+    super(params: params,
+          tjson: tjson,
+          tmarkdown: tmarkdown,
+          placeholders: {},
+          prop_accumulator: "messages",
+          prop_newdata: "response",
+          update_proc: proc do
             case method
             when "completions"
-              obj = objectify
               ############################################################
-              # Research mode recuder defined here                       #
-              # obj: old Hash object                                     #
-              # res: new response Hash object to be modified             #
+              # Research mode reduder defined here                       #
+              # @messages: messages to this point                        #
+              # @metadata: currently available metdata sent from GPT     #
               ############################################################
+
               conditions = [
-                res["messages"].size > 1,
-                res["tokens"].to_i > params["max_tokens"].to_i / 2,
-                !obj["topics"].empty?,
-                res["topics"] != obj["topics"]
+                @messages.size > 1,
+                @metadata["tokens"].to_i > params["max_tokens"].to_i / 2
               ]
-              if conditions.all?
-                res["messages"].shift(1)
-                res["turns"] = res["turns"].to_i - 1
-              end
-              res
+
+              @metadata["turns"] = @metadata["turns"].to_i - 1 if conditions.all?
+
             when "chat/completions"
-              # obj = objectify
               ############################################################
               # Normal mode recuder defined here                         #
-              # obj: old Hash object (uncomment a line above before use) #
-              # res: new response Hash object to be modified             #
+              # @messages: messages to this point                        #
               ############################################################
+
               conditions = [
-                res.size > @num_retained_turns * 2 + 1
+                @messages.size > @num_retained_turns * 2 + 1
               ]
+
               if conditions.all?
-                res.each_with_index do |ele, i|
+                @messages.each_with_index do |ele, i|
                   if ele["role"] != "system"
-                    res.delete_at i
+                    @messages.delete_at i
                     break
                   end
                 end
               end
-              res
             end
           end
          )

data/apps/code/code.json

@@ -1,4 +1,8 @@
 {"messages": [
   {"role": "system",
-   "content": "You are a friendly but professional software engineer who answers various questions, write computer program code, make decent suggestions, give helpful advice in response to a prompt from the user."}
+   "content": "You are a friendly but professional software engineer who answers various questions, writes computer program code, makes decent suggestions, and gives helpful advice in response to a prompt from the user."},
+   {"role": "user",
+   "content": "Can I ask something?"},
+   {"role": "assistant",
+   "content": "Sure!"}
 ]}

data/apps/code/code.md

@@ -1,8 +1,13 @@
-You are a friendly but professional computer software assistant capable of answering various questions, writing computer program code, making decent suggestions, and giving helpful advice in response to a new prompt from the user. Create a detailed response to the following new prompt from the user and set your response to the "response" property of the JSON object shown below. The preceding context is stored in the value of the "messages" property. Always try to make your response relavant to the preceding context.
+{{SYSTEM}}
+
+Create a response "NEW PROMPT" from the user and set your response to the "response" property of the JSON object shown below. In "PAST MESSAGES", "assistant" refers to you. Make your response as detailed as possible.
 
 NEW PROMPT: {{PROMPT}}
 
-Make your response as detailed as possible.
+PAST MESSAGES:
+{{MESSAGES}}
+
+JSON:
 
 ```json
 {
@@ -12,8 +17,7 @@ Make your response as detailed as possible.
   "turns": 1,
   "language": "English",
   "topics": [],
-  "tokens": 109,
-  "messages": [{"user": "Can I ask something?", "assistant": "Sure!\n\n###\n\n"}]
+  "tokens": 109
 }
 ```
 
@@ -21,12 +25,11 @@ Make sure the following content requirements are all fulfilled:
 
 - keep the value of the "mode" property at "chat"
 - set the new prompt to the "prompt" property
-- create your response to the new prompt in accordance with the "messages" and set it to "response"
-- insert both the new prompt and the response after all the existing items in the "messages"
+- create your response to the new prompt based on "PAST MESSAGES" and set it to "response"
 - if the prompt is in a language other than the current value of "language", set the name of the new prompt language to "language" and make sure that "response" is in that language
 - make your response in the same language as the new prompt
 - analyze the topic of the new prompt and insert it at the end of the value list of the "topics" property
-- avoid giving a response that is the same or similar to one of the previous responses in "messages"
+- avoid giving a response that is the same or similar to one of the previous responses in "PAST MESSAGES"
 - program code in the response must be embedded in a code block in the markdown text
 - update the value of "tokens" with the number of tokens of the resulting JSON object"
 
@@ -34,7 +37,7 @@ Make sure the following formal requirements are all fulfilled:
 
 - do not use invalid characters in the JSON object
 - escape double quotes and other special characters in the text values in the resulting JSON object
-- increment the value of "turns" by 1 and update the property so that the value of "turns" equals the number of the items in the "messages" of the resulting JSON object
+- increment the value of "turns" by 1
 - check the validity of the generated JSON object and correct any possible parsing problems before returning it 
 
 Add "\n\n###\n\n" at the end of the "response" value.