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

package/dist/swagger/schemas.d.ts

@@ -0,0 +1,757 @@
+/**
+ * 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.
+ */
+export declare const schemas: {
+    ErrorResponse: {
+        type: string;
+        properties: {
+            errors: {
+                type: string;
+                items: {
+                    type: string;
+                    properties: {
+                        message: {
+                            type: string;
+                        };
+                        code: {
+                            type: string;
+                        };
+                    };
+                    additionalProperties: boolean;
+                };
+            };
+        };
+        additionalProperties: boolean;
+    };
+    LLMProvider: {
+        type: string;
+        required: string[];
+        properties: {
+            name: {
+                type: string;
+            };
+            title: {
+                type: string;
+            };
+            supportedModel: {
+                type: string;
+                items: {
+                    type: string;
+                    enum: string[];
+                };
+            };
+            supportWebSearch: {
+                type: string;
+            };
+            webSearchModels: {
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+        };
+        additionalProperties: boolean;
+    };
+    LLMProviderModelsRequest: {
+        type: string;
+        required: string[];
+        properties: {
+            provider: {
+                type: string;
+            };
+            options: {
+                type: string;
+                description: string;
+                properties: {
+                    apiKey: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    accessKey: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    secretKey: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    password: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    baseURL: {
+                        type: string;
+                        format: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            model: {
+                type: string;
+                description: string;
+            };
+        };
+        additionalProperties: boolean;
+    };
+    LLMTestFlightRequest: {
+        type: string;
+        required: string[];
+        properties: {
+            provider: {
+                type: string;
+            };
+            options: {
+                type: string;
+                description: string;
+                properties: {
+                    apiKey: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    accessKey: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    secretKey: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    password: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    baseURL: {
+                        type: string;
+                        format: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            model: {
+                type: string;
+            };
+        };
+        additionalProperties: boolean;
+    };
+    LLMModel: {
+        type: string;
+        required: string[];
+        properties: {
+            id: {
+                type: string;
+            };
+        };
+        additionalProperties: boolean;
+    };
+    LLMTestFlightResult: {
+        type: string;
+        required: string[];
+        properties: {
+            status: {
+                type: string;
+                enum: string[];
+            };
+            code: {
+                type: string;
+            };
+            message: {
+                type: string;
+            };
+        };
+        additionalProperties: boolean;
+    };
+    LLMServiceCreate: {
+        type: string;
+        required: string[];
+        properties: {
+            name: {
+                type: string;
+            };
+            title: {
+                type: string;
+            };
+            provider: {
+                type: string;
+            };
+            options: {
+                type: string;
+                description: string;
+                properties: {
+                    apiKey: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    accessKey: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    secretKey: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    password: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    baseURL: {
+                        type: string;
+                        format: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            enabledModels: {
+                type: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    mode: {
+                        type: string;
+                        enum: string[];
+                        description: string;
+                    };
+                    models: {
+                        type: string;
+                        items: {
+                            type: string;
+                            required: string[];
+                            additionalProperties: boolean;
+                            properties: {
+                                label: {
+                                    type: string;
+                                };
+                                value: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            enabled: {
+                type: string;
+            };
+        };
+        additionalProperties: boolean;
+    };
+    LLMServicePatch: {
+        type: string;
+        properties: {
+            name: {
+                type: string;
+            };
+            title: {
+                type: string;
+            };
+            provider: {
+                type: string;
+            };
+            options: {
+                type: string;
+                description: string;
+                properties: {
+                    apiKey: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    accessKey: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    secretKey: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    password: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    baseURL: {
+                        type: string;
+                        format: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            enabledModels: {
+                type: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    mode: {
+                        type: string;
+                        enum: string[];
+                        description: string;
+                    };
+                    models: {
+                        type: string;
+                        items: {
+                            type: string;
+                            required: string[];
+                            additionalProperties: boolean;
+                            properties: {
+                                label: {
+                                    type: string;
+                                };
+                                value: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            enabled: {
+                type: string;
+            };
+        };
+        additionalProperties: boolean;
+    };
+    LLMService: {
+        type: string;
+        properties: {
+            modelOptions: {
+                type: string;
+                readOnly: boolean;
+                additionalProperties: boolean;
+            };
+            createdAt: {
+                type: string;
+                format: string;
+                readOnly: boolean;
+            };
+            updatedAt: {
+                type: string;
+                format: string;
+                readOnly: boolean;
+            };
+            name: {
+                type: string;
+            };
+            title: {
+                type: string;
+            };
+            provider: {
+                type: string;
+            };
+            options: {
+                type: string;
+                description: string;
+                properties: {
+                    apiKey: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    accessKey: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    secretKey: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    password: {
+                        type: string;
+                        writeOnly: boolean;
+                        description: string;
+                    };
+                    baseURL: {
+                        type: string;
+                        format: string;
+                    };
+                };
+                additionalProperties: boolean;
+            };
+            enabledModels: {
+                type: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    mode: {
+                        type: string;
+                        enum: string[];
+                        description: string;
+                    };
+                    models: {
+                        type: string;
+                        items: {
+                            type: string;
+                            required: string[];
+                            additionalProperties: boolean;
+                            properties: {
+                                label: {
+                                    type: string;
+                                };
+                                value: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            enabled: {
+                type: string;
+            };
+        };
+        additionalProperties: boolean;
+    };
+    EnabledLLMService: {
+        type: string;
+        properties: {
+            name: {
+                type: string;
+            };
+            title: {
+                type: string;
+            };
+            provider: {
+                type: string;
+            };
+            enabled: {
+                type: string;
+            };
+            enabledModels: {
+                type: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    mode: {
+                        type: string;
+                        enum: string[];
+                        description: string;
+                    };
+                    models: {
+                        type: string;
+                        items: {
+                            type: string;
+                            required: string[];
+                            additionalProperties: boolean;
+                            properties: {
+                                label: {
+                                    type: string;
+                                };
+                                value: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        additionalProperties: boolean;
+    };
+    AIEmployeeCreate: {
+        type: string;
+        required: string[];
+        properties: {
+            username: {
+                type: string;
+            };
+            nickname: {
+                type: string;
+            };
+            position: {
+                type: string;
+            };
+            avatar: {
+                type: string;
+            };
+            bio: {
+                type: string;
+            };
+            about: {
+                type: string;
+            };
+            greeting: {
+                type: string;
+            };
+            modelSettings: {
+                type: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    enabled: {
+                        type: string;
+                    };
+                    models: {
+                        type: string;
+                        items: {
+                            type: string;
+                            required: string[];
+                            additionalProperties: boolean;
+                            properties: {
+                                llmService: {
+                                    type: string;
+                                };
+                                model: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            enableKnowledgeBase: {
+                type: string;
+            };
+            knowledgeBase: {
+                type: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    topK: {
+                        type: string;
+                        minimum: number;
+                    };
+                    score: {
+                        type: string;
+                        description: string;
+                        example: string;
+                    };
+                    knowledgeBaseKeys: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    retrievalStrategy: {
+                        type: string;
+                        enum: string[];
+                        description: string;
+                    };
+                };
+            };
+            enabled: {
+                type: string;
+            };
+        };
+        additionalProperties: boolean;
+    };
+    AIEmployeePatch: {
+        type: string;
+        properties: {
+            username: {
+                type: string;
+            };
+            nickname: {
+                type: string;
+            };
+            position: {
+                type: string;
+            };
+            avatar: {
+                type: string;
+            };
+            bio: {
+                type: string;
+            };
+            about: {
+                type: string;
+            };
+            greeting: {
+                type: string;
+            };
+            modelSettings: {
+                type: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    enabled: {
+                        type: string;
+                    };
+                    models: {
+                        type: string;
+                        items: {
+                            type: string;
+                            required: string[];
+                            additionalProperties: boolean;
+                            properties: {
+                                llmService: {
+                                    type: string;
+                                };
+                                model: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            enableKnowledgeBase: {
+                type: string;
+            };
+            knowledgeBase: {
+                type: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    topK: {
+                        type: string;
+                        minimum: number;
+                    };
+                    score: {
+                        type: string;
+                        description: string;
+                        example: string;
+                    };
+                    knowledgeBaseKeys: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    retrievalStrategy: {
+                        type: string;
+                        enum: string[];
+                        description: string;
+                    };
+                };
+            };
+            enabled: {
+                type: string;
+            };
+        };
+        additionalProperties: boolean;
+    };
+    AIEmployee: {
+        type: string;
+        properties: {
+            builtIn: {
+                type: string;
+                readOnly: boolean;
+            };
+            category: {
+                type: string;
+                readOnly: boolean;
+            };
+            deprecated: {
+                type: string;
+                readOnly: boolean;
+            };
+            missingKnowledgeBaseKeys: {
+                type: string;
+                readOnly: boolean;
+                items: {
+                    type: string;
+                };
+            };
+            createdAt: {
+                type: string;
+                format: string;
+                readOnly: boolean;
+            };
+            updatedAt: {
+                type: string;
+                format: string;
+                readOnly: boolean;
+            };
+            username: {
+                type: string;
+            };
+            nickname: {
+                type: string;
+            };
+            position: {
+                type: string;
+            };
+            avatar: {
+                type: string;
+            };
+            bio: {
+                type: string;
+            };
+            about: {
+                type: string;
+            };
+            greeting: {
+                type: string;
+            };
+            modelSettings: {
+                type: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    enabled: {
+                        type: string;
+                    };
+                    models: {
+                        type: string;
+                        items: {
+                            type: string;
+                            required: string[];
+                            additionalProperties: boolean;
+                            properties: {
+                                llmService: {
+                                    type: string;
+                                };
+                                model: {
+                                    type: string;
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+            enableKnowledgeBase: {
+                type: string;
+            };
+            knowledgeBase: {
+                type: string;
+                required: string[];
+                additionalProperties: boolean;
+                properties: {
+                    topK: {
+                        type: string;
+                        minimum: number;
+                    };
+                    score: {
+                        type: string;
+                        description: string;
+                        example: string;
+                    };
+                    knowledgeBaseKeys: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
+                    retrievalStrategy: {
+                        type: string;
+                        enum: string[];
+                        description: string;
+                    };
+                };
+            };
+            enabled: {
+                type: string;
+            };
+        };
+        additionalProperties: boolean;
+    };
+};