-
Notifications
You must be signed in to change notification settings - Fork 217
/
Copy pathgptel-curl.el
460 lines (416 loc) · 21 KB
/
gptel-curl.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
;;; gptel-curl.el --- Curl support for gptel -*- lexical-binding: t; -*-
;; Copyright (C) 2023 Karthik Chikmagalur
;; Author: Karthik Chikmagalur;; <[email protected]>
;; 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:
;; Curl support for gptel. Utility functions.
;;; Code:
(require 'gptel)
(eval-when-compile
(require 'cl-lib)
(require 'subr-x))
(require 'map)
(declare-function json-read "json" ())
(defvar json-object-type)
(declare-function gptel--stream-convert-markdown->org "gptel-org")
(defcustom gptel-curl-extra-args nil
"Extra arguments to pass to Curl when sending queries.
This should be a list of strings, each one a Curl command line
argument. Note that these should not conflict with the options
in `gptel-curl--common-args', which gptel requires for correct
functioning.
If you want to specify extra arguments only when using a specific
gptel backend, use the `:curl-args' slot of the backend instead.
See `gptel-backend'."
:group 'gptel
:type '(repeat string))
(defconst gptel-curl--common-args
(if (memq system-type '(windows-nt ms-dos))
'("--disable" "--location" "--silent" "-XPOST"
"-y300" "-Y1" "-D-")
'("--disable" "--location" "--silent" "--compressed"
"-XPOST" "-y300" "-Y1" "-D-"))
"Arguments always passed to Curl for gptel queries.")
(defun gptel-curl--get-args (info token)
"Produce list of arguments for calling Curl.
REQUEST-DATA is the data to send, TOKEN is a unique identifier."
(let* ((data (plist-get info :data))
;; We have to let-bind the following two variables since their dynamic
;; values are used for key lookup and url resoloution
(gptel-backend (plist-get info :backend))
(gptel-stream (plist-get info :stream))
(url (let ((backend-url (gptel-backend-url gptel-backend)))
(if (functionp backend-url)
(funcall backend-url) backend-url)))
(data-json (encode-coding-string (gptel--json-encode data) 'utf-8))
(headers
(append '(("Content-Type" . "application/json"))
(when-let* ((header (gptel-backend-header gptel-backend)))
(if (functionp header)
(funcall header) header)))))
(when gptel-log-level
(when (eq gptel-log-level 'debug)
(gptel--log (gptel--json-encode
(mapcar (lambda (pair) (cons (intern (car pair)) (cdr pair)))
headers))
"request headers"))
(gptel--log data-json "request body"))
(append
gptel-curl--common-args
gptel-curl-extra-args
(gptel-backend-curl-args gptel-backend)
(list (format "-w(%s . %%{size_header})" token))
(if (length< data-json gptel-curl-file-size-threshold)
(list (format "-d%s" data-json))
(letrec
((temp-filename (make-temp-file "gptel-curl-data" nil ".json" data-json))
(cleanup-fn (lambda (&rest _)
(when (file-exists-p temp-filename)
(delete-file temp-filename)
(remove-hook 'gptel-post-response-functions cleanup-fn)))))
(add-hook 'gptel-post-response-functions cleanup-fn)
(list "--data-binary"
(format "@%s" temp-filename))))
(when (not (string-empty-p gptel-proxy))
(list "--proxy" gptel-proxy
"--proxy-negotiate"
"--proxy-user" ":"))
(cl-loop for (key . val) in headers
collect (format "-H%s: %s" key val))
(list url))))
;;TODO: The :transformer argument here is an alternate implementation of
;;`gptel-response-filter-functions'. The two need to be unified.
;;;###autoload
(defun gptel-curl-get-response (fsm)
"Fetch response to prompt in state FSM from the LLM using Curl.
FSM is the state machine driving this request.
FSM is the state machine driving this request. Its INFO slot
contains the data required for setting up the request. INFO is a
plist with the following keys, among others:
- :data (the data being sent)
- :buffer (the gptel buffer)
- :position (marker at which to insert the response).
- :callback (optional, the request callback)
Call CALLBACK with the response and INFO afterwards. If omitted
the response is inserted into the current buffer after point."
(let* ((token (md5 (format "%s%s%s%s"
(random) (emacs-pid) (user-full-name)
(recent-keys))))
(info (gptel-fsm-info fsm))
(args (gptel-curl--get-args info token))
(stream (plist-get info :stream))
(process (apply #'start-process "gptel-curl"
(gptel--temp-buffer " *gptel-curl*") "curl" args)))
;; Don't try to convert cr-lf to cr on Windows so that curl's "header size
;; in bytes" stays correct. Explicitly set utf-8 for non-win systems too,
;; for cases when buffer coding system is not set to utf-8.
(set-process-coding-system process 'utf-8-unix 'utf-8-unix)
(when (eq gptel-log-level 'debug)
(gptel--log (mapconcat #'shell-quote-argument (cons "curl" args) " \\\n")
"request Curl command" 'no-json))
(with-current-buffer (process-buffer process)
(set-process-query-on-exit-flag process nil)
(if (plist-get info :token) ;not the first run, set only the token
(plist-put info :token token)
(setf (gptel-fsm-info fsm) ;fist run, set all process parameters
(nconc (list :token token
:transformer
(when (with-current-buffer (plist-get info :buffer)
(and (derived-mode-p 'org-mode)
gptel-org-convert-response))
(gptel--stream-convert-markdown->org
(plist-get info :position))))
(unless (plist-get info :callback)
(list :callback (if stream
#'gptel-curl--stream-insert-response
#'gptel--insert-response)))
info)))
(if stream
(progn (set-process-sentinel process #'gptel-curl--stream-cleanup)
(set-process-filter process #'gptel-curl--stream-filter))
(set-process-sentinel process #'gptel-curl--sentinel))
(setf (alist-get process gptel--request-alist) fsm))))
;; ;; Ahead-Of-Time dispatch code for the parsers
;; :parser ; FIXME `cl--generic-*' are internal functions
;; (cl--generic-method-function
;; (if stream
;; (cl-loop
;; for type in
;; (cl--class-allparents (get (type-of backend) 'cl--class))
;; with methods = (cl--generic-method-table
;; (cl--generic 'gptel-curl--parse-stream))
;; when (cl--generic-member-method `(,type t) nil methods)
;; return (car it))
;; (cl-loop
;; for type in
;; (cl--class-allparents (get (type-of backend) 'cl--class))
;; with methods = (cl--generic-method-table
;; (cl--generic 'gptel--parse-response))
;; when (cl--generic-member-method `(,type t t) nil methods)
;; return (car it))))
(defun gptel-curl--log-response (proc-buf proc-info)
"Parse response buffer PROC-BUF and log response.
PROC-INFO is the plist containing process metadata."
(with-current-buffer proc-buf
(save-excursion
(goto-char (point-min))
(when (re-search-forward "?\n?\n" nil t)
(when (eq gptel-log-level 'debug)
(gptel--log (gptel--json-encode
(buffer-substring-no-properties
(point-min) (1- (point))))
"response headers"))
(let ((p (point)))
(when (search-forward (plist-get proc-info :token) nil t)
(goto-char (1- (match-beginning 0)))
(gptel--log (buffer-substring-no-properties p (point))
"response body")))))))
;; TODO: Separate user-messaging from this function
(defun gptel-curl--stream-cleanup (process _status)
"Process sentinel for gptel curl requests.
PROCESS and _STATUS are process parameters."
(let ((proc-buf (process-buffer process)))
(let* ((fsm (alist-get process gptel--request-alist))
(info (gptel-fsm-info fsm))
(http-status (plist-get info :http-status)))
(when gptel-log-level (gptel-curl--log-response proc-buf info)) ;logging
(if (member http-status '("200" "100")) ;Finish handling response
;; Run the callback one last time to signal that the process has ended
(with-demoted-errors "gptel callback error: %S"
(funcall (plist-get info :callback) t info))
(with-current-buffer proc-buf ; Or Capture error message
(goto-char (point-max))
(search-backward (plist-get info :token))
(backward-char)
(pcase-let* ((`(,_ . ,header-size) (read (current-buffer)))
(response (progn (goto-char header-size)
(condition-case nil (gptel--json-read)
(error 'json-read-error))))
(error-data (plist-get response :error)))
(cond
(error-data
(plist-put info :error error-data))
((eq response 'json-read-error)
(plist-put info :error "Malformed JSON in response."))
(t (plist-put info :error "Could not parse HTTP response.")))))
(with-demoted-errors "gptel callback error: %S"
(funcall (plist-get info :callback) nil info)))
(gptel--fsm-transition fsm)) ; Move to next state
(setf (alist-get process gptel--request-alist nil 'remove) nil)
(kill-buffer proc-buf)))
(defun gptel-curl--stream-insert-response (response info &optional raw)
"Insert streaming RESPONSE from an LLM into the gptel buffer.
INFO is a mutable plist containing information relevant to this buffer.
See `gptel--url-get-response' for details.
Optional RAW disables text properties and transformation."
(pcase response
((pred stringp)
(let ((start-marker (plist-get info :position))
(tracking-marker (plist-get info :tracking-marker))
(transformer (plist-get info :transformer)))
(with-current-buffer (marker-buffer start-marker)
(save-excursion
(unless tracking-marker
(goto-char start-marker)
(unless (or (bobp) (plist-get info :in-place))
(insert gptel-response-separator)
(when gptel-mode
;; Put prefix before AI response.
(insert (gptel-response-prefix-string)))
(move-marker start-marker (point)))
(setq tracking-marker (set-marker (make-marker) (point)))
(set-marker-insertion-type tracking-marker t)
(plist-put info :tracking-marker tracking-marker))
(goto-char tracking-marker)
(unless raw
(when transformer
(setq response (funcall transformer response)))
(add-text-properties
0 (length response) '(gptel response front-sticky (gptel))
response))
;; (run-hooks 'gptel-pre-stream-hook)
(insert response)
(run-hooks 'gptel-post-stream-hook)))))
(`(reasoning . ,text)
(gptel--display-reasoning-stream text info))
(`(tool-call . ,tool-calls)
(gptel--display-tool-calls tool-calls info))
(`(tool-result . ,tool-results)
(gptel--display-tool-results tool-results info))))
(defun gptel-curl--stream-filter (process output)
(let* ((fsm (alist-get process gptel--request-alist))
(proc-info (gptel-fsm-info fsm))
(callback (or (plist-get proc-info :callback)
#'gptel-curl--stream-insert-response)))
(with-current-buffer (process-buffer process)
;; Insert output
(save-excursion
(goto-char (process-mark process))
(insert output)
(set-marker (process-mark process) (point)))
;; Find HTTP status
(unless (plist-get proc-info :http-status)
(save-excursion
(goto-char (point-min))
(when-let* (((not (= (line-end-position) (point-max))))
(http-msg (buffer-substring (line-beginning-position)
(line-end-position)))
(http-status
(save-match-data
(and (string-match "HTTP/[.0-9]+ +\\([0-9]+\\)" http-msg)
(match-string 1 http-msg)))))
(plist-put proc-info :http-status http-status)
(plist-put proc-info :status (string-trim http-msg))
(gptel--fsm-transition fsm))))
(when-let* ((http-msg (plist-get proc-info :status))
(http-status (plist-get proc-info :http-status)))
;; Find data chunk(s) and run callback
;; FIXME Handle the case where HTTP 100 is followed by HTTP (not 200) BUG #194
(when (member http-status '("200" "100"))
(let ((response (gptel-curl--parse-stream
(plist-get proc-info :backend) proc-info))
(reasoning-block (plist-get proc-info :reasoning-block)))
;; Depending on the API, there are two modes that reasoning or
;; chain-of-thought content appears: as part of the main response
;; but surrounded by <think>...</think> tags, or as a separate
;; JSON field in the response stream.
;;
;; These cases are handled using two PROC-INFO keys:
;;
;; :reasoning-block is nil before checking for reasoning, 'in when
;; in a reasoning block, t when we reach the end of the block, and
;; 'done afterwards or if no reasoning block is found. This
;; applies to both the modes above.
;;
;; :reasoning contains the reasoning text parsed from the separate
;; JSON field.
;;
;; NOTE: We assume here that the reasoning block always
;; precedes the main response block.
(unless (eq reasoning-block 'done)
(let ((reasoning (plist-get proc-info :reasoning)))
(cond
((stringp reasoning)
;; Obtained from separate JSON field in response
(funcall callback (cons 'reasoning reasoning) proc-info)
(unless reasoning-block ;Record that we're in a reasoning block (#709)
(plist-put proc-info :reasoning-block 'in))
(plist-put proc-info :reasoning nil)) ;Reset for next parsing round
((and (null reasoning-block) (length> response 0))
(if (string-match-p "^ *<think>" response)
;; Obtained from main response stream
(progn (setq response (cons 'reasoning response))
(plist-put proc-info :reasoning-block 'in))
(plist-put proc-info :reasoning-block 'done)))
((length> response 0)
(if-let* ((idx (string-match-p "</think>" response)))
(progn
(funcall callback
(cons 'reasoning ;last reasoning chunk
(string-trim-left
(substring response nil (+ idx 8))))
proc-info)
;; Signal end of reasoning stream
(funcall callback '(reasoning . t) proc-info)
(setq response (substring response (+ idx 8)))
(plist-put proc-info :reasoning-block 'done))
(setq response (cons 'reasoning response)))))
(when (eq reasoning-block t) ;End of reasoning block
(funcall callback '(reasoning . t) proc-info)
(plist-put proc-info :reasoning-block 'done))))
(unless (equal response "") ;Response callback
(funcall callback response proc-info))))))))
(cl-defgeneric gptel-curl--parse-stream (backend proc-info)
"Stream parser for gptel-curl.
Implementations of this function run as part of the process
filter for the active query, and return partial responses from
the LLM.
BACKEND is the LLM backend in use.
PROC-INFO is a plist with process information and other context.
See `gptel-curl--get-response' for its contents.")
(defun gptel-curl--sentinel (process _status)
"Process sentinel for gptel curl requests.
PROCESS and _STATUS are process parameters."
(let ((proc-buf (process-buffer process)))
(when-let* (((eq (process-status process) 'exit))
(fsm (alist-get process gptel--request-alist))
(proc-info (gptel-fsm-info fsm))
(proc-callback (plist-get proc-info :callback)))
(when gptel-log-level (gptel-curl--log-response proc-buf proc-info)) ;logging
(pcase-let ((`(,response ,http-status ,http-msg ,error)
(with-current-buffer proc-buf
(gptel-curl--parse-response proc-info))))
(plist-put proc-info :http-status http-status)
(plist-put proc-info :status http-msg)
(gptel--fsm-transition fsm) ;WAIT -> TYPE
(when error (plist-put proc-info :error error))
(when response ;Look for a reasoning block
(if (string-match-p "^ *<think>\n" response)
(when-let* ((idx (string-search "</think>\n" response)))
(with-demoted-errors "gptel callback error: %S"
(funcall proc-callback
(cons 'reasoning (substring response nil (+ idx 8)))
proc-info))
(setq response
(string-trim-left (substring response (+ idx 8)))))
(when-let* ((reasoning (plist-get proc-info :reasoning))
((stringp reasoning)))
(funcall proc-callback (cons 'reasoning reasoning) proc-info))))
(when (or response (not (member http-status '("200" "100"))))
(with-demoted-errors "gptel callback error: %S"
(funcall proc-callback response proc-info))))
(gptel--fsm-transition fsm)) ;TYPE -> next
(setf (alist-get process gptel--request-alist nil 'remove) nil)
(kill-buffer proc-buf)))
(defun gptel-curl--parse-response (proc-info)
"Parse the buffer BUF with curl's response.
PROC-INFO is a plist with contextual information."
(let ((token (plist-get proc-info :token)))
(goto-char (point-max))
(search-backward token)
(backward-char)
(pcase-let* ((`(,_ . ,header-size) (read (current-buffer))))
(goto-char (point-min))
(if-let* ((http-msg (string-trim
(buffer-substring (line-beginning-position)
(line-end-position))))
(http-status
(save-match-data
(and (string-match "HTTP/[.0-9]+ +\\([0-9]+\\)" http-msg)
(match-string 1 http-msg))))
(response (progn (goto-char header-size)
(condition-case nil
(gptel--json-read)
(error 'json-read-error)))))
(cond
;; FIXME Handle the case where HTTP 100 is followed by HTTP (not 200) BUG #194
((member http-status '("200" "100"))
(list (and-let* ((resp ;; (funcall parser nil response proc-info)
(gptel--parse-response (plist-get proc-info :backend)
response proc-info)))
(string-trim resp))
http-status http-msg))
((plist-get response :error)
(list nil http-status http-msg (plist-get response :error)))
((eq response 'json-read-error)
(list nil http-status (concat "(" http-msg ") Malformed JSON in response.")
"Malformed JSON in response"))
(t (list nil http-status (concat "(" http-msg ") Could not parse HTTP response.")
"Could not parse HTTP response.")))
(list nil http-status (concat "(" http-msg ") Could not parse HTTP response.")
"Could not parse HTTP response.")))))
(provide 'gptel-curl)
;;; gptel-curl.el ends here