Merge pull request #14076 from dskarzh/feature/openai-base-url

AI models: add base URL to OpenAI
1 year ago · 15356225c3
10 changed files with 88 additions and 23 deletions
--- a/application/src/main/java/org/thingsboard/server/service/ai/Langchain4jChatModelConfigurerImpl.java
+++ b/application/src/main/java/org/thingsboard/server/service/ai/Langchain4jChatModelConfigurerImpl.java
@ -70,6 +70,7 @@ class Langchain4jChatModelConfigurerImpl implements Langchain4jChatModelConfigur
    @Override
    public ChatModel configureChatModel(OpenAiChatModelConfig chatModelConfig) {
        return OpenAiChatModel.builder()
+                .baseUrl(chatModelConfig.providerConfig().baseUrl())
                .apiKey(chatModelConfig.providerConfig().apiKey())
                .modelName(chatModelConfig.modelId())
                .temperature(chatModelConfig.temperature())
--- a/application/src/test/java/org/thingsboard/server/controller/AiModelControllerTest.java
+++ b/application/src/test/java/org/thingsboard/server/controller/AiModelControllerTest.java
@ -104,7 +104,10 @@ public class AiModelControllerTest extends AbstractControllerTest {
        var model = doPost("/api/ai/model", constructValidOpenAiModel("Test model"), AiModel.class);

        var newModelConfig = OpenAiChatModelConfig.builder()
-                .providerConfig(new OpenAiProviderConfig("test-api-key-updated"))
+                .providerConfig(OpenAiProviderConfig.builder()
+                        .baseUrl(OpenAiProviderConfig.OPENAI_OFFICIAL_BASE_URL)
+                        .apiKey("test-api-key-updated")
+                        .build())
                .modelId("o4-mini")
                .temperature(0.2)
                .topP(0.4)
@ -270,7 +273,7 @@ public class AiModelControllerTest extends AbstractControllerTest {
                .tenantId(tenantId)
                .name("Test model 1")
                .configuration(OpenAiChatModelConfig.builder()
-                        .providerConfig(new OpenAiProviderConfig("test-api-key"))
+                        .providerConfig(OpenAiProviderConfig.builder().apiKey("test-api-key").build())
                        .modelId("o3-pro")
                        .build())
                .build(), AiModel.class);
@ -594,7 +597,10 @@ public class AiModelControllerTest extends AbstractControllerTest {

    private AiModel constructValidOpenAiModel(String name) {
        var modelConfig = OpenAiChatModelConfig.builder()
-                .providerConfig(new OpenAiProviderConfig("test-api-key"))
+                .providerConfig(OpenAiProviderConfig.builder()
+                        .baseUrl(OpenAiProviderConfig.OPENAI_OFFICIAL_BASE_URL)
+                        .apiKey("test-api-key")
+                        .build())
                .modelId("gpt-4o")
                .temperature(0.5)
                .topP(0.3)
--- a/application/src/test/java/org/thingsboard/server/service/entitiy/ai/DefaultTbAiModelServiceTest.java
+++ b/application/src/test/java/org/thingsboard/server/service/entitiy/ai/DefaultTbAiModelServiceTest.java
@ -253,7 +253,7 @@ class DefaultTbAiModelServiceTest {

    private static AiModelConfig constructValidOpenAiModelConfig() {
        return OpenAiChatModelConfig.builder()
-                .providerConfig(new OpenAiProviderConfig("test-api-key"))
+                .providerConfig(OpenAiProviderConfig.builder().apiKey("test-api-key").build())
                .modelId("gpt-4o")
                .temperature(0.5)
                .topP(0.3)
--- a/application/src/test/java/org/thingsboard/server/service/resource/sql/BaseTbResourceServiceTest.java
+++ b/application/src/test/java/org/thingsboard/server/service/resource/sql/BaseTbResourceServiceTest.java
@ -682,7 +682,10 @@ public class BaseTbResourceServiceTest extends AbstractControllerTest {

    private AiModel constructValidOpenAiModel(String name) {
        var modelConfig = OpenAiChatModelConfig.builder()
-                .providerConfig(new OpenAiProviderConfig("test-api-key"))
+                .providerConfig(OpenAiProviderConfig.builder()
+                        .baseUrl(OpenAiProviderConfig.OPENAI_OFFICIAL_BASE_URL)
+                        .apiKey("test-api-key")
+                        .build())
                .modelId("gpt-4o")
                .temperature(0.5)
                .topP(0.3)
@ -699,6 +702,7 @@ public class BaseTbResourceServiceTest extends AbstractControllerTest {
                .configuration(modelConfig)
                .build();
    }
+
    @Test
    public void testFindTenantResourcesByTenantId() throws Exception {
        loginSysAdmin();
--- a/common/data/src/main/java/org/thingsboard/server/common/data/ai/provider/OpenAiProviderConfig.java
+++ b/common/data/src/main/java/org/thingsboard/server/common/data/ai/provider/OpenAiProviderConfig.java
@ -15,8 +15,32 @@
 */
 package org.thingsboard.server.common.data.ai.provider;

-import jakarta.validation.constraints.NotNull;
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import jakarta.validation.constraints.AssertTrue;
+import lombok.Builder;
+import org.apache.commons.lang3.StringUtils;

+import java.util.Objects;
+
+@Builder
 public record OpenAiProviderConfig(
-        @NotNull String apiKey
-) implements AiProviderConfig {}
+        String baseUrl,
+        String apiKey
+) implements AiProviderConfig {
+
+    public static final String OPENAI_OFFICIAL_BASE_URL = "https://api.openai.com/v1";
+
+    public OpenAiProviderConfig {
+        baseUrl = Objects.requireNonNullElse(baseUrl, OPENAI_OFFICIAL_BASE_URL);
+    }
+
+    @JsonIgnore
+    @AssertTrue(message = "API key is required when using the official OpenAI API")
+    public boolean isValid() {
+        if (baseUrl.equals(OPENAI_OFFICIAL_BASE_URL)) {
+            return StringUtils.isNotBlank(apiKey);
+        }
+        return true;
+    }
+
+}
--- a/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/ai/TbAiNodeTest.java
+++ b/rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/ai/TbAiNodeTest.java
@ -129,7 +129,10 @@ class TbAiNodeTest {
        config = new TbAiNodeConfiguration();

        modelConfig = OpenAiChatModelConfig.builder()
-                .providerConfig(new OpenAiProviderConfig("test-api-key"))
+                .providerConfig(OpenAiProviderConfig.builder()
+                        .baseUrl(OpenAiProviderConfig.OPENAI_OFFICIAL_BASE_URL)
+                        .apiKey("test-api-key")
+                        .build())
                .modelId("gpt-4o")
                .temperature(0.5)
                .topP(0.3)
--- a/ui-ngx/src/app/modules/home/components/ai-model/ai-model-dialog.component.html
+++ b/ui-ngx/src/app/modules/home/components/ai-model/ai-model-dialog.component.html
@ -116,14 +116,24 @@
                <input matInput formControlName="serviceVersion">
              </mat-form-field>
            }
+            @if (providerFieldsList.includes('baseUrl')) {
+              <mat-form-field class="mat-block flex-1" appearance="outline">
+                <mat-label translate>ai-models.baseurl</mat-label>
+                <input required matInput formControlName="baseUrl">
+                <mat-error *ngIf="aiModelForms.get('configuration.providerConfig.baseUrl').hasError('required') ||
+                  aiModelForms.get('configuration.providerConfig.baseUrl').hasError('pattern')">
+                  {{ 'ai-models.baseurl-required' | translate }}
+                </mat-error>
+              </mat-form-field>
+            }
            @if (providerFieldsList.includes('apiKey')) {
              <mat-form-field class="mat-block flex-1" appearance="outline">
                <mat-label translate>ai-models.api-key</mat-label>
-                <input type="password" required matInput formControlName="apiKey" autocomplete="new-password">
+                <input type="password" matInput formControlName="apiKey" [required]="apiKeyRequired" autocomplete="new-password">
                <tb-toggle-password matSuffix></tb-toggle-password>
                <mat-error *ngIf="aiModelForms.get('configuration.providerConfig.apiKey').hasError('required') ||
                  aiModelForms.get('configuration.providerConfig.apiKey').hasError('pattern')">
-                  {{ 'ai-models.api-key-required' | translate }}
+                  {{ ( provider === aiProvider.OPENAI ? 'ai-models.api-key-open-ai-required' : 'ai-models.api-key-required') | translate }}
                </mat-error>
              </mat-form-field>
            }
@ -158,16 +168,6 @@
                </mat-error>
              </mat-form-field>
            }
-            @if (providerFieldsList.includes('baseUrl')) {
-              <mat-form-field class="mat-block flex-1" appearance="outline">
-                <mat-label translate>ai-models.baseurl</mat-label>
-                <input required matInput formControlName="baseUrl">
-                <mat-error *ngIf="aiModelForms.get('configuration.providerConfig.baseUrl').hasError('required') ||
-                  aiModelForms.get('configuration.providerConfig.baseUrl').hasError('pattern')">
-                  {{ 'ai-models.baseurl-required' | translate }}
-                </mat-error>
-              </mat-form-field>
-            }
            @if (provider === aiProvider.OLLAMA) {
              <div class="tb-form-panel stroked no-gap no-padding-bottom mb-4" formGroupName="auth">
                <div class="flex flex-row items-center justify-between xs:flex-col xs:items-start xs:gap-3">
--- a/ui-ngx/src/app/modules/home/components/ai-model/ai-model-dialog.component.ts
+++ b/ui-ngx/src/app/modules/home/components/ai-model/ai-model-dialog.component.ts
@ -74,6 +74,9 @@ export class AIModelDialogComponent extends DialogComponent<AIModelDialogCompone

  authenticationHint: string;

+  apiKeyRequired = true;
+  private readonly openAiDefaultBaseUrl = 'https://api.openai.com/v1';
+
  constructor(protected store: Store<AppState>,
              protected router: Router,
              protected dialogRef: MatDialogRef<AIModelDialogComponent, AiModel>,
@ -107,7 +110,7 @@ export class AIModelDialogComponent extends DialogComponent<AIModelDialogCompone
          region: [this.data.AIModel ? this.data.AIModel.configuration.providerConfig?.region : '', [Validators.required, Validators.pattern(/.*\S.*/)]],
          accessKeyId: [this.data.AIModel ? this.data.AIModel.configuration.providerConfig?.accessKeyId : '', [Validators.required, Validators.pattern(/.*\S.*/)]],
          secretAccessKey: [this.data.AIModel ? this.data.AIModel.configuration.providerConfig?.secretAccessKey : '', [Validators.required, Validators.pattern(/.*\S.*/)]],
-          baseUrl: [this.data.AIModel ? this.data.AIModel.configuration.providerConfig?.baseUrl : '', [Validators.required, Validators.pattern(/.*\S.*/)]],
+          baseUrl: [this.data.AIModel ? this.data.AIModel.configuration.providerConfig?.baseUrl : this.openAiDefaultBaseUrl, [Validators.required, Validators.pattern(/.*\S.*/)]],
          auth: this.fb.group({
            type: [this.data.AIModel?.configuration?.providerConfig?.auth?.type ?? AuthenticationType.NONE],
            username: [this.data.AIModel?.configuration?.providerConfig?.auth?.username ?? '', [Validators.required, Validators.pattern(/.*\S.*/)]],
@ -133,6 +136,18 @@ export class AIModelDialogComponent extends DialogComponent<AIModelDialogCompone
      this.aiModelForms.get('configuration.modelId').reset('');
      this.aiModelForms.get('configuration.providerConfig').reset({});
      this.updateValidation(provider);
+      if (provider === AiProvider.OPENAI) {
+        this.aiModelForms.get('configuration.providerConfig.baseUrl').patchValue(this.openAiDefaultBaseUrl, {emitEvent: false});
+        this.updateApiKeyValidatorForOpenAIProvider(this.openAiDefaultBaseUrl);
+      }
+    });
+
+    this.aiModelForms.get('configuration.providerConfig.baseUrl').valueChanges.pipe(
+      takeUntilDestroyed()
+    ).subscribe((url: string) => {
+      if (this.provider === AiProvider.OPENAI) {
+        this.updateApiKeyValidatorForOpenAIProvider(url);
+      }
    });

    this.aiModelForms.get('configuration.providerConfig.auth.type').valueChanges.pipe(
@ -161,6 +176,17 @@ export class AIModelDialogComponent extends DialogComponent<AIModelDialogCompone
      );
  }

+  private updateApiKeyValidatorForOpenAIProvider(url: string) {
+    if (url !== this.openAiDefaultBaseUrl) {
+      this.aiModelForms.get('configuration.providerConfig.apiKey').removeValidators(Validators.required);
+      this.apiKeyRequired = false;
+    } else {
+      this.aiModelForms.get('configuration.providerConfig.apiKey').addValidators(Validators.required);
+      this.apiKeyRequired = true;
+    }
+    this.aiModelForms.get('configuration.providerConfig.apiKey').updateValueAndValidity({emitEvent: false});
+  }
+
  private getAuthenticationHint(type: AuthenticationType) {
    if (type === AuthenticationType.BASIC) {
      this.authenticationHint = this.translate.instant('ai-models.authentication-basic-hint');
--- a/ui-ngx/src/app/shared/models/ai-model.models.ts
+++ b/ui-ngx/src/app/shared/models/ai-model.models.ts
@ -116,7 +116,7 @@ export const AiModelMap = new Map<AiProvider, { modelList: string[], providerFie
        'gpt-4o',
        'gpt-4o-mini',
      ],
-      providerFieldsList: ['apiKey'],
+      providerFieldsList: ['baseUrl', 'apiKey'],
      modelFieldsList: ['temperature', 'topP', 'frequencyPenalty', 'presencePenalty', 'maxOutputTokens'],
    },
  ],
--- a/ui-ngx/src/assets/locale/locale.constant-en_US.json
+++ b/ui-ngx/src/assets/locale/locale.constant-en_US.json
@ -1120,6 +1120,7 @@
        "provider": "Provider",
        "api-key": "API key",
        "api-key-required": "API key is required.",
+        "api-key-open-ai-required": "API key is required when using the official OpenAI API.",
        "project-id": "Project ID",
        "project-id-required": "Project ID is required",
        "location": "Location",