-
Notifications
You must be signed in to change notification settings - Fork 189
/
Copy pathgptel-transient.el
1453 lines (1306 loc) · 57.4 KB
/
gptel-transient.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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; gptel-transient.el --- Transient menu for GPTel -*- lexical-binding: t; -*-
;; Copyright (C) 2023 Karthik Chikmagalur
;; Author: Karthik Chikmagalur <karthikchikmagalur@gmail.com>
;; Keywords: convenience
;; SPDX-License-Identifier: GPL-3.0-or-later
;; This program 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.
;; This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;;
;;; Code:
(require 'cl-lib)
(require 'gptel)
(require 'transient)
(declare-function ediff-regions-internal "ediff")
(declare-function ediff-make-cloned-buffer "ediff-utils")
;; * Helper functions and vars
(defvar-local gptel--rewrite-overlays nil
"List of active rewrite overlays in the buffer.")
(defun gptel--rewrite-sanitize-overlays ()
"Ensure gptel's rewrite overlays in buffer are consistent."
(setq gptel--rewrite-overlays
(cl-delete-if-not #'overlay-buffer
gptel--rewrite-overlays)))
(defvar gptel--set-buffer-locally nil
"Set model parameters from `gptel-menu' buffer-locally.
Affects the system message too.")
(defun gptel--set-with-scope (sym value &optional scope)
"Set SYMBOL's symbol-value to VALUE with SCOPE.
If SCOPE is t, set it buffer-locally.
If SCOPE is 1, reset it after the next gptel-request. (oneshot)
Otherwise, clear any buffer-local value and set its default
global value."
(pcase scope
(1 (put sym 'gptel-history (symbol-value sym))
(set sym value)
(letrec ((restore-value
(lambda ()
(remove-hook 'gptel-post-request-hook restore-value)
(run-at-time ; Required to work around let bindings
0 nil (lambda (s) ; otherwise this change is overwritten!
(set s (get s 'gptel-history))
(put s 'gptel-history nil))
sym))))
(add-hook 'gptel-post-request-hook restore-value)))
('t (set (make-local-variable sym) value))
(_ (kill-local-variable sym)
(set sym value))))
(defun gptel--get-directive (args)
"Find the additional directive in the transient ARGS.
Meant to be called when `gptel-menu' is active."
(cl-some (lambda (s) (and (stringp s) (string-prefix-p ":" s)
(substring s 1)))
args))
(defun gptel--instructions-make-overlay (text &optional ov)
"Make or move overlay OV with TEXT."
(save-excursion
;; Move point to overlay position
(cond
((use-region-p)
(if (pos-visible-in-window-p (region-beginning))
(goto-char (region-beginning))))
((gptel--in-response-p)
(gptel-beginning-of-response)
(skip-chars-forward "\n \t"))
(t (text-property-search-backward 'gptel 'response)
(skip-chars-forward "\n \t")))
;; Make overlay
(if (and ov (overlayp ov))
(move-overlay ov (point) (point) (current-buffer))
(setq ov (make-overlay (point) (point) nil t)))
(overlay-put ov 'before-string nil)
;; (unless (or (bobp) (eq (char-before) "\n"))
;; (overlay-put ov 'before-string (propertize "\n" 'font-lock-face 'shadow)))
(overlay-put ov 'category 'gptel)
(overlay-put
ov 'after-string
(concat (propertize (concat "DIRECTIVE: " text)
'font-lock-face '(:inherit shadow :weight bold :box t))
"\n"))
ov))
(defconst gptel--read-with-prefix-help
(concat
(propertize "(" 'face 'default)
(propertize "TAB" 'face 'help-key-binding)
(propertize " to expand, " 'face 'default)
(propertize "M-n" 'face 'help-key-binding)
(propertize "/" 'face 'default)
(propertize "M-p" 'face 'help-key-binding)
(propertize " for next/previous): " 'face 'default))
"Help string ;TODO: ")
(defun gptel--read-with-prefix (prefix)
"Show string PREFIX in the minibuffer after the minibuffer prompt.
PREFIX is shown in an overlay. Repeated calls to this function
will toggle its visibility state."
(unless (minibufferp)
(user-error "This command is intended to be used in the minibuffer."))
(let* ((update
(lambda (ov s)
(overlay-put
ov 'after-string
(and s (concat (propertize (concat "\n" s "\n") 'face 'shadow)
(make-separator-line))))))
(max-width (- (window-width) (minibuffer-prompt-end)))
(max (or max-mini-window-height 0.4))
(max-height (- (or (and (natnump max) max)
(floor (* max (frame-height))))
5)))
(when (and prefix (not (string-empty-p prefix)) (> max-height 1))
(unless visual-line-mode (visual-line-mode 1))
(goto-char (minibuffer-prompt-end))
(pcase-let ((`(,prop . ,ov)
(get-char-property-and-overlay
(point-min) 'gptel)))
(unless ov
(setq ov (make-overlay
(point-min) (minibuffer-prompt-end) nil t)))
(pcase prop
('partial
(if (> (length prefix) max-width)
(progn
(overlay-put ov 'gptel 'prefix)
(let ((disp-size
(cl-loop for char across prefix
for idx upfrom 0
with n = 0 with max-length = (* max-height max-width)
if (eq char ?\n) do (cl-incf n)
if (> n max-height) return idx
if (> idx max-length)
return idx
finally return nil)))
(funcall update ov
(if disp-size
(truncate-string-to-width
prefix disp-size nil nil 'ellipsis)
prefix))))
(overlay-put ov 'gptel 'hide)
(funcall update ov nil)))
('prefix (overlay-put ov 'gptel 'hide)
(funcall update ov nil))
(_ (overlay-put ov 'gptel 'partial)
(funcall update ov (truncate-string-to-width
prefix max-width nil nil
'ellipsis))))))))
(defun gptel--transient-read-variable (prompt initial-input history)
"Read value from minibuffer and interpret the result as a Lisp object.
PROMPT, INITIAL-INPUT and HISTORY are as in the Transient reader
documention."
(ignore-errors
(read-from-minibuffer prompt initial-input read-expression-map t history)))
(defun gptel-system-prompt--format (&optional message)
"Format the system MESSAGE for display in gptel's transient menus.
Handle formatting for system messages when the active
`gptel-model' does not support system messages."
(setq message (or message gptel--system-message))
(if (gptel--model-capable-p 'nosystem)
(concat (propertize "[No system message support for model "
'face 'transient-heading)
(propertize (gptel--model-name gptel-model)
'face 'warning)
(propertize "]" 'face 'transient-heading))
(if message
(gptel--describe-directive
message (max (- (window-width) 12) 14) "⮐ ")
"[No system message set]")))
(defun gptel--tools-init-value (obj)
"Set the initial state of a tool OBJ in `gptel-tools'.
OBJ is a tool-infix of type `gptel--switch'."
(when-let* ((name (car (member (oref obj argument)
(mapcar #'gptel-tool-name gptel-tools)))))
(oset obj value (list (oref obj category) name))))
(defvar gptel--crowdsourced-prompts-url
"https://raw.githubusercontent.com/f/awesome-chatgpt-prompts/main/prompts.csv"
"URL for crowdsourced LLM system prompts.")
(defvar gptel--crowdsourced-prompts
(make-hash-table :test #'equal)
"Crowdsourced LLM system prompts.")
(defun gptel--crowdsourced-prompts ()
"Acquire and read crowdsourced LLM system prompts.
These are stored in the variable `gptel--crowdsourced-prompts',
which see."
(when (hash-table-p gptel--crowdsourced-prompts)
(when (hash-table-empty-p gptel--crowdsourced-prompts)
(unless gptel-crowdsourced-prompts-file
(run-at-time 0 nil #'gptel-system-prompt)
(user-error "No crowdsourced prompts available"))
(unless (and (file-exists-p gptel-crowdsourced-prompts-file)
(time-less-p
(time-subtract (current-time) (days-to-time 14))
(file-attribute-modification-time
(file-attributes gptel-crowdsourced-prompts-file))))
(when (y-or-n-p
(concat
"Fetch crowdsourced system prompts from "
(propertize "https://github.com/f/awesome-chatgpt-prompts" 'face 'link)
"?"))
;; Fetch file
(message "Fetching prompts...")
(let ((dir (file-name-directory gptel-crowdsourced-prompts-file)))
(unless (file-exists-p dir) (mkdir dir 'create-parents))
(if (url-copy-file gptel--crowdsourced-prompts-url
gptel-crowdsourced-prompts-file
'ok-if-already-exists)
(message "Fetching prompts... done.")
(message "Could not retrieve new prompts.")))))
(if (not (file-readable-p gptel-crowdsourced-prompts-file))
(progn (message "No crowdsourced prompts available")
(call-interactively #'gptel-system-prompt))
(with-temp-buffer
(insert-file-contents gptel-crowdsourced-prompts-file)
(goto-char (point-min))
(forward-line 1)
(while (not (eobp))
(when-let ((act (read (current-buffer))))
(forward-char)
(save-excursion
(while (re-search-forward "\"\"" (line-end-position) t)
(replace-match "\\\\\"")))
(when-let ((prompt (read (current-buffer))))
(puthash act prompt gptel--crowdsourced-prompts)))
(forward-line 1)))))
gptel--crowdsourced-prompts))
;; * Transient classes and methods for gptel
(defclass gptel-lisp-variable (transient-lisp-variable)
((display-nil :initarg :display-nil) ;String to display if value if nil
(display-map :initarg :display-map :initform nil)) ;Display string from alist display-map
"Lisp variables that show :display-nil instead of nil.")
(cl-defmethod transient-format-value ((obj gptel-lisp-variable))
(let ((display-value
(with-slots (value display-nil display-map) obj
(cond ((null value) display-nil)
(display-map (cdr (assoc value display-map)))
(t value)))))
(propertize
(if (stringp display-value) display-value (prin1-to-string display-value))
'face 'transient-value)))
(cl-defmethod transient-infix-set ((obj gptel-lisp-variable) value)
(funcall (oref obj set-value)
(oref obj variable)
(oset obj value value)
gptel--set-buffer-locally))
(defclass gptel--switch (transient-switch)
((category :initarg :category))
"Class used for arguments that share a category.")
(cl-defmethod transient-infix-set ((obj gptel--switch) value)
"The VALUE of a gptel--switch OBJ is a list of the category
and argument, e.g. (\"filesystem\" \"read_file\")."
(if value
(oset obj value (list (oref obj category) value))
(oset obj value nil)))
(defclass gptel--switch-category (transient-switch)
((category :initarg :category))
"Class used for arguments that switch a group of other arguments.
Their own value is ignored")
(cl-defmethod transient-infix-set ((obj gptel--switch-category) value)
"When setting VALUE, set all options in the category of OBJ."
(dolist (suffix-obj transient--suffixes)
;; Find all suffixes that have this category
(when-let* (((cl-typep suffix-obj 'gptel--switch))
((equal (oref suffix-obj category)
(oref obj category)))
(arg (if (slot-boundp suffix-obj 'argument)
(oref suffix-obj argument)
(oref obj argument-format))))
;; Turn on/off all members in category
(if value
(transient-infix-set suffix-obj arg)
(transient-infix-set suffix-obj nil))))
;; Finally set the "value" of the category itself
(oset obj value value))
(defclass gptel--switches (gptel-lisp-variable)
((display-if-true :initarg :display-if-true :initform "True")
(display-if-false :initarg :display-if-false :initform "False"))
"Boolean lisp variable class for gptel-transient.")
(cl-defmethod transient-infix-read ((obj gptel--switches))
"Cycle through the mutually exclusive switches."
(not (oref obj value)))
(cl-defmethod transient-format-value ((obj gptel--switches))
(with-slots (value display-if-true display-if-false) obj
(format
(propertize "(%s)" 'face 'transient-delimiter)
(concat
(propertize display-if-false
'face (if value 'transient-inactive-value 'transient-value))
(propertize "|" 'face 'transient-delimiter)
(propertize display-if-true
'face (if value 'transient-value 'transient-inactive-value))))))
(defclass gptel--scope (gptel--switches)
((display-if-true :initarg :display-if-true :initform "buffer")
(display-if-false :initarg :display-if-false :initform "global"))
"Singleton lisp variable class for `gptel--set-buffer-locally'.
This is used only for setting this variable via `gptel-menu'.")
(cl-defmethod transient-infix-read ((obj gptel--scope))
"Cycle through the mutually exclusive switches."
(with-slots (value) obj
(pcase value
('t (message "Parameters will be set for the next request only"))
('nil (message "Parameters will be set buffer-locally"))
(1 (message "Parameters will be set globally")))
(pcase value ('t 1) ('nil t) (1 nil))))
(cl-defmethod transient-format-value ((obj gptel--scope))
(with-slots (value display-if-true display-if-false) obj
(format
(propertize "(%s)" 'face 'transient-delimiter)
(concat
(propertize display-if-false
'face (if (null value) 'transient-value 'transient-inactive-value))
(propertize "|" 'face 'transient-delimiter)
(propertize display-if-true
'face (if (eq value t) 'transient-value 'transient-inactive-value))
(propertize "|" 'face 'transient-delimiter)
(propertize "oneshot" 'face
(if (eql value 1) 'transient-value 'transient-inactive-value))))))
(cl-defmethod transient-infix-set ((obj gptel--scope) value)
(funcall (oref obj set-value)
(oref obj variable)
(oset obj value value)))
(defclass gptel-provider-variable (transient-lisp-variable)
((model :initarg :model)
(model-value :initarg :model-value)
(always-read :initform t)
(set-value :initarg :set-value :initform #'set))
"Class used for gptel-backends.")
(cl-defmethod transient-format-value ((obj gptel-provider-variable))
(propertize (concat
(gptel-backend-name (oref obj value)) ":"
(gptel--model-name
(buffer-local-value (oref obj model) transient--original-buffer)))
'face 'transient-value))
(cl-defmethod transient-infix-set ((obj gptel-provider-variable) value)
(pcase-let ((`(,backend-value ,model-value) value))
(funcall (oref obj set-value)
(oref obj variable)
(oset obj value backend-value)
gptel--set-buffer-locally)
(funcall (oref obj set-value)
(oref obj model)
(oset obj model-value model-value)
gptel--set-buffer-locally))
(transient-setup))
(defclass gptel-option-overlaid (transient-option)
((display-nil :initarg :display-nil)
(overlay :initarg :overlay))
"Transient options for overlays displayed in the working buffer.")
(cl-defmethod transient-format-value ((obj gptel-option-overlaid))
"set up the in-buffer overlay for additional directive, a string.
Also format its value in the Transient menu."
(let ((value (oref obj value))
(ov (oref obj overlay))
(argument (oref obj argument)))
;; Making an overlay
(if (or (not value) (string-empty-p value))
(when ov (delete-overlay ov))
(with-current-buffer transient--original-buffer
(oset obj overlay (gptel--instructions-make-overlay value ov)))
(letrec ((ov-clear-hook
(lambda () (when-let* ((ov (oref obj overlay))
((overlayp ov)))
(remove-hook 'transient-exit-hook
ov-clear-hook)
(delete-overlay ov)))))
(add-hook 'transient-exit-hook ov-clear-hook)))
;; Updating transient menu display
(if value
(propertize (concat argument (truncate-string-to-width value 25 nil nil "..."))
'face 'transient-value)
(propertize
(concat "(" (symbol-name (oref obj display-nil)) ")")
'face 'transient-inactive-value))))
;; * Transient Prefixes
(define-obsolete-function-alias 'gptel-send-menu 'gptel-menu "0.3.2")
;; BUG: The `:incompatible' spec doesn't work if there's a `:description' below it.
;;;###autoload (autoload 'gptel-menu "gptel-transient" nil t)
(transient-define-prefix gptel-menu ()
"Change parameters of prompt to send to the LLM."
;; :incompatible '(("-m" "-n" "-k" "-e"))
[:description gptel-system-prompt--format
[""
:if (lambda () (not (gptel--model-capable-p 'nosystem)))
"Instructions"
("s" "Set system message" gptel-system-prompt :transient t)
(gptel--infix-add-directive)]
[:pad-keys t
""
"Context"
(gptel--infix-context-add-region)
(gptel--infix-context-add-buffer)
(gptel--infix-context-add-file)
(gptel--infix-context-remove-all)
(gptel--suffix-context-buffer)]
[:pad-keys t
:if (lambda () (and gptel-use-tools gptel--known-tools))
"" (:info
(lambda () (concat "Tools" (and gptel-tools
(format " (%d selected)"
(length gptel-tools)))))
:format "%d" :face transient-heading)
("t" "Select tools" gptel-tools :transient t)
("T" "Continue tool calls"
(lambda () (interactive) (gptel--handle-tool-use gptel--fsm-last))
:if (lambda () (and gptel--fsm-last
(eq (gptel-fsm-state gptel--fsm-last) 'TOOL))))]]
[["Request Parameters"
:pad-keys t
(gptel--infix-variable-scope)
(gptel--infix-provider)
(gptel--infix-max-tokens)
(gptel--infix-num-messages-to-send
:if (lambda () (and gptel-expert-commands
(or gptel-mode gptel-track-response))))
(gptel--infix-temperature :if (lambda () gptel-expert-commands))
(gptel--infix-use-context)
(gptel--infix-use-tools)
(gptel--infix-track-response
:if (lambda () (and gptel-expert-commands (not gptel-mode))))
(gptel--infix-track-media
:if (lambda () (and gptel-mode (gptel--model-capable-p 'media))))]
[" <Prompt from"
("m" "Minibuffer instead" "m")
("y" "Kill-ring instead" "y")
""
("i" "Respond in place" "i")]
[" >Response to"
("e" "Echo area" "e")
("g" "gptel session" "g"
:class transient-option
:prompt "Existing or new gptel session: "
:reader
(lambda (prompt _ _history)
(read-buffer
prompt (generate-new-buffer-name
(concat "*" (gptel-backend-name gptel-backend) "*"))
nil (lambda (buf-name)
(if (consp buf-name) (setq buf-name (car buf-name)))
(let ((buf (get-buffer buf-name)))
(and (buffer-local-value 'gptel-mode buf)
(not (eq (current-buffer) buf))))))))
("b" "Any buffer" "b"
:class transient-option
:prompt "Output to buffer: "
:reader
(lambda (prompt _ _history)
(read-buffer prompt (buffer-name (other-buffer)) nil)))
("k" "Kill-ring" "k")]]
[["Send"
(gptel--suffix-send)
("M-RET" "Regenerate" gptel--regenerate :if gptel--in-response-p)]
[:description (lambda () (concat (and gptel--rewrite-overlays "Continue ")
"Rewrite"))
:if (lambda () (or (use-region-p)
(and gptel--rewrite-overlays
(gptel--rewrite-sanitize-overlays))))
("r"
(lambda () (if (get-char-property (point) 'gptel-rewrite)
"Iterate" "Rewrite"))
gptel-rewrite)]
["Tweak Response" :if gptel--in-response-p :pad-keys t
("SPC" "Mark" gptel--mark-response)
("P" "Previous variant" gptel--previous-variant
:if gptel--at-response-history-p
:transient t)
("N" "Next variant" gptel--previous-variant
:if gptel--at-response-history-p
:transient t)
("E" "Ediff previous" gptel--ediff
:if gptel--at-response-history-p)]
["Dry Run" :if (lambda () (or gptel-log-level gptel-expert-commands))
("I" "Inspect query (Lisp)"
(lambda ()
"Inspect the query that will be sent as a lisp object."
(interactive)
(gptel--sanitize-model)
(gptel--inspect-query
(gptel--suffix-send
(cons "I" (transient-args transient-current-command))))))
("J" "Inspect query (JSON)"
(lambda ()
"Inspect the query that will be sent as a JSON object."
(interactive)
(gptel--sanitize-model)
(gptel--inspect-query
(gptel--suffix-send
(cons "I" (transient-args transient-current-command)))
'json)))]]
(interactive)
(gptel--sanitize-model)
(transient-setup 'gptel-menu))
;; ** Prefix for setting the system prompt.
(defun gptel--setup-directive-menu (sym msg &optional external)
"Return a list of transient infix definitions for setting gptel
directives.
SYM is the symbol whose value is set to the selected directive..
MSG is the meaning of symbol, used when messaging.
If EXTERNAL is non-nil, include external sources of directives."
(cl-loop for (type . prompt) in gptel-directives
;; Avoid clashes with the custom directive key
with unused-keys = (delete ?s (number-sequence ?a ?z))
with width = (window-width)
for name = (symbol-name type)
for key = (seq-find (lambda (k) (member k unused-keys)) name (seq-first unused-keys))
do (setq unused-keys (delete key unused-keys))
;; The explicit declaration ":transient transient--do-return" here
;; appears to be required for Transient v0.5 and up. Without it, these
;; are treated as suffixes when invoking `gptel-system-prompt' directly,
;; and infixes when going through `gptel-menu'.
;; TODO: Raise an issue with Transient.
collect
(list (key-description (list key))
(concat (capitalize name) " "
(propertize " " 'display '(space :align-to 20))
(propertize
(concat "(" (gptel--describe-directive prompt (- width 30)) ")")
'face 'shadow))
`(lambda () (interactive)
(message "%s: %s" ,msg ,(gptel--describe-directive prompt 100 "⮐ "))
(gptel--set-with-scope ',sym ',prompt gptel--set-buffer-locally))
:transient 'transient--do-return)
into prompt-suffixes
finally return
(nconc
prompt-suffixes
(list (list "DEL" "None"
`(lambda () (interactive)
(message "%s unset" ,msg)
(gptel--set-with-scope ',sym nil gptel--set-buffer-locally))
:transient 'transient--do-return))
(and external
(list (list "SPC" "Pick crowdsourced prompt"
'gptel--read-crowdsourced-prompt
;; NOTE: Quitting the completing read when picking a
;; crowdsourced prompt will cause the transient to exit
;; instead of returning to the system prompt menu.
:transient 'transient--do-exit))))))
;;;###autoload (autoload 'gptel-system-prompt "gptel-transient" nil t)
(transient-define-prefix gptel-system-prompt ()
"Set the LLM system message for LLM interactions.
The \"system message\" establishes directives for the chat
session and modifies the behavior of the LLM. Some examples of
system prompts are:
You are a helpful assistant. Answer as concisely as possible.
Reply only with shell commands and no prose.
You are a poet. Reply only in verse.
More extensive system messages can be useful for specific tasks.
Customize `gptel-directives' for task-specific prompts."
[:description gptel-system-prompt--format
[(gptel--suffix-system-message)]
[(gptel--infix-variable-scope)]]
[:class transient-column
:setup-children
(lambda (_) (transient-parse-suffixes
'gptel-system-prompt
(gptel--setup-directive-menu
'gptel--system-message "Directive" t)))
:pad-keys t])
;; ** Prefix for selecting tools
;;;###autoload (autoload 'gptel-tools "gptel-transient" nil t)
(transient-define-prefix gptel-tools ()
"Select tools to include with gptel requests.
Tools are organized into categories. Selecting the category
toggles all the tools with that category.
To add tools to this list, use `gptel-make-tool', which see.
Using the scope option, you can set tools to use with gptel
requests globally, in this buffer or for the next request
only (\"oneshot\")."
[:description "Provide the LLM with tools to run tasks for you"
[""
(gptel--infix-variable-scope)
(gptel--infix-use-tools)
(gptel--infix-confirm-tool-calls)
(gptel--infix-include-tool-results)]
[""
("RET" "Confirm selection"
(lambda (args)
(interactive (list (transient-args transient-current-command)))
;; There are two kinds of ARGS: categories with value "(*)", and lists of
;; the type '("category" "tool_name"). We only want the latter, to use an
;; index into `gptel--known-backends.'
(gptel--set-with-scope
'gptel-tools
(mapcar (lambda (category-and-name)
(map-nested-elt gptel--known-tools category-and-name))
(cl-delete-if-not #'consp args))
gptel--set-buffer-locally))
:transient transient--do-return)
("q" "Cancel" transient-quit-one)]]
[:class transient-column
:setup-children
(lambda (_)
(transient-parse-suffixes
'gptel-tools
(cdr
(cl-loop ;loop through gptel--known tools and collect categories
for (category . tools-alist) in gptel--known-tools
with unused-keys = (delete ?q (number-sequence ?a ?z))
for category-key = (seq-find (lambda (k) (member k unused-keys)) category
(seq-first unused-keys))
do (setq unused-keys (delete category-key unused-keys))
nconc
(cl-loop ;for each category, collect tools as infixes
for (name . tool) in tools-alist
with tool-keys = (delete category-key (number-sequence ?a ?z))
for tool-key = (seq-find (lambda (k) (member k tool-keys)) name
(seq-first tool-keys))
do (setq tool-keys (delete tool-key tool-keys))
collect ;Each list is a transient infix of type gptel--switch
(list (key-description (list category-key tool-key))
(concat (make-string (max (- 20 (length name)) 0) ? )
(propertize
(concat "(" (gptel--describe-directive
(gptel-tool-description tool) (- (window-width) 40))
")")
'face 'shadow))
(gptel-tool-name tool)
:format " %k %v %d"
:init-value #'gptel--tools-init-value
:class 'gptel--switch
:category category)
into infixes-for-category
finally return
(identity ;TODO(tool): Replace with vconcat for groups separated by category
;; Add a category header that can be used to toggle all tools in that category
(nconc (list " " (list (key-description (list category-key category-key))
(concat (propertize (concat (capitalize category) " tools")
'face 'transient-heading)
(make-string (max (- 14 (length category)) 0) ? ))
"(*)"
:format " %k %d %v"
:class 'gptel--switch-category
:category category))
infixes-for-category)))))))])
;; * Transient Infixes
;; ** Infixes for context aggregation
(transient-define-infix gptel--infix-use-context ()
"Describe target destination for context injection.
gptel will include with the LLM request any additional context
added with `gptel-add'. This context can be ignored, included
with the system message or included with the user prompt.
Where in the request this context is included depends on the
value of `gptel-use-context', set from here."
:description "Include context"
:class 'gptel-lisp-variable
:variable 'gptel-use-context
:format " %k %d %v"
:set-value #'gptel--set-with-scope
:display-nil "No"
:display-map '((nil . "No")
(system . "with system message")
(user . "with user prompt"))
:key "-i"
:reader (lambda (prompt &rest _)
(let* ((choices '(("No" . nil)
("with system message" . system)
("with user prompt" . user)))
(destination (completing-read prompt choices nil t)))
(cdr (assoc destination choices)))))
;; ** Infixes for model parameters
(transient-define-infix gptel--infix-variable-scope ()
"Set gptel's model parameters and system message in this buffer or globally."
:argument "scope"
:variable 'gptel--set-buffer-locally
:class 'gptel--scope
:format " %k %d %v"
:key "="
:description (propertize "Scope" 'face 'transient-inactive-argument))
(transient-define-infix gptel--infix-num-messages-to-send ()
"Number of recent messages to send with each exchange.
By default, the full conversation history is sent with every new
prompt. This retains the full context of the conversation, but
can be expensive in token size. Set how many recent messages to
include."
:description "previous responses"
:class 'gptel-lisp-variable
:variable 'gptel--num-messages-to-send
:set-value #'gptel--set-with-scope
:display-nil 'all
:format " %k %v %d"
:key "-n"
:prompt "Number of past messages to include for context (leave empty for all): "
:reader 'gptel--transient-read-variable)
(transient-define-infix gptel--infix-max-tokens ()
"Max tokens per response.
This is roughly the number of words in the response. 100-300 is a
reasonable range for short answers, 400 or more for longer
responses."
:description "Response length (tokens)"
:class 'gptel-lisp-variable
:variable 'gptel-max-tokens
:set-value #'gptel--set-with-scope
:display-nil 'auto
:key "-c"
:prompt "Response length in tokens (leave empty: default, 80-200: short, 200-500: long): "
:reader 'gptel--transient-read-variable)
(transient-define-infix gptel--infix-provider ()
"AI Provider for Chat."
:description "GPT Model"
:class 'gptel-provider-variable
:prompt "Model: "
:variable 'gptel-backend
:set-value #'gptel--set-with-scope
:model 'gptel-model
:key "-m"
:reader (lambda (prompt &rest _)
(cl-loop
for (name . backend) in gptel--known-backends
nconc (cl-loop for model in (gptel-backend-models backend)
collect (list (concat name ":" (gptel--model-name model))
backend model))
into models-alist
with completion-extra-properties =
`(:annotation-function
,(lambda (comp)
(let* ((model (nth 2 (assoc comp models-alist)))
(desc (get model :description))
(caps (get model :capabilities))
(context (get model :context-window))
(input-cost (get model :input-cost))
(output-cost (get model :output-cost))
(cutoff (get model :cutoff-date)))
(when (or desc caps context input-cost output-cost cutoff)
(concat
(propertize " " 'display `(space :align-to 40))
(when desc (truncate-string-to-width desc 70 nil ? t t))
" " (propertize " " 'display `(space :align-to 112))
(when caps (truncate-string-to-width (prin1-to-string caps) 21 nil ? t t))
" " (propertize " " 'display `(space :align-to 134))
(when context (format "%5dk" context))
" " (propertize " " 'display `(space :align-to 142))
(when input-cost (format "$%5.2f in" input-cost))
(if (and input-cost output-cost) "," " ")
" " (propertize " " 'display `(space :align-to 153))
(when output-cost (format "$%6.2f out" output-cost))
" " (propertize " " 'display `(space :align-to 166))
cutoff)))))
finally return
(cdr (assoc (completing-read prompt models-alist nil t)
models-alist)))))
(transient-define-infix gptel--infix-temperature ()
"Temperature of request."
:description "Temperature (0 - 2.0)"
:display-nil "default"
:class 'gptel-lisp-variable
:variable 'gptel-temperature
:set-value #'gptel--set-with-scope
:key "-T"
:prompt "Temperature controls the response randomness (0.0-2.0, leave empty for API default): "
:reader 'gptel--transient-read-variable)
(transient-define-infix gptel--infix-track-response ()
"Distinguish between user messages and LLM responses.
When creating a prompt to send to the LLM, gptel distinguishes
between text entered by the user and past LLM responses. This is
required for multi-turn conversations, and is always the case in
dedicated chat buffers (in `gptel-mode').
In regular buffers, you can toggle this behavior here or by
customizing `gptel-track-response'. When response tracking is
turned off, all text will be assigned the \"user\" role when
querying the LLM."
:description "Track LLM responses"
:class 'gptel--switches
:variable 'gptel-track-response
:set-value #'gptel--set-with-scope
:display-if-true "Yes"
:display-if-false "No"
:key "-v")
(transient-define-infix gptel--infix-track-media ()
"Send media from \"standalone\" links in the prompt.
When the active `gptel-model' supports it, gptel can send images
or other media from links in the buffer to the LLM. Only
\"standalone\" links are considered: these are links on their own
line with no surrounding text.
What link types are sent depends on the mime-types the model
supports. See `gptel-track-media' for more information."
:description "Send media from links"
:class 'gptel--switches
:variable 'gptel-track-media
:set-value #'gptel--set-with-scope
:display-if-true "Yes"
:display-if-false "No"
:key "-I")
;; ** Infixes for adding and removing context
(declare-function gptel-context--at-point "gptel-context")
(declare-function gptel-add "gptel-context")
(transient-define-suffix gptel--infix-context-add-region ()
"Add current region to gptel's context."
:transient 'transient--do-stay
:key "-r"
:if (lambda () (or (use-region-p)
(and (fboundp 'gptel-context--at-point)
(gptel-context--at-point))))
:description
(lambda ()
(if (and (fboundp 'gptel-context--at-point)
(gptel-context--at-point))
"Remove context at point"
"Add region to context"))
(interactive)
(gptel-add)
(transient-setup))
(transient-define-suffix gptel--infix-context-add-buffer ()
"Add a buffer to gptel's context."
:transient 'transient--do-stay
:key "-b"
:description "Add a buffer to context"
(interactive)
(gptel-add '(4))
(transient-setup))
(declare-function gptel-add-file "gptel-context")
(declare-function gptel-context-remove-all "gptel-context")
(transient-define-suffix gptel--infix-context-add-file ()
"Add a file to gptel's context."
:transient 'transient--do-stay
:key "-f"
:description "Add a file to context"
(interactive)
(call-interactively #'gptel-add-file)
(transient-setup))
(transient-define-suffix gptel--infix-context-remove-all ()
"Clear gptel's context."
:if (lambda () gptel-context--alist)
:transient 'transient--do-stay
:key "-d"
:description "Remove all"
(interactive)
(gptel-context-remove-all t)
(transient-setup))
;; ** Infix for additional directive
(transient-define-infix gptel--infix-add-directive ()
"Additional directive intended for the next query only.
This is useful to define a quick task on top of a more extensive
or detailed system message.
For example, with code/text selected:
- Rewrite this function to do X while avoiding Y.
- Change the tone of the following paragraph to be more direct.
Or in an extended conversation:
- Phrase you next response in ten words or less.
- Pretend for now that you're an anthropologist."
:class 'gptel-option-overlaid
;; :variable 'gptel--instructions
:display-nil 'none
:overlay nil
:argument ":"
:prompt (concat "Add instructions for next request only "
gptel--read-with-prefix-help)
:reader (lambda (prompt initial history)
(let* ((directive
(car-safe (gptel--parse-directive gptel--system-message 'raw)))
(cycle-prefix (lambda () (interactive)
(gptel--read-with-prefix directive)))
(minibuffer-local-map
(make-composed-keymap
(define-keymap "TAB" cycle-prefix "<tab>" cycle-prefix)
minibuffer-local-map))
(extra (minibuffer-with-setup-hook cycle-prefix
(read-string prompt (or initial " ") history))))
(unless (string-empty-p extra) extra)))
:format " %k %d %v"
:key "d"
:argument ":"
:description "Add instruction"
:transient t)
;; ** Infixes for tool use
(transient-define-infix gptel--infix-use-tools ()
"Whether LLM tool use with gptel is enabled.
This is a three-way toggle. Assuming one or more tools to be
sent with requests have been selected, tool use can be
- disabled,
- enabled, where the LLM may choose to respond with tool calls
- forced, where the LLM must respond with one or more tool calls.
You can set this here or by customizing `gptel-use-tools', which
see."
:description "Use tools"
:class 'gptel-lisp-variable
:variable 'gptel-use-tools
:set-value (lambda (sym value scope)
(gptel--set-with-scope sym value scope)
(transient-setup))
:display-nil "off"
:display-map '((nil . "off")
(t . "on")
(force . "force"))