Update .gif previews, allow custom system prompt and add note on expected response structure

Author: dalthviz

README.md

@@ -7,11 +7,10 @@
 [![OpenCollective Backers](https://opencollective.com/spyder/backers/badge.svg?color=blue)](#backers)
 [![OpenCollective Sponsors](https://opencollective.com/spyder/sponsors/badge.svg?color=blue)](#sponsors)
 
-----
+---
 
 # Overview
 
-
 ## Installation
 
 To use this completions provider you will need to install Spyder 6 (at least 6.0.0a3)
@@ -26,8 +25,30 @@ Or from PyPI something like:
 
 Also, you need to set the environment variable `OPENAI_API_KEY`. In case
 you are actually using the OpenAI API you can get it from [here](https://platform.openai.com/signup)
-but for usage with for example local LLMs (via things like [LMStudio](https://lmstudio.ai))
- you just need to set it with a corresponding valid value.
+but for usage with, for example, local LLMs (via things like [LMStudio](https://lmstudio.ai))
+you will need to set it with a corresponding valid value.
+
+Depending on the API you are using and options to configure available, setting the
+following JSON schema for the model structured output could be useful:
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Generated schema for responses",
+  "type": "object",
+  "properties": {
+    "suggestions": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "required": [
+    "suggestions"
+  ]
+}
+```
 
 ## Preview
 
@@ -71,8 +92,7 @@ and the donations we have received from our users around the world through [Open
 
 [Spyder Github](https://github.com/spyder-ide/spyder)
 
-[Troubleshooting Guide and FAQ](
-https://github.com/spyder-ide/spyder/wiki/Troubleshooting-Guide-and-FAQ)
+[Troubleshooting Guide and FAQ](https://github.com/spyder-ide/spyder/wiki/Troubleshooting-Guide-and-FAQ)
 
 [Development Wiki](https://github.com/spyder-ide/spyder/wiki/Dev:-Index)
 

langchain-provider-config.gif

@@ -36,17 +36,23 @@ class LangchainProvider(SpyderCompletionProvider):
         ("language", "Python"),
         ("model_name", "No model"),
         ("api_url", "https://api.openai.com/v1"),
+        (
+            "template",
+            """You are a helpful assistant in completing following {language} code based
+on the previous sentence.
+
+You always give {num_suggestions} suggestions.
+
+Example : a=3 b=4 print
+AI : "suggestions": ["print(a)", "print(b)", "print(a+b)"]
+Example : a=3 b=4 c
+AI : "suggestions": ["c=a+b", "c=a-b", "c=5"]
+Format the output as JSON with the following key:
+    suggestions
+
+""",
+        ),
     ]
-    TEMPLATE_PARAM = """You are a helpful assistant in completing following {0} code based
-                  on the previous sentence.
-                  You always complete the code in same line and give {1} suggestions.
-                  Example : a=3 b=4 print
-                  AI : "suggestions": ["print(a)", "print(b)", "print(a+b)"]
-                  Example : a=3 b=4 c
-                  AI : "suggestions": ["c=a+b", "c=a-b", "c=5"]
-                  Format the output as JSON with the following key:
-                      suggestions
-                  """
 
     def __init__(self, parent, config):
         super().__init__(parent, config)
@@ -58,8 +64,9 @@ def __init__(self, parent, config):
             None,
             model_name=self.get_conf("model_name"),
             api_url=self.get_conf("api_url"),
-            template=self.TEMPLATE_PARAM.format(
-                self.get_conf("language"), self.get_conf("suggestions")
+            template=self.get_conf("template").format(
+                language=self.get_conf("language"),
+                num_suggestions=self.get_conf("suggestions"),
             ),
         )
 
@@ -131,8 +138,9 @@ def update_langchain_configuration(self, config):
         self.client.update_configuration(
             self.get_conf("model_name"),
             self.get_conf("api_url"),
-            self.TEMPLATE_PARAM.format(
-                self.get_conf("language"), self.get_conf("suggestions")
+            self.get_conf("template").format(
+                language=self.get_conf("language"),
+                num_suggestions=self.get_conf("suggestions"),
             ),
         )
 

langchain-provider.gif

@@ -13,12 +13,13 @@
 # Third party imports
 from qtpy.QtCore import Qt
 from qtpy.QtWidgets import (
-    QLineEdit,
     QDialog,
     QDialogButtonBox,
     QFormLayout,
-    QSpinBox,
     QHBoxLayout,
+    QLineEdit,
+    QSpinBox,
+    QTextEdit,
     QVBoxLayout,
 )
 
@@ -31,9 +32,9 @@
 class LangchainConfigDialog(QDialog):
     def __init__(self, provider, parent=None):
         super().__init__(parent=parent)
-
         self._provider = provider
 
+        self.setFixedSize(600, 400)
         self.setAttribute(Qt.WA_DeleteOnClose)
         self.setWindowTitle(_("Langchain provider configuration"))
         self.setModal(True)
@@ -52,10 +53,16 @@ def __init__(self, provider, parent=None):
         self.api_url_lineedit = QLineEdit()
         self.api_url_lineedit.setText(provider.get_conf("api_url"))
 
+        template_label_text = _("System prompt:")
+        self.template_textedit = QTextEdit()
+        self.template_textedit.setPlainText(provider.get_conf("template"))
+
         form_layout = QFormLayout()
+        form_layout.setFieldGrowthPolicy(QFormLayout.ExpandingFieldsGrow)
         form_layout.addRow(suggestions_label_text, self.suggestions_spinbox)
         form_layout.addRow(model_label_text, self.model_lineedit)
         form_layout.addRow(api_url_label_text, self.api_url_lineedit)
+        form_layout.addRow(template_label_text, self.template_textedit)
 
         bbox = QDialogButtonBox(
             QDialogButtonBox.Ok | QDialogButtonBox.Cancel, Qt.Vertical, self
@@ -78,4 +85,5 @@ def accept(self):
             self._provider.set_conf("suggestions", self.suggestions_spinbox.value())
             self._provider.set_conf("model_name", self.model_lineedit.text())
             self._provider.set_conf("api_url", self.api_url_lineedit.text())
+            self._provider.set_conf("template", self.template_textedit.toPlainText())
             super().accept()