plugin-custom-llm 1.2.0 → 1.2.2

package/src/client/llm-providers/custom-llm/ModelSettings.tsx

@@ -0,0 +1,139 @@
+import React from 'react';
+import { SchemaComponent } from '@nocobase/client';
+import { tval } from '@nocobase/utils/client';
+import { namespace, useT } from '../../locale';
+import { Collapse } from 'antd';
+import { ModelSelect } from '@nocobase/plugin-ai/client';
+
+const Options: React.FC = () => {
+  const t = useT();
+  return (
+    <div style={{ marginBottom: 24 }}>
+      <Collapse
+        bordered={false}
+        size="small"
+        items={[
+          {
+            key: 'options',
+            label: t('Options'),
+            forceRender: true,
+            children: (
+              <SchemaComponent
+                schema={{
+                  type: 'void',
+                  name: 'custom-llm',
+                  properties: {
+                    temperature: {
+                      title: tval('Temperature', { ns: namespace }),
+                      type: 'number',
+                      'x-decorator': 'FormItem',
+                      'x-component': 'InputNumber',
+                      default: 0.7,
+                      'x-component-props': {
+                        step: 0.1,
+                        min: 0.0,
+                        max: 2.0,
+                      },
+                    },
+                    maxCompletionTokens: {
+                      title: tval('Max completion tokens', { ns: namespace }),
+                      type: 'number',
+                      'x-decorator': 'FormItem',
+                      'x-component': 'InputNumber',
+                      default: -1,
+                    },
+                    topP: {
+                      title: tval('Top P', { ns: namespace }),
+                      type: 'number',
+                      'x-decorator': 'FormItem',
+                      'x-component': 'InputNumber',
+                      default: 1.0,
+                      'x-component-props': {
+                        step: 0.1,
+                        min: 0.0,
+                        max: 1.0,
+                      },
+                    },
+                    frequencyPenalty: {
+                      title: tval('Frequency penalty', { ns: namespace }),
+                      type: 'number',
+                      'x-decorator': 'FormItem',
+                      'x-component': 'InputNumber',
+                      default: 0.0,
+                      'x-component-props': {
+                        step: 0.1,
+                        min: -2.0,
+                        max: 2.0,
+                      },
+                    },
+                    presencePenalty: {
+                      title: tval('Presence penalty', { ns: namespace }),
+                      type: 'number',
+                      'x-decorator': 'FormItem',
+                      'x-component': 'InputNumber',
+                      default: 0.0,
+                      'x-component-props': {
+                        step: 0.1,
+                        min: -2.0,
+                        max: 2.0,
+                      },
+                    },
+                    responseFormat: {
+                      title: tval('Response format', { ns: namespace }),
+                      type: 'string',
+                      'x-decorator': 'FormItem',
+                      'x-component': 'Select',
+                      enum: [
+                        { label: t('Text'), value: 'text' },
+                        { label: t('JSON'), value: 'json_object' },
+                      ],
+                      default: 'text',
+                    },
+                    timeout: {
+                      title: tval('Timeout (ms)', { ns: namespace }),
+                      type: 'number',
+                      'x-decorator': 'FormItem',
+                      'x-component': 'InputNumber',
+                      default: 60000,
+                    },
+                    maxRetries: {
+                      title: tval('Max retries', { ns: namespace }),
+                      type: 'number',
+                      'x-decorator': 'FormItem',
+                      'x-component': 'InputNumber',
+                      default: 1,
+                    },
+                  },
+                }}
+              />
+            ),
+          },
+        ]}
+      />
+    </div>
+  );
+};
+
+export const ModelSettingsForm: React.FC = () => {
+  return (
+    <SchemaComponent
+      components={{ Options, ModelSelect }}
+      schema={{
+        type: 'void',
+        properties: {
+          model: {
+            title: tval('Model', { ns: namespace }),
+            type: 'string',
+            required: true,
+            'x-decorator': 'FormItem',
+            'x-component': 'ModelSelect',
+          },
+          options: {
+            type: 'void',
+            'x-component': 'Options',
+          },
+        },
+      }}
+    />
+  );
+};

package/src/client/llm-providers/custom-llm/ProviderSettings.tsx

@@ -0,0 +1,115 @@
+import React from 'react';
+import { SchemaComponent } from '@nocobase/client';
+import { tval } from '@nocobase/utils/client';
+import { namespace } from '../../locale';
+
+export const ProviderSettingsForm: React.FC = () => {
+  return (
+    <SchemaComponent
+      schema={{
+        type: 'void',
+        properties: {
+          apiKey: {
+            title: tval('API Key', { ns: namespace }),
+            type: 'string',
+            required: true,
+            'x-decorator': 'FormItem',
+            'x-component': 'TextAreaWithGlobalScope',
+          },
+          disableStream: {
+            title: tval('Disable streaming', { ns: namespace }),
+            type: 'boolean',
+            'x-decorator': 'FormItem',
+            'x-component': 'Checkbox',
+            'x-content': tval('Disable streaming description', { ns: namespace }),
+          },
+          streamKeepAlive: {
+            title: tval('Stream keepalive', { ns: namespace }),
+            type: 'boolean',
+            'x-decorator': 'FormItem',
+            'x-component': 'Checkbox',
+            'x-content': tval('Stream keepalive description', { ns: namespace }),
+          },
+          keepAliveIntervalMs: {
+            title: tval('Keepalive interval (ms)', { ns: namespace }),
+            type: 'number',
+            'x-decorator': 'FormItem',
+            'x-component': 'InputNumber',
+            'x-component-props': {
+              placeholder: '5000',
+              min: 1000,
+              step: 1000,
+              style: { width: '100%' },
+            },
+            description: tval('Keepalive interval description', { ns: namespace }),
+          },
+          keepAliveContent: {
+            title: tval('Keepalive content', { ns: namespace }),
+            type: 'string',
+            'x-decorator': 'FormItem',
+            'x-component': 'Input',
+            'x-component-props': {
+              placeholder: '...',
+            },
+            description: tval('Keepalive content description', { ns: namespace }),
+          },
+          timeout: {
+            title: tval('Timeout (ms)', { ns: namespace }),
+            type: 'number',
+            'x-decorator': 'FormItem',
+            'x-component': 'InputNumber',
+            'x-component-props': {
+              placeholder: '120000',
+              min: 0,
+              step: 1000,
+              style: { width: '100%' },
+            },
+            description: tval('Timeout description', { ns: namespace }),
+          },
+          requestConfig: {
+            title: tval('Request config (JSON)', { ns: namespace }),
+            type: 'string',
+            'x-decorator': 'FormItem',
+            'x-component': 'Input.TextArea',
+            'x-component-props': {
+              placeholder: JSON.stringify(
+                {
+                  extraHeaders: {},
+                  extraBody: {},
+                  modelKwargs: {},
+                },
+                null,
+                2,
+              ),
+              rows: 6,
+              style: { fontFamily: 'monospace', fontSize: 12 },
+            },
+            description: tval('Request config description', { ns: namespace }),
+          },
+          responseConfig: {
+            title: tval('Response config (JSON)', { ns: namespace }),
+            type: 'string',
+            'x-decorator': 'FormItem',
+            'x-component': 'Input.TextArea',
+            'x-component-props': {
+              placeholder: JSON.stringify(
+                {
+                  contentPath: 'auto',
+                  reasoningKey: 'reasoning_content',
+                  responseMapping: {
+                    content: 'message.response',
+                  },
+                },
+                null,
+                2,
+              ),
+              rows: 8,
+              style: { fontFamily: 'monospace', fontSize: 12 },
+            },
+            description: tval('Response config description', { ns: namespace }),
+          },
+        },
+      }}
+    />
+  );
+};

package/src/client/llm-providers/custom-llm/index.ts

@@ -0,0 +1,10 @@
+import { LLMProviderOptions } from '@nocobase/plugin-ai/client';
+import { ProviderSettingsForm } from './ProviderSettings';
+import { ModelSettingsForm } from './ModelSettings';
+
+export const customLLMProviderOptions: LLMProviderOptions = {
+  components: {
+    ProviderSettingsForm,
+    ModelSettingsForm,
+  },
+};

package/src/client/locale.ts

@@ -0,0 +1,8 @@
+import { useTranslation } from 'react-i18next';
+
+export const namespace = '@nocobase/plugin-custom-llm';
+
+export function useT() {
+  const { t } = useTranslation(namespace, { nsMode: 'fallback' });
+  return t;
+}

package/src/client/models/index.ts

@@ -0,0 +1,12 @@
+/**
+ * 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.
+ */
+
+import { ModelConstructor } from '@nocobase/flow-engine';
+
+export default {} as Record<string, ModelConstructor>;

package/src/client/plugin.tsx

@@ -0,0 +1,10 @@
+import { Plugin } from '@nocobase/client';
+import models from './models';
+
+export class PluginCustomLlmClient extends Plugin {
+  async load() {
+    this.flowEngine.registerModels(models);
+  }
+}
+
+export default PluginCustomLlmClient;

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './server';
+export { default } from './server';

package/src/locale/en-US.json

@@ -0,0 +1,29 @@
+{
+  "Base URL": "Base URL",
+  "API Key": "API Key",
+  "Model": "Model",
+  "Options": "Options",
+  "Temperature": "Temperature",
+  "Max completion tokens": "Max completion tokens",
+  "Top P": "Top P",
+  "Frequency penalty": "Frequency penalty",
+  "Presence penalty": "Presence penalty",
+  "Response format": "Response format",
+  "Text": "Text",
+  "JSON": "JSON",
+  "Timeout (ms)": "Timeout (ms)",
+  "Timeout description": "Request timeout in milliseconds. Increase this for models with long thinking/processing phases. Default: 120000 (2 minutes).",
+  "Max retries": "Max retries",
+  "Disable streaming": "Disable streaming",
+  "Disable streaming description": "Use non-streaming mode. Enable this for models that have a long \"thinking\" phase before responding, which can cause empty stream values and processing to terminate early.",
+  "Stream keepalive": "Stream keepalive",
+  "Stream keepalive description": "Keep stream alive during model thinking. Injects placeholder content when no data arrives within the keepalive interval. Works only when streaming is enabled.",
+  "Keepalive interval (ms)": "Keepalive interval (ms)",
+  "Keepalive interval description": "Interval in milliseconds between keepalive signals. Default: 5000 (5 seconds).",
+  "Keepalive content": "Keepalive content",
+  "Keepalive content description": "Placeholder text used as keepalive signal (invisible to the user). Default: '...'",
+  "Request config (JSON)": "Request config (JSON)",
+  "Request config description": "Extra configuration for LLM requests. Supported keys: extraHeaders (custom HTTP headers), extraBody (extra request body fields), modelKwargs (LangChain model kwargs).",
+  "Response config (JSON)": "Response config (JSON)",
+  "Response config description": "Configure response parsing. contentPath: 'auto' or dot-path. reasoningKey: key for reasoning content. responseMapping: { content: 'dot.path' } — maps non-standard LLM response to OpenAI format (e.g., 'message.response')."
+}

package/src/locale/vi-VN.json

@@ -0,0 +1,29 @@
+{
+  "Base URL": "URL cơ sở",
+  "API Key": "API Key",
+  "Model": "Mô hình",
+  "Options": "Tùy chọn",
+  "Temperature": "Nhiệt độ",
+  "Max completion tokens": "Số token tối đa",
+  "Top P": "Top P",
+  "Frequency penalty": "Hình phạt tần suất",
+  "Presence penalty": "Hình phạt sự hiện diện",
+  "Response format": "Định dạng phản hồi",
+  "Text": "Văn bản",
+  "JSON": "JSON",
+  "Timeout (ms)": "Thời gian chờ (ms)",
+  "Timeout description": "Thời gian chờ request tính bằng mili giây. Tăng giá trị này cho các model có giai đoạn thinking/xử lý dài. Mặc định: 120000 (2 phút).",
+  "Max retries": "Số lần thử lại tối đa",
+  "Disable streaming": "Tắt streaming",
+  "Disable streaming description": "Sử dụng chế độ non-streaming. Bật tính năng này cho các model có giai đoạn \"thinking\" dài trước khi trả lời, gây ra stream rỗng và xử lý bị ngắt sớm.",
+  "Stream keepalive": "Giữ kết nối stream",
+  "Stream keepalive description": "Giữ stream hoạt động khi model đang thinking. Gửi nội dung giữ kết nối khi không có dữ liệu trong khoảng thời gian đã cấu hình. Chỉ hoạt động khi streaming được bật.",
+  "Keepalive interval (ms)": "Khoảng thời gian keepalive (ms)",
+  "Keepalive interval description": "Khoảng thời gian giữa các tín hiệu keepalive, tính bằng mili giây. Mặc định: 5000 (5 giây).",
+  "Keepalive content": "Nội dung keepalive",
+  "Keepalive content description": "Nội dung giữ kết nối (không hiển thị cho người dùng). Mặc định: '...'",
+  "Request config (JSON)": "Cấu hình request (JSON)",
+  "Request config description": "Cấu hình bổ sung cho request LLM. Các key hỗ trợ: extraHeaders (HTTP headers tùy chỉnh), extraBody (thêm trường vào request body), modelKwargs (tham số model LangChain).",
+  "Response config (JSON)": "Cấu hình response (JSON)",
+  "Response config description": "Cấu hình parse response. contentPath: 'auto' hoặc dot-path. reasoningKey: key reasoning. responseMapping: { content: 'dot.path' } — mapping response không chuẩn OpenAI (ví dụ: 'message.response')."
+}

package/src/locale/zh-CN.json

@@ -0,0 +1,16 @@
+{
+  "Base URL": "基础 URL",
+  "API Key": "API 密钥",
+  "Model": "模型",
+  "Options": "选项",
+  "Temperature": "温度",
+  "Max completion tokens": "最大完成令牌数",
+  "Top P": "Top P",
+  "Frequency penalty": "频率惩罚",
+  "Presence penalty": "存在惩罚",
+  "Response format": "响应格式",
+  "Text": "文本",
+  "JSON": "JSON",
+  "Timeout (ms)": "超时 (毫秒)",
+  "Max retries": "最大重试次数"
+}

package/src/server/index.ts

@@ -0,0 +1 @@
+export { default } from './plugin';