Changes between Version 7 and Version 8 of Public/DjAiAdmin

Timestamp:

Jul 9, 2023, 12:19:29 PM (17 months ago)

Author:

Boris Horner

Comment:

—

Public/DjAiAdmin

@@ -30 +30 @@
 dotnet djAI.dll --urls http://127.0.0.1:5000
 }}}
-* Configure the service to start on system reboot:
- * **Linux:** Run {{{crontab -e}}} and add the following line:
-  {{{
-@reboot /path/to/djAI/run_djAI.cmd
-}}}
- * **Windows:** Use //Scheduled tasks// to configure automatic start. 
 
 
@@ -92 +86 @@
 //dj//**AI** is not, and does not contain, a Large Language Model (LLM) by itself. Instead, it's a flexible interface to standardize and simplify AI briefing and use. The actual AI functionality is provided by external services.
 
+Model support is done by simple plugins that must implement an interface with very few methods. We'll implement more models as needed (integration of RedPajama running on a local video board is on the way). We'll provide the interface definition with some documentation, so anyone can write their own plugins.
+
 Currently, //dj//**AI** supports these models:
 * openAI: GPT3.5 turbo. We are still on the waitlist for GPT4 and will integrate it as soon as we can access it.
-* AlephAlpha: base, extended and supreme levels.
+* !AlephAlpha: base, extended and supreme levels.
 
-Model support is done by simple plugins that must implement an interface with very few methods. We'll implement more models as needed (integration of RedPajama running on a local video board is on the way). We'll provide the interface definition with some documentation, so anyone can write their own plugins.
+To use any of these services, you must have an account with openAI and/or !AlephAlpha, and you must obtain an API secret for each of the services you want to use.
 
 In //djAI//, AI models are configured in the file {{{Models.json}}} in the main program folder. The default file looks like this:
@@ -158 +154 @@
     }
   }
-}}}}
+}
+}}}
+
+If you have an API secret for a model, insert it in the {{{ApiKey}}} field. If you do not have a secret for a model, remove it from the configuration by deleting its configuration (JSON does not allow commenting it out).
+
+Please note that the {{{Temperature}}} parameter is currently not read, instead, the default value is used. In the future, it will be possible to configure other values for this and other parameters of the model. Please do not modify any parameters than the {{{ApiKey}}} one.
+
+=== Running the djAI service
+To run the djAI web service on your client machine, execute {{{run_djAI.cmd}}} by double-clicking it, before you start the client.
+
+=== Configuration of the djAI service to start on reboot
+* **Windows Server:** Using //Scheduled Tasks//, configure {{{run_djAI.cmd}}} to start at server start.
+* **Linux Server:**
+ * In the {{{djAI}}} program folder, copy {{{run_djAI.cmd}}} to {{{run_djAI.sh}}}.
+ * Set the execute permission of {{{run_djAI.sh}}} to the user in whose context you want to run it.
+ * Add the following line to {{{crontab -e}}}:
+  {{{
+@reboot /path/to/run_djAI.sh
+}}}
+
+> **NOTE:** Optionally, you might want to run //dj//**AI** behind a proxy. Follow the documentation of the proxy's web server.