/*
 * 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.
 */
/*
 * This code was generated by https://github.com/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.contentwarehouse.v1.model;

/**
 * Debug info for Q anchors. Next ID: 15
 *
 * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
 * transmitted over HTTP when working with the Document AI Warehouse API. For a detailed explanation
 * see:
 * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
 * </p>
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class VideoContentSearchQnaAnchorSetFeatures extends com.google.api.client.json.GenericJson {

  /**
   * Path to Descartes background encoding in the form of a serialized drishti.DenseFeatureData
   * proto. This is generated by the flume_generate_background_encoding binary.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String backgroundEncodingPath;

  /**
   * This field is used for debugging which model the decartes_model_score is generated from. You
   * can learn more about the Descartes model at go/descartes-qa.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String descartesModelVersion;

  /**
   * Descartes score threshold for determining whether to output a QA pair as an anchor. This
   * currently effects only the Descartes ranking score.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float descartesScoreThreshold;

  /**
   * The configuration used for fetching Dolphin scores.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private VideoContentSearchDolphinScoringConfig dolphinConfig;

  /**
   * Path to Ranklab ensemble model used in post-trigger step.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String ensembleModelPath;

  /**
   * Minimum score for video anchor to pass the post-trigger step. Calculated by training a
   * logisitic regression model with 95% precision. Training colab can be found at go/video-qa-
   * ensemble.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float ensembleModelScoreThreshold;

  /**
   * Threshold for determining whether to consider an entity from a CDoc for sourcing questions on
   * that topic. Learn more about this score at: http://go/topicality-score
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float minEntityTopicalityScore;

  /**
   * Threshold for determining whether questions belong in the same cluster.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float minQuestionDistance;

  /**
   * Path to the Related Questions SSTable that maps entities to questions.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String relatedQuestionsSstablePath;

  /**
   * The duration threshold for merging captions.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  private java.lang.Long spanDurationSecs;

  /**
   * Path to Descartes background encoding in the form of a serialized drishti.DenseFeatureData
   * proto. This is generated by the flume_generate_background_encoding binary.
   * @return value or {@code null} for none
   */
  public java.lang.String getBackgroundEncodingPath() {
    return backgroundEncodingPath;
  }

  /**
   * Path to Descartes background encoding in the form of a serialized drishti.DenseFeatureData
   * proto. This is generated by the flume_generate_background_encoding binary.
   * @param backgroundEncodingPath backgroundEncodingPath or {@code null} for none
   */
  public VideoContentSearchQnaAnchorSetFeatures setBackgroundEncodingPath(java.lang.String backgroundEncodingPath) {
    this.backgroundEncodingPath = backgroundEncodingPath;
    return this;
  }

  /**
   * This field is used for debugging which model the decartes_model_score is generated from. You
   * can learn more about the Descartes model at go/descartes-qa.
   * @return value or {@code null} for none
   */
  public java.lang.String getDescartesModelVersion() {
    return descartesModelVersion;
  }

  /**
   * This field is used for debugging which model the decartes_model_score is generated from. You
   * can learn more about the Descartes model at go/descartes-qa.
   * @param descartesModelVersion descartesModelVersion or {@code null} for none
   */
  public VideoContentSearchQnaAnchorSetFeatures setDescartesModelVersion(java.lang.String descartesModelVersion) {
    this.descartesModelVersion = descartesModelVersion;
    return this;
  }

  /**
   * Descartes score threshold for determining whether to output a QA pair as an anchor. This
   * currently effects only the Descartes ranking score.
   * @return value or {@code null} for none
   */
  public java.lang.Float getDescartesScoreThreshold() {
    return descartesScoreThreshold;
  }

  /**
   * Descartes score threshold for determining whether to output a QA pair as an anchor. This
   * currently effects only the Descartes ranking score.
   * @param descartesScoreThreshold descartesScoreThreshold or {@code null} for none
   */
  public VideoContentSearchQnaAnchorSetFeatures setDescartesScoreThreshold(java.lang.Float descartesScoreThreshold) {
    this.descartesScoreThreshold = descartesScoreThreshold;
    return this;
  }

  /**
   * The configuration used for fetching Dolphin scores.
   * @return value or {@code null} for none
   */
  public VideoContentSearchDolphinScoringConfig getDolphinConfig() {
    return dolphinConfig;
  }

  /**
   * The configuration used for fetching Dolphin scores.
   * @param dolphinConfig dolphinConfig or {@code null} for none
   */
  public VideoContentSearchQnaAnchorSetFeatures setDolphinConfig(VideoContentSearchDolphinScoringConfig dolphinConfig) {
    this.dolphinConfig = dolphinConfig;
    return this;
  }

  /**
   * Path to Ranklab ensemble model used in post-trigger step.
   * @return value or {@code null} for none
   */
  public java.lang.String getEnsembleModelPath() {
    return ensembleModelPath;
  }

  /**
   * Path to Ranklab ensemble model used in post-trigger step.
   * @param ensembleModelPath ensembleModelPath or {@code null} for none
   */
  public VideoContentSearchQnaAnchorSetFeatures setEnsembleModelPath(java.lang.String ensembleModelPath) {
    this.ensembleModelPath = ensembleModelPath;
    return this;
  }

  /**
   * Minimum score for video anchor to pass the post-trigger step. Calculated by training a
   * logisitic regression model with 95% precision. Training colab can be found at go/video-qa-
   * ensemble.
   * @return value or {@code null} for none
   */
  public java.lang.Float getEnsembleModelScoreThreshold() {
    return ensembleModelScoreThreshold;
  }

  /**
   * Minimum score for video anchor to pass the post-trigger step. Calculated by training a
   * logisitic regression model with 95% precision. Training colab can be found at go/video-qa-
   * ensemble.
   * @param ensembleModelScoreThreshold ensembleModelScoreThreshold or {@code null} for none
   */
  public VideoContentSearchQnaAnchorSetFeatures setEnsembleModelScoreThreshold(java.lang.Float ensembleModelScoreThreshold) {
    this.ensembleModelScoreThreshold = ensembleModelScoreThreshold;
    return this;
  }

  /**
   * Threshold for determining whether to consider an entity from a CDoc for sourcing questions on
   * that topic. Learn more about this score at: http://go/topicality-score
   * @return value or {@code null} for none
   */
  public java.lang.Float getMinEntityTopicalityScore() {
    return minEntityTopicalityScore;
  }

  /**
   * Threshold for determining whether to consider an entity from a CDoc for sourcing questions on
   * that topic. Learn more about this score at: http://go/topicality-score
   * @param minEntityTopicalityScore minEntityTopicalityScore or {@code null} for none
   */
  public VideoContentSearchQnaAnchorSetFeatures setMinEntityTopicalityScore(java.lang.Float minEntityTopicalityScore) {
    this.minEntityTopicalityScore = minEntityTopicalityScore;
    return this;
  }

  /**
   * Threshold for determining whether questions belong in the same cluster.
   * @return value or {@code null} for none
   */
  public java.lang.Float getMinQuestionDistance() {
    return minQuestionDistance;
  }

  /**
   * Threshold for determining whether questions belong in the same cluster.
   * @param minQuestionDistance minQuestionDistance or {@code null} for none
   */
  public VideoContentSearchQnaAnchorSetFeatures setMinQuestionDistance(java.lang.Float minQuestionDistance) {
    this.minQuestionDistance = minQuestionDistance;
    return this;
  }

  /**
   * Path to the Related Questions SSTable that maps entities to questions.
   * @return value or {@code null} for none
   */
  public java.lang.String getRelatedQuestionsSstablePath() {
    return relatedQuestionsSstablePath;
  }

  /**
   * Path to the Related Questions SSTable that maps entities to questions.
   * @param relatedQuestionsSstablePath relatedQuestionsSstablePath or {@code null} for none
   */
  public VideoContentSearchQnaAnchorSetFeatures setRelatedQuestionsSstablePath(java.lang.String relatedQuestionsSstablePath) {
    this.relatedQuestionsSstablePath = relatedQuestionsSstablePath;
    return this;
  }

  /**
   * The duration threshold for merging captions.
   * @return value or {@code null} for none
   */
  public java.lang.Long getSpanDurationSecs() {
    return spanDurationSecs;
  }

  /**
   * The duration threshold for merging captions.
   * @param spanDurationSecs spanDurationSecs or {@code null} for none
   */
  public VideoContentSearchQnaAnchorSetFeatures setSpanDurationSecs(java.lang.Long spanDurationSecs) {
    this.spanDurationSecs = spanDurationSecs;
    return this;
  }

  @Override
  public VideoContentSearchQnaAnchorSetFeatures set(String fieldName, Object value) {
    return (VideoContentSearchQnaAnchorSetFeatures) super.set(fieldName, value);
  }

  @Override
  public VideoContentSearchQnaAnchorSetFeatures clone() {
    return (VideoContentSearchQnaAnchorSetFeatures) super.clone();
  }

}
