-
-
Notifications
You must be signed in to change notification settings - Fork 53
/
org-ai.el
248 lines (215 loc) · 10.2 KB
/
org-ai.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
;;; org-ai.el --- Use ChatGPT and other LLMs in org-mode and beyond -*- lexical-binding: t; -*-
;; Copyright (C) 2023, 2024 Robert Krahn
;; Author: Robert Krahn <[email protected]>
;; URL: https://github.com/rksm/org-ai
;; Version: 0.5.1
;; Package-Requires: ((emacs "27.1") (websocket "1.15"))
;; This file is NOT part of GNU Emacs.
;; org-ai.el is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; org-ai.el is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with org-ai.el.
;; If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; Provides a minor-mode for org-mode and a global minor-mode that allows you to
;; interact with the OpenAI API, with Stable Diffusion, as well as various local LLMs.
;;
;; It allows you to:
;; - "chat" with a language model from within an org mode buffer
;; - generate images
;; - has support for speech input and output
;; - #+begin_ai..#+end_ai blocks for org-mode
;; - various commands usable everywhere
;;
;; See see https://github.com/rksm/org-ai for the full set of features and setup
;; instructions.
;;
;; At the minimum, you will want something like:
;;
;; (use-package org-ai
;; :ensure
;; :commands (org-ai-mode org-ai-global-mode)
;; :init
;; (add-hook 'org-mode-hook #'org-ai-mode)
;; (org-ai-global-mode))
;;
;; You will need an OpenAI API key. It can be stored in the format
;; machine api.openai.com login org-ai password <your-api-key>
;; in your ~/.authinfo.gpg file (or other auth-source) and will be picked up
;; when the package is loaded.
;;
;; For the speech input/output setup please see
;; https://github.com/rksm/org-ai/blob/master/README.md#setting-up-speech-input--output
;;
;; Available commands:
;;
;; - Inside org-mode / #+begin_ai..#+end_ai blocks:
;; - C-c C-c to send the text to the OpenAI API and insert a response
;; - Press C-c <backspace> (org-ai-kill-region-at-point) to remove the chat part under point.
;; - org-ai-mark-region-at-point will mark the region at point.
;; - org-ai-mark-last-region will mark the last chat part.
;;
;; - Speech input/output. Talk with your AI!
;; - In org-mode / #+begin_ai..#+end_ai blocks:
;; - C-c r to record and transcribe speech via whisper.el in org blocks.
;; - Everywhere else:
;; - Enable speech input with org-ai-talk-input-toggle for other commands (see below).
;; - Enable speech output with org-ai-talk-output-enable. Speech output uses os internal speech synth (macOS) or espeak otherwise.
;; - See [Setting up speech input / output](#setting-up-speech-input--output) below for more details.
;;
;; - Non-org-mode commands
;; - org-ai-on-region: Ask a question about the selected text or tell the AI to do something with it.
;; - org-ai-refactor-code: Tell the AI how to change the selected code, a diff buffer will appear with the changes.
;; - org-ai-on-project: Query / modify multiple files at once. Will use projectile if available.
;; - org-ai-prompt: prompt the user for a text and then print the AI's response in current buffer.
;; - org-ai-summarize: Summarize the selected text.
;; - org-ai-explain-code: Explain the selected code.
;;
;; - org-ai-open-account-usage-page show how much money you burned.
;; - org-ai-install-yasnippets install snippets for #+begin_ai..#+end_ai blocks.
;; - org-ai-open-request-buffer for debugging, open the request buffer.
;;; Code:
(require 'org-ai-block)
(require 'org-ai-openai)
(require 'org-ai-openai-image)
(require 'org-ai-useful)
(require 'org-ai-on-project)
(require 'org-ai-talk)
(require 'org-ai-sd)
(require 'org-ai-oobabooga)
;; -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
(defun org-ai-ctrl-c-ctrl-c ()
"This is added to `org-ctrl-c-ctrl-c-hook' to enable the `org-mode' integration."
(when-let ((context (org-ai-special-block)))
(org-ai-complete-block)
t))
(defun org-ai-complete-block ()
"Main command which is normally bound to \\[org-ai-complete-block].
When you are inside an #+begin_ai...#+end_ai block, it will send
the text content to the OpenAI API and replace the block with the
result."
(interactive)
(let* ((context (org-ai-special-block))
(info (org-ai-get-block-info context))
(content (org-ai-get-block-content context))
(req-type (org-ai--request-type info))
(sys-prompt-for-all-messages (or (not (eql 'x (alist-get :sys-everywhere info 'x)))
(org-entry-get-with-inheritance "SYS-EVERYWHERE")
org-ai-default-inject-sys-prompt-for-all-messages))
(default-system-prompt (or (org-entry-get-with-inheritance "SYS")
org-ai-default-chat-system-prompt)))
(cl-case req-type
(completion (org-ai-stream-completion :prompt content
:context context))
(image (org-ai-create-and-embed-image context))
(sd-image (org-ai-create-and-embed-sd context))
(local-chat (org-ai-oobabooga-stream :messages (org-ai--collect-chat-messages
content
default-system-prompt
sys-prompt-for-all-messages)
:context context))
(t (org-ai-stream-completion :messages (org-ai--collect-chat-messages
content
default-system-prompt
sys-prompt-for-all-messages)
:context context)))))
(defun org-ai-expand-block (&optional context)
"Show a temp buffer with what the org-ai block expands to.
This is what will be sent to the api. CONTEXT is the org-ai block."
(interactive)
(let* ((context (or context (org-ai-special-block)))
(expanded (org-ai-get-block-content context)))
(if (called-interactively-p 'any)
(let ((buf (get-buffer-create "*Org-Ai Preview*")))
(with-help-window buf (with-current-buffer buf
(insert expanded))))
expanded)))
;; -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
;; keyboard quit
(defvar org-ai-talk--reading-process)
(defun org-ai-keyboard-quit ()
"Keyboard quit advice.
It's designed to \"do the right thing\":
- If there is an active region, do nothing (normal \\<mapvar> & \\[keyboard-quit] will deactivate it).
- If there is speech recorded or played, stop it.
- If there is currently a running openai request, stop it."
(interactive)
(condition-case _
(cond
((region-active-p) nil)
((and (boundp 'org-ai-talk--reading-process)
(fboundp 'org-ai-talk-stop)
org-ai-talk--reading-process
(process-live-p org-ai-talk--reading-process))
(org-ai-talk-stop))
(org-ai-oobabooga--current-request
(org-ai-oobabooga-stop))
(org-ai--current-request-buffer-for-stream
(org-ai-interrupt-current-request))
(org-ai--current-request-buffer
(org-ai-interrupt-current-request))
(org-ai--current-request-buffer-for-image
(org-ai-image-interrupt-current-request)))
(error nil)))
(defun org-ai--install-keyboard-quit-advice ()
"Cancel current request when `keyboard-quit' is called."
(unless (advice-member-p #'org-ai-keyboard-quit 'keyboard-quit)
(advice-add 'keyboard-quit :before #'org-ai-keyboard-quit)))
(defun org-ai--uninstall-keyboard-quit-advice ()
"Remove the advice that cancels current request when `keyboard-quit' is called."
(advice-remove 'keyboard-quit #'org-ai-keyboard-quit))
;; -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
(defvar org-ai-mode-map (make-sparse-keymap)
"Keymap for `org-ai-mode'.")
(let ((map org-ai-mode-map))
(define-key map (kbd "C-c M-a v") 'org-ai-image-variation)
(define-key map (kbd "C-c M-a $") 'org-ai-open-account-usage-page)
(define-key map (kbd "C-c M-a SPC") 'org-ai-mark-region-at-point)
(define-key map (kbd "C-c DEL") 'org-ai-kill-region-at-point)
(define-key map (kbd "C-c <backspace>") 'org-ai-kill-region-at-point)
(define-key map (kbd (string-join (list "C-c" " r"))) 'org-ai-talk-capture-in-org)) ; C-c r ¯\_(ツ)_/¯
;; create a minor-mode for org-mode
(define-minor-mode org-ai-mode
"Minor mode for `org-mode' integration with the OpenAI API."
:init-value nil
:lighter " org-ai"
:keymap org-ai-mode-map
:group 'org-ai
(add-hook 'org-ctrl-c-ctrl-c-hook #'org-ai-ctrl-c-ctrl-c nil t))
(org-ai--install-keyboard-quit-advice)
;; -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
(defvar org-ai-global-prefix-map (make-sparse-keymap)
"Keymap for `org-ai-global-mode'.")
(let ((map org-ai-global-prefix-map))
(define-key map (kbd "p") 'org-ai-on-project)
(define-key map (kbd "P") 'org-ai-prompt-in-new-buffer)
(define-key map (kbd "r") 'org-ai-on-region)
(define-key map (kbd "c") 'org-ai-refactor-code)
(define-key map (kbd "s") 'org-ai-summarize)
(define-key map (kbd "m") 'org-ai-switch-chat-model)
(define-key map (kbd "!") 'org-ai-open-request-buffer)
(define-key map (kbd "$") 'org-ai-open-account-usage-page)
(define-key map (kbd "t") 'org-ai-talk-input-toggle)
(define-key map (kbd "T") 'org-ai-talk-output-toggle)
(define-key map (kbd "R") 'org-ai-talk-read-region)
(define-key map (kbd "SPC") 'org-ai-mark-region-at-point))
(defvar org-ai-global-mode-map (make-sparse-keymap)
"Keymap for `org-ai-global-mode'.")
(define-key org-ai-global-mode-map (kbd "C-c M-a") org-ai-global-prefix-map)
;;;###autoload
(define-minor-mode org-ai-global-mode
"Non `org-mode' specific minor mode for the OpenAI API."
:init-value nil
:lighter ""
:global t
:keymap org-ai-global-mode-map
:group 'org-ai)
;; -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
(provide 'org-ai)
;;; org-ai.el ends here