@casual-simulation/aux-common 3.2.1 → 3.2.2-alpha.5675659631

package/runtime/AuxLibraryDefinitions.def

@@ -8569,6 +8569,11 @@ declare global {
      */
     const os: Os;
 
+    /**
+     * Defines a set of functions that relate to AI operations.
+     */
+    const ai: Ai;
+
     /**
      * Defines a set of functions that relate to common server operations.
      * Typically, these operations are instance-independent.
@@ -9399,6 +9404,11 @@ interface DebuggerBase {
      */
     os: Os;
 
+    /**
+     * Defines a set of functions that relate to AI operations.
+     */
+    ai: Ai;
+
     /**
      * Defines a set of functions that relate to common server operations.
      * Typically, these operations are instance-independent.
@@ -9760,6 +9770,260 @@ export interface StopFormAnimationOptions {
     duration: number;
 }
 
+/**
+ * Defines an interface that represents a single chat message in a conversation with an AI.
+ *
+ * @dochash types/ai
+ * @docname AIChatMessage
+ */
+export interface AIChatMessage {
+    /**
+     * The role of the message.
+     *
+     * - `system` means that the message was generated by the system. Useful for telling the AI how to behave while.
+     * - `user` means that the message was generated by the user.
+     * - `assistant` means that the message was generated by the AI assistant.
+     * - `function` means that the message contains the results of a function call.
+     */
+    role: 'system' | 'user' | 'assistant' | 'function';
+
+    /**
+     * The contents of the message.
+     */
+    content: string;
+
+    /**
+     * The name of the author of the message.
+     *
+     * This is required if the role is `function`.
+     */
+    author?: string;
+
+    /**
+     * The reason why the message was finished.
+     */
+    finishReason?: string;
+}
+
+
+/**
+ * Defines an interface that represents options for {@link ai.chat}.
+ *
+ * @dochash types/ai
+ * @docname AIChatOptions
+ */
+export interface AIChatOptions extends RecordActionOptions {
+    /**
+     * The model that should be used.
+     *
+     * If not specified, then a default will be used.
+     *
+     * Currently, the following models are supported:
+     *
+     * - `gpt-4`
+     * - `gpt-3.5-turbo`
+     */
+    preferredModel?: 'gpt-4' | 'gpt-3.5-turbo';
+
+    /**
+     * The temperature that should be used.
+     *
+     * If not specified, then a default will be used.
+     */
+    temperature?: number;
+
+    /**
+     * The nucleus sampling probability.
+     */
+    topP?: number;
+
+    /**
+     * The presence penalty.
+     *
+     * Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.
+     */
+    presencePenalty?: number;
+
+    /**
+     * The frequency penalty.
+     *
+     * Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.
+     */
+    frequencyPenalty?: number;
+
+    /**
+     * The list of stop words that should be used.
+     * 
+     * If the AI generates a sequence of tokens that match one of the given words, then it will stop generating tokens.
+     */
+    stopWords?: string[];
+}
+
+interface Ai {
+    /**
+     * Sends a chat message to the AI.
+     * Returns a promise that contains the response from the AI.
+     * Throws a {@link CasualOSError} if an error occurs while sending the message.
+     *
+     * This function can be useful for creating chat bots, or for using an Artificial Intelligence (AI) to process a message.
+     *
+     * @param message The message that should be sent to the AI.
+     * @param options The options that should be used.
+     *
+     * @example Send a message to the AI and log the response.
+     * const response = await ai.chat("Hello!");
+     * console.log(response);
+     *
+     * @dochash actions/ai
+     * @doctitle AI Actions
+     * @docsidebar AI
+     * @docdescription AI actions are functions that make it easier to work with the AI.
+     * @docname ai.chat
+     * @docid ai.chat-string
+     */
+    chat(message: string, options?: AIChatOptions): Promise<string>;
+
+    /**
+     * Sends a chat message to the AI.
+     * Returns a promise that contains the response from the AI.
+     * Throws a {@link CasualOSError} if an error occurs while sending the message.
+     *
+     * This function can be useful for creating chat bots, or for using an Artificial Intelligence (AI) to process a message.
+     *
+     * @param message The message that should be sent to the AI.
+     * @param options The options that should be used.
+     *
+     * @example Send a message to the AI and log the response.
+     * const response = await ai.chat({
+     *     role: "user",
+     *     content: "Hello!"
+     * });
+     * console.log(`${response.role}: ${response.content}`);
+     *
+     * @dochash actions/ai
+     * @docname ai.chat
+     * @docid ai.chat-message
+     */
+    chat(
+        message: AIChatMessage,
+        options?: AIChatOptions
+    ): Promise<AIChatMessage>;
+
+    /**
+     * Sends a chat message to the AI.
+     * Returns a promise that contains the response from the AI.
+     * Throws a {@link CasualOSError} if an error occurs while sending the message.
+     *
+     * This function can be useful for creating chat bots, or for using an Artificial Intelligence (AI) to process a message.
+     *
+     * @param message The message that should be sent to the AI.
+     * @param options The options that should be used.
+     *
+     * @example Send a message to the AI and log the response.
+     * const response = await ai.chat([
+     *      {
+     *          role: "system",
+     *          content: "You are a helpful assistant."
+     *      },
+     *     {
+     *          role: "user",
+     *          content: "Hello!"
+     *     }
+     * ]);
+     * console.log(`${response.role}: ${response.content}`);
+     *
+     * @example Build a basic chat bot.
+     * const messages = [
+     *      {
+     *          role: "system",
+     *          content: "You are a helpful assistant."
+     *      },
+     * ];
+     *
+     * while(true) {
+     *      const userInput = await os.showInput();
+     *      if (!userInput) {
+     *          break;
+     *      }
+     *      messages.push({
+     *          role: "user",
+     *          content: userInput
+     *      });
+     *
+     *      const response = await ai.chat(messages);
+     *      messages.push(response);
+     *      os.toast(response.content);
+     * }
+     *
+     * os.toast("Goodbye!");
+     *
+     * @dochash actions/ai
+     * @docname ai.chat
+     * @docid ai.chat-messages
+     */
+    chat(
+        messages: AIChatMessage[],
+        options?: AIChatOptions
+    ): Promise<AIChatMessage>;
+
+    /**
+     * Sends a chat message to the AI.
+     * Returns a promise that contains the response from the AI.
+     * Throws a {@link CasualOSError} if an error occurs while sending the message.
+     *
+     * This function can be useful for creating chat bots, or for using an Artificial Intelligence (AI) to process a message.
+     *
+     * @param message The message that should be sent to the AI.
+     * @param options The options that should be used.
+     *
+     * @example Send a message to the AI and log the response.
+     * const response = await ai.chat([
+     *      {
+     *          role: "system",
+     *          content: "You are a helpful assistant."
+     *      },
+     *     {
+     *          role: "user",
+     *          content: "Hello!"
+     *     }
+     * ]);
+     * console.log(`${response.role}: ${response.content}`);
+     *
+     * @example Build a basic chat bot.
+     * const messages = [
+     *      {
+     *          role: "system",
+     *          content: "You are a helpful assistant."
+     *      },
+     * ];
+     *
+     * while(true) {
+     *      const userInput = await os.showInput();
+     *      if (!userInput) {
+     *          break;
+     *      }
+     *      messages.push({
+     *          role: "user",
+     *          content: userInput
+     *      });
+     *
+     *      const response = await ai.chat(messages);
+     *      messages.push(response);
+     *      os.toast(response.content);
+     * }
+     *
+     * os.toast("Goodbye!");
+     *
+     * @dochash actions/ai
+     * @docname ai.chat
+     * @docid ai.chat-messages
+     */
+    chat(
+        messages: string | AIChatMessage | AIChatMessage[],
+        options?: AIChatOptions
+    ): Promise<AIChatMessage | string>
+}
+
 interface Os {
     /**
          * Sleeps for time in ms.

package/runtime/CasualOSError.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Defines an interface that represents a generic error.
+ *
+ * @dochash types/error
+ * @docname GenericError
+ */
+export interface GenericError {
+    /**
+     * The error code.
+     */
+    errorCode: string;
+    /**
+     * The error message.
+     */
+    errorMessage: string;
+}
+/**
+ * Defines a class that represents a generic CasualOS error.
+ *
+ * @dochash types/error
+ * @doctitle Error Types
+ * @docsidebar Error
+ * @docdescription Types that contain information about errors that can occur in CasualOS.
+ * @docname CasualOSError
+ */
+export declare class CasualOSError extends Error {
+    /**
+     * The error code that occurred.
+     */
+    errorCode: string;
+    /**
+     * The error message that occurred.
+     */
+    errorMessage: string;
+    constructor(error: GenericError | string);
+}
+//# sourceMappingURL=CasualOSError.d.ts.map

package/runtime/CasualOSError.js

@@ -0,0 +1,25 @@
+/**
+ * Defines a class that represents a generic CasualOS error.
+ *
+ * @dochash types/error
+ * @doctitle Error Types
+ * @docsidebar Error
+ * @docdescription Types that contain information about errors that can occur in CasualOS.
+ * @docname CasualOSError
+ */
+export class CasualOSError extends Error {
+    constructor(error) {
+        super(typeof error === 'string'
+            ? error
+            : `${error.errorCode}: ${error.errorMessage}`);
+        if (typeof error === 'string') {
+            this.errorCode = 'error';
+            this.errorMessage = error;
+        }
+        else {
+            this.errorCode = error.errorCode;
+            this.errorMessage = error.errorMessage;
+        }
+    }
+}
+//# sourceMappingURL=CasualOSError.js.map

package/runtime/CasualOSError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CasualOSError.js","sourceRoot":"","sources":["CasualOSError.ts"],"names":[],"mappings":"AAkBA;;;;;;;;GAQG;AACH,MAAM,OAAO,aAAc,SAAQ,KAAK;IAWpC,YAAY,KAA4B;QACpC,KAAK,CACD,OAAO,KAAK,KAAK,QAAQ;YACrB,CAAC,CAAC,KAAK;YACP,CAAC,CAAC,GAAG,KAAK,CAAC,SAAS,KAAK,KAAK,CAAC,YAAY,EAAE,CACpD,CAAC;QACF,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC3B,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC;YACzB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;SAC7B;aAAM;YACH,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;YACjC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;SAC1C;IACL,CAAC;CACJ"}