Paolo Cristiani
1 year ago
committed by
GitHub
GitHub
468 changed files with 13009 additions and 3322 deletions
@ -0,0 +1,178 @@ |
|||
/** |
|||
* Copyright © 2016-2025 The Thingsboard Authors |
|||
* |
|||
* Licensed under the Apache License, Version 2.0 (the "License"); |
|||
* you may not use this file except in compliance with the License. |
|||
* You may obtain a copy of the License at |
|||
* |
|||
* http://www.apache.org/licenses/LICENSE-2.0
|
|||
* |
|||
* Unless required by applicable law or agreed to in writing, software |
|||
* distributed under the License is distributed on an "AS IS" BASIS, |
|||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|||
* See the License for the specific language governing permissions and |
|||
* limitations under the License. |
|||
*/ |
|||
package org.thingsboard.server.controller; |
|||
|
|||
import com.google.common.util.concurrent.ListenableFuture; |
|||
import dev.langchain4j.model.chat.request.ChatRequest; |
|||
import io.swagger.v3.oas.annotations.Parameter; |
|||
import io.swagger.v3.oas.annotations.media.Schema; |
|||
import jakarta.validation.Valid; |
|||
import lombok.RequiredArgsConstructor; |
|||
import org.springframework.security.access.prepost.PreAuthorize; |
|||
import org.springframework.validation.annotation.Validated; |
|||
import org.springframework.web.bind.annotation.DeleteMapping; |
|||
import org.springframework.web.bind.annotation.GetMapping; |
|||
import org.springframework.web.bind.annotation.PathVariable; |
|||
import org.springframework.web.bind.annotation.PostMapping; |
|||
import org.springframework.web.bind.annotation.RequestBody; |
|||
import org.springframework.web.bind.annotation.RequestMapping; |
|||
import org.springframework.web.bind.annotation.RequestParam; |
|||
import org.springframework.web.bind.annotation.RestController; |
|||
import org.springframework.web.context.request.async.DeferredResult; |
|||
import org.thingsboard.server.common.data.ai.AiModel; |
|||
import org.thingsboard.server.common.data.ai.dto.TbChatRequest; |
|||
import org.thingsboard.server.common.data.ai.dto.TbChatResponse; |
|||
import org.thingsboard.server.common.data.ai.model.chat.AiChatModelConfig; |
|||
import org.thingsboard.server.common.data.exception.ThingsboardException; |
|||
import org.thingsboard.server.common.data.id.AiModelId; |
|||
import org.thingsboard.server.common.data.page.PageData; |
|||
import org.thingsboard.server.config.annotations.ApiOperation; |
|||
import org.thingsboard.server.queue.util.TbCoreComponent; |
|||
import org.thingsboard.server.service.ai.AiChatModelService; |
|||
import org.thingsboard.server.service.security.permission.Operation; |
|||
import org.thingsboard.server.service.security.permission.Resource; |
|||
|
|||
import java.time.Duration; |
|||
import java.util.Optional; |
|||
import java.util.UUID; |
|||
|
|||
import static com.google.common.util.concurrent.MoreExecutors.directExecutor; |
|||
import static org.thingsboard.server.controller.ControllerConstants.AI_MODEL_TEXT_SEARCH_DESCRIPTION; |
|||
import static org.thingsboard.server.controller.ControllerConstants.PAGE_DATA_PARAMETERS; |
|||
import static org.thingsboard.server.controller.ControllerConstants.PAGE_NUMBER_DESCRIPTION; |
|||
import static org.thingsboard.server.controller.ControllerConstants.PAGE_SIZE_DESCRIPTION; |
|||
import static org.thingsboard.server.controller.ControllerConstants.SORT_ORDER_DESCRIPTION; |
|||
import static org.thingsboard.server.controller.ControllerConstants.SORT_PROPERTY_DESCRIPTION; |
|||
import static org.thingsboard.server.controller.ControllerConstants.TENANT_AUTHORITY_PARAGRAPH; |
|||
|
|||
@Validated |
|||
@RestController |
|||
@TbCoreComponent |
|||
@RequiredArgsConstructor |
|||
@RequestMapping("/api/ai/model") |
|||
class AiModelController extends BaseController { |
|||
|
|||
private final AiChatModelService aiChatModelService; |
|||
|
|||
@ApiOperation( |
|||
value = "Create or update AI model (saveAiModel)", |
|||
notes = "Creates or updates an AI model record.\n\n" + |
|||
"• **Create:** Omit the `id` to create a new record. The platform assigns a UUID to the new record and returns it in the `id` field of the response.\n\n" + |
|||
"• **Update:** Include an existing `id` to modify that record. If no matching record exists, the API responds with **404 Not Found**.\n\n" + |
|||
"Tenant ID for the AI model will be taken from the authenticated user making the request, regardless of any value provided in the request body." + |
|||
TENANT_AUTHORITY_PARAGRAPH |
|||
) |
|||
@PreAuthorize("hasAuthority('TENANT_ADMIN')") |
|||
@PostMapping |
|||
public AiModel saveAiModel(@RequestBody @Valid AiModel model) throws ThingsboardException { |
|||
var user = getCurrentUser(); |
|||
model.setTenantId(user.getTenantId()); |
|||
checkEntity(model.getId(), model, Resource.AI_MODEL); |
|||
return tbAiModelService.save(model, user); |
|||
} |
|||
|
|||
@ApiOperation( |
|||
value = "Get AI model by ID (getAiModelById)", |
|||
notes = "Fetches an AI model record by its `id`." + |
|||
TENANT_AUTHORITY_PARAGRAPH |
|||
) |
|||
@PreAuthorize("hasAuthority('TENANT_ADMIN')") |
|||
@GetMapping("/{modelUuid}") |
|||
public AiModel getAiModelById( |
|||
@Parameter( |
|||
description = "ID of the AI model record", |
|||
required = true, |
|||
example = "de7900d4-30e2-11f0-9cd2-0242ac120002" |
|||
) |
|||
@PathVariable UUID modelUuid |
|||
) throws ThingsboardException { |
|||
return checkAiModelId(new AiModelId(modelUuid), Operation.READ); |
|||
} |
|||
|
|||
@ApiOperation( |
|||
value = "Get AI models (getAiModels)", |
|||
notes = "Returns a page of AI models. " + |
|||
PAGE_DATA_PARAMETERS + TENANT_AUTHORITY_PARAGRAPH |
|||
) |
|||
@PreAuthorize("hasAuthority('TENANT_ADMIN')") |
|||
@GetMapping |
|||
public PageData<AiModel> getAiModels( |
|||
@Parameter(description = PAGE_SIZE_DESCRIPTION, required = true) |
|||
@RequestParam int pageSize, |
|||
@Parameter(description = PAGE_NUMBER_DESCRIPTION, required = true) |
|||
@RequestParam int page, |
|||
@Parameter(description = AI_MODEL_TEXT_SEARCH_DESCRIPTION) |
|||
@RequestParam(required = false) String textSearch, |
|||
@Parameter(description = SORT_PROPERTY_DESCRIPTION, schema = @Schema(allowableValues = {"createdTime", "name", "provider", "modelId"})) |
|||
@RequestParam(required = false) String sortProperty, |
|||
@Parameter(description = SORT_ORDER_DESCRIPTION, schema = @Schema(allowableValues = {"ASC", "DESC"})) |
|||
@RequestParam(required = false) String sortOrder |
|||
) throws ThingsboardException { |
|||
var user = getCurrentUser(); |
|||
accessControlService.checkPermission(user, Resource.AI_MODEL, Operation.READ); |
|||
var pageLink = createPageLink(pageSize, page, textSearch, sortProperty, sortOrder); |
|||
return aiModelService.findAiModelsByTenantId(user.getTenantId(), pageLink); |
|||
} |
|||
|
|||
@ApiOperation( |
|||
value = "Delete AI model by ID (deleteAiModelById)", |
|||
notes = "Deletes the AI model record by its `id`. " + |
|||
"If a record with the specified `id` exists, the record is deleted and the endpoint returns `true`. " + |
|||
"If no such record exists, the endpoint returns `false`." + |
|||
TENANT_AUTHORITY_PARAGRAPH |
|||
) |
|||
@PreAuthorize("hasAuthority('TENANT_ADMIN')") |
|||
@DeleteMapping("/{modelUuid}") |
|||
public boolean deleteAiModelById( |
|||
@Parameter( |
|||
description = "ID of the AI model record", |
|||
required = true, |
|||
example = "de7900d4-30e2-11f0-9cd2-0242ac120002" |
|||
) |
|||
@PathVariable UUID modelUuid |
|||
) throws ThingsboardException { |
|||
var user = getCurrentUser(); |
|||
var modelId = new AiModelId(modelUuid); |
|||
accessControlService.checkPermission(user, Resource.AI_MODEL, Operation.DELETE); |
|||
Optional<AiModel> toDelete = aiModelService.findAiModelByTenantIdAndId(user.getTenantId(), modelId); |
|||
if (toDelete.isEmpty()) { |
|||
return false; |
|||
} |
|||
accessControlService.checkPermission(user, Resource.AI_MODEL, Operation.DELETE, modelId, toDelete.get()); |
|||
return tbAiModelService.delete(toDelete.get(), user); |
|||
} |
|||
|
|||
@ApiOperation( |
|||
value = "Send request to AI chat model (sendChatRequest)", |
|||
notes = "Submits a single prompt - made up of an optional system message and a required user message - to the specified AI chat model " + |
|||
"and returns either the generated answer or an error envelope." + |
|||
TENANT_AUTHORITY_PARAGRAPH |
|||
) |
|||
@PreAuthorize("hasAuthority('TENANT_ADMIN')") |
|||
@PostMapping("/chat") |
|||
public DeferredResult<TbChatResponse> sendChatRequest(@Valid @RequestBody TbChatRequest tbChatRequest) { |
|||
ChatRequest langChainChatRequest = tbChatRequest.toLangChainChatRequest(); |
|||
AiChatModelConfig<?> chatModelConfig = tbChatRequest.chatModelConfig(); |
|||
|
|||
ListenableFuture<TbChatResponse> future = aiChatModelService.sendChatRequestAsync(chatModelConfig, langChainChatRequest) |
|||
.transform(chatResponse -> (TbChatResponse) new TbChatResponse.Success(chatResponse.aiMessage().text()), directExecutor()) |
|||
.catching(Throwable.class, ex -> new TbChatResponse.Failure(ex.getMessage()), directExecutor()); |
|||
|
|||
Integer requestTimeoutSeconds = chatModelConfig.timeoutSeconds(); |
|||
return requestTimeoutSeconds != null ? wrapFuture(future, Duration.ofSeconds(requestTimeoutSeconds).toMillis()) : wrapFuture(future); |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,20 @@ |
|||
/** |
|||
* Copyright © 2016-2025 The Thingsboard Authors |
|||
* |
|||
* Licensed under the Apache License, Version 2.0 (the "License"); |
|||
* you may not use this file except in compliance with the License. |
|||
* You may obtain a copy of the License at |
|||
* |
|||
* http://www.apache.org/licenses/LICENSE-2.0
|
|||
* |
|||
* Unless required by applicable law or agreed to in writing, software |
|||
* distributed under the License is distributed on an "AS IS" BASIS, |
|||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|||
* See the License for the specific language governing permissions and |
|||
* limitations under the License. |
|||
*/ |
|||
package org.thingsboard.server.service.ai; |
|||
|
|||
import org.thingsboard.rule.engine.api.RuleEngineAiChatModelService; |
|||
|
|||
public interface AiChatModelService extends RuleEngineAiChatModelService {} |
|||
@ -0,0 +1,40 @@ |
|||
/** |
|||
* Copyright © 2016-2025 The Thingsboard Authors |
|||
* |
|||
* Licensed under the Apache License, Version 2.0 (the "License"); |
|||
* you may not use this file except in compliance with the License. |
|||
* You may obtain a copy of the License at |
|||
* |
|||
* http://www.apache.org/licenses/LICENSE-2.0
|
|||
* |
|||
* Unless required by applicable law or agreed to in writing, software |
|||
* distributed under the License is distributed on an "AS IS" BASIS, |
|||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|||
* See the License for the specific language governing permissions and |
|||
* limitations under the License. |
|||
*/ |
|||
package org.thingsboard.server.service.ai; |
|||
|
|||
import com.google.common.util.concurrent.FluentFuture; |
|||
import dev.langchain4j.model.chat.ChatModel; |
|||
import dev.langchain4j.model.chat.request.ChatRequest; |
|||
import dev.langchain4j.model.chat.response.ChatResponse; |
|||
import lombok.RequiredArgsConstructor; |
|||
import org.springframework.stereotype.Service; |
|||
import org.thingsboard.server.common.data.ai.model.chat.AiChatModelConfig; |
|||
import org.thingsboard.server.common.data.ai.model.chat.Langchain4jChatModelConfigurer; |
|||
|
|||
@Service |
|||
@RequiredArgsConstructor |
|||
class AiChatModelServiceImpl implements AiChatModelService { |
|||
|
|||
private final Langchain4jChatModelConfigurer chatModelConfigurer; |
|||
private final AiRequestsExecutor aiRequestsExecutor; |
|||
|
|||
@Override |
|||
public <C extends AiChatModelConfig<C>> FluentFuture<ChatResponse> sendChatRequestAsync(AiChatModelConfig<C> chatModelConfig, ChatRequest chatRequest) { |
|||
ChatModel langChainChatModel = chatModelConfig.configure(chatModelConfigurer); |
|||
return aiRequestsExecutor.sendChatRequestAsync(langChainChatModel, chatRequest); |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,27 @@ |
|||
/** |
|||
* Copyright © 2016-2025 The Thingsboard Authors |
|||
* |
|||
* Licensed under the Apache License, Version 2.0 (the "License"); |
|||
* you may not use this file except in compliance with the License. |
|||
* You may obtain a copy of the License at |
|||
* |
|||
* http://www.apache.org/licenses/LICENSE-2.0
|
|||
* |
|||
* Unless required by applicable law or agreed to in writing, software |
|||
* distributed under the License is distributed on an "AS IS" BASIS, |
|||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|||
* See the License for the specific language governing permissions and |
|||
* limitations under the License. |
|||
*/ |
|||
package org.thingsboard.server.service.ai; |
|||
|
|||
import com.google.common.util.concurrent.FluentFuture; |
|||
import dev.langchain4j.model.chat.ChatModel; |
|||
import dev.langchain4j.model.chat.request.ChatRequest; |
|||
import dev.langchain4j.model.chat.response.ChatResponse; |
|||
|
|||
public interface AiRequestsExecutor { |
|||
|
|||
FluentFuture<ChatResponse> sendChatRequestAsync(ChatModel chatModel, ChatRequest chatRequest); |
|||
|
|||
} |
|||
@ -0,0 +1,86 @@ |
|||
/** |
|||
* Copyright © 2016-2025 The Thingsboard Authors |
|||
* |
|||
* Licensed under the Apache License, Version 2.0 (the "License"); |
|||
* you may not use this file except in compliance with the License. |
|||
* You may obtain a copy of the License at |
|||
* |
|||
* http://www.apache.org/licenses/LICENSE-2.0
|
|||
* |
|||
* Unless required by applicable law or agreed to in writing, software |
|||
* distributed under the License is distributed on an "AS IS" BASIS, |
|||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|||
* See the License for the specific language governing permissions and |
|||
* limitations under the License. |
|||
*/ |
|||
package org.thingsboard.server.service.ai; |
|||
|
|||
import com.google.common.util.concurrent.FluentFuture; |
|||
import com.google.common.util.concurrent.ListeningExecutorService; |
|||
import com.google.common.util.concurrent.MoreExecutors; |
|||
import dev.langchain4j.model.chat.ChatModel; |
|||
import dev.langchain4j.model.chat.request.ChatRequest; |
|||
import dev.langchain4j.model.chat.response.ChatResponse; |
|||
import jakarta.annotation.PostConstruct; |
|||
import jakarta.annotation.PreDestroy; |
|||
import jakarta.validation.constraints.Min; |
|||
import jakarta.validation.constraints.NotBlank; |
|||
import lombok.Data; |
|||
import lombok.RequiredArgsConstructor; |
|||
import org.springframework.boot.context.properties.ConfigurationProperties; |
|||
import org.springframework.context.annotation.Configuration; |
|||
import org.springframework.context.annotation.Lazy; |
|||
import org.springframework.stereotype.Component; |
|||
import org.springframework.validation.annotation.Validated; |
|||
import org.thingsboard.common.util.ThingsBoardThreadFactory; |
|||
|
|||
import java.time.Duration; |
|||
import java.util.concurrent.Executors; |
|||
|
|||
@Lazy |
|||
@Component |
|||
@RequiredArgsConstructor |
|||
class DefaultAiRequestsExecutor implements AiRequestsExecutor { |
|||
|
|||
private final AiRequestsExecutorProperties properties; |
|||
|
|||
@Data |
|||
@Validated |
|||
@Configuration |
|||
@ConfigurationProperties(prefix = "actors.rule.ai-requests-thread-pool") |
|||
private static class AiRequestsExecutorProperties { |
|||
|
|||
@NotBlank(message = "Pool name must be not blank") |
|||
private String poolName = "ai-requests"; |
|||
|
|||
@Min(value = 1, message = "Pool size must be at least 1") |
|||
private int poolSize = 50; |
|||
|
|||
@Min(value = 1, message = "Termination timeout must be at least 1 second") |
|||
private int terminationTimeoutSeconds = 60; |
|||
|
|||
} |
|||
|
|||
private ListeningExecutorService executorService; |
|||
|
|||
@PostConstruct |
|||
private void init() { |
|||
executorService = MoreExecutors.listeningDecorator( |
|||
Executors.newFixedThreadPool(properties.getPoolSize(), ThingsBoardThreadFactory.forName(properties.getPoolName())) |
|||
); |
|||
} |
|||
|
|||
@Override |
|||
public FluentFuture<ChatResponse> sendChatRequestAsync(ChatModel chatModel, ChatRequest chatRequest) { |
|||
return FluentFuture.from(executorService.submit(() -> chatModel.chat(chatRequest))); |
|||
} |
|||
|
|||
@PreDestroy |
|||
private void destroy() { |
|||
if (executorService != null) { |
|||
MoreExecutors.shutdownAndAwaitTermination(executorService, Duration.ofSeconds(properties.getTerminationTimeoutSeconds())); |
|||
executorService = null; |
|||
} |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,269 @@ |
|||
/** |
|||
* Copyright © 2016-2025 The Thingsboard Authors |
|||
* |
|||
* Licensed under the Apache License, Version 2.0 (the "License"); |
|||
* you may not use this file except in compliance with the License. |
|||
* You may obtain a copy of the License at |
|||
* |
|||
* http://www.apache.org/licenses/LICENSE-2.0
|
|||
* |
|||
* Unless required by applicable law or agreed to in writing, software |
|||
* distributed under the License is distributed on an "AS IS" BASIS, |
|||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|||
* See the License for the specific language governing permissions and |
|||
* limitations under the License. |
|||
*/ |
|||
package org.thingsboard.server.service.ai; |
|||
|
|||
import com.google.api.gax.core.FixedCredentialsProvider; |
|||
import com.google.api.gax.retrying.RetrySettings; |
|||
import com.google.auth.oauth2.ServiceAccountCredentials; |
|||
import com.google.cloud.vertexai.Transport; |
|||
import com.google.cloud.vertexai.VertexAI; |
|||
import com.google.cloud.vertexai.api.GenerationConfig; |
|||
import com.google.cloud.vertexai.api.PredictionServiceClient; |
|||
import com.google.cloud.vertexai.api.PredictionServiceSettings; |
|||
import com.google.cloud.vertexai.generativeai.GenerativeModel; |
|||
import dev.langchain4j.model.anthropic.AnthropicChatModel; |
|||
import dev.langchain4j.model.azure.AzureOpenAiChatModel; |
|||
import dev.langchain4j.model.bedrock.BedrockChatModel; |
|||
import dev.langchain4j.model.chat.ChatModel; |
|||
import dev.langchain4j.model.chat.request.ChatRequestParameters; |
|||
import dev.langchain4j.model.github.GitHubModelsChatModel; |
|||
import dev.langchain4j.model.googleai.GoogleAiGeminiChatModel; |
|||
import dev.langchain4j.model.mistralai.MistralAiChatModel; |
|||
import dev.langchain4j.model.openai.OpenAiChatModel; |
|||
import dev.langchain4j.model.vertexai.gemini.VertexAiGeminiChatModel; |
|||
import org.springframework.stereotype.Component; |
|||
import org.thingsboard.server.common.data.ai.model.chat.AmazonBedrockChatModelConfig; |
|||
import org.thingsboard.server.common.data.ai.model.chat.AnthropicChatModelConfig; |
|||
import org.thingsboard.server.common.data.ai.model.chat.AzureOpenAiChatModelConfig; |
|||
import org.thingsboard.server.common.data.ai.model.chat.GitHubModelsChatModelConfig; |
|||
import org.thingsboard.server.common.data.ai.model.chat.GoogleAiGeminiChatModelConfig; |
|||
import org.thingsboard.server.common.data.ai.model.chat.GoogleVertexAiGeminiChatModelConfig; |
|||
import org.thingsboard.server.common.data.ai.model.chat.Langchain4jChatModelConfigurer; |
|||
import org.thingsboard.server.common.data.ai.model.chat.MistralAiChatModelConfig; |
|||
import org.thingsboard.server.common.data.ai.model.chat.OpenAiChatModelConfig; |
|||
import org.thingsboard.server.common.data.ai.provider.AmazonBedrockProviderConfig; |
|||
import org.thingsboard.server.common.data.ai.provider.AzureOpenAiProviderConfig; |
|||
import org.thingsboard.server.common.data.ai.provider.GoogleVertexAiGeminiProviderConfig; |
|||
import software.amazon.awssdk.auth.credentials.AwsBasicCredentials; |
|||
import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider; |
|||
import software.amazon.awssdk.regions.Region; |
|||
import software.amazon.awssdk.services.bedrockruntime.BedrockRuntimeClient; |
|||
|
|||
import java.io.ByteArrayInputStream; |
|||
import java.io.IOException; |
|||
import java.time.Duration; |
|||
|
|||
@Component |
|||
class Langchain4jChatModelConfigurerImpl implements Langchain4jChatModelConfigurer { |
|||
|
|||
@Override |
|||
public ChatModel configureChatModel(OpenAiChatModelConfig chatModelConfig) { |
|||
return OpenAiChatModel.builder() |
|||
.apiKey(chatModelConfig.providerConfig().apiKey()) |
|||
.modelName(chatModelConfig.modelId()) |
|||
.temperature(chatModelConfig.temperature()) |
|||
.topP(chatModelConfig.topP()) |
|||
.frequencyPenalty(chatModelConfig.frequencyPenalty()) |
|||
.presencePenalty(chatModelConfig.presencePenalty()) |
|||
.maxTokens(chatModelConfig.maxOutputTokens()) |
|||
.timeout(toDuration(chatModelConfig.timeoutSeconds())) |
|||
.maxRetries(chatModelConfig.maxRetries()) |
|||
.build(); |
|||
} |
|||
|
|||
@Override |
|||
public ChatModel configureChatModel(AzureOpenAiChatModelConfig chatModelConfig) { |
|||
AzureOpenAiProviderConfig providerConfig = chatModelConfig.providerConfig(); |
|||
return AzureOpenAiChatModel.builder() |
|||
.endpoint(providerConfig.endpoint()) |
|||
.serviceVersion(providerConfig.serviceVersion()) |
|||
.apiKey(providerConfig.apiKey()) |
|||
.deploymentName(chatModelConfig.modelId()) |
|||
.temperature(chatModelConfig.temperature()) |
|||
.topP(chatModelConfig.topP()) |
|||
.frequencyPenalty(chatModelConfig.frequencyPenalty()) |
|||
.presencePenalty(chatModelConfig.presencePenalty()) |
|||
.maxTokens(chatModelConfig.maxOutputTokens()) |
|||
.timeout(toDuration(chatModelConfig.timeoutSeconds())) |
|||
.maxRetries(chatModelConfig.maxRetries()) |
|||
.build(); |
|||
} |
|||
|
|||
@Override |
|||
public ChatModel configureChatModel(GoogleAiGeminiChatModelConfig chatModelConfig) { |
|||
return GoogleAiGeminiChatModel.builder() |
|||
.apiKey(chatModelConfig.providerConfig().apiKey()) |
|||
.modelName(chatModelConfig.modelId()) |
|||
.temperature(chatModelConfig.temperature()) |
|||
.topP(chatModelConfig.topP()) |
|||
.topK(chatModelConfig.topK()) |
|||
.frequencyPenalty(chatModelConfig.frequencyPenalty()) |
|||
.presencePenalty(chatModelConfig.presencePenalty()) |
|||
.maxOutputTokens(chatModelConfig.maxOutputTokens()) |
|||
.timeout(toDuration(chatModelConfig.timeoutSeconds())) |
|||
.maxRetries(chatModelConfig.maxRetries()) |
|||
.build(); |
|||
} |
|||
|
|||
@Override |
|||
public ChatModel configureChatModel(GoogleVertexAiGeminiChatModelConfig chatModelConfig) { |
|||
GoogleVertexAiGeminiProviderConfig providerConfig = chatModelConfig.providerConfig(); |
|||
|
|||
// construct service account credentials using service account key JSON
|
|||
ServiceAccountCredentials serviceAccountCredentials; |
|||
try { |
|||
serviceAccountCredentials = ServiceAccountCredentials.fromStream(new ByteArrayInputStream(providerConfig.serviceAccountKey().getBytes())); |
|||
} catch (IOException e) { |
|||
throw new RuntimeException("Failed to parse service account key JSON", e); |
|||
} |
|||
|
|||
PredictionServiceSettings predictionServiceClientSettings; |
|||
try { |
|||
// create prediction service settings for REST transport with service account key credentials
|
|||
PredictionServiceSettings.Builder settingsBuilder = PredictionServiceSettings.newHttpJsonBuilder() |
|||
.setCredentialsProvider(FixedCredentialsProvider.create(serviceAccountCredentials)); |
|||
|
|||
// get the retry settings that control request timeout for generateContent RPC
|
|||
RetrySettings.Builder retrySettings = settingsBuilder |
|||
.generateContentSettings() |
|||
.getRetrySettings() |
|||
.toBuilder(); |
|||
|
|||
// set request timeout from model config
|
|||
if (chatModelConfig.timeoutSeconds() != null) { |
|||
retrySettings.setTotalTimeout(org.threeten.bp.Duration.ofSeconds(chatModelConfig.timeoutSeconds())); |
|||
} |
|||
|
|||
// set updated retry settings
|
|||
settingsBuilder.generateContentSettings().setRetrySettings(retrySettings.build()); |
|||
|
|||
// build the client settings
|
|||
predictionServiceClientSettings = settingsBuilder.build(); |
|||
} catch (IOException e) { |
|||
throw new RuntimeException("Failed to create prediction service client settings", e); |
|||
} |
|||
|
|||
// construct Vertex AI instance
|
|||
var vertexAI = new VertexAI.Builder() |
|||
.setProjectId(providerConfig.projectId()) |
|||
.setLocation(providerConfig.location()) |
|||
.setPredictionClientSupplier(() -> createPredictionServiceClient(predictionServiceClientSettings)) |
|||
.setTransport(Transport.REST) // GRPC also possible, but likely does not work with service account keys
|
|||
.build(); |
|||
|
|||
// map model config to generation config
|
|||
var generationConfigBuilder = GenerationConfig.newBuilder(); |
|||
if (chatModelConfig.temperature() != null) { |
|||
generationConfigBuilder.setTemperature(chatModelConfig.temperature().floatValue()); |
|||
} |
|||
if (chatModelConfig.topP() != null) { |
|||
generationConfigBuilder.setTopP(chatModelConfig.topP().floatValue()); |
|||
} |
|||
if (chatModelConfig.topK() != null) { |
|||
generationConfigBuilder.setTopK(chatModelConfig.topK()); |
|||
} |
|||
if (chatModelConfig.frequencyPenalty() != null) { |
|||
generationConfigBuilder.setFrequencyPenalty(chatModelConfig.frequencyPenalty().floatValue()); |
|||
} |
|||
if (chatModelConfig.frequencyPenalty() != null) { |
|||
generationConfigBuilder.setPresencePenalty(chatModelConfig.frequencyPenalty().floatValue()); |
|||
} |
|||
if (chatModelConfig.maxOutputTokens() != null) { |
|||
generationConfigBuilder.setMaxOutputTokens(chatModelConfig.maxOutputTokens()); |
|||
} |
|||
var generationConfig = generationConfigBuilder.build(); |
|||
|
|||
// construct generative model instance
|
|||
var generativeModel = new GenerativeModel(chatModelConfig.modelId(), vertexAI).withGenerationConfig(generationConfig); |
|||
|
|||
return new VertexAiGeminiChatModel(generativeModel, generationConfig, chatModelConfig.maxRetries()); |
|||
} |
|||
|
|||
private static PredictionServiceClient createPredictionServiceClient(PredictionServiceSettings settings) { |
|||
try { |
|||
return PredictionServiceClient.create(settings); |
|||
} catch (IOException e) { |
|||
throw new RuntimeException("Failed to create prediction service client", e); |
|||
} |
|||
} |
|||
|
|||
@Override |
|||
public ChatModel configureChatModel(MistralAiChatModelConfig chatModelConfig) { |
|||
return MistralAiChatModel.builder() |
|||
.apiKey(chatModelConfig.providerConfig().apiKey()) |
|||
.modelName(chatModelConfig.modelId()) |
|||
.temperature(chatModelConfig.temperature()) |
|||
.topP(chatModelConfig.topP()) |
|||
.frequencyPenalty(chatModelConfig.frequencyPenalty()) |
|||
.presencePenalty(chatModelConfig.presencePenalty()) |
|||
.maxTokens(chatModelConfig.maxOutputTokens()) |
|||
.timeout(toDuration(chatModelConfig.timeoutSeconds())) |
|||
.maxRetries(chatModelConfig.maxRetries()) |
|||
.build(); |
|||
} |
|||
|
|||
@Override |
|||
public ChatModel configureChatModel(AnthropicChatModelConfig chatModelConfig) { |
|||
return AnthropicChatModel.builder() |
|||
.apiKey(chatModelConfig.providerConfig().apiKey()) |
|||
.modelName(chatModelConfig.modelId()) |
|||
.temperature(chatModelConfig.temperature()) |
|||
.topP(chatModelConfig.topP()) |
|||
.topK(chatModelConfig.topK()) |
|||
.maxTokens(chatModelConfig.maxOutputTokens()) |
|||
.timeout(toDuration(chatModelConfig.timeoutSeconds())) |
|||
.maxRetries(chatModelConfig.maxRetries()) |
|||
.build(); |
|||
} |
|||
|
|||
@Override |
|||
public ChatModel configureChatModel(AmazonBedrockChatModelConfig chatModelConfig) { |
|||
AmazonBedrockProviderConfig providerConfig = chatModelConfig.providerConfig(); |
|||
|
|||
var credentialsProvider = StaticCredentialsProvider.create( |
|||
AwsBasicCredentials.create(providerConfig.accessKeyId(), providerConfig.secretAccessKey()) |
|||
); |
|||
|
|||
var bedrockClient = BedrockRuntimeClient.builder() |
|||
.region(Region.of(providerConfig.region())) |
|||
.credentialsProvider(credentialsProvider) |
|||
.build(); |
|||
|
|||
var defaultChatRequestParams = ChatRequestParameters.builder() |
|||
.temperature(chatModelConfig.temperature()) |
|||
.topP(chatModelConfig.topP()) |
|||
.maxOutputTokens(chatModelConfig.maxOutputTokens()) |
|||
.build(); |
|||
|
|||
return BedrockChatModel.builder() |
|||
.client(bedrockClient) |
|||
.modelId(chatModelConfig.modelId()) |
|||
.defaultRequestParameters(defaultChatRequestParams) |
|||
.timeout(toDuration(chatModelConfig.timeoutSeconds())) |
|||
.maxRetries(chatModelConfig.maxRetries()) |
|||
.build(); |
|||
} |
|||
|
|||
@Override |
|||
public ChatModel configureChatModel(GitHubModelsChatModelConfig chatModelConfig) { |
|||
return GitHubModelsChatModel.builder() |
|||
.gitHubToken(chatModelConfig.providerConfig().personalAccessToken()) |
|||
.modelName(chatModelConfig.modelId()) |
|||
.temperature(chatModelConfig.temperature()) |
|||
.topP(chatModelConfig.topP()) |
|||
.frequencyPenalty(chatModelConfig.frequencyPenalty()) |
|||
.presencePenalty(chatModelConfig.presencePenalty()) |
|||
.maxTokens(chatModelConfig.maxOutputTokens()) |
|||
.timeout(toDuration(chatModelConfig.timeoutSeconds())) |
|||
.maxRetries(chatModelConfig.maxRetries()) |
|||
.build(); |
|||
} |
|||
|
|||
private static Duration toDuration(Integer timeoutSeconds) { |
|||
return timeoutSeconds != null ? Duration.ofSeconds(timeoutSeconds) : null; |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,80 @@ |
|||
/** |
|||
* Copyright © 2016-2025 The Thingsboard Authors |
|||
* |
|||
* Licensed under the Apache License, Version 2.0 (the "License"); |
|||
* you may not use this file except in compliance with the License. |
|||
* You may obtain a copy of the License at |
|||
* |
|||
* http://www.apache.org/licenses/LICENSE-2.0
|
|||
* |
|||
* Unless required by applicable law or agreed to in writing, software |
|||
* distributed under the License is distributed on an "AS IS" BASIS, |
|||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|||
* See the License for the specific language governing permissions and |
|||
* limitations under the License. |
|||
*/ |
|||
package org.thingsboard.server.service.entitiy.ai; |
|||
|
|||
import lombok.RequiredArgsConstructor; |
|||
import org.springframework.stereotype.Service; |
|||
import org.thingsboard.server.common.data.EntityType; |
|||
import org.thingsboard.server.common.data.User; |
|||
import org.thingsboard.server.common.data.ai.AiModel; |
|||
import org.thingsboard.server.common.data.audit.ActionType; |
|||
import org.thingsboard.server.dao.ai.AiModelService; |
|||
import org.thingsboard.server.queue.util.TbCoreComponent; |
|||
import org.thingsboard.server.service.entitiy.AbstractTbEntityService; |
|||
|
|||
import static java.util.Objects.requireNonNullElseGet; |
|||
|
|||
@Service |
|||
@TbCoreComponent |
|||
@RequiredArgsConstructor |
|||
class DefaultTbAiModelService extends AbstractTbEntityService implements TbAiModelService { |
|||
|
|||
private final AiModelService aiModelService; |
|||
|
|||
@Override |
|||
public AiModel save(AiModel model, User user) { |
|||
var actionType = model.getId() == null ? ActionType.ADDED : ActionType.UPDATED; |
|||
|
|||
var tenantId = user.getTenantId(); |
|||
model.setTenantId(tenantId); |
|||
|
|||
AiModel savedModel; |
|||
try { |
|||
savedModel = aiModelService.save(model); |
|||
autoCommit(user, savedModel.getId()); |
|||
} catch (Exception e) { |
|||
logEntityActionService.logEntityAction(tenantId, requireNonNullElseGet(model.getId(), () -> emptyId(EntityType.AI_MODEL)), model, actionType, user, e); |
|||
throw e; |
|||
} |
|||
|
|||
logEntityActionService.logEntityAction(tenantId, savedModel.getId(), savedModel, actionType, user); |
|||
|
|||
return savedModel; |
|||
} |
|||
|
|||
@Override |
|||
public boolean delete(AiModel model, User user) { |
|||
var actionType = ActionType.DELETED; |
|||
|
|||
var tenantId = user.getTenantId(); |
|||
var modelId = model.getId(); |
|||
|
|||
boolean deleted; |
|||
try { |
|||
deleted = aiModelService.deleteByTenantIdAndId(tenantId, modelId); |
|||
} catch (Exception e) { |
|||
logEntityActionService.logEntityAction(tenantId, modelId, model, actionType, user, e, modelId.toString()); |
|||
throw e; |
|||
} |
|||
|
|||
if (deleted) { |
|||
logEntityActionService.logEntityAction(tenantId, modelId, model, actionType, user, modelId.toString()); |
|||
} |
|||
|
|||
return deleted; |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,27 @@ |
|||
/** |
|||
* Copyright © 2016-2025 The Thingsboard Authors |
|||
* |
|||
* Licensed under the Apache License, Version 2.0 (the "License"); |
|||
* you may not use this file except in compliance with the License. |
|||
* You may obtain a copy of the License at |
|||
* |
|||
* http://www.apache.org/licenses/LICENSE-2.0
|
|||
* |
|||
* Unless required by applicable law or agreed to in writing, software |
|||
* distributed under the License is distributed on an "AS IS" BASIS, |
|||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|||
* See the License for the specific language governing permissions and |
|||
* limitations under the License. |
|||
*/ |
|||
package org.thingsboard.server.service.entitiy.ai; |
|||
|
|||
import org.thingsboard.server.common.data.User; |
|||
import org.thingsboard.server.common.data.ai.AiModel; |
|||
|
|||
public interface TbAiModelService { |
|||
|
|||
AiModel save(AiModel model, User user); |
|||
|
|||
boolean delete(AiModel model, User user); |
|||
|
|||
} |
|||
@ -0,0 +1,36 @@ |
|||
/** |
|||
* Copyright © 2016-2025 The Thingsboard Authors |
|||
* |
|||
* Licensed under the Apache License, Version 2.0 (the "License"); |
|||
* you may not use this file except in compliance with the License. |
|||
* You may obtain a copy of the License at |
|||
* |
|||
* http://www.apache.org/licenses/LICENSE-2.0
|
|||
* |
|||
* Unless required by applicable law or agreed to in writing, software |
|||
* distributed under the License is distributed on an "AS IS" BASIS, |
|||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|||
* See the License for the specific language governing permissions and |
|||
* limitations under the License. |
|||
*/ |
|||
package org.thingsboard.server.service.sync.ie.exporting.impl; |
|||
|
|||
import org.springframework.stereotype.Service; |
|||
import org.thingsboard.server.common.data.EntityType; |
|||
import org.thingsboard.server.common.data.ai.AiModel; |
|||
import org.thingsboard.server.common.data.id.AiModelId; |
|||
import org.thingsboard.server.common.data.sync.ie.EntityExportData; |
|||
import org.thingsboard.server.queue.util.TbCoreComponent; |
|||
|
|||
import java.util.Set; |
|||
|
|||
@Service |
|||
@TbCoreComponent |
|||
class AiModelExportService extends BaseEntityExportService<AiModelId, AiModel, EntityExportData<AiModel>> { |
|||
|
|||
@Override |
|||
public Set<EntityType> getSupportedEntityTypes() { |
|||
return Set.of(EntityType.AI_MODEL); |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,49 @@ |
|||
/** |
|||
* Copyright © 2016-2025 The Thingsboard Authors |
|||
* |
|||
* Licensed under the Apache License, Version 2.0 (the "License"); |
|||
* you may not use this file except in compliance with the License. |
|||
* You may obtain a copy of the License at |
|||
* |
|||
* http://www.apache.org/licenses/LICENSE-2.0
|
|||
* |
|||
* Unless required by applicable law or agreed to in writing, software |
|||
* distributed under the License is distributed on an "AS IS" BASIS, |
|||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|||
* See the License for the specific language governing permissions and |
|||
* limitations under the License. |
|||
*/ |
|||
package org.thingsboard.server.service.sync.ie.exporting.impl; |
|||
|
|||
import lombok.RequiredArgsConstructor; |
|||
import org.springframework.stereotype.Service; |
|||
import org.thingsboard.server.common.data.EntityType; |
|||
import org.thingsboard.server.common.data.OtaPackage; |
|||
import org.thingsboard.server.common.data.id.OtaPackageId; |
|||
import org.thingsboard.server.common.data.sync.ie.OtaPackageExportData; |
|||
import org.thingsboard.server.queue.util.TbCoreComponent; |
|||
import org.thingsboard.server.service.sync.vc.data.EntitiesExportCtx; |
|||
|
|||
import java.util.Set; |
|||
|
|||
@Service |
|||
@TbCoreComponent |
|||
@RequiredArgsConstructor |
|||
public class OtaPackageExportService extends BaseEntityExportService<OtaPackageId, OtaPackage, OtaPackageExportData> { |
|||
|
|||
@Override |
|||
protected void setRelatedEntities(EntitiesExportCtx<?> ctx, OtaPackage otaPackage, OtaPackageExportData exportData) { |
|||
otaPackage.setDeviceProfileId(getExternalIdOrElseInternal(ctx, otaPackage.getDeviceProfileId())); |
|||
} |
|||
|
|||
@Override |
|||
protected OtaPackageExportData newExportData() { |
|||
return new OtaPackageExportData(); |
|||
} |
|||
|
|||
@Override |
|||
public Set<EntityType> getSupportedEntityTypes() { |
|||
return Set.of(EntityType.OTA_PACKAGE); |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,77 @@ |
|||
/** |
|||
* Copyright © 2016-2025 The Thingsboard Authors |
|||
* |
|||
* Licensed under the Apache License, Version 2.0 (the "License"); |
|||
* you may not use this file except in compliance with the License. |
|||
* You may obtain a copy of the License at |
|||
* |
|||
* http://www.apache.org/licenses/LICENSE-2.0
|
|||
* |
|||
* Unless required by applicable law or agreed to in writing, software |
|||
* distributed under the License is distributed on an "AS IS" BASIS, |
|||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|||
* See the License for the specific language governing permissions and |
|||
* limitations under the License. |
|||
*/ |
|||
package org.thingsboard.server.service.sync.ie.importing.impl; |
|||
|
|||
import lombok.RequiredArgsConstructor; |
|||
import org.springframework.stereotype.Service; |
|||
import org.thingsboard.server.common.data.EntityType; |
|||
import org.thingsboard.server.common.data.ai.AiModel; |
|||
import org.thingsboard.server.common.data.id.AiModelId; |
|||
import org.thingsboard.server.common.data.id.TenantId; |
|||
import org.thingsboard.server.common.data.sync.ie.EntityExportData; |
|||
import org.thingsboard.server.dao.ai.AiModelService; |
|||
import org.thingsboard.server.queue.util.TbCoreComponent; |
|||
import org.thingsboard.server.service.sync.vc.data.EntitiesImportCtx; |
|||
|
|||
@Service |
|||
@TbCoreComponent |
|||
@RequiredArgsConstructor |
|||
class AiModelImportService extends BaseEntityImportService<AiModelId, AiModel, EntityExportData<AiModel>> { |
|||
|
|||
private final AiModelService aiModelService; |
|||
|
|||
@Override |
|||
protected void setOwner( |
|||
TenantId tenantId, |
|||
AiModel model, |
|||
BaseEntityImportService<AiModelId, AiModel, EntityExportData<AiModel>>.IdProvider idProvider |
|||
) { |
|||
model.setTenantId(tenantId); |
|||
} |
|||
|
|||
@Override |
|||
protected AiModel prepare( |
|||
EntitiesImportCtx ctx, |
|||
AiModel model, |
|||
AiModel oldModel, |
|||
EntityExportData<AiModel> exportData, |
|||
BaseEntityImportService<AiModelId, AiModel, EntityExportData<AiModel>>.IdProvider idProvider |
|||
) { |
|||
return model; |
|||
} |
|||
|
|||
@Override |
|||
protected AiModel deepCopy(AiModel model) { |
|||
return new AiModel(model); |
|||
} |
|||
|
|||
@Override |
|||
protected AiModel saveOrUpdate( |
|||
EntitiesImportCtx ctx, |
|||
AiModel model, |
|||
EntityExportData<AiModel> exportData, |
|||
BaseEntityImportService<AiModelId, AiModel, EntityExportData<AiModel>>.IdProvider idProvider, |
|||
CompareResult compareResult |
|||
) { |
|||
return aiModelService.save(model); |
|||
} |
|||
|
|||
@Override |
|||
public EntityType getEntityType() { |
|||
return EntityType.AI_MODEL; |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,76 @@ |
|||
/** |
|||
* Copyright © 2016-2025 The Thingsboard Authors |
|||
* |
|||
* Licensed under the Apache License, Version 2.0 (the "License"); |
|||
* you may not use this file except in compliance with the License. |
|||
* You may obtain a copy of the License at |
|||
* |
|||
* http://www.apache.org/licenses/LICENSE-2.0
|
|||
* |
|||
* Unless required by applicable law or agreed to in writing, software |
|||
* distributed under the License is distributed on an "AS IS" BASIS, |
|||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|||
* See the License for the specific language governing permissions and |
|||
* limitations under the License. |
|||
*/ |
|||
package org.thingsboard.server.service.sync.ie.importing.impl; |
|||
|
|||
import lombok.RequiredArgsConstructor; |
|||
import org.springframework.stereotype.Service; |
|||
import org.thingsboard.server.common.data.EntityType; |
|||
import org.thingsboard.server.common.data.OtaPackage; |
|||
import org.thingsboard.server.common.data.OtaPackageInfo; |
|||
import org.thingsboard.server.common.data.id.OtaPackageId; |
|||
import org.thingsboard.server.common.data.id.TenantId; |
|||
import org.thingsboard.server.common.data.sync.ie.OtaPackageExportData; |
|||
import org.thingsboard.server.dao.ota.OtaPackageService; |
|||
import org.thingsboard.server.queue.util.TbCoreComponent; |
|||
import org.thingsboard.server.service.sync.vc.data.EntitiesImportCtx; |
|||
|
|||
@Service |
|||
@TbCoreComponent |
|||
@RequiredArgsConstructor |
|||
public class OtaPackageImportService extends BaseEntityImportService<OtaPackageId, OtaPackage, OtaPackageExportData> { |
|||
|
|||
private final OtaPackageService otaPackageService; |
|||
|
|||
@Override |
|||
protected void setOwner(TenantId tenantId, OtaPackage otaPackage, IdProvider idProvider) { |
|||
otaPackage.setTenantId(tenantId); |
|||
} |
|||
|
|||
@Override |
|||
protected OtaPackage prepare(EntitiesImportCtx ctx, OtaPackage otaPackage, OtaPackage oldOtaPackage, OtaPackageExportData exportData, IdProvider idProvider) { |
|||
otaPackage.setDeviceProfileId(idProvider.getInternalId(otaPackage.getDeviceProfileId())); |
|||
return otaPackage; |
|||
} |
|||
|
|||
@Override |
|||
protected OtaPackage findExistingEntity(EntitiesImportCtx ctx, OtaPackage otaPackage, IdProvider idProvider) { |
|||
OtaPackage existingOtaPackage = super.findExistingEntity(ctx, otaPackage, idProvider); |
|||
if (existingOtaPackage == null && ctx.isFindExistingByName()) { |
|||
existingOtaPackage = otaPackageService.findOtaPackageByTenantIdAndTitleAndVersion(ctx.getTenantId(), otaPackage.getTitle(), otaPackage.getVersion()); |
|||
} |
|||
return existingOtaPackage; |
|||
} |
|||
|
|||
@Override |
|||
protected OtaPackage deepCopy(OtaPackage otaPackage) { |
|||
return new OtaPackage(otaPackage); |
|||
} |
|||
|
|||
@Override |
|||
protected OtaPackage saveOrUpdate(EntitiesImportCtx ctx, OtaPackage otaPackage, OtaPackageExportData exportData, IdProvider idProvider, CompareResult compareResult) { |
|||
if (otaPackage.hasUrl()) { |
|||
OtaPackageInfo info = new OtaPackageInfo(otaPackage); |
|||
return new OtaPackage(otaPackageService.saveOtaPackageInfo(info, info.hasUrl())); |
|||
} |
|||
return otaPackageService.saveOtaPackage(otaPackage); |
|||
} |
|||
|
|||
@Override |
|||
public EntityType getEntityType() { |
|||
return EntityType.OTA_PACKAGE; |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,615 @@ |
|||
/** |
|||
* Copyright © 2016-2025 The Thingsboard Authors |
|||
* |
|||
* Licensed under the Apache License, Version 2.0 (the "License"); |
|||
* you may not use this file except in compliance with the License. |
|||
* You may obtain a copy of the License at |
|||
* |
|||
* http://www.apache.org/licenses/LICENSE-2.0
|
|||
* |
|||
* Unless required by applicable law or agreed to in writing, software |
|||
* distributed under the License is distributed on an "AS IS" BASIS, |
|||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|||
* See the License for the specific language governing permissions and |
|||
* limitations under the License. |
|||
*/ |
|||
package org.thingsboard.server.controller; |
|||
|
|||
import com.datastax.oss.driver.api.core.uuid.Uuids; |
|||
import com.fasterxml.jackson.core.type.TypeReference; |
|||
import org.junit.Test; |
|||
import org.springframework.test.web.servlet.ResultActions; |
|||
import org.thingsboard.server.common.data.EntityType; |
|||
import org.thingsboard.server.common.data.ai.AiModel; |
|||
import org.thingsboard.server.common.data.ai.model.chat.AnthropicChatModelConfig; |
|||
import org.thingsboard.server.common.data.ai.model.chat.GoogleAiGeminiChatModelConfig; |
|||
import org.thingsboard.server.common.data.ai.model.chat.OpenAiChatModelConfig; |
|||
import org.thingsboard.server.common.data.ai.provider.AnthropicProviderConfig; |
|||
import org.thingsboard.server.common.data.ai.provider.GoogleAiGeminiProviderConfig; |
|||
import org.thingsboard.server.common.data.ai.provider.OpenAiProviderConfig; |
|||
import org.thingsboard.server.common.data.id.AiModelId; |
|||
import org.thingsboard.server.common.data.id.EntityId; |
|||
import org.thingsboard.server.common.data.page.PageData; |
|||
import org.thingsboard.server.common.data.page.PageLink; |
|||
import org.thingsboard.server.common.data.page.SortOrder; |
|||
import org.thingsboard.server.dao.service.DaoSqlTest; |
|||
|
|||
import static org.assertj.core.api.Assertions.assertThat; |
|||
import static org.hamcrest.Matchers.equalTo; |
|||
import static org.hamcrest.Matchers.is; |
|||
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; |
|||
|
|||
@DaoSqlTest |
|||
public class AiModelControllerTest extends AbstractControllerTest { |
|||
|
|||
/* --- Save API tests --- */ |
|||
|
|||
@Test |
|||
public void saveAiModel_whenUserIsSysAdmin_shouldReturnForbidden() throws Exception { |
|||
// GIVEN
|
|||
loginSysAdmin(); |
|||
|
|||
AiModel model = constructValidOpenAiModel("Test model"); |
|||
|
|||
// WHEN
|
|||
ResultActions result = doPost("/api/ai/model", model); |
|||
|
|||
// THEN
|
|||
result.andExpect(status().isForbidden()).andExpect(statusReason(equalTo(msgErrorPermission))); |
|||
} |
|||
|
|||
@Test |
|||
public void saveAiModel_whenUserIsCustomerUser_shouldReturnForbidden() throws Exception { |
|||
// GIVEN
|
|||
loginCustomerUser(); |
|||
|
|||
AiModel model = constructValidOpenAiModel("Test model"); |
|||
|
|||
// WHEN
|
|||
ResultActions result = doPost("/api/ai/model", model); |
|||
|
|||
// THEN
|
|||
result.andExpect(status().isForbidden()).andExpect(statusReason(equalTo(msgErrorPermission))); |
|||
} |
|||
|
|||
@Test |
|||
public void saveAiModel_whenCreatingValidModelAsTenantAdmin_shouldSucceed() throws Exception { |
|||
// GIVEN
|
|||
loginTenantAdmin(); |
|||
|
|||
AiModel model = constructValidOpenAiModel("Test model"); |
|||
|
|||
// WHEN
|
|||
var savedModel = doPost("/api/ai/model", model, AiModel.class); |
|||
|
|||
// THEN
|
|||
|
|||
// verify returned object
|
|||
assertThat(savedModel.getId()).isNotNull(); |
|||
assertThat(savedModel.getUuidId()).isNotNull().isNotEqualTo(EntityId.NULL_UUID); |
|||
assertThat(savedModel.getId().getEntityType()).isEqualTo(EntityType.AI_MODEL); |
|||
assertThat(savedModel.getCreatedTime()).isPositive(); |
|||
assertThat(savedModel.getVersion()).isEqualTo(1); |
|||
assertThat(savedModel.getTenantId()).isEqualTo(tenantId); |
|||
assertThat(savedModel.getName()).isEqualTo("Test model"); |
|||
assertThat(savedModel.getConfiguration()).isEqualTo(model.getConfiguration()); |
|||
assertThat(savedModel.getExternalId()).isNull(); |
|||
} |
|||
|
|||
@Test |
|||
public void saveAiModel_whenUpdatingExistingModelAsTenantAdmin_shouldSucceed() throws Exception { |
|||
// GIVEN
|
|||
loginTenantAdmin(); |
|||
|
|||
var model = doPost("/api/ai/model", constructValidOpenAiModel("Test model"), AiModel.class); |
|||
|
|||
var newModelConfig = OpenAiChatModelConfig.builder() |
|||
.providerConfig(new OpenAiProviderConfig("test-api-key-updated")) |
|||
.modelId("o4-mini") |
|||
.temperature(0.2) |
|||
.topP(0.4) |
|||
.frequencyPenalty(0.2) |
|||
.presencePenalty(0.5) |
|||
.maxOutputTokens(2000) |
|||
.timeoutSeconds(20) |
|||
.maxRetries(0) |
|||
.build(); |
|||
|
|||
model.setName("Test model updated"); |
|||
model.setConfiguration(newModelConfig); |
|||
|
|||
// WHEN
|
|||
var updatedModel = doPost("/api/ai/model", model, AiModel.class); |
|||
|
|||
// THEN
|
|||
|
|||
// verify returned object
|
|||
assertThat(updatedModel.getId()).isEqualTo(model.getId()); |
|||
assertThat(updatedModel.getCreatedTime()).isEqualTo(model.getCreatedTime()); |
|||
assertThat(updatedModel.getVersion()).isEqualTo(2); |
|||
assertThat(updatedModel.getTenantId()).isEqualTo(tenantId); |
|||
assertThat(updatedModel.getName()).isEqualTo("Test model updated"); |
|||
assertThat(updatedModel.getConfiguration()).isEqualTo(newModelConfig); |
|||
assertThat(updatedModel.getExternalId()).isNull(); |
|||
} |
|||
|
|||
/* --- Get by ID API tests --- */ |
|||
|
|||
@Test |
|||
public void getAiModelById_whenUserIsSysAdmin_shouldReturnForbidden() throws Exception { |
|||
// GIVEN
|
|||
loginSysAdmin(); |
|||
|
|||
// WHEN
|
|||
ResultActions result = doGet("/api/ai/model/" + Uuids.timeBased()); |
|||
|
|||
// THEN
|
|||
result.andExpect(status().isForbidden()).andExpect(statusReason(equalTo(msgErrorPermission))); |
|||
} |
|||
|
|||
@Test |
|||
public void getAiModelById_whenUserIsCustomerUser_shouldReturnForbidden() throws Exception { |
|||
// GIVEN
|
|||
loginCustomerUser(); |
|||
|
|||
// WHEN
|
|||
ResultActions result = doGet("/api/ai/model/" + Uuids.timeBased()); |
|||
|
|||
// THEN
|
|||
result.andExpect(status().isForbidden()).andExpect(statusReason(equalTo(msgErrorPermission))); |
|||
} |
|||
|
|||
@Test |
|||
public void getAiModelById_whenGettingExistingModelAsTenantAdmin_shouldReturnModel() throws Exception { |
|||
// GIVEN
|
|||
loginTenantAdmin(); |
|||
|
|||
var saved = doPost("/api/ai/model", constructValidOpenAiModel("Test model"), AiModel.class); |
|||
|
|||
// WHEN
|
|||
AiModel actual = doGet("/api/ai/model/" + saved.getId(), AiModel.class); |
|||
|
|||
// THEN
|
|||
assertThat(actual).isEqualTo(saved); |
|||
} |
|||
|
|||
@Test |
|||
public void getAiModelById_whenGettingNonexistentModelAsTenantAdmin_shouldReturnNotFound() throws Exception { |
|||
// GIVEN
|
|||
loginTenantAdmin(); |
|||
|
|||
var nonexistentModelId = new AiModelId(Uuids.timeBased()); |
|||
|
|||
// WHEN
|
|||
ResultActions result = doGet("/api/ai/model/" + nonexistentModelId); |
|||
|
|||
// THEN
|
|||
result.andExpect(status().isNotFound()) |
|||
.andExpect(statusReason(is("AI model with id [" + nonexistentModelId + "] is not found"))); |
|||
} |
|||
|
|||
/* --- Get paged API tests --- */ |
|||
|
|||
@Test |
|||
public void getAiModels_whenUserIsSysAdmin_shouldReturnForbidden() throws Exception { |
|||
// GIVEN
|
|||
loginSysAdmin(); |
|||
|
|||
// WHEN
|
|||
ResultActions result = doGet("/api/ai/model?pageSize=10&page=0"); |
|||
|
|||
// THEN
|
|||
result.andExpect(status().isForbidden()).andExpect(statusReason(equalTo(msgErrorPermission))); |
|||
} |
|||
|
|||
@Test |
|||
public void getAiModels_whenUserIsCustomerUser_shouldReturnForbidden() throws Exception { |
|||
// GIVEN
|
|||
loginCustomerUser(); |
|||
|
|||
// WHEN
|
|||
ResultActions result = doGet("/api/ai/model?pageSize=10&page=0"); |
|||
|
|||
// THEN
|
|||
result.andExpect(status().isForbidden()).andExpect(statusReason(equalTo(msgErrorPermission))); |
|||
} |
|||
|
|||
@Test |
|||
public void getAiModels_testPagination() throws Exception { |
|||
// GIVEN
|
|||
loginTenantAdmin(); |
|||
|
|||
var model1 = doPost("/api/ai/model", constructValidOpenAiModel("Test model 1"), AiModel.class); |
|||
var model2 = doPost("/api/ai/model", constructValidOpenAiModel("Test model 2"), AiModel.class); |
|||
var model3 = doPost("/api/ai/model", constructValidOpenAiModel("Test model 3"), AiModel.class); |
|||
var model4 = doPost("/api/ai/model", constructValidOpenAiModel("Test model 4"), AiModel.class); |
|||
var model5 = doPost("/api/ai/model", constructValidOpenAiModel("Test model 5"), AiModel.class); |
|||
|
|||
// WHEN
|
|||
PageData<AiModel> result = doGetTypedWithPageLink("/api/ai/model?", new TypeReference<>() {}, new PageLink(2, 1)); |
|||
|
|||
// THEN
|
|||
assertThat(result.getData()).containsExactly(model3, model4); |
|||
assertThat(result.getTotalPages()).isEqualTo(3); |
|||
assertThat(result.getTotalElements()).isEqualTo(5); |
|||
assertThat(result.hasNext()).isTrue(); |
|||
} |
|||
|
|||
@Test |
|||
public void getAiModels_testSearchAndSortAppliedBeforePagination() throws Exception { |
|||
// GIVEN
|
|||
loginTenantAdmin(); |
|||
|
|||
// Create 5 models: 3 with "Alpha" in name, 2 with "Beta" in name
|
|||
var alpha1 = doPost("/api/ai/model", constructValidOpenAiModel("Alpha Model 1"), AiModel.class); |
|||
var beta1 = doPost("/api/ai/model", constructValidOpenAiModel("Beta Model 1"), AiModel.class); |
|||
var alpha2 = doPost("/api/ai/model", constructValidOpenAiModel("Alpha Model 2"), AiModel.class); |
|||
var beta2 = doPost("/api/ai/model", constructValidOpenAiModel("Beta Model 2"), AiModel.class); |
|||
var alpha3 = doPost("/api/ai/model", constructValidOpenAiModel("Alpha Model 3"), AiModel.class); |
|||
|
|||
// WHEN
|
|||
// Search for "Alpha", sort by name DESC, get the first page with size 2
|
|||
PageData<AiModel> result = doGetTypedWithPageLink("/api/ai/model?", |
|||
new TypeReference<>() {}, |
|||
new PageLink(2, 0, "Alpha", SortOrder.of("name", SortOrder.Direction.DESC))); |
|||
|
|||
// THEN
|
|||
// Should find only 3 "Alpha" models, sort them DESC (3, 2, 1), then return first 2
|
|||
assertThat(result.getData()).containsExactly(alpha3, alpha2); |
|||
assertThat(result.getTotalPages()).isEqualTo(2); // One more "Alpha" model on the next page
|
|||
assertThat(result.getTotalElements()).isEqualTo(3); // Only 3 models match "Alpha", not 5
|
|||
assertThat(result.hasNext()).isTrue(); // One more "Alpha" model on the next page
|
|||
} |
|||
|
|||
@Test |
|||
public void getAiModels_testTextSearch() throws Exception { |
|||
// GIVEN
|
|||
loginTenantAdmin(); |
|||
|
|||
var model1 = doPost("/api/ai/model", AiModel.builder() |
|||
.tenantId(tenantId) |
|||
.name("Test model 1") |
|||
.configuration(OpenAiChatModelConfig.builder() |
|||
.providerConfig(new OpenAiProviderConfig("test-api-key")) |
|||
.modelId("o3-pro") |
|||
.build()) |
|||
.build(), AiModel.class); |
|||
var model2 = doPost("/api/ai/model", AiModel.builder() |
|||
.tenantId(tenantId) |
|||
.name("Test model 2") |
|||
.configuration(GoogleAiGeminiChatModelConfig.builder() |
|||
.providerConfig(new GoogleAiGeminiProviderConfig("test-api-key")) |
|||
.modelId("gemini-2.5-flash") |
|||
.build()) |
|||
.build(), AiModel.class); |
|||
var model3 = doPost("/api/ai/model", AiModel.builder() |
|||
.tenantId(tenantId) |
|||
.name("Test model 3") |
|||
.configuration(GoogleAiGeminiChatModelConfig.builder() |
|||
.providerConfig(new GoogleAiGeminiProviderConfig("test-api-key")) |
|||
.modelId("gemini-2.5-pro") |
|||
.build()) |
|||
.build(), AiModel.class); |
|||
|
|||
// WHEN
|
|||
int pageSize = 10; |
|||
int page = 0; |
|||
SortOrder sortOrder = null; |
|||
|
|||
PageData<AiModel> result1 = doGetTypedWithPageLink("/api/ai/model?", new TypeReference<>() {}, new PageLink(pageSize, page, "google ai", sortOrder)); |
|||
|
|||
PageData<AiModel> result2 = doGetTypedWithPageLink("/api/ai/model?", new TypeReference<>() {}, new PageLink(pageSize, page, "pro", sortOrder)); |
|||
|
|||
PageData<AiModel> result3 = doGetTypedWithPageLink("/api/ai/model?", new TypeReference<>() {}, new PageLink(pageSize, page, "test", sortOrder)); |
|||
|
|||
PageData<AiModel> result4 = doGetTypedWithPageLink("/api/ai/model?", new TypeReference<>() {}, new PageLink(pageSize, page, "anthropic", sortOrder)); |
|||
|
|||
// THEN
|
|||
|
|||
// should find google models
|
|||
assertThat(result1.getData()).containsExactly(model2, model3); |
|||
assertThat(result1.getTotalPages()).isEqualTo(1); |
|||
assertThat(result1.getTotalElements()).isEqualTo(2); |
|||
assertThat(result1.hasNext()).isFalse(); |
|||
|
|||
// should find "o3-pro" and "gemini-2.5-pro" models
|
|||
assertThat(result2.getData()).containsExactly(model1, model3); |
|||
assertThat(result2.getTotalPages()).isEqualTo(1); |
|||
assertThat(result2.getTotalElements()).isEqualTo(2); |
|||
assertThat(result2.hasNext()).isFalse(); |
|||
|
|||
// should find all models (all contain "Test" in their names)
|
|||
assertThat(result3.getData()).containsExactly(model1, model2, model3); |
|||
assertThat(result3.getTotalPages()).isEqualTo(1); |
|||
assertThat(result3.getTotalElements()).isEqualTo(3); |
|||
assertThat(result3.hasNext()).isFalse(); |
|||
|
|||
// should find no models (nothing matches "anthropic")
|
|||
assertThat(result4.getData()).isEmpty(); |
|||
assertThat(result4.getTotalPages()).isEqualTo(0); |
|||
assertThat(result4.getTotalElements()).isEqualTo(0); |
|||
assertThat(result4.hasNext()).isFalse(); |
|||
} |
|||
|
|||
@Test |
|||
public void getAiModels_testSortingByCreatedTime() throws Exception { |
|||
// GIVEN
|
|||
loginTenantAdmin(); |
|||
|
|||
var model1 = doPost("/api/ai/model", constructValidOpenAiModel("Test model 1"), AiModel.class); |
|||
var model2 = doPost("/api/ai/model", constructValidOpenAiModel("Test model 2"), AiModel.class); |
|||
|
|||
// WHEN
|
|||
int pageSize = 2; |
|||
int page = 0; |
|||
String textSearch = null; |
|||
|
|||
PageData<AiModel> resultAsc = doGetTypedWithPageLink( |
|||
"/api/ai/model?", new TypeReference<>() {}, |
|||
new PageLink(pageSize, page, textSearch, SortOrder.of("createdTime", SortOrder.Direction.ASC)) |
|||
); |
|||
PageData<AiModel> resultDesc = doGetTypedWithPageLink( |
|||
"/api/ai/model?", new TypeReference<>() {}, |
|||
new PageLink(pageSize, page, textSearch, SortOrder.of("createdTime", SortOrder.Direction.DESC)) |
|||
); |
|||
|
|||
// THEN
|
|||
assertThat(resultAsc.getData()).containsExactly(model1, model2); |
|||
assertThat(resultAsc.getTotalPages()).isEqualTo(1); |
|||
assertThat(resultAsc.getTotalElements()).isEqualTo(2); |
|||
assertThat(resultAsc.hasNext()).isFalse(); |
|||
|
|||
assertThat(resultDesc.getData()).containsExactly(model2, model1); |
|||
assertThat(resultDesc.getTotalPages()).isEqualTo(1); |
|||
assertThat(resultDesc.getTotalElements()).isEqualTo(2); |
|||
assertThat(resultDesc.hasNext()).isFalse(); |
|||
} |
|||
|
|||
@Test |
|||
public void getAiModels_testSortingByName() throws Exception { |
|||
// GIVEN
|
|||
loginTenantAdmin(); |
|||
|
|||
var modelA = doPost("/api/ai/model", constructValidOpenAiModel("Test model A"), AiModel.class); |
|||
var modelB = doPost("/api/ai/model", constructValidOpenAiModel("Test model B"), AiModel.class); |
|||
|
|||
// WHEN
|
|||
int pageSize = 2; |
|||
int page = 0; |
|||
String textSearch = null; |
|||
|
|||
PageData<AiModel> resultAsc = doGetTypedWithPageLink( |
|||
"/api/ai/model?", new TypeReference<>() {}, |
|||
new PageLink(pageSize, page, textSearch, SortOrder.of("name", SortOrder.Direction.ASC)) |
|||
); |
|||
PageData<AiModel> resultDesc = doGetTypedWithPageLink( |
|||
"/api/ai/model?", new TypeReference<>() {}, |
|||
new PageLink(pageSize, page, textSearch, SortOrder.of("name", SortOrder.Direction.DESC)) |
|||
); |
|||
|
|||
// THEN
|
|||
assertThat(resultAsc.getData()).containsExactly(modelA, modelB); |
|||
assertThat(resultAsc.getTotalPages()).isEqualTo(1); |
|||
assertThat(resultAsc.getTotalElements()).isEqualTo(2); |
|||
assertThat(resultAsc.hasNext()).isFalse(); |
|||
|
|||
assertThat(resultDesc.getData()).containsExactly(modelB, modelA); |
|||
assertThat(resultDesc.getTotalPages()).isEqualTo(1); |
|||
assertThat(resultDesc.getTotalElements()).isEqualTo(2); |
|||
assertThat(resultDesc.hasNext()).isFalse(); |
|||
} |
|||
|
|||
@Test |
|||
public void getAiModels_testSortingByProvider() throws Exception { |
|||
// GIVEN
|
|||
loginTenantAdmin(); |
|||
|
|||
var anthropicModel = doPost("/api/ai/model", AiModel.builder() |
|||
.tenantId(tenantId) |
|||
.name("Test model 1") |
|||
.configuration(AnthropicChatModelConfig.builder() |
|||
.providerConfig(new AnthropicProviderConfig("test-api-key")) |
|||
.modelId("claude-sonnet-4-0") |
|||
.build()) |
|||
.build(), AiModel.class); |
|||
var geminiModel = doPost("/api/ai/model", AiModel.builder() |
|||
.tenantId(tenantId) |
|||
.name("Test model 2") |
|||
.configuration(GoogleAiGeminiChatModelConfig.builder() |
|||
.providerConfig(new GoogleAiGeminiProviderConfig("test-api-key")) |
|||
.modelId("gemini-2.5-pro") |
|||
.build()) |
|||
.build(), AiModel.class); |
|||
|
|||
// WHEN
|
|||
int pageSize = 2; |
|||
int page = 0; |
|||
String textSearch = null; |
|||
|
|||
PageData<AiModel> resultAsc = doGetTypedWithPageLink( |
|||
"/api/ai/model?", new TypeReference<>() {}, |
|||
new PageLink(pageSize, page, textSearch, SortOrder.of("provider", SortOrder.Direction.ASC)) |
|||
); |
|||
PageData<AiModel> resultDesc = doGetTypedWithPageLink( |
|||
"/api/ai/model?", new TypeReference<>() {}, |
|||
new PageLink(pageSize, page, textSearch, SortOrder.of("provider", SortOrder.Direction.DESC)) |
|||
); |
|||
|
|||
// THEN
|
|||
assertThat(resultAsc.getData()).containsExactly(anthropicModel, geminiModel); |
|||
assertThat(resultAsc.getTotalPages()).isEqualTo(1); |
|||
assertThat(resultAsc.getTotalElements()).isEqualTo(2); |
|||
assertThat(resultAsc.hasNext()).isFalse(); |
|||
|
|||
assertThat(resultDesc.getData()).containsExactly(geminiModel, anthropicModel); |
|||
assertThat(resultDesc.getTotalPages()).isEqualTo(1); |
|||
assertThat(resultDesc.getTotalElements()).isEqualTo(2); |
|||
assertThat(resultDesc.hasNext()).isFalse(); |
|||
} |
|||
|
|||
@Test |
|||
public void getAiModels_testSortingByModelId() throws Exception { |
|||
// GIVEN
|
|||
loginTenantAdmin(); |
|||
|
|||
var modelA = doPost("/api/ai/model", AiModel.builder() |
|||
.tenantId(tenantId) |
|||
.name("Test model 1") |
|||
.configuration(AnthropicChatModelConfig.builder() |
|||
.providerConfig(new AnthropicProviderConfig("test-api-key")) |
|||
.modelId("model-a") |
|||
.build()) |
|||
.build(), AiModel.class); |
|||
|
|||
var modelB = doPost("/api/ai/model", AiModel.builder() |
|||
.tenantId(tenantId) |
|||
.name("Test model 2") |
|||
.configuration(GoogleAiGeminiChatModelConfig.builder() |
|||
.providerConfig(new GoogleAiGeminiProviderConfig("test-api-key")) |
|||
.modelId("model-b") |
|||
.build()) |
|||
.build(), AiModel.class); |
|||
|
|||
// WHEN
|
|||
int pageSize = 2; |
|||
int page = 0; |
|||
String textSearch = null; |
|||
|
|||
PageData<AiModel> resultAsc = doGetTypedWithPageLink( |
|||
"/api/ai/model?", new TypeReference<>() {}, |
|||
new PageLink(pageSize, page, textSearch, SortOrder.of("modelId", SortOrder.Direction.ASC)) |
|||
); |
|||
PageData<AiModel> resultDesc = doGetTypedWithPageLink( |
|||
"/api/ai/model?", new TypeReference<>() {}, |
|||
new PageLink(pageSize, page, textSearch, SortOrder.of("modelId", SortOrder.Direction.DESC)) |
|||
); |
|||
|
|||
// THEN
|
|||
assertThat(resultAsc.getData()).containsExactly(modelA, modelB); |
|||
assertThat(resultAsc.getTotalPages()).isEqualTo(1); |
|||
assertThat(resultAsc.getTotalElements()).isEqualTo(2); |
|||
assertThat(resultAsc.hasNext()).isFalse(); |
|||
|
|||
assertThat(resultDesc.getData()).containsExactly(modelB, modelA); |
|||
assertThat(resultDesc.getTotalPages()).isEqualTo(1); |
|||
assertThat(resultDesc.getTotalElements()).isEqualTo(2); |
|||
assertThat(resultDesc.hasNext()).isFalse(); |
|||
} |
|||
|
|||
@Test |
|||
public void getAiModels_testSortingByIdTieBreaker() throws Exception { |
|||
// GIVEN
|
|||
loginTenantAdmin(); |
|||
|
|||
// Both models are from OpenAI and sorting will be done on provider
|
|||
var modelA = doPost("/api/ai/model", constructValidOpenAiModel("Test model A"), AiModel.class); |
|||
var modelB = doPost("/api/ai/model", constructValidOpenAiModel("Test model B"), AiModel.class); |
|||
|
|||
// WHEN
|
|||
int pageSize = 2; |
|||
int page = 0; |
|||
String textSearch = null; |
|||
|
|||
PageData<AiModel> resultAsc = doGetTypedWithPageLink( |
|||
"/api/ai/model?", new TypeReference<>() {}, |
|||
new PageLink(pageSize, page, textSearch, SortOrder.of("provider", SortOrder.Direction.ASC)) |
|||
); |
|||
PageData<AiModel> resultDesc = doGetTypedWithPageLink( |
|||
"/api/ai/model?", new TypeReference<>() {}, |
|||
new PageLink(pageSize, page, textSearch, SortOrder.of("provider", SortOrder.Direction.DESC)) |
|||
); |
|||
|
|||
// THEN
|
|||
|
|||
// in both cases result should be the same since in case of ties (both models have OpenAI as provider, sorting by ID ascending is used)
|
|||
assertThat(resultAsc.getData()).containsExactly(modelA, modelB); |
|||
assertThat(resultAsc.getTotalPages()).isEqualTo(1); |
|||
assertThat(resultAsc.getTotalElements()).isEqualTo(2); |
|||
assertThat(resultAsc.hasNext()).isFalse(); |
|||
|
|||
assertThat(resultDesc.getData()).containsExactly(modelA, modelB); |
|||
assertThat(resultDesc.getTotalPages()).isEqualTo(1); |
|||
assertThat(resultDesc.getTotalElements()).isEqualTo(2); |
|||
assertThat(resultDesc.hasNext()).isFalse(); |
|||
} |
|||
|
|||
/* --- Delete API tests --- */ |
|||
|
|||
@Test |
|||
public void deleteAiModelById_whenUserIsSysAdmin_shouldReturnForbidden() throws Exception { |
|||
// GIVEN
|
|||
loginSysAdmin(); |
|||
|
|||
// WHEN
|
|||
ResultActions result = doDelete("/api/ai/model/" + Uuids.timeBased()); |
|||
|
|||
// THEN
|
|||
result.andExpect(status().isForbidden()).andExpect(statusReason(equalTo(msgErrorPermission))); |
|||
} |
|||
|
|||
@Test |
|||
public void deleteAiModelById_whenUserIsCustomerUser_shouldReturnForbidden() throws Exception { |
|||
// GIVEN
|
|||
loginCustomerUser(); |
|||
|
|||
// WHEN
|
|||
ResultActions result = doDelete("/api/ai/model/" + Uuids.timeBased()); |
|||
|
|||
// THEN
|
|||
result.andExpect(status().isForbidden()).andExpect(statusReason(equalTo(msgErrorPermission))); |
|||
} |
|||
|
|||
@Test |
|||
public void deleteAiModelById_whenDeletingExistingModelAsTenantAdmin_shouldSucceedAndReturnTrue() throws Exception { |
|||
// GIVEN
|
|||
loginTenantAdmin(); |
|||
|
|||
var model = doPost("/api/ai/model", constructValidOpenAiModel("Test model"), AiModel.class); |
|||
|
|||
// WHEN
|
|||
boolean deleted = doDelete("/api/ai/model/" + model.getId(), Boolean.class); |
|||
|
|||
// THEN
|
|||
assertThat(deleted).isTrue(); |
|||
|
|||
// verify model cannot be found anymore
|
|||
doGet("/api/ai/model/" + model.getId()) |
|||
.andExpect(status().isNotFound()) |
|||
.andExpect(statusReason(is("AI model with id [" + model.getId() + "] is not found"))); |
|||
} |
|||
|
|||
@Test |
|||
public void deleteAiModelById_whenDeletingNonexistentModelAsTenantAdmin_shouldSucceedAndReturnFalse() throws Exception { |
|||
// GIVEN
|
|||
loginTenantAdmin(); |
|||
|
|||
var nonexistentModelId = new AiModelId(Uuids.timeBased()); |
|||
|
|||
// WHEN
|
|||
boolean deleted = doDelete("/api/ai/model/" + nonexistentModelId, Boolean.class); |
|||
|
|||
// THEN
|
|||
assertThat(deleted).isFalse(); |
|||
} |
|||
|
|||
private AiModel constructValidOpenAiModel(String name) { |
|||
var modelConfig = OpenAiChatModelConfig.builder() |
|||
.providerConfig(new OpenAiProviderConfig("test-api-key")) |
|||
.modelId("gpt-4o") |
|||
.temperature(0.5) |
|||
.topP(0.3) |
|||
.frequencyPenalty(0.1) |
|||
.presencePenalty(0.2) |
|||
.maxOutputTokens(1000) |
|||
.timeoutSeconds(60) |
|||
.maxRetries(2) |
|||
.build(); |
|||
|
|||
return AiModel.builder() |
|||
.tenantId(tenantId) |
|||
.name(name) |
|||
.configuration(modelConfig) |
|||
.build(); |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,268 @@ |
|||
/** |
|||
* Copyright © 2016-2025 The Thingsboard Authors |
|||
* |
|||
* Licensed under the Apache License, Version 2.0 (the "License"); |
|||
* you may not use this file except in compliance with the License. |
|||
* You may obtain a copy of the License at |
|||
* |
|||
* http://www.apache.org/licenses/LICENSE-2.0
|
|||
* |
|||
* Unless required by applicable law or agreed to in writing, software |
|||
* distributed under the License is distributed on an "AS IS" BASIS, |
|||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|||
* See the License for the specific language governing permissions and |
|||
* limitations under the License. |
|||
*/ |
|||
package org.thingsboard.server.service.entitiy.ai; |
|||
|
|||
import org.junit.jupiter.api.BeforeEach; |
|||
import org.junit.jupiter.api.Test; |
|||
import org.junit.jupiter.api.extension.ExtendWith; |
|||
import org.mockito.InjectMocks; |
|||
import org.mockito.Mock; |
|||
import org.mockito.Spy; |
|||
import org.mockito.junit.jupiter.MockitoExtension; |
|||
import org.springframework.test.util.ReflectionTestUtils; |
|||
import org.thingsboard.server.common.data.User; |
|||
import org.thingsboard.server.common.data.ai.AiModel; |
|||
import org.thingsboard.server.common.data.ai.model.AiModelConfig; |
|||
import org.thingsboard.server.common.data.ai.model.chat.OpenAiChatModelConfig; |
|||
import org.thingsboard.server.common.data.ai.provider.OpenAiProviderConfig; |
|||
import org.thingsboard.server.common.data.audit.ActionType; |
|||
import org.thingsboard.server.common.data.id.AiModelId; |
|||
import org.thingsboard.server.common.data.id.EntityId; |
|||
import org.thingsboard.server.common.data.id.TenantId; |
|||
import org.thingsboard.server.dao.ai.AiModelService; |
|||
import org.thingsboard.server.service.entitiy.TbLogEntityActionService; |
|||
import org.thingsboard.server.service.sync.vc.EntitiesVersionControlService; |
|||
|
|||
import java.util.UUID; |
|||
|
|||
import static org.assertj.core.api.Assertions.assertThat; |
|||
import static org.assertj.core.api.Assertions.assertThatThrownBy; |
|||
import static org.mockito.ArgumentMatchers.any; |
|||
import static org.mockito.BDDMockito.given; |
|||
import static org.mockito.BDDMockito.then; |
|||
import static org.mockito.Mockito.never; |
|||
|
|||
@ExtendWith(MockitoExtension.class) |
|||
class DefaultTbAiModelServiceTest { |
|||
|
|||
@Mock |
|||
EntitiesVersionControlService vcServiceMock; |
|||
|
|||
@Mock |
|||
AiModelService aiModelServiceMock; |
|||
|
|||
@Mock |
|||
TbLogEntityActionService logEntityActionServiceMock; |
|||
|
|||
@Spy |
|||
@InjectMocks |
|||
DefaultTbAiModelService service; |
|||
|
|||
TenantId tenantId = TenantId.fromUUID(UUID.randomUUID()); |
|||
|
|||
User user; |
|||
|
|||
@BeforeEach |
|||
void setUp() { |
|||
user = new User(); |
|||
user.setTenantId(tenantId); |
|||
|
|||
service = new DefaultTbAiModelService(aiModelServiceMock); |
|||
ReflectionTestUtils.setField(service, "vcService", vcServiceMock); |
|||
ReflectionTestUtils.setField(service, "logEntityActionService", logEntityActionServiceMock); |
|||
} |
|||
|
|||
@Test |
|||
void save_whenCreatingNewModel_shouldAutoCommitAndLogAddedActionAndUseTenantIdFromUser() { |
|||
// GIVEN
|
|||
var modelToSave = AiModel.builder() |
|||
.name("Model to save") |
|||
.configuration(constructValidOpenAiModelConfig()) |
|||
.build(); |
|||
|
|||
var savedModel = new AiModel(modelToSave); |
|||
savedModel.setId(new AiModelId(UUID.randomUUID())); |
|||
savedModel.setTenantId(user.getTenantId()); |
|||
savedModel.setVersion(1L); |
|||
savedModel.setCreatedTime(System.currentTimeMillis()); |
|||
|
|||
given(aiModelServiceMock.save(modelToSave)).willReturn(savedModel); |
|||
|
|||
// WHEN
|
|||
AiModel result = service.save(modelToSave, user); |
|||
|
|||
// THEN
|
|||
assertThat(result).isEqualTo(savedModel); |
|||
|
|||
then(aiModelServiceMock).should().save(modelToSave); |
|||
then(vcServiceMock).should().autoCommit(user, savedModel.getId()); |
|||
then(logEntityActionServiceMock).should().logEntityAction(tenantId, savedModel.getId(), savedModel, ActionType.ADDED, user); |
|||
} |
|||
|
|||
@Test |
|||
void save_whenUpdatingExistingModel_shouldAutoCommitAndLogUpdatedAction() { |
|||
// GIVEN
|
|||
var modelToUpdate = AiModel.builder() |
|||
.tenantId(tenantId) |
|||
.version(1L) |
|||
.name("Model to update") |
|||
.configuration(constructValidOpenAiModelConfig()) |
|||
.build(); |
|||
modelToUpdate.setId(new AiModelId(UUID.randomUUID())); |
|||
modelToUpdate.setCreatedTime(System.currentTimeMillis()); |
|||
|
|||
var updatedModel = new AiModel(modelToUpdate); |
|||
updatedModel.setVersion(2L); |
|||
updatedModel.setName("Updated model"); |
|||
|
|||
given(aiModelServiceMock.save(modelToUpdate)).willReturn(updatedModel); |
|||
|
|||
// WHEN
|
|||
AiModel result = service.save(modelToUpdate, user); |
|||
|
|||
// THEN
|
|||
assertThat(result).isEqualTo(updatedModel); |
|||
|
|||
then(aiModelServiceMock).should().save(modelToUpdate); |
|||
then(vcServiceMock).should().autoCommit(user, updatedModel.getId()); |
|||
then(logEntityActionServiceMock).should().logEntityAction(tenantId, updatedModel.getId(), updatedModel, ActionType.UPDATED, user); |
|||
} |
|||
|
|||
@Test |
|||
void save_whenCreatingNewModelThrowsException_shouldUseEmptyIdAndLogError() { |
|||
// GIVEN
|
|||
var modelToSave = AiModel.builder() |
|||
.tenantId(tenantId) |
|||
.name("Model to save") |
|||
.configuration(constructValidOpenAiModelConfig()) |
|||
.build(); |
|||
|
|||
var exception = new RuntimeException("Failed to save"); |
|||
|
|||
given(aiModelServiceMock.save(modelToSave)).willThrow(exception); |
|||
|
|||
// WHEN-THEN
|
|||
assertThatThrownBy(() -> service.save(modelToSave, user)) |
|||
.isInstanceOf(RuntimeException.class) |
|||
.hasMessageContaining("Failed to save"); |
|||
|
|||
then(aiModelServiceMock).should().save(modelToSave); |
|||
then(vcServiceMock).should(never()).autoCommit(any(), any()); |
|||
then(logEntityActionServiceMock).should().logEntityAction(tenantId, new AiModelId(EntityId.NULL_UUID), modelToSave, ActionType.ADDED, user, exception); |
|||
} |
|||
|
|||
@Test |
|||
void save_whenUpdatingExistingModelThrowsException_shouldUseExistingModelIdAndLogError() { |
|||
// GIVEN
|
|||
var modelToUpdate = AiModel.builder() |
|||
.tenantId(tenantId) |
|||
.version(1L) |
|||
.name("Model to update") |
|||
.configuration(constructValidOpenAiModelConfig()) |
|||
.build(); |
|||
modelToUpdate.setId(new AiModelId(UUID.randomUUID())); |
|||
modelToUpdate.setCreatedTime(System.currentTimeMillis()); |
|||
|
|||
var exception = new RuntimeException("Failed to save"); |
|||
|
|||
given(aiModelServiceMock.save(modelToUpdate)).willThrow(exception); |
|||
|
|||
// WHEN-THEN
|
|||
assertThatThrownBy(() -> service.save(modelToUpdate, user)) |
|||
.isInstanceOf(RuntimeException.class) |
|||
.hasMessageContaining("Failed to save"); |
|||
|
|||
then(aiModelServiceMock).should().save(modelToUpdate); |
|||
then(vcServiceMock).should(never()).autoCommit(any(), any()); |
|||
then(logEntityActionServiceMock).should().logEntityAction(tenantId, modelToUpdate.getId(), modelToUpdate, ActionType.UPDATED, user, exception); |
|||
} |
|||
|
|||
@Test |
|||
void delete_whenDeleteSuccessful_shouldLogDeletedAction() { |
|||
// GIVEN
|
|||
var modelToDelete = AiModel.builder() |
|||
.tenantId(tenantId) |
|||
.version(1L) |
|||
.name("Model to delete") |
|||
.configuration(constructValidOpenAiModelConfig()) |
|||
.build(); |
|||
modelToDelete.setId(new AiModelId(UUID.randomUUID())); |
|||
modelToDelete.setCreatedTime(System.currentTimeMillis()); |
|||
|
|||
given(aiModelServiceMock.deleteByTenantIdAndId(tenantId, modelToDelete.getId())).willReturn(true); |
|||
|
|||
// WHEN
|
|||
boolean result = service.delete(modelToDelete, user); |
|||
|
|||
// THEN
|
|||
assertThat(result).isTrue(); |
|||
then(aiModelServiceMock).should().deleteByTenantIdAndId(tenantId, modelToDelete.getId()); |
|||
then(logEntityActionServiceMock).should().logEntityAction(tenantId, modelToDelete.getId(), modelToDelete, ActionType.DELETED, user, modelToDelete.getId().toString()); |
|||
} |
|||
|
|||
@Test |
|||
void delete_whenDeleteReturnsFalse_shouldNotLogAction() { |
|||
// GIVEN
|
|||
var modelToDelete = AiModel.builder() |
|||
.tenantId(tenantId) |
|||
.version(1L) |
|||
.name("Model to delete") |
|||
.configuration(constructValidOpenAiModelConfig()) |
|||
.build(); |
|||
modelToDelete.setId(new AiModelId(UUID.randomUUID())); |
|||
modelToDelete.setCreatedTime(System.currentTimeMillis()); |
|||
|
|||
given(aiModelServiceMock.deleteByTenantIdAndId(tenantId, modelToDelete.getId())).willReturn(false); |
|||
|
|||
// WHEN
|
|||
boolean result = service.delete(modelToDelete, user); |
|||
|
|||
// THEN
|
|||
assertThat(result).isFalse(); |
|||
then(aiModelServiceMock).should().deleteByTenantIdAndId(tenantId, modelToDelete.getId()); |
|||
then(logEntityActionServiceMock).should(never()).logEntityAction(tenantId, modelToDelete.getId(), modelToDelete, ActionType.DELETED, user, modelToDelete.getId().toString()); |
|||
} |
|||
|
|||
@Test |
|||
void delete_whenDeleteThrowsException_shouldLogError() { |
|||
// GIVEN
|
|||
var modelToDelete = AiModel.builder() |
|||
.tenantId(tenantId) |
|||
.version(1L) |
|||
.name("Model to delete") |
|||
.configuration(constructValidOpenAiModelConfig()) |
|||
.build(); |
|||
modelToDelete.setId(new AiModelId(UUID.randomUUID())); |
|||
modelToDelete.setCreatedTime(System.currentTimeMillis()); |
|||
|
|||
var exception = new RuntimeException("Failed to delete"); |
|||
|
|||
given(aiModelServiceMock.deleteByTenantIdAndId(tenantId, modelToDelete.getId())).willThrow(exception); |
|||
|
|||
// WHEN-THEN
|
|||
assertThatThrownBy(() -> service.delete(modelToDelete, user)) |
|||
.isInstanceOf(RuntimeException.class) |
|||
.hasMessageContaining("Failed to delete"); |
|||
|
|||
then(aiModelServiceMock).should().deleteByTenantIdAndId(tenantId, modelToDelete.getId()); |
|||
then(logEntityActionServiceMock).should().logEntityAction(tenantId, modelToDelete.getId(), modelToDelete, ActionType.DELETED, user, exception, modelToDelete.getId().toString()); |
|||
} |
|||
|
|||
private static AiModelConfig constructValidOpenAiModelConfig() { |
|||
return OpenAiChatModelConfig.builder() |
|||
.providerConfig(new OpenAiProviderConfig("test-api-key")) |
|||
.modelId("gpt-4o") |
|||
.temperature(0.5) |
|||
.topP(0.3) |
|||
.frequencyPenalty(0.1) |
|||
.presencePenalty(0.2) |
|||
.maxOutputTokens(1000) |
|||
.timeoutSeconds(60) |
|||
.maxRetries(2) |
|||
.build(); |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,31 @@ |
|||
/** |
|||
* Copyright © 2016-2025 The Thingsboard Authors |
|||
* |
|||
* Licensed under the Apache License, Version 2.0 (the "License"); |
|||
* you may not use this file except in compliance with the License. |
|||
* You may obtain a copy of the License at |
|||
* |
|||
* http://www.apache.org/licenses/LICENSE-2.0
|
|||
* |
|||
* Unless required by applicable law or agreed to in writing, software |
|||
* distributed under the License is distributed on an "AS IS" BASIS, |
|||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|||
* See the License for the specific language governing permissions and |
|||
* limitations under the License. |
|||
*/ |
|||
package org.thingsboard.server.transport.lwm2m.rpc.sql; |
|||
|
|||
import org.junit.Test; |
|||
import org.thingsboard.server.common.data.device.credentials.lwm2m.LwM2MDeviceCredentials; |
|||
import org.thingsboard.server.transport.lwm2m.security.AbstractSecurityLwM2MIntegrationTest; |
|||
|
|||
public class RpcLwm2mIntegrationDataReceivedFromClientTest extends AbstractSecurityLwM2MIntegrationTest { |
|||
|
|||
@Test |
|||
public void testWithNoSecConnectLwm2mSuccessAndObserveTelemetry() throws Exception { |
|||
String clientEndpoint = CLIENT_ENDPOINT_NO_SEC; |
|||
LwM2MDeviceCredentials clientCredentials = getDeviceCredentialsNoSec(createNoSecClientCredentials(clientEndpoint)); |
|||
super.testConnectionWithoutObserveWithDataReceivedSingleTelemetry(SECURITY_NO_SEC, clientCredentials, clientEndpoint, false); |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,42 @@ |
|||
/** |
|||
* Copyright © 2016-2025 The Thingsboard Authors |
|||
* |
|||
* Licensed under the Apache License, Version 2.0 (the "License"); |
|||
* you may not use this file except in compliance with the License. |
|||
* You may obtain a copy of the License at |
|||
* |
|||
* http://www.apache.org/licenses/LICENSE-2.0
|
|||
* |
|||
* Unless required by applicable law or agreed to in writing, software |
|||
* distributed under the License is distributed on an "AS IS" BASIS, |
|||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|||
* See the License for the specific language governing permissions and |
|||
* limitations under the License. |
|||
*/ |
|||
package org.thingsboard.server.dao.ai; |
|||
|
|||
import com.google.common.util.concurrent.FluentFuture; |
|||
import org.thingsboard.server.common.data.ai.AiModel; |
|||
import org.thingsboard.server.common.data.id.AiModelId; |
|||
import org.thingsboard.server.common.data.id.TenantId; |
|||
import org.thingsboard.server.common.data.page.PageData; |
|||
import org.thingsboard.server.common.data.page.PageLink; |
|||
import org.thingsboard.server.dao.entity.EntityDaoService; |
|||
|
|||
import java.util.Optional; |
|||
|
|||
public interface AiModelService extends EntityDaoService { |
|||
|
|||
AiModel save(AiModel model); |
|||
|
|||
Optional<AiModel> findAiModelById(TenantId tenantId, AiModelId modelId); |
|||
|
|||
PageData<AiModel> findAiModelsByTenantId(TenantId tenantId, PageLink pageLink); |
|||
|
|||
Optional<AiModel> findAiModelByTenantIdAndId(TenantId tenantId, AiModelId modelId); |
|||
|
|||
FluentFuture<Optional<AiModel>> findAiModelByTenantIdAndIdAsync(TenantId tenantId, AiModelId modelId); |
|||
|
|||
boolean deleteByTenantIdAndId(TenantId tenantId, AiModelId modelId); |
|||
|
|||
} |
|||
Some files were not shown because too many files changed in this diff
Loading…
Reference in new issue