From e105a52541caf41e7ebdafa1aa8afa7bc07e958d Mon Sep 17 00:00:00 2001 From: Karthik Chikmagalur Date: Fri, 15 Dec 2023 09:42:37 -0800 Subject: [PATCH] gptel: Update docstrings for prompt/response prefixes README: Mention `gptel-response-prefix-alist` gptel.el (gptel-prompt-prefix-alist, gptel-response-prefix-alist): Improve docstring. --- README.org | 15 ++++++++------- gptel.el | 10 ++++++++-- 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/README.org b/README.org index c122f84..9fa9bf6 100644 --- a/README.org +++ b/README.org @@ -305,13 +305,14 @@ These are packages that depend on GPTel to provide additional functionality | =gptel-temperature= | Randomness in response text, 0 to 2. | |---------------------------+---------------------------------------------------------------------| -|---------------------------+---------------------------------------------------------------------| -| *Chat UI options* | | -|---------------------------+---------------------------------------------------------------------| -| =gptel-default-mode= | Major mode for dedicated chat buffers. | -| =gptel-prompt-prefix-alist= | Text demarcating queries and replies. | -|---------------------------+---------------------------------------------------------------------| - +|-----------------------------+----------------------------------------| +| *Chat UI options* | | +|-----------------------------+----------------------------------------| +| =gptel-default-mode= | Major mode for dedicated chat buffers. | +| =gptel-prompt-prefix-alist= | Text inserted before queries. | +| =gptel-response-prefix-alist= | Text inserted before responses. | +|-----------------------------+----------------------------------------| + ** Why another LLM client? Other Emacs clients for LLMs prescribe the format of the interaction (a comint shell, org-babel blocks, etc). I wanted: diff --git a/gptel.el b/gptel.el index 7f9ddb1..0f9bdf9 100644 --- a/gptel.el +++ b/gptel.el @@ -228,7 +228,10 @@ defaults to `text-mode'." '((markdown-mode . "### ") (org-mode . "*** ") (text-mode . "### ")) - "String inserted after the response from ChatGPT. + "String used as a prefix to the query being sent to the LLM. + +This is meant for the user to distinguish between queries and +responses, and is removed from the query before it is sent. This is an alist mapping major modes to the prefix strings. This is only inserted in dedicated gptel buffers." @@ -239,7 +242,10 @@ is only inserted in dedicated gptel buffers." '((markdown-mode . "") (org-mode . "") (text-mode . "")) - "String inserted after the response from ChatGPT. + "String inserted before the response from the LLM. + +This is meant for the user to distinguish between queries and +responses. This is an alist mapping major modes to the reply prefix strings. This is only inserted in dedicated gptel buffers before the AI's response."