com.konfigthis.carbonai.client.model.S3FileSyncInput Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of carbonai-java-sdk Show documentation
Show all versions of carbonai-java-sdk Show documentation
Connect external data to LLMs, no matter the source.
This library was generated by https://konfigthis.com
/*
* Carbon
* Connect external data to LLMs, no matter the source.
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by Konfig (https://konfigthis.com).
* Do not edit the class manually.
*/
package com.konfigthis.carbonai.client.model;
import java.util.Objects;
import java.util.Arrays;
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 com.konfigthis.carbonai.client.model.EmbeddingGenerators;
import com.konfigthis.carbonai.client.model.FileSyncConfigNullable;
import com.konfigthis.carbonai.client.model.S3GetFileInput;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import org.openapitools.jackson.nullable.JsonNullable;
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 org.apache.commons.lang3.StringUtils;
import java.lang.reflect.Type;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import com.konfigthis.carbonai.client.JSON;
/**
* S3FileSyncInput
*/@javax.annotation.Generated(value = "Generated by https://konfigthis.com")
public class S3FileSyncInput {
public static final String SERIALIZED_NAME_TAGS = "tags";
@SerializedName(SERIALIZED_NAME_TAGS)
private Object tags;
public static final String SERIALIZED_NAME_IDS = "ids";
@SerializedName(SERIALIZED_NAME_IDS)
private List ids = new ArrayList<>();
public static final String SERIALIZED_NAME_CHUNK_SIZE = "chunk_size";
@SerializedName(SERIALIZED_NAME_CHUNK_SIZE)
private Integer chunkSize = 1500;
public static final String SERIALIZED_NAME_CHUNK_OVERLAP = "chunk_overlap";
@SerializedName(SERIALIZED_NAME_CHUNK_OVERLAP)
private Integer chunkOverlap = 20;
public static final String SERIALIZED_NAME_SKIP_EMBEDDING_GENERATION = "skip_embedding_generation";
@SerializedName(SERIALIZED_NAME_SKIP_EMBEDDING_GENERATION)
private Boolean skipEmbeddingGeneration = false;
public static final String SERIALIZED_NAME_EMBEDDING_MODEL = "embedding_model";
@SerializedName(SERIALIZED_NAME_EMBEDDING_MODEL)
private EmbeddingGenerators embeddingModel;
public static final String SERIALIZED_NAME_GENERATE_SPARSE_VECTORS = "generate_sparse_vectors";
@SerializedName(SERIALIZED_NAME_GENERATE_SPARSE_VECTORS)
private Boolean generateSparseVectors = false;
public static final String SERIALIZED_NAME_PREPEND_FILENAME_TO_CHUNKS = "prepend_filename_to_chunks";
@SerializedName(SERIALIZED_NAME_PREPEND_FILENAME_TO_CHUNKS)
private Boolean prependFilenameToChunks = false;
public static final String SERIALIZED_NAME_MAX_ITEMS_PER_CHUNK = "max_items_per_chunk";
@SerializedName(SERIALIZED_NAME_MAX_ITEMS_PER_CHUNK)
private Integer maxItemsPerChunk;
public static final String SERIALIZED_NAME_SET_PAGE_AS_BOUNDARY = "set_page_as_boundary";
@SerializedName(SERIALIZED_NAME_SET_PAGE_AS_BOUNDARY)
private Boolean setPageAsBoundary = false;
public static final String SERIALIZED_NAME_DATA_SOURCE_ID = "data_source_id";
@SerializedName(SERIALIZED_NAME_DATA_SOURCE_ID)
private Integer dataSourceId;
public static final String SERIALIZED_NAME_REQUEST_ID = "request_id";
@SerializedName(SERIALIZED_NAME_REQUEST_ID)
private String requestId;
public static final String SERIALIZED_NAME_USE_OCR = "use_ocr";
@SerializedName(SERIALIZED_NAME_USE_OCR)
private Boolean useOcr = false;
public static final String SERIALIZED_NAME_PARSE_PDF_TABLES_WITH_OCR = "parse_pdf_tables_with_ocr";
@SerializedName(SERIALIZED_NAME_PARSE_PDF_TABLES_WITH_OCR)
private Boolean parsePdfTablesWithOcr = false;
public static final String SERIALIZED_NAME_FILE_SYNC_CONFIG = "file_sync_config";
@SerializedName(SERIALIZED_NAME_FILE_SYNC_CONFIG)
private FileSyncConfigNullable fileSyncConfig;
public S3FileSyncInput() {
}
public S3FileSyncInput tags(Object tags) {
this.tags = tags;
return this;
}
/**
* Get tags
* @return tags
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "{}", value = "")
public Object getTags() {
return tags;
}
public void setTags(Object tags) {
this.tags = tags;
}
public S3FileSyncInput ids(List ids) {
this.ids = ids;
return this;
}
public S3FileSyncInput addIdsItem(S3GetFileInput idsItem) {
this.ids.add(idsItem);
return this;
}
/**
* Get ids
* @return ids
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "")
public List getIds() {
return ids;
}
public void setIds(List ids) {
this.ids = ids;
}
public S3FileSyncInput chunkSize(Integer chunkSize) {
this.chunkSize = chunkSize;
return this;
}
/**
* Get chunkSize
* @return chunkSize
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "1500", value = "")
public Integer getChunkSize() {
return chunkSize;
}
public void setChunkSize(Integer chunkSize) {
this.chunkSize = chunkSize;
}
public S3FileSyncInput chunkOverlap(Integer chunkOverlap) {
this.chunkOverlap = chunkOverlap;
return this;
}
/**
* Get chunkOverlap
* @return chunkOverlap
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "20", value = "")
public Integer getChunkOverlap() {
return chunkOverlap;
}
public void setChunkOverlap(Integer chunkOverlap) {
this.chunkOverlap = chunkOverlap;
}
public S3FileSyncInput skipEmbeddingGeneration(Boolean skipEmbeddingGeneration) {
this.skipEmbeddingGeneration = skipEmbeddingGeneration;
return this;
}
/**
* Get skipEmbeddingGeneration
* @return skipEmbeddingGeneration
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "false", value = "")
public Boolean getSkipEmbeddingGeneration() {
return skipEmbeddingGeneration;
}
public void setSkipEmbeddingGeneration(Boolean skipEmbeddingGeneration) {
this.skipEmbeddingGeneration = skipEmbeddingGeneration;
}
public S3FileSyncInput embeddingModel(EmbeddingGenerators embeddingModel) {
this.embeddingModel = embeddingModel;
return this;
}
/**
* Get embeddingModel
* @return embeddingModel
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
public EmbeddingGenerators getEmbeddingModel() {
return embeddingModel;
}
public void setEmbeddingModel(EmbeddingGenerators embeddingModel) {
this.embeddingModel = embeddingModel;
}
public S3FileSyncInput generateSparseVectors(Boolean generateSparseVectors) {
this.generateSparseVectors = generateSparseVectors;
return this;
}
/**
* Get generateSparseVectors
* @return generateSparseVectors
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "false", value = "")
public Boolean getGenerateSparseVectors() {
return generateSparseVectors;
}
public void setGenerateSparseVectors(Boolean generateSparseVectors) {
this.generateSparseVectors = generateSparseVectors;
}
public S3FileSyncInput prependFilenameToChunks(Boolean prependFilenameToChunks) {
this.prependFilenameToChunks = prependFilenameToChunks;
return this;
}
/**
* Get prependFilenameToChunks
* @return prependFilenameToChunks
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "false", value = "")
public Boolean getPrependFilenameToChunks() {
return prependFilenameToChunks;
}
public void setPrependFilenameToChunks(Boolean prependFilenameToChunks) {
this.prependFilenameToChunks = prependFilenameToChunks;
}
public S3FileSyncInput maxItemsPerChunk(Integer maxItemsPerChunk) {
this.maxItemsPerChunk = maxItemsPerChunk;
return this;
}
/**
* Number of objects per chunk. For csv, tsv, xlsx, and json files only.
* @return maxItemsPerChunk
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Number of objects per chunk. For csv, tsv, xlsx, and json files only.")
public Integer getMaxItemsPerChunk() {
return maxItemsPerChunk;
}
public void setMaxItemsPerChunk(Integer maxItemsPerChunk) {
this.maxItemsPerChunk = maxItemsPerChunk;
}
public S3FileSyncInput setPageAsBoundary(Boolean setPageAsBoundary) {
this.setPageAsBoundary = setPageAsBoundary;
return this;
}
/**
* Get setPageAsBoundary
* @return setPageAsBoundary
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "false", value = "")
public Boolean getSetPageAsBoundary() {
return setPageAsBoundary;
}
public void setSetPageAsBoundary(Boolean setPageAsBoundary) {
this.setPageAsBoundary = setPageAsBoundary;
}
public S3FileSyncInput dataSourceId(Integer dataSourceId) {
this.dataSourceId = dataSourceId;
return this;
}
/**
* Get dataSourceId
* @return dataSourceId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
public Integer getDataSourceId() {
return dataSourceId;
}
public void setDataSourceId(Integer dataSourceId) {
this.dataSourceId = dataSourceId;
}
public S3FileSyncInput requestId(String requestId) {
this.requestId = requestId;
return this;
}
/**
* Get requestId
* @return requestId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
public String getRequestId() {
return requestId;
}
public void setRequestId(String requestId) {
this.requestId = requestId;
}
public S3FileSyncInput useOcr(Boolean useOcr) {
this.useOcr = useOcr;
return this;
}
/**
* Get useOcr
* @return useOcr
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "false", value = "")
public Boolean getUseOcr() {
return useOcr;
}
public void setUseOcr(Boolean useOcr) {
this.useOcr = useOcr;
}
public S3FileSyncInput parsePdfTablesWithOcr(Boolean parsePdfTablesWithOcr) {
this.parsePdfTablesWithOcr = parsePdfTablesWithOcr;
return this;
}
/**
* Get parsePdfTablesWithOcr
* @return parsePdfTablesWithOcr
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "false", value = "")
public Boolean getParsePdfTablesWithOcr() {
return parsePdfTablesWithOcr;
}
public void setParsePdfTablesWithOcr(Boolean parsePdfTablesWithOcr) {
this.parsePdfTablesWithOcr = parsePdfTablesWithOcr;
}
public S3FileSyncInput fileSyncConfig(FileSyncConfigNullable fileSyncConfig) {
this.fileSyncConfig = fileSyncConfig;
return this;
}
/**
* Get fileSyncConfig
* @return fileSyncConfig
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
public FileSyncConfigNullable getFileSyncConfig() {
return fileSyncConfig;
}
public void setFileSyncConfig(FileSyncConfigNullable fileSyncConfig) {
this.fileSyncConfig = fileSyncConfig;
}
/**
* 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 S3FileSyncInput instance itself
*/
public S3FileSyncInput 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;
}
S3FileSyncInput s3FileSyncInput = (S3FileSyncInput) o;
return Objects.equals(this.tags, s3FileSyncInput.tags) &&
Objects.equals(this.ids, s3FileSyncInput.ids) &&
Objects.equals(this.chunkSize, s3FileSyncInput.chunkSize) &&
Objects.equals(this.chunkOverlap, s3FileSyncInput.chunkOverlap) &&
Objects.equals(this.skipEmbeddingGeneration, s3FileSyncInput.skipEmbeddingGeneration) &&
Objects.equals(this.embeddingModel, s3FileSyncInput.embeddingModel) &&
Objects.equals(this.generateSparseVectors, s3FileSyncInput.generateSparseVectors) &&
Objects.equals(this.prependFilenameToChunks, s3FileSyncInput.prependFilenameToChunks) &&
Objects.equals(this.maxItemsPerChunk, s3FileSyncInput.maxItemsPerChunk) &&
Objects.equals(this.setPageAsBoundary, s3FileSyncInput.setPageAsBoundary) &&
Objects.equals(this.dataSourceId, s3FileSyncInput.dataSourceId) &&
Objects.equals(this.requestId, s3FileSyncInput.requestId) &&
Objects.equals(this.useOcr, s3FileSyncInput.useOcr) &&
Objects.equals(this.parsePdfTablesWithOcr, s3FileSyncInput.parsePdfTablesWithOcr) &&
Objects.equals(this.fileSyncConfig, s3FileSyncInput.fileSyncConfig)&&
Objects.equals(this.additionalProperties, s3FileSyncInput.additionalProperties);
}
private static boolean equalsNullable(JsonNullable a, JsonNullable b) {
return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get()));
}
@Override
public int hashCode() {
return Objects.hash(tags, ids, chunkSize, chunkOverlap, skipEmbeddingGeneration, embeddingModel, generateSparseVectors, prependFilenameToChunks, maxItemsPerChunk, setPageAsBoundary, dataSourceId, requestId, useOcr, parsePdfTablesWithOcr, fileSyncConfig, additionalProperties);
}
private static int hashCodeNullable(JsonNullable a) {
if (a == null) {
return 1;
}
return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class S3FileSyncInput {\n");
sb.append(" tags: ").append(toIndentedString(tags)).append("\n");
sb.append(" ids: ").append(toIndentedString(ids)).append("\n");
sb.append(" chunkSize: ").append(toIndentedString(chunkSize)).append("\n");
sb.append(" chunkOverlap: ").append(toIndentedString(chunkOverlap)).append("\n");
sb.append(" skipEmbeddingGeneration: ").append(toIndentedString(skipEmbeddingGeneration)).append("\n");
sb.append(" embeddingModel: ").append(toIndentedString(embeddingModel)).append("\n");
sb.append(" generateSparseVectors: ").append(toIndentedString(generateSparseVectors)).append("\n");
sb.append(" prependFilenameToChunks: ").append(toIndentedString(prependFilenameToChunks)).append("\n");
sb.append(" maxItemsPerChunk: ").append(toIndentedString(maxItemsPerChunk)).append("\n");
sb.append(" setPageAsBoundary: ").append(toIndentedString(setPageAsBoundary)).append("\n");
sb.append(" dataSourceId: ").append(toIndentedString(dataSourceId)).append("\n");
sb.append(" requestId: ").append(toIndentedString(requestId)).append("\n");
sb.append(" useOcr: ").append(toIndentedString(useOcr)).append("\n");
sb.append(" parsePdfTablesWithOcr: ").append(toIndentedString(parsePdfTablesWithOcr)).append("\n");
sb.append(" fileSyncConfig: ").append(toIndentedString(fileSyncConfig)).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("tags");
openapiFields.add("ids");
openapiFields.add("chunk_size");
openapiFields.add("chunk_overlap");
openapiFields.add("skip_embedding_generation");
openapiFields.add("embedding_model");
openapiFields.add("generate_sparse_vectors");
openapiFields.add("prepend_filename_to_chunks");
openapiFields.add("max_items_per_chunk");
openapiFields.add("set_page_as_boundary");
openapiFields.add("data_source_id");
openapiFields.add("request_id");
openapiFields.add("use_ocr");
openapiFields.add("parse_pdf_tables_with_ocr");
openapiFields.add("file_sync_config");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("ids");
}
/**
* Validates the JSON Object and throws an exception if issues found
*
* @param jsonObj JSON Object
* @throws IOException if the JSON Object is invalid with respect to S3FileSyncInput
*/
public static void validateJsonObject(JsonObject jsonObj) throws IOException {
if (jsonObj == null) {
if (!S3FileSyncInput.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null
throw new IllegalArgumentException(String.format("The required field(s) %s in S3FileSyncInput is not found in the empty JSON string", S3FileSyncInput.openapiRequiredFields.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : S3FileSyncInput.openapiRequiredFields) {
if (jsonObj.get(requiredField) == null) {
throw new IllegalArgumentException(String.format("The required field `%s` is not found in the JSON string: %s", requiredField, jsonObj.toString()));
}
}
// ensure the json data is an array
if (!jsonObj.get("ids").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `ids` to be an array in the JSON string but got `%s`", jsonObj.get("ids").toString()));
}
JsonArray jsonArrayids = jsonObj.getAsJsonArray("ids");
// validate the required field `ids` (array)
for (int i = 0; i < jsonArrayids.size(); i++) {
S3GetFileInput.validateJsonObject(jsonArrayids.get(i).getAsJsonObject());
};
if (!jsonObj.get("request_id").isJsonNull() && (jsonObj.get("request_id") != null && !jsonObj.get("request_id").isJsonNull()) && !jsonObj.get("request_id").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `request_id` to be a primitive type in the JSON string but got `%s`", jsonObj.get("request_id").toString()));
}
// validate the optional field `file_sync_config`
if (jsonObj.get("file_sync_config") != null && !jsonObj.get("file_sync_config").isJsonNull()) {
FileSyncConfigNullable.validateJsonObject(jsonObj.getAsJsonObject("file_sync_config"));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!S3FileSyncInput.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'S3FileSyncInput' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(S3FileSyncInput.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, S3FileSyncInput value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
obj.remove("additionalProperties");
// serialize additonal 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 {
obj.add(entry.getKey(), gson.toJsonTree(entry.getValue()).getAsJsonObject());
}
}
}
elementAdapter.write(out, obj);
}
@Override
public S3FileSyncInput read(JsonReader in) throws IOException {
JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
validateJsonObject(jsonObj);
// store additional fields in the deserialized instance
S3FileSyncInput 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 S3FileSyncInput given an JSON string
*
* @param jsonString JSON string
* @return An instance of S3FileSyncInput
* @throws IOException if the JSON string is invalid with respect to S3FileSyncInput
*/
public static S3FileSyncInput fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, S3FileSyncInput.class);
}
/**
* Convert an instance of S3FileSyncInput to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}