@nocobase/plugin-ai 2.3.0-alpha.1 → 2.3.0-beta.3

package/dist/swagger/llm.js

@@ -0,0 +1,255 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var llm_exports = {};
+__export(llm_exports, {
+  llmPaths: () => llmPaths
+});
+module.exports = __toCommonJS(llm_exports);
+var import_common = require("./common");
+const modelTypeParameter = {
+  name: "model",
+  in: "query",
+  description: "Filter by supported model type.",
+  schema: {
+    type: "string",
+    enum: ["LLM", "EMBEDDING"]
+  }
+};
+const llmPaths = {
+  "/ai:listLLMProviders": {
+    get: {
+      operationId: "ai:listLLMProviders",
+      tags: ["ai"],
+      summary: "List registered LLM providers",
+      responses: (0, import_common.withErrorResponses)(
+        (0, import_common.okResponse)({
+          type: "array",
+          items: {
+            $ref: "#/components/schemas/LLMProvider"
+          }
+        })
+      )
+    }
+  },
+  "/ai:listProviderModels": {
+    post: {
+      operationId: "ai:listProviderModels",
+      tags: ["ai"],
+      summary: "List models available from an LLM provider",
+      requestBody: {
+        required: true,
+        content: (0, import_common.jsonContent)({
+          $ref: "#/components/schemas/LLMProviderModelsRequest"
+        })
+      },
+      responses: (0, import_common.withErrorResponses)(
+        (0, import_common.okResponse)({
+          type: "array",
+          items: {
+            $ref: "#/components/schemas/LLMModel"
+          }
+        })
+      )
+    }
+  },
+  "/ai:testFlight": {
+    post: {
+      operationId: "ai:testFlight",
+      tags: ["ai"],
+      summary: "Validate an LLM provider configuration",
+      requestBody: {
+        required: true,
+        content: (0, import_common.jsonContent)({
+          $ref: "#/components/schemas/LLMTestFlightRequest"
+        })
+      },
+      responses: (0, import_common.withErrorResponses)(
+        (0, import_common.okResponse)({
+          $ref: "#/components/schemas/LLMTestFlightResult"
+        })
+      )
+    }
+  },
+  "/ai:listModels": {
+    get: {
+      operationId: "ai:listModels",
+      tags: ["ai"],
+      summary: "List models available for an LLM service",
+      parameters: [
+        {
+          name: "llmService",
+          in: "query",
+          required: true,
+          schema: {
+            type: "string"
+          }
+        },
+        modelTypeParameter
+      ],
+      responses: (0, import_common.withErrorResponses)(
+        (0, import_common.okResponse)({
+          type: "array",
+          items: {
+            $ref: "#/components/schemas/LLMModel"
+          }
+        })
+      )
+    }
+  },
+  "/ai:listLLMServices": {
+    get: {
+      operationId: "ai:listLLMServices",
+      tags: ["ai"],
+      summary: "List enabled LLM services",
+      parameters: [
+        {
+          name: "filter",
+          in: "query",
+          description: "NocoBase filter object encoded as JSON.",
+          schema: {
+            type: "object",
+            additionalProperties: true
+          }
+        },
+        modelTypeParameter
+      ],
+      responses: (0, import_common.withErrorResponses)(
+        (0, import_common.okResponse)({
+          type: "array",
+          items: {
+            $ref: "#/components/schemas/EnabledLLMService"
+          }
+        })
+      )
+    }
+  },
+  "/llmServices:list": {
+    get: {
+      operationId: "llmServices:list",
+      tags: ["llmServices"],
+      summary: "List saved LLM services",
+      parameters: import_common.listParameters,
+      responses: (0, import_common.withErrorResponses)(
+        (0, import_common.okResponse)({
+          oneOf: [
+            {
+              type: "array",
+              items: {
+                $ref: "#/components/schemas/LLMService"
+              }
+            },
+            {
+              type: "object",
+              properties: {
+                rows: {
+                  type: "array",
+                  items: {
+                    $ref: "#/components/schemas/LLMService"
+                  }
+                },
+                count: {
+                  type: "integer"
+                }
+              }
+            }
+          ]
+        })
+      )
+    }
+  },
+  "/llmServices:get": {
+    get: {
+      operationId: "llmServices:get",
+      tags: ["llmServices"],
+      summary: "Get one saved LLM service",
+      parameters: [import_common.filterByTkParameter],
+      responses: (0, import_common.withErrorResponses)(
+        (0, import_common.okResponse)({
+          $ref: "#/components/schemas/LLMService"
+        })
+      )
+    }
+  },
+  "/llmServices:create": {
+    post: {
+      operationId: "llmServices:create",
+      "x-nocobase-cli-ui": {
+        path: "admin/settings/ai/llm-services",
+        parameters: ["provider"]
+      },
+      tags: ["llmServices"],
+      summary: "Create an LLM service",
+      requestBody: {
+        required: true,
+        content: (0, import_common.jsonContent)({
+          $ref: "#/components/schemas/LLMServiceCreate"
+        })
+      },
+      responses: (0, import_common.withErrorResponses)(
+        (0, import_common.okResponse)({
+          $ref: "#/components/schemas/LLMService"
+        })
+      )
+    }
+  },
+  "/llmServices:update": {
+    post: {
+      operationId: "llmServices:update",
+      "x-nocobase-cli-ui": {
+        path: "admin/settings/ai/llm-services",
+        parameters: ["filterByTk"]
+      },
+      tags: ["llmServices"],
+      summary: "Update an LLM service",
+      parameters: [import_common.filterByTkParameter],
+      requestBody: {
+        required: true,
+        content: (0, import_common.jsonContent)({
+          $ref: "#/components/schemas/LLMServicePatch"
+        })
+      },
+      responses: (0, import_common.withErrorResponses)(
+        (0, import_common.okResponse)({
+          $ref: "#/components/schemas/LLMService"
+        })
+      )
+    }
+  },
+  "/llmServices:destroy": {
+    post: {
+      operationId: "llmServices:destroy",
+      tags: ["llmServices"],
+      summary: "Delete an LLM service",
+      parameters: [import_common.filterByTkParameter],
+      responses: (0, import_common.withErrorResponses)((0, import_common.okResponse)())
+    }
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  llmPaths
+});