ProcessDocumentRequest

package com.acumenvelocity.ath.model;

import java.net.URI;
import java.util.List;
import java.util.Objects;
import java.util.UUID;

import com.fasterxml.jackson.annotation.JsonProperty;

import io.swagger.annotations.ApiModelProperty;

@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaInflectorServerCodegen", comments = "Generator version: 7.15.0")
public class ProcessDocumentRequest {
  @JsonProperty("doc_gcs_url")
  private URI docGcsUrl;

  @JsonProperty("doc_out_gcs_url")
  private URI docOutGcsUrl;

  @JsonProperty("doc_file_name")
  private String docFileName;

  @JsonProperty("src_lang")
  private String srcLang = "en";

  @JsonProperty("trg_lang")
  private String trgLang = "fr";

  @JsonProperty("doc_encoding")
  private String docEncoding = "";

  @JsonProperty("doc_out_encoding")
  private String docOutEncoding = "";

  @JsonProperty("filter_id")
  private String filterId = "";

  @JsonProperty("filter_params")
  private String filterParams = "";

  @JsonProperty("src_srx")
  private String srcSrx = "";

  @JsonProperty("tm_id")
  private UUID tmId;

  @JsonProperty("tm_threshold")
  private Integer tmThreshold = 75;

  @JsonProperty("mt_engine_id")
  private String mtEngineId = "GoogleMTv3";

  @JsonProperty("mt_engine_params")
  private String mtEngineParams = "";

  @JsonProperty("mt_custom_resources")
  private List<MtResources> mtCustomResources = null;

  @JsonProperty("mt_use_translate_llm")
  private Boolean mtUseTranslateLlm = false;

  @JsonProperty("mt_send_plain_text")
  private Boolean mtSendPlainText = true;

  @JsonProperty("mt_provide_confidence_scores")
  private Boolean mtProvideConfidenceScores = false;

  @JsonProperty("use_codes_reinsertion_model")
  private Boolean useCodesReinsertionModel = false;

  @JsonProperty("codes_reinsertion_model_name")
  private String codesReinsertionModelName = "gemini-2.5-flash";

  @JsonProperty("adjust_target_pages")
  private Boolean adjustTargetPages = true;

  @JsonProperty("user_id")
  private UUID userId;

  /**
   * GCS URL (gs://...) of the source document to process.
   **/
  public ProcessDocumentRequest docGcsUrl(URI docGcsUrl) {
    this.docGcsUrl = docGcsUrl;
    return this;
  }

  @ApiModelProperty(required = true, value = "GCS URL (gs://...) of the source document to process.")
  @JsonProperty("doc_gcs_url")
  public URI getDocGcsUrl() {
    return docGcsUrl;
  }

  public void setDocGcsUrl(URI docGcsUrl) {
    this.docGcsUrl = docGcsUrl;
  }

  /**
   * GCS URL (gs://...) where the translated document will be written.
   **/
  public ProcessDocumentRequest docOutGcsUrl(URI docOutGcsUrl) {
    this.docOutGcsUrl = docOutGcsUrl;
    return this;
  }

  @ApiModelProperty(required = true, value = "GCS URL (gs://...) where the translated document will be written.")
  @JsonProperty("doc_out_gcs_url")
  public URI getDocOutGcsUrl() {
    return docOutGcsUrl;
  }

  public void setDocOutGcsUrl(URI docOutGcsUrl) {
    this.docOutGcsUrl = docOutGcsUrl;
  }

  /**
   * Original filename (used for filter detection and metadata).
   **/
  public ProcessDocumentRequest docFileName(String docFileName) {
    this.docFileName = docFileName;
    return this;
  }

  @ApiModelProperty(required = true, value = "Original filename (used for filter detection and metadata).")
  @JsonProperty("doc_file_name")
  public String getDocFileName() {
    return docFileName;
  }

  public void setDocFileName(String docFileName) {
    this.docFileName = docFileName;
  }

  /**
   * Source language ISO code.
   **/
  public ProcessDocumentRequest srcLang(String srcLang) {
    this.srcLang = srcLang;
    return this;
  }

  @ApiModelProperty(required = true, value = "Source language ISO code.")
  @JsonProperty("src_lang")
  public String getSrcLang() {
    return srcLang;
  }

  public void setSrcLang(String srcLang) {
    this.srcLang = srcLang;
  }

  /**
   * Target language ISO code.
   **/
  public ProcessDocumentRequest trgLang(String trgLang) {
    this.trgLang = trgLang;
    return this;
  }

  @ApiModelProperty(required = true, value = "Target language ISO code.")
  @JsonProperty("trg_lang")
  public String getTrgLang() {
    return trgLang;
  }

  public void setTrgLang(String trgLang) {
    this.trgLang = trgLang;
  }

  /**
   * Source document encoding (if known). If omitted, auto-detected.
   **/
  public ProcessDocumentRequest docEncoding(String docEncoding) {
    this.docEncoding = docEncoding;
    return this;
  }

  @ApiModelProperty(value = "Source document encoding (if known). If omitted, auto-detected.")
  @JsonProperty("doc_encoding")
  public String getDocEncoding() {
    return docEncoding;
  }

  public void setDocEncoding(String docEncoding) {
    this.docEncoding = docEncoding;
  }

  /**
   * Desired output encoding. If omitted, uses source encoding.
   **/
  public ProcessDocumentRequest docOutEncoding(String docOutEncoding) {
    this.docOutEncoding = docOutEncoding;
    return this;
  }

  @ApiModelProperty(value = "Desired output encoding. If omitted, uses source encoding.")
  @JsonProperty("doc_out_encoding")
  public String getDocOutEncoding() {
    return docOutEncoding;
  }

  public void setDocOutEncoding(String docOutEncoding) {
    this.docOutEncoding = docOutEncoding;
  }

  /**
   * Filter configuration ID to use for document import.
   **/
  public ProcessDocumentRequest filterId(String filterId) {
    this.filterId = filterId;
    return this;
  }

  @ApiModelProperty(value = "Filter configuration ID to use for document import.")
  @JsonProperty("filter_id")
  public String getFilterId() {
    return filterId;
  }

  public void setFilterId(String filterId) {
    this.filterId = filterId;
  }

  /**
   * Optional string with filter configuration parameters, filter defaults are used if omitted.
   **/
  public ProcessDocumentRequest filterParams(String filterParams) {
    this.filterParams = filterParams;
    return this;
  }

  @ApiModelProperty(value = "Optional string with filter configuration parameters, filter defaults are used  if omitted.")
  @JsonProperty("filter_params")
  public String getFilterParams() {
    return filterParams;
  }

  public void setFilterParams(String filterParams) {
    this.filterParams = filterParams;
  }

  /**
   * Optional SRX string for source segmentation.
   **/
  public ProcessDocumentRequest srcSrx(String srcSrx) {
    this.srcSrx = srcSrx;
    return this;
  }

  @ApiModelProperty(value = "Optional SRX string for source segmentation.")
  @JsonProperty("src_srx")
  public String getSrcSrx() {
    return srcSrx;
  }

  public void setSrcSrx(String srcSrx) {
    this.srcSrx = srcSrx;
  }

  /**
   * Translation memory ID.
   **/
  public ProcessDocumentRequest tmId(UUID tmId) {
    this.tmId = tmId;
    return this;
  }

  @ApiModelProperty(value = "Translation memory ID.")
  @JsonProperty("tm_id")
  public UUID getTmId() {
    return tmId;
  }

  public void setTmId(UUID tmId) {
    this.tmId = tmId;
  }

  /**
   * Translation memory threshold percentage (0-101, where 100 means exact, 101 in-context exact
   * match).
   * minimum: 0
   * maximum: 101
   **/
  public ProcessDocumentRequest tmThreshold(Integer tmThreshold) {
    this.tmThreshold = tmThreshold;
    return this;
  }

  @ApiModelProperty(value = "Translation memory threshold percentage (0-101, where 100 means exact,  101 in-context exact match).")
  @JsonProperty("tm_threshold")
  public Integer getTmThreshold() {
    return tmThreshold;
  }

  public void setTmThreshold(Integer tmThreshold) {
    this.tmThreshold = tmThreshold;
  }

  /**
   * Optional name of the MT engine if MT is used.
   **/
  public ProcessDocumentRequest mtEngineId(String mtEngineId) {
    this.mtEngineId = mtEngineId;
    return this;
  }

  @ApiModelProperty(value = "Optional name of the MT engine if MT is used.")
  @JsonProperty("mt_engine_id")
  public String getMtEngineId() {
    return mtEngineId;
  }

  public void setMtEngineId(String mtEngineId) {
    this.mtEngineId = mtEngineId;
  }

  /**
   * Optional parameters of the MT engine if MT is used (API key, model name etc. in the format the
   * MT engine expects).
   **/
  public ProcessDocumentRequest mtEngineParams(String mtEngineParams) {
    this.mtEngineParams = mtEngineParams;
    return this;
  }

  @ApiModelProperty(value = "Optional parameters of the MT engine if MT is used (API key, model name etc.  in the format the MT engine expects).")
  @JsonProperty("mt_engine_params")
  public String getMtEngineParams() {
    return mtEngineParams;
  }

  public void setMtEngineParams(String mtEngineParams) {
    this.mtEngineParams = mtEngineParams;
  }

  /**
   * Array of MT resources (glossary + custom model) objects. Some MT resources are hardcoded in the
   * controller, this array contains additional resources like client glossaries and models.
   **/
  public ProcessDocumentRequest mtCustomResources(List<MtResources> mtCustomResources) {
    this.mtCustomResources = mtCustomResources;
    return this;
  }

  @ApiModelProperty(value = "Array of MT resources (glossary + custom model) objects. Some MT resources are hardcoded in the controller, this array contains additional resources like client glossaries and models.")
  @JsonProperty("mt_custom_resources")
  public List<MtResources> getMtCustomResources() {
    return mtCustomResources;
  }

  public void setMtCustomResources(List<MtResources> mtCustomResources) {
    this.mtCustomResources = mtCustomResources;
  }

  /**
   * True to use Google Translate LLM instead of NMT when confidence scores are not calculated
   * (`mt_provide_confidence_scores` is false).
   **/
  public ProcessDocumentRequest mtUseTranslateLlm(Boolean mtUseTranslateLlm) {
    this.mtUseTranslateLlm = mtUseTranslateLlm;
    return this;
  }

  @ApiModelProperty(value = "True to use Google Translate LLM instead of NMT when confidence scores  are not calculated (`mt_provide_confidence_scores` is false).")
  @JsonProperty("mt_use_translate_llm")
  public Boolean getMtUseTranslateLlm() {
    return mtUseTranslateLlm;
  }

  public void setMtUseTranslateLlm(Boolean mtUseTranslateLlm) {
    this.mtUseTranslateLlm = mtUseTranslateLlm;
  }

  /**
   * True to remove inline codes from the souce text before sending it for MT. Some models
   * hallucinate when a text flow is interrupted with codes and cannot provide a high quality
   * translation.
   **/
  public ProcessDocumentRequest mtSendPlainText(Boolean mtSendPlainText) {
    this.mtSendPlainText = mtSendPlainText;
    return this;
  }

  @ApiModelProperty(value = "True to remove inline codes from the souce text before sending it for MT. Some models hallucinate when a text flow is interrupted with codes and cannot provide a high quality translation.")
  @JsonProperty("mt_send_plain_text")
  public Boolean getMtSendPlainText() {
    return mtSendPlainText;
  }

  public void setMtSendPlainText(Boolean mtSendPlainText) {
    this.mtSendPlainText = mtSendPlainText;
  }

  /**
   * True to provide several translations, each by a separate MT service, then calculate confidence
   * scores for them. If GCT v3 (`GoogleMTv3`) is specified in `mt_engine_id` and the flag set to
   * true, then the following models are inferenced in parallel: Goodle Cloud Translation v3 NMT,
   * Translation LLM, and all the AutoML models specified in `mt_custom_resources`. If set to false,
   * only one translation is generated by the MT engine specified in `mt_engine_id`, and the
   * confidence score is 0.
   **/
  public ProcessDocumentRequest mtProvideConfidenceScores(Boolean mtProvideConfidenceScores) {
    this.mtProvideConfidenceScores = mtProvideConfidenceScores;
    return this;
  }

  @ApiModelProperty(value = "True to provide several translations, each by a separate MT service, then  calculate confidence scores for them. If GCT v3 (`GoogleMTv3`) is specified in  `mt_engine_id` and the flag set to true, then the following models are  inferenced in parallel: Goodle Cloud Translation v3 NMT, Translation LLM, and  all the AutoML models specified in `mt_custom_resources`. If set to false, only one translation is generated by the MT engine specified in  `mt_engine_id`, and the confidence score is 0.")
  @JsonProperty("mt_provide_confidence_scores")
  public Boolean getMtProvideConfidenceScores() {
    return mtProvideConfidenceScores;
  }

  public void setMtProvideConfidenceScores(Boolean mtProvideConfidenceScores) {
    this.mtProvideConfidenceScores = mtProvideConfidenceScores;
  }

  /**
   * True to use LLM-based target codes reinsertion, false to have Okapi reinsert. This option has
   * effect only when plainTextMT is true.
   **/
  public ProcessDocumentRequest useCodesReinsertionModel(Boolean useCodesReinsertionModel) {
    this.useCodesReinsertionModel = useCodesReinsertionModel;
    return this;
  }

  @ApiModelProperty(value = "True to use LLM-based target codes reinsertion, false to have Okapi reinsert. This option has effect only when plainTextMT is true.")
  @JsonProperty("use_codes_reinsertion_model")
  public Boolean getUseCodesReinsertionModel() {
    return useCodesReinsertionModel;
  }

  public void setUseCodesReinsertionModel(Boolean useCodesReinsertionModel) {
    this.useCodesReinsertionModel = useCodesReinsertionModel;
  }

  /**
   * Gemini AI model name to use for target codes reinsertion.
   **/
  public ProcessDocumentRequest codesReinsertionModelName(String codesReinsertionModelName) {
    this.codesReinsertionModelName = codesReinsertionModelName;
    return this;
  }

  @ApiModelProperty(value = "Gemini AI model name to use for target codes reinsertion.")
  @JsonProperty("codes_reinsertion_model_name")
  public String getCodesReinsertionModelName() {
    return codesReinsertionModelName;
  }

  public void setCodesReinsertionModelName(String codesReinsertionModelName) {
    this.codesReinsertionModelName = codesReinsertionModelName;
  }

  /**
   * True to modify font sizes in the PDF translation document to have the page count less or equal
   * to the page count of the original document. Has no effect for other document formats.
   **/
  public ProcessDocumentRequest adjustTargetPages(Boolean adjustTargetPages) {
    this.adjustTargetPages = adjustTargetPages;
    return this;
  }

  @ApiModelProperty(value = "True to modify font sizes in the PDF translation document to have the page count less or equal to the page count of the original document. Has no effect for other document formats. ")
  @JsonProperty("adjust_target_pages")
  public Boolean getAdjustTargetPages() {
    return adjustTargetPages;
  }

  public void setAdjustTargetPages(Boolean adjustTargetPages) {
    this.adjustTargetPages = adjustTargetPages;
  }

  /**
   * UUID of the user importing the document.
   **/
  public ProcessDocumentRequest userId(UUID userId) {
    this.userId = userId;
    return this;
  }

  @ApiModelProperty(required = true, value = "UUID of the user importing the document.")
  @JsonProperty("user_id")
  public UUID getUserId() {
    return userId;
  }

  public void setUserId(UUID userId) {
    this.userId = userId;
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    ProcessDocumentRequest processDocumentRequest = (ProcessDocumentRequest) o;
    return Objects.equals(docGcsUrl, processDocumentRequest.docGcsUrl) &&
        Objects.equals(docOutGcsUrl, processDocumentRequest.docOutGcsUrl) &&
        Objects.equals(docFileName, processDocumentRequest.docFileName) &&
        Objects.equals(srcLang, processDocumentRequest.srcLang) &&
        Objects.equals(trgLang, processDocumentRequest.trgLang) &&
        Objects.equals(docEncoding, processDocumentRequest.docEncoding) &&
        Objects.equals(docOutEncoding, processDocumentRequest.docOutEncoding) &&
        Objects.equals(filterId, processDocumentRequest.filterId) &&
        Objects.equals(filterParams, processDocumentRequest.filterParams) &&
        Objects.equals(srcSrx, processDocumentRequest.srcSrx) &&
        Objects.equals(tmId, processDocumentRequest.tmId) &&
        Objects.equals(tmThreshold, processDocumentRequest.tmThreshold) &&
        Objects.equals(mtEngineId, processDocumentRequest.mtEngineId) &&
        Objects.equals(mtEngineParams, processDocumentRequest.mtEngineParams) &&
        Objects.equals(mtCustomResources, processDocumentRequest.mtCustomResources) &&
        Objects.equals(mtUseTranslateLlm, processDocumentRequest.mtUseTranslateLlm) &&
        Objects.equals(mtSendPlainText, processDocumentRequest.mtSendPlainText) &&
        Objects.equals(mtProvideConfidenceScores, processDocumentRequest.mtProvideConfidenceScores)
        &&
        Objects.equals(useCodesReinsertionModel, processDocumentRequest.useCodesReinsertionModel) &&
        Objects.equals(codesReinsertionModelName, processDocumentRequest.codesReinsertionModelName)
        &&
        Objects.equals(adjustTargetPages, processDocumentRequest.adjustTargetPages) &&
        Objects.equals(userId, processDocumentRequest.userId);
  }

  @Override
  public int hashCode() {
    return Objects.hash(docGcsUrl, docOutGcsUrl, docFileName, srcLang, trgLang, docEncoding,
        docOutEncoding, filterId, filterParams, srcSrx, tmId, tmThreshold, mtEngineId,
        mtEngineParams, mtCustomResources, mtUseTranslateLlm, mtSendPlainText,
        mtProvideConfidenceScores, useCodesReinsertionModel, codesReinsertionModelName,
        adjustTargetPages, userId);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class ProcessDocumentRequest {\n");

    sb.append("    docGcsUrl: ").append(toIndentedString(docGcsUrl)).append("\n");
    sb.append("    docOutGcsUrl: ").append(toIndentedString(docOutGcsUrl)).append("\n");
    sb.append("    docFileName: ").append(toIndentedString(docFileName)).append("\n");
    sb.append("    srcLang: ").append(toIndentedString(srcLang)).append("\n");
    sb.append("    trgLang: ").append(toIndentedString(trgLang)).append("\n");
    sb.append("    docEncoding: ").append(toIndentedString(docEncoding)).append("\n");
    sb.append("    docOutEncoding: ").append(toIndentedString(docOutEncoding)).append("\n");
    sb.append("    filterId: ").append(toIndentedString(filterId)).append("\n");
    sb.append("    filterParams: ").append(toIndentedString(filterParams)).append("\n");
    sb.append("    srcSrx: ").append(toIndentedString(srcSrx)).append("\n");
    sb.append("    tmId: ").append(toIndentedString(tmId)).append("\n");
    sb.append("    tmThreshold: ").append(toIndentedString(tmThreshold)).append("\n");
    sb.append("    mtEngineId: ").append(toIndentedString(mtEngineId)).append("\n");
    sb.append("    mtEngineParams: ").append(toIndentedString(mtEngineParams)).append("\n");
    sb.append("    mtCustomResources: ").append(toIndentedString(mtCustomResources)).append("\n");
    sb.append("    mtUseTranslateLlm: ").append(toIndentedString(mtUseTranslateLlm)).append("\n");
    sb.append("    mtSendPlainText: ").append(toIndentedString(mtSendPlainText)).append("\n");
    sb.append("    mtProvideConfidenceScores: ").append(toIndentedString(mtProvideConfidenceScores))
        .append("\n");
    sb.append("    useCodesReinsertionModel: ").append(toIndentedString(useCodesReinsertionModel))
        .append("\n");
    sb.append("    codesReinsertionModelName: ").append(toIndentedString(codesReinsertionModelName))
        .append("\n");
    sb.append("    adjustTargetPages: ").append(toIndentedString(adjustTargetPages)).append("\n");
    sb.append("    userId: ").append(toIndentedString(userId)).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    ");
  }
}