Cloudpods/backend/pkg/apis/llm/llm_spec.go

// Copyright 2019 Yunion
//
// 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 llm

import (
	"reflect"

	"yunion.io/x/jsonutils"
	"yunion.io/x/pkg/gotypes"
)

// LLMSpec is the flat spec for LLM SKU: optional ollama/vllm/dify payload. Type is on LLMSku.LLMType.
type LLMSpec struct {
	Ollama   *LLMSpecOllama   `json:"ollama,omitempty"`
	Vllm     *LLMSpecVllm     `json:"vllm,omitempty"`
	Dify     *LLMSpecDify     `json:"dify,omitempty"`
	ComfyUI  *LLMSpecComfyUI  `json:"comfyui,omitempty"`
	OpenClaw *LLMSpecOpenClaw `json:"openclaw,omitempty"`
}

func (s *LLMSpec) String() string {
	return jsonutils.Marshal(s).String()
}

func (s *LLMSpec) IsZero() bool {
	if s == nil {
		return true
	}
	return s.Ollama == nil && s.Vllm == nil && s.Dify == nil && s.ComfyUI == nil && s.OpenClaw == nil
}

// LLMSpecOllama holds type-specific fields for ollama SKUs.
type LLMSpecOllama struct {
}

func (s *LLMSpecOllama) String() string {
	return jsonutils.Marshal(s).String()
}

func (s *LLMSpecOllama) IsZero() bool {
	if s == nil {
		return true
	}
	return false
}

// LLMSpecVllm holds type-specific fields for vllm SKUs (includes PreferredModel).
type LLMSpecVllm struct {
	PreferredModel string               `json:"preferred_model"`
	CustomizedArgs []*VllmCustomizedArg `json:"customized_args,omitempty"`
}

type VllmCustomizedArg struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

func (s *LLMSpecVllm) String() string {
	return jsonutils.Marshal(s).String()
}

func (s *LLMSpecVllm) IsZero() bool {
	if s == nil {
		return true
	}
	return s.PreferredModel == "" && len(s.CustomizedArgs) == 0
}

// LLMSpecDify holds type-specific fields for Dify SKUs (multiple image ids + customized envs).
type LLMSpecDify struct {
	PostgresImageId     string               `json:"postgres_image_id"`
	RedisImageId        string               `json:"redis_image_id"`
	NginxImageId        string               `json:"nginx_image_id"`
	DifyApiImageId      string               `json:"dify_api_image_id"`
	DifyPluginImageId   string               `json:"dify_plugin_image_id"`
	DifyWebImageId      string               `json:"dify_web_image_id"`
	DifySandboxImageId  string               `json:"dify_sandbox_image_id"`
	DifySSRFImageId     string               `json:"dify_ssrf_image_id"`
	DifyWeaviateImageId string               `json:"dify_weaviate_image_id"`
	CustomizedEnvs      []*DifyCustomizedEnv `json:"customized_envs,omitempty"`
}

func (s *LLMSpecDify) String() string {
	return jsonutils.Marshal(s).String()
}

func (s *LLMSpecDify) IsZero() bool {
	if s == nil {
		return true
	}
	return s.PostgresImageId == "" && s.RedisImageId == "" && s.NginxImageId == "" &&
		s.DifyApiImageId == "" && s.DifyPluginImageId == "" && s.DifyWebImageId == "" &&
		s.DifySandboxImageId == "" && s.DifySSRFImageId == "" && s.DifyWeaviateImageId == "" &&
		len(s.CustomizedEnvs) == 0
}

type LLMSpecComfyUI struct {
}

func (s *LLMSpecComfyUI) String() string {
	return jsonutils.Marshal(s).String()
}

func (s *LLMSpecComfyUI) IsZero() bool {
	if s == nil {
		return true
	}
	return false
}

type LLMSpecCredential struct {
	Id         string   `json:"id"`
	ExportKeys []string `json:"export_keys"`
}

type LLMSpecOpenClawProvider struct {
	Name       string             `json:"name"`
	Credential *LLMSpecCredential `json:"credential"`
}

type LLMSpecOpenClawChannel struct {
	Name       string             `json:"name"`
	Credential *LLMSpecCredential `json:"credential"`
}

type LLMSpecOpenClaw struct {
	Providers          []*LLMSpecOpenClawProvider         `json:"providers"`
	Channels           []*LLMSpecOpenClawChannel          `json:"channels"`
	WorkspaceTemplates *LLMSpecOpenClawWorkspaceTemplates `json:"workspace_templates"`
}

type LLMSpecOpenClawWorkspaceTemplates struct {
	AgentsMD string `json:"agents_md"`
	SoulMD   string `json:"soul_md"`
	UserMD   string `json:"user_md"`
}

func init() {
	gotypes.RegisterSerializable(reflect.TypeOf(new(LLMSpec)), func() gotypes.ISerializable {
		return new(LLMSpec)
	})
}