Inline completion with overlay #2

BrachystochroneSD · 2023-09-27T17:38:29Z

Hello,
I really like to project, I would like to contribute with that pull request.

I have taken inspiration (and lots of code) from copilot.el. It allows to show with overlay the completion got fetched from codegeex and let the user cycle between the completions and accept one if wanted. Here is a little gif showing the process:

It should work right now. I may restructure the files as it is kind of a mess right now.

Here is the configuration of codegeex for that example:

(use-package codegeex
  :after uuidgen
  :load-path "~/.emacs.d/my-packages/codegeex.el"
  :custom (codegeex-idle-delay 1)
  :bind (:map codegeex-mode-map
              ("C-:" . codegeex-accept-completion)
              ("C-=" . codegeex-next-completion)
              ("C-;" . codegeex-previous-completion)))

BrachystochroneSD

Here are my comments on the code.

BrachystochroneSD · 2023-09-27T17:41:38Z

codegeex.el

-(defvar codegeex-endpoint "https://tianqi.aminer.cn/api/v2/" "the endpoint of CodeGeeX API")
-(defvar codegeex-apikey "68cf004321e94b47a91c2e45a8109852" "API key obtained from CodeGeeX website")
-(defvar codegeex-apisecret "e82b86a16f9d471ab215f653060310e3" "API secret obtained from CodeGeeX website")
-(defvar codegeex-temperature 0.2 "temperature for completion by CodeGeeX")
-(defvar codegeex-top_p 0.95 "top_p for completion by CodeGeeX")
-(defvar codegeex-top_k 0 "top_k for completion by CodeGeeX")


Could be subject to an other pull request
These could be defcustom. And currently you put your own api key and api secret. Which is not ideal.
Maybe we can create a login method like the vscode plugin. Retrieving the api with it.
But I have no idea how the api is working.

Some explanation of top_p and top_k or temperature could be added as well.

In fact, they are not my private api key and api secret, they are copied from vscode extension.

Based on my previous test, this extension uses some of non-open API of codegeex(e.g. fill in middle API), which can be accessed only if using this key.

Maybe @Stanislas0 could provide more information about it.

The API is kind of shady it seems. I guess some clarification would be needed indeed.

copied from vscode extension

You mean this one? I don't even know if it's the source code of the current extension shown in the marketplace.

We can clearly see that the completion proposed with the API for this package is not the same than the one from the vscode plugin.

Compared to:

Clearly there is a new version of the API or something need to be changed in the Call itself.

I'll create an issue on the CodeGeeX2 github project since you get no news from @Stanislas0 in the issue #1.

EDIT: created

Well, that difference between the completions proposed was my fault, sorry for that dumb mistake (fixed in last commits).

I've checked the files of the vscode extension, I didn't know the whole code was available.
Indeed everything could be retrieved from it. But I hope a better documentation would be available.

BrachystochroneSD · 2023-09-27T17:42:30Z

codegeex.el

-(defvar codegeex-temperature 0.2 "temperature for completion by CodeGeeX")
-(defvar codegeex-top_p 0.95 "top_p for completion by CodeGeeX")
-(defvar codegeex-top_k 0 "top_k for completion by CodeGeeX")
-(defvar codegeex-extinfo `((sid . ,(uuidgen-4))


This is the only usage of uuid package. Maybe put the function in the package to avoid dependencies would be interesting

Yes, in fact you can remove this parameter directly. It does not affect any behavior. I added it because I think this may help codegeex to improve their codelm, since sid exists in their official vscode extension.

Let's remove it right now then and we can rethink about this in the future, when we will get a correct API documentation (if we have one)

BrachystochroneSD · 2023-09-27T17:47:28Z

codegeex.el

-(defun codegeex-buffer-completion ()
-  "CodeGeeX buffer completion.
+(defun codegeex-complete ()


codegeex-buffer-completion become:

codegeex-complete, which callback is the overlay handler codegeex-completion--show-completion

codegeex-complete-at-point, similar of previous codegeex-buffer-completion, which insert the first completion fetched

BrachystochroneSD · 2023-09-27T17:49:06Z

codegeex.el

+(defun codegeex-accept-completion (&optional transform-fn)
+  "Accept completion. Return t if there is a completion.
+Use TRANSFORM-FN to transform completion if provided."
+  (interactive)
+  (when (codegeex--overlay-visible)
+    (let* ((completion (overlay-get codegeex--overlay 'completion))
+           (start (overlay-get codegeex--overlay 'start))
+           (end (codegeex--overlay-end codegeex--overlay))
+           (uuid (overlay-get codegeex--overlay 'uuid))
+           (t-completion (funcall (or transform-fn #'identity) completion)))
+      (codegeex-clear-overlay)
+      (if (eq major-mode 'vterm-mode)
+          (progn
+            (vterm-delete-region start end)


codegeex-accept-completion codegeex-next-completion and codegeex-previous-completion are use to handle the overlaid completion proposition fetched. They can be binded for convenience by the user

BrachystochroneSD · 2023-09-27T17:52:03Z

codegeex.el

+(defmacro codegeex--satisfy-predicates (enable disable)
+  "Return t if satisfy all predicates in ENABLE and none in DISABLE."
+  `(and (cl-every (lambda (pred)
+                    (if (functionp pred) (funcall pred) t))
+                  ,enable)
+        (cl-notany (lambda (pred)
+                     (if (functionp pred) (funcall pred) nil))
+                   ,disable)))


This is used to trigger the request to codegeex api. Maybe we can add options to avoid triggering it on a comment line or something. Or even using a context system where different api endpoint are used based on where the pointer is in the buffer.

BrachystochroneSD · 2023-09-27T17:54:58Z

codegeex.el

+;; Contributor: Samuel Dawant <samueld@mailo.com>
 ;; Keywords: codegeex, completion
-;; Version: 0.0.1
+;; Version: 0.1.0


I took the liberty to increase the version (medium one since it add a functionality) and put myself in the contributor ;). If I may

BrachystochroneSD · 2023-09-27T17:55:29Z

codegeex.el

+(require 'codegeex-completion)
+(require 'codegeex-overlay)


Structure will certainly change soon

BrachystochroneSD · 2023-09-27T17:57:01Z

codegeex-api.el

+  (let ((n-factor
+         (cond
+          ((<= (length prefix) 300) 3)
+          ((> (length prefix) 600) 2)
+          ((> (length prefix) 900) 1))))
+    (when (> (length prefix) 1200 )
+      (setq prefix (substring prefix 0 1200)))


I took that cond from the vscode. Don't know if it's useful here.
Actually, I have no clue on the version of codegeex at the current endpoint, and I didn't found any documentation on the API

BrachystochroneSD · 2023-09-27T17:58:07Z

codegeex-api.el

+    (json-encode
+     `(:prompt ,prefix
+               :suffix ,suffix
+               :n ,n-factor
+               :apikey ,codegeex-apikey
+               :apisecret ,codegeex-apisecret
+               :temperature ,codegeex-temperature
+               :top_p ,codegeex-top_p
+               :top_k ,codegeex-top_k
+               :isFimEnabled ,(not (equal suffix ""))
+               :lang ,lang
+               :ext ,codegeex-extinfo))))
+


I use plist for convenience (and for its similarity with json object). The properties are highlighted and it is easier to manipulate

BrachystochroneSD · 2023-09-27T17:59:22Z

codegeex-api.el

+(defun codegeex-api--url-retrieve (url json-data callback)
+  "Default url retrieve as POST with json data"
+  (let ((url-request-method "POST")
+        (url-request-extra-headers
+         '(("Content-Type" . "application/json")))
+        (url-request-data json-data))
+    (url-retrieve
+     url
+     (lambda (status init-buffer callback)
+       (let ((result (codegeex-api--get-json-result)))
+         (setq codegeex-response-cache result)
+         (with-current-buffer init-buffer
+           (funcall callback result))))
+     `(,(current-buffer) ,callback) t)))


Will be the main api fetcher. With custom callback that take the json-result as argument. Can be used for the other api call that you have implemented by the way.

hzhangxyz · 2023-09-28T18:29:31Z

The code seems ok. But I don't want to check it carefully, since it is national day off in my country this week. So I add you to collaborators, and if you think it is ok, merge it by yourself.

BrachystochroneSD · 2023-09-29T07:59:52Z

The code seems ok. But I don't want to check it carefully, since it is national day off in my country this week. So I add you to collaborators, and if you think it is ok, merge it by yourself.

As you wish, I am not in a urge so I can wait for a proper review.
And that will give me more time to continue testing it with my other project.

Let's keep that pull request open until the end of your national holidays.

Enjoy your holiday

+ Increase prompt length limit to 5000 characters

BrachystochroneSD · 2023-10-08T13:20:43Z

Some bugs has been found.

It seems to no working without evil-mode. I'm checking what's wrong
When moving the cursor between the call request and the call response, the completion received is put in the cursor position and not where it has been called. For this I'll create a cache system.

BrachystochroneSD · 2023-10-14T16:48:31Z

Last commit check if the cursor doesn't move between the http request and the response.

I am checking if I can find other bugs before merging

BrachystochroneSD · 2024-10-27T18:41:42Z

Old api of codegeex is no longer working at my side.

Impossible to understand a thing on the api documentation of wiki at aminer.

I found "mistral.ai" project with codestral. Which is much more convenient and open in term of documentation. I've created an emacs package for it. I'll work in there. I will no longer work on this.

Samuel D added 2 commits September 25, 2023 20:56

Proof of concept for a overlay completion system

d711638

Working version

88629e7

BrachystochroneSD commented Sep 27, 2023

View reviewed changes

BrachystochroneSD marked this pull request as ready for review September 27, 2023 20:00

Typo

161bb2b

Samuel D added 3 commits October 1, 2023 00:19

Fixed: prefix/prompt substring was trunacting the end of the string

ecf755a

+ Increase prompt length limit to 5000 characters

Added: Cache the json request

43585cc

Change defun order

5ecc7b6

Samuel D added 2 commits October 14, 2023 18:45

Merge codegeex-completion with main codegeex.el

4fd0937

check if cursor doesn't change between the http request and response

609e5b7

Samuel D added 2 commits October 15, 2023 14:37

REmove require statement

d8a51f8

Add missing requirement

d03c551

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Inline completion with overlay #2

Inline completion with overlay #2

BrachystochroneSD commented Sep 27, 2023

BrachystochroneSD left a comment

BrachystochroneSD Sep 27, 2023

hzhangxyz Sep 28, 2023

BrachystochroneSD Sep 29, 2023 •

edited

Loading

BrachystochroneSD Sep 30, 2023 •

edited

Loading

BrachystochroneSD Sep 30, 2023 •

edited

Loading

BrachystochroneSD Sep 27, 2023

hzhangxyz Sep 28, 2023

BrachystochroneSD Sep 29, 2023

BrachystochroneSD Sep 27, 2023

BrachystochroneSD Sep 27, 2023

BrachystochroneSD Sep 27, 2023

BrachystochroneSD Sep 27, 2023

BrachystochroneSD Sep 27, 2023

BrachystochroneSD Sep 27, 2023

BrachystochroneSD Sep 27, 2023

BrachystochroneSD Sep 27, 2023

hzhangxyz commented Sep 28, 2023

BrachystochroneSD commented Sep 29, 2023

BrachystochroneSD commented Oct 8, 2023

BrachystochroneSD commented Oct 14, 2023

BrachystochroneSD commented Oct 27, 2024

		(require 'codegeex-completion)
		(require 'codegeex-overlay)

Inline completion with overlay #2

Are you sure you want to change the base?

Inline completion with overlay #2

Conversation

BrachystochroneSD commented Sep 27, 2023

BrachystochroneSD left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BrachystochroneSD Sep 29, 2023 • edited Loading

Choose a reason for hiding this comment

BrachystochroneSD Sep 30, 2023 • edited Loading

Choose a reason for hiding this comment

BrachystochroneSD Sep 30, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hzhangxyz commented Sep 28, 2023

BrachystochroneSD commented Sep 29, 2023

BrachystochroneSD commented Oct 8, 2023

BrachystochroneSD commented Oct 14, 2023

BrachystochroneSD commented Oct 27, 2024

BrachystochroneSD Sep 29, 2023 •

edited

Loading

BrachystochroneSD Sep 30, 2023 •

edited

Loading

BrachystochroneSD Sep 30, 2023 •

edited

Loading