fun.freechat.client.model.PromptTaskDetailsDTO Maven / Gradle / Ivy
/*
* FreeChat OpenAPI Definition
* # FreeChat: Create Some Friends for Yourself with AI English | [中文版](https://github.com/freechat-fun/freechat/blob/main/README.zh-CN.md) ## Introduction Welcome! FreeChat aims to build a cloud-native, robust, and quickly commercializable enterprise-level AI virtual character platform. It also serves as a prompt engineering platform. ## Features - Primarily uses Java and emphasizes **security, robustness, scalability, traceability, and maintainability**. - Boasts **account systems and permission management**, supporting OAuth2 authentication. Introduces the \"organization\" concept and related permission constraint functions. - Extensively employs distributed technologies and caching to support **high concurrency** access. - Provides flexible character customization options, supports direct intervention in prompts, and supports **configuring multiple backends for each character**. - **Offers a comprehensive range of Open APIs**, with more than 180 interfaces and provides java/python/typescript SDKs. These interfaces enable easy construction of systems for end-users. - Supports setting **RAG** (Retrieval Augmented Generation) for characters. - Supports **long-term memory, preset memory** for characters. - Supports characters evoking **proactive chat**. - Supports setting **quota limits** for characters. - Supports characters **importing and exporting**. - Supports individual **debugging and sharing prompts**. ## Snapshots ### On PC #### Home Page  #### Development View  #### Chat View  ### On Mobile  
  ## Character Design ```mermaid flowchart TD A(Character) --> B(Profile) A --> C(Knowledge/RAG) A --> D(Album) A --> E(Backend-1) A --> F(Backend-n...) E --> G(Message Window) E --> H(Long Term Memory Settings) E --> I(Quota Limit) E --> J(Chat Prompt Task) E --> K(Greeting Prompt Task) E --> L(Moderation Settings) J --> M(Model & Parameters) J --> N(API Keys) J --> O(Prompt Refence) J --> P(Tool Specifications) O --> Q(Template) O --> R(Variables) O --> S(Version) O --> T(...) style K stroke-dasharray: 5, 5 style L stroke-dasharray: 5, 5 style P stroke-dasharray: 5, 5 ``` After setting up an unified persona and knowledge for a character, different backends can be configured. For example, different model may be adopted for different users based on cost considerations. ## How to Play ### Online Website You can visit [freechat.fun](https://www.freechat.fun) to experience FreeChat. Share your designed AI character! ### Running in a Kubernetes Cluster FreeChat is dedicated to the principles of cloud-native design. If you have a Kubernetes cluster, you can deploy FreeChat to your environment by following these steps: 1. Put the Kubernetes configuration file in the `configs/helm/` directory, named `kube-private.conf`. 2. Place the Helm configuration file in the same directory, named `values-private.yaml`. Make sure to reference the default `values.yaml` and customize the variables as needed. 3. Switch to the `scripts/` directory. 4. If needed, run `install-in.sh` to deploy `ingress-nginx` on the Kubernetes cluster. 5. If needed, run `install-cm.sh` to deploy `cert-manager` on the Kubernetes cluster, which automatically issues certificates for domains specified in `ingress.hosts`. 6. Run `install-pvc.sh` to install PersistentVolumeClaim resources. > By default, FreeChat operates files by accessing the \"local file system.\" You may want to use high-availability distributed storage in the cloud. As a cloud-native-designed system, we recommend interfacing through Kubernetes CSI to avoid individually adapting storage products for each cloud platform. Most cloud service providers offer cloud storage drivers for Kubernetes, with a series of predefined StorageClass resources. Please choose the appropriate configuration according to your actual needs and set it in Helm's `global.storageClass` option. > > *In the future, FreeChat may be refactored to use MinIO's APIs directly, as it is now installed in the Kubernetes cluster as a dependency (serving Milvus).* 7. Run `install.sh` script to install FreeChat and its dependencies. 8. FreeChat aims to provide Open API services. If you like the interactive experience of [freechat.fun](https://freechat.fun), run `install-web.sh` to deploy the front-end application. 9. Run `restart.sh` to restart the service. 10. If you modified any Helm configuration files, use `upgrade.sh` to update the corresponding Kubernetes resources. 11. To remove specific resources, run the `uninstall*.sh` script corresponding to the resource you want to uninstall. As a cloud-native application, the services FreeChat relies on are obtained and deployed to your cluster through the helm repository. If you prefer cloud services with SLA (Service Level Agreement) guarantees, simply make the relevant settings in `configs/helm/values-private.yaml`: ```yaml mysql: deployment: enabled: false url: auth: rootPassword: username: password: redis: deployment: enabled: false url: auth: password: milvus: deployment: enabled: false url: milvus: auth: token: ``` With this, FreeChat will not automatically install these services, but rather use the configuration information to connect directly. If your Kubernetes cluster does not have a standalone monitoring system, you can enable the following switch. This will install Prometheus and Grafana services in the same namespace, dedicated to monitoring the status of the services under the FreeChat application: ```yaml prometheus: deployment: enabled: true grafana: deployment: enabled: true ``` ### Running Locally You can also run FreeChat locally. Currently supported on MacOS and Linux (although only tested on MacOS). You need to install the Docker toolset and have a network that can access [Docker Hub](https://hub.docker.com/). Once ready, enter the `scripts/` directory and run `local-run.sh`, which will download and run the necessary docker containers. After a successful startup, you can access `http://localhost` via a browser to see the locally running freechat.fun. The built-in administrator username and password are \"admin:freechat\". Use `local-run.sh --help` to view the supported options of the script. Good luck! ### Running in an IDE To run FreeChat in an IDE, you need to start all dependent services first but do not need to run the container for the FreeChat application itself. You can execute the `scripts/local-deps.sh` script to start services like `MySQL`, `Redis`, `Milvus`, etc., locally. Once done, open and debug `freechat-start/src/main/java/fun/freechat/Application.java`。Make sure you have set the following startup VM options: ```shell -Dspring.config.location=classpath:/application.yml,classpath:/application-local.yml \\ -DAPP_HOME=local-data/freechat \\ -Dspring.profiles.active=local ``` ### Use SDK #### Java - **Dependency** ```xml fun.freechat freechat-sdk ${freechat-sdk.version} ``` - **Example** ```java import fun.freechat.client.ApiClient; import fun.freechat.client.ApiException; import fun.freechat.client.Configuration; import fun.freechat.client.api.AccountApi; import fun.freechat.client.auth.ApiKeyAuth; import fun.freechat.client.model.UserDetailsDTO; public class AccountClientExample { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath(\"https://freechat.fun\"); // Configure HTTP bearer authorization: bearerAuth HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication(\"bearerAuth\"); bearerAuth.setBearerToken(\"FREECHAT_TOKEN\"); AccountApi apiInstance = new AccountApi(defaultClient); try { UserDetailsDTO result = apiInstance.getUserDetails(); System.out.println(result); } catch (ApiException e) { e.printStackTrace(); } } } ``` #### Python - **Installation** ```shell pip install freechat-sdk ``` - **Example** ```python import freechat_sdk from freechat_sdk.rest import ApiException from pprint import pprint # Defining the host is optional and defaults to https://freechat.fun # See configuration.py for a list of all supported configuration parameters. configuration = freechat_sdk.Configuration( host = \"https://freechat.fun\" ) # Configure Bearer authorization: bearerAuth configuration = freechat_sdk.Configuration( access_token = os.environ[\"FREECHAT_TOKEN\"] ) # Enter a context with an instance of the API client with freechat_sdk.ApiClient(configuration) as api_client: # Create an instance of the API class api_instance = freechat_sdk.AccountApi(api_client) try: details = api_instance.get_user_details() pprint(details) except ApiException as e: print(\"Exception when calling AccountClient->get_user_details: %s\\n\" % e) ``` #### TypeScript - **Installation** ```shell npm install freechat-sdk --save ``` - **Example** Refer to [FreeChatApiContext.tsx](https://github.com/freechat-fun/freechat/blob/main/freechat-web/src/contexts/FreeChatApiProvider.tsx) ## System Dependencies | | Projects | ---- | ---- | Application Framework | [Spring Boot](https://spring.io/projects/spring-boot/) | LLM Framework | [LangChain4j](https://docs.langchain4j.dev/) | Model Providers | [OpenAI](https://platform.openai.com/), [Azure OpenAI](https://oai.azure.com/), [DashScope(Alibaba)](https://dashscope.aliyun.com/) | Database Systems | [MySQL](https://www.mysql.com/), [Redis](https://redis.io/), [Milvus](https://milvus.io/) | Monitoring & Alerting | [Prometheus](https://prometheus.io/), [Grafana](https://grafana.com/) | OpenAPI Tools | [Springdoc-openapi](https://springdoc.org/), [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator), [OpenAPI Explorer](https://github.com/Authress-Engineering/openapi-explorer) ## Collaboration ### Application Integration The FreeChat system is entirely oriented towards Open APIs. The site [freechat.fun](https://freechat.fun) is developed using its TypeScript SDK and hardly depends on private interfaces. You can use these online interfaces to develop your own applications or sites, making them fit your preferences. Currently, FreeChat is completely free with no paid plans (after all, users use their own API Key to call LLM services). ### Model Integration FreeChat aims to explore AI virtual character technology with anthropomorphic characteristics. So far, it supports model services from OpenAI GPT and Alibaba Qwen series models. However, we are more interested in supporting models that are under research and can endow AI with more personality traits. If you are researching this area and hope FreeChat supports your model, please contact us. We look forward to AI technology helping people create their own \"soul mates\" in the future.
*
* The version of the OpenAPI document: 1.4.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package fun.freechat.client.model;
import java.util.Objects;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import fun.freechat.client.model.PromptRefDTO;
import java.io.IOException;
import java.time.OffsetDateTime;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonArray;
import com.google.gson.JsonDeserializationContext;
import com.google.gson.JsonDeserializer;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParseException;
import com.google.gson.TypeAdapterFactory;
import com.google.gson.reflect.TypeToken;
import com.google.gson.TypeAdapter;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import java.io.IOException;
import java.lang.reflect.Type;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import fun.freechat.client.JSON;
/**
* Prompt task detailed information
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.7.0")
public class PromptTaskDetailsDTO {
public static final String SERIALIZED_NAME_REQUEST_ID = "requestId";
@SerializedName(SERIALIZED_NAME_REQUEST_ID)
private String requestId;
public static final String SERIALIZED_NAME_TASK_ID = "taskId";
@SerializedName(SERIALIZED_NAME_TASK_ID)
private String taskId;
public static final String SERIALIZED_NAME_GMT_CREATE = "gmtCreate";
@SerializedName(SERIALIZED_NAME_GMT_CREATE)
private OffsetDateTime gmtCreate;
public static final String SERIALIZED_NAME_GMT_MODIFIED = "gmtModified";
@SerializedName(SERIALIZED_NAME_GMT_MODIFIED)
private OffsetDateTime gmtModified;
public static final String SERIALIZED_NAME_GMT_START = "gmtStart";
@SerializedName(SERIALIZED_NAME_GMT_START)
private OffsetDateTime gmtStart;
public static final String SERIALIZED_NAME_GMT_END = "gmtEnd";
@SerializedName(SERIALIZED_NAME_GMT_END)
private OffsetDateTime gmtEnd;
public static final String SERIALIZED_NAME_PROMPT_REF = "promptRef";
@SerializedName(SERIALIZED_NAME_PROMPT_REF)
private PromptRefDTO promptRef;
public static final String SERIALIZED_NAME_MODEL_ID = "modelId";
@SerializedName(SERIALIZED_NAME_MODEL_ID)
private String modelId;
public static final String SERIALIZED_NAME_API_KEY_NAME = "apiKeyName";
@SerializedName(SERIALIZED_NAME_API_KEY_NAME)
private String apiKeyName;
public static final String SERIALIZED_NAME_API_KEY_VALUE = "apiKeyValue";
@SerializedName(SERIALIZED_NAME_API_KEY_VALUE)
private String apiKeyValue;
public static final String SERIALIZED_NAME_PARAMS = "params";
@SerializedName(SERIALIZED_NAME_PARAMS)
private Map params = new HashMap<>();
public static final String SERIALIZED_NAME_CRON = "cron";
@SerializedName(SERIALIZED_NAME_CRON)
private String cron;
public static final String SERIALIZED_NAME_STATUS = "status";
@SerializedName(SERIALIZED_NAME_STATUS)
private String status;
public static final String SERIALIZED_NAME_EXT = "ext";
@SerializedName(SERIALIZED_NAME_EXT)
private String ext;
public PromptTaskDetailsDTO() {
}
public PromptTaskDetailsDTO requestId(String requestId) {
this.requestId = requestId;
return this;
}
/**
* Request identifier
* @return requestId
*/
@javax.annotation.Nullable
public String getRequestId() {
return requestId;
}
public void setRequestId(String requestId) {
this.requestId = requestId;
}
public PromptTaskDetailsDTO taskId(String taskId) {
this.taskId = taskId;
return this;
}
/**
* Prompt task identifier
* @return taskId
*/
@javax.annotation.Nullable
public String getTaskId() {
return taskId;
}
public void setTaskId(String taskId) {
this.taskId = taskId;
}
public PromptTaskDetailsDTO gmtCreate(OffsetDateTime gmtCreate) {
this.gmtCreate = gmtCreate;
return this;
}
/**
* Creation time
* @return gmtCreate
*/
@javax.annotation.Nullable
public OffsetDateTime getGmtCreate() {
return gmtCreate;
}
public void setGmtCreate(OffsetDateTime gmtCreate) {
this.gmtCreate = gmtCreate;
}
public PromptTaskDetailsDTO gmtModified(OffsetDateTime gmtModified) {
this.gmtModified = gmtModified;
return this;
}
/**
* Modification time
* @return gmtModified
*/
@javax.annotation.Nullable
public OffsetDateTime getGmtModified() {
return gmtModified;
}
public void setGmtModified(OffsetDateTime gmtModified) {
this.gmtModified = gmtModified;
}
public PromptTaskDetailsDTO gmtStart(OffsetDateTime gmtStart) {
this.gmtStart = gmtStart;
return this;
}
/**
* Task start execution time
* @return gmtStart
*/
@javax.annotation.Nullable
public OffsetDateTime getGmtStart() {
return gmtStart;
}
public void setGmtStart(OffsetDateTime gmtStart) {
this.gmtStart = gmtStart;
}
public PromptTaskDetailsDTO gmtEnd(OffsetDateTime gmtEnd) {
this.gmtEnd = gmtEnd;
return this;
}
/**
* Task end execution time
* @return gmtEnd
*/
@javax.annotation.Nullable
public OffsetDateTime getGmtEnd() {
return gmtEnd;
}
public void setGmtEnd(OffsetDateTime gmtEnd) {
this.gmtEnd = gmtEnd;
}
public PromptTaskDetailsDTO promptRef(PromptRefDTO promptRef) {
this.promptRef = promptRef;
return this;
}
/**
* Get promptRef
* @return promptRef
*/
@javax.annotation.Nullable
public PromptRefDTO getPromptRef() {
return promptRef;
}
public void setPromptRef(PromptRefDTO promptRef) {
this.promptRef = promptRef;
}
public PromptTaskDetailsDTO modelId(String modelId) {
this.modelId = modelId;
return this;
}
/**
* Model identifier
* @return modelId
*/
@javax.annotation.Nullable
public String getModelId() {
return modelId;
}
public void setModelId(String modelId) {
this.modelId = modelId;
}
public PromptTaskDetailsDTO apiKeyName(String apiKeyName) {
this.apiKeyName = apiKeyName;
return this;
}
/**
* API-KEY name
* @return apiKeyName
*/
@javax.annotation.Nullable
public String getApiKeyName() {
return apiKeyName;
}
public void setApiKeyName(String apiKeyName) {
this.apiKeyName = apiKeyName;
}
public PromptTaskDetailsDTO apiKeyValue(String apiKeyValue) {
this.apiKeyValue = apiKeyValue;
return this;
}
/**
* API-KEY value
* @return apiKeyValue
*/
@javax.annotation.Nullable
public String getApiKeyValue() {
return apiKeyValue;
}
public void setApiKeyValue(String apiKeyValue) {
this.apiKeyValue = apiKeyValue;
}
public PromptTaskDetailsDTO params(Map params) {
this.params = params;
return this;
}
public PromptTaskDetailsDTO putParamsItem(String key, Object paramsItem) {
if (this.params == null) {
this.params = new HashMap<>();
}
this.params.put(key, paramsItem);
return this;
}
/**
* Model call parameters
* @return params
*/
@javax.annotation.Nullable
public Map getParams() {
return params;
}
public void setParams(Map params) {
this.params = params;
}
public PromptTaskDetailsDTO cron(String cron) {
this.cron = cron;
return this;
}
/**
* Task scheduling configuration which compatible with Quartz cron format
* @return cron
*/
@javax.annotation.Nullable
public String getCron() {
return cron;
}
public void setCron(String cron) {
this.cron = cron;
}
public PromptTaskDetailsDTO status(String status) {
this.status = status;
return this;
}
/**
* Task execution status: pending | running | succeeded | failed | canceled
* @return status
*/
@javax.annotation.Nullable
public String getStatus() {
return status;
}
public void setStatus(String status) {
this.status = status;
}
public PromptTaskDetailsDTO ext(String ext) {
this.ext = ext;
return this;
}
/**
* Additional information, JSON format
* @return ext
*/
@javax.annotation.Nullable
public String getExt() {
return ext;
}
public void setExt(String ext) {
this.ext = ext;
}
/**
* A container for additional, undeclared properties.
* This is a holder for any undeclared properties as specified with
* the 'additionalProperties' keyword in the OAS document.
*/
private Map additionalProperties;
/**
* Set the additional (undeclared) property with the specified name and value.
* If the property does not already exist, create it otherwise replace it.
*
* @param key name of the property
* @param value value of the property
* @return the PromptTaskDetailsDTO instance itself
*/
public PromptTaskDetailsDTO putAdditionalProperty(String key, Object value) {
if (this.additionalProperties == null) {
this.additionalProperties = new HashMap();
}
this.additionalProperties.put(key, value);
return this;
}
/**
* Return the additional (undeclared) property.
*
* @return a map of objects
*/
public Map getAdditionalProperties() {
return additionalProperties;
}
/**
* Return the additional (undeclared) property with the specified name.
*
* @param key name of the property
* @return an object
*/
public Object getAdditionalProperty(String key) {
if (this.additionalProperties == null) {
return null;
}
return this.additionalProperties.get(key);
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
PromptTaskDetailsDTO promptTaskDetailsDTO = (PromptTaskDetailsDTO) o;
return Objects.equals(this.requestId, promptTaskDetailsDTO.requestId) &&
Objects.equals(this.taskId, promptTaskDetailsDTO.taskId) &&
Objects.equals(this.gmtCreate, promptTaskDetailsDTO.gmtCreate) &&
Objects.equals(this.gmtModified, promptTaskDetailsDTO.gmtModified) &&
Objects.equals(this.gmtStart, promptTaskDetailsDTO.gmtStart) &&
Objects.equals(this.gmtEnd, promptTaskDetailsDTO.gmtEnd) &&
Objects.equals(this.promptRef, promptTaskDetailsDTO.promptRef) &&
Objects.equals(this.modelId, promptTaskDetailsDTO.modelId) &&
Objects.equals(this.apiKeyName, promptTaskDetailsDTO.apiKeyName) &&
Objects.equals(this.apiKeyValue, promptTaskDetailsDTO.apiKeyValue) &&
Objects.equals(this.params, promptTaskDetailsDTO.params) &&
Objects.equals(this.cron, promptTaskDetailsDTO.cron) &&
Objects.equals(this.status, promptTaskDetailsDTO.status) &&
Objects.equals(this.ext, promptTaskDetailsDTO.ext)&&
Objects.equals(this.additionalProperties, promptTaskDetailsDTO.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(requestId, taskId, gmtCreate, gmtModified, gmtStart, gmtEnd, promptRef, modelId, apiKeyName, apiKeyValue, params, cron, status, ext, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class PromptTaskDetailsDTO {\n");
sb.append(" requestId: ").append(toIndentedString(requestId)).append("\n");
sb.append(" taskId: ").append(toIndentedString(taskId)).append("\n");
sb.append(" gmtCreate: ").append(toIndentedString(gmtCreate)).append("\n");
sb.append(" gmtModified: ").append(toIndentedString(gmtModified)).append("\n");
sb.append(" gmtStart: ").append(toIndentedString(gmtStart)).append("\n");
sb.append(" gmtEnd: ").append(toIndentedString(gmtEnd)).append("\n");
sb.append(" promptRef: ").append(toIndentedString(promptRef)).append("\n");
sb.append(" modelId: ").append(toIndentedString(modelId)).append("\n");
sb.append(" apiKeyName: ").append(toIndentedString(apiKeyName)).append("\n");
sb.append(" apiKeyValue: ").append(toIndentedString(apiKeyValue)).append("\n");
sb.append(" params: ").append(toIndentedString(params)).append("\n");
sb.append(" cron: ").append(toIndentedString(cron)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" ext: ").append(toIndentedString(ext)).append("\n");
sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
public static HashSet openapiFields;
public static HashSet openapiRequiredFields;
static {
// a set of all properties/fields (JSON key names)
openapiFields = new HashSet();
openapiFields.add("requestId");
openapiFields.add("taskId");
openapiFields.add("gmtCreate");
openapiFields.add("gmtModified");
openapiFields.add("gmtStart");
openapiFields.add("gmtEnd");
openapiFields.add("promptRef");
openapiFields.add("modelId");
openapiFields.add("apiKeyName");
openapiFields.add("apiKeyValue");
openapiFields.add("params");
openapiFields.add("cron");
openapiFields.add("status");
openapiFields.add("ext");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
}
/**
* Validates the JSON Element and throws an exception if issues found
*
* @param jsonElement JSON Element
* @throws IOException if the JSON Element is invalid with respect to PromptTaskDetailsDTO
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!PromptTaskDetailsDTO.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in PromptTaskDetailsDTO is not found in the empty JSON string", PromptTaskDetailsDTO.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("requestId") != null && !jsonObj.get("requestId").isJsonNull()) && !jsonObj.get("requestId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `requestId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("requestId").toString()));
}
if ((jsonObj.get("taskId") != null && !jsonObj.get("taskId").isJsonNull()) && !jsonObj.get("taskId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `taskId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("taskId").toString()));
}
// validate the optional field `promptRef`
if (jsonObj.get("promptRef") != null && !jsonObj.get("promptRef").isJsonNull()) {
PromptRefDTO.validateJsonElement(jsonObj.get("promptRef"));
}
if ((jsonObj.get("modelId") != null && !jsonObj.get("modelId").isJsonNull()) && !jsonObj.get("modelId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `modelId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("modelId").toString()));
}
if ((jsonObj.get("apiKeyName") != null && !jsonObj.get("apiKeyName").isJsonNull()) && !jsonObj.get("apiKeyName").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `apiKeyName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("apiKeyName").toString()));
}
if ((jsonObj.get("apiKeyValue") != null && !jsonObj.get("apiKeyValue").isJsonNull()) && !jsonObj.get("apiKeyValue").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `apiKeyValue` to be a primitive type in the JSON string but got `%s`", jsonObj.get("apiKeyValue").toString()));
}
if ((jsonObj.get("cron") != null && !jsonObj.get("cron").isJsonNull()) && !jsonObj.get("cron").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `cron` to be a primitive type in the JSON string but got `%s`", jsonObj.get("cron").toString()));
}
if ((jsonObj.get("status") != null && !jsonObj.get("status").isJsonNull()) && !jsonObj.get("status").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `status` to be a primitive type in the JSON string but got `%s`", jsonObj.get("status").toString()));
}
if ((jsonObj.get("ext") != null && !jsonObj.get("ext").isJsonNull()) && !jsonObj.get("ext").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `ext` to be a primitive type in the JSON string but got `%s`", jsonObj.get("ext").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!PromptTaskDetailsDTO.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'PromptTaskDetailsDTO' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(PromptTaskDetailsDTO.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, PromptTaskDetailsDTO value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
obj.remove("additionalProperties");
// serialize additional properties
if (value.getAdditionalProperties() != null) {
for (Map.Entry entry : value.getAdditionalProperties().entrySet()) {
if (entry.getValue() instanceof String)
obj.addProperty(entry.getKey(), (String) entry.getValue());
else if (entry.getValue() instanceof Number)
obj.addProperty(entry.getKey(), (Number) entry.getValue());
else if (entry.getValue() instanceof Boolean)
obj.addProperty(entry.getKey(), (Boolean) entry.getValue());
else if (entry.getValue() instanceof Character)
obj.addProperty(entry.getKey(), (Character) entry.getValue());
else {
JsonElement jsonElement = gson.toJsonTree(entry.getValue());
if (jsonElement.isJsonArray()) {
obj.add(entry.getKey(), jsonElement.getAsJsonArray());
} else {
obj.add(entry.getKey(), jsonElement.getAsJsonObject());
}
}
}
}
elementAdapter.write(out, obj);
}
@Override
public PromptTaskDetailsDTO read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
PromptTaskDetailsDTO instance = thisAdapter.fromJsonTree(jsonObj);
for (Map.Entry entry : jsonObj.entrySet()) {
if (!openapiFields.contains(entry.getKey())) {
if (entry.getValue().isJsonPrimitive()) { // primitive type
if (entry.getValue().getAsJsonPrimitive().isString())
instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString());
else if (entry.getValue().getAsJsonPrimitive().isNumber())
instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber());
else if (entry.getValue().getAsJsonPrimitive().isBoolean())
instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean());
else
throw new IllegalArgumentException(String.format("The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString()));
} else if (entry.getValue().isJsonArray()) {
instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class));
} else { // JSON object
instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class));
}
}
}
return instance;
}
}.nullSafe();
}
}
/**
* Create an instance of PromptTaskDetailsDTO given an JSON string
*
* @param jsonString JSON string
* @return An instance of PromptTaskDetailsDTO
* @throws IOException if the JSON string is invalid with respect to PromptTaskDetailsDTO
*/
public static PromptTaskDetailsDTO fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, PromptTaskDetailsDTO.class);
}
/**
* Convert an instance of PromptTaskDetailsDTO to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy