com.google.api.services.dialogflow.v3.model.GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpec Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-dialogflow Show documentation
The newest version!
/*
 * 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.dialogflow.v3.model;

/**
 * Boost applies to documents which match a condition.
 *
 *  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 Dialogflow API. For a detailed explanation see:
 * https://developers.google.com/api-client-library/java/google-http-java-client/json
 * 
 *
 * @author Google, Inc.
 */
@SuppressWarnings("javadoc")
public final class GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpec extends com.google.api.client.json.GenericJson {

  /**
   * Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means
   * demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does
   * not necessarily mean that the boosted document will be the top result at all times, nor that
   * other documents will be excluded. Results could still be shown even when none of them matches
   * the condition. And results that are significantly more relevant to the search query can still
   * trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big
   * demotion. However, results that are deeply relevant might still be shown. The document will
   * have an upstream battle to get a fairly high ranking, but it is not blocked out completely.
   * Setting to 0.0 means no boost applied. The boosting condition is ignored.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float boost;

  /**
   * Optional. An expression which specifies a boost condition. The syntax and supported fields are
   * the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or
   * "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color:
   * ANY("Red","Blue"))
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String condition;

  /**
   * Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means
   * demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does
   * not necessarily mean that the boosted document will be the top result at all times, nor that
   * other documents will be excluded. Results could still be shown even when none of them matches
   * the condition. And results that are significantly more relevant to the search query can still
   * trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big
   * demotion. However, results that are deeply relevant might still be shown. The document will
   * have an upstream battle to get a fairly high ranking, but it is not blocked out completely.
   * Setting to 0.0 means no boost applied. The boosting condition is ignored.
   * @return value or {@code null} for none
   */
  public java.lang.Float getBoost() {
    return boost;
  }

  /**
   * Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means
   * demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does
   * not necessarily mean that the boosted document will be the top result at all times, nor that
   * other documents will be excluded. Results could still be shown even when none of them matches
   * the condition. And results that are significantly more relevant to the search query can still
   * trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big
   * demotion. However, results that are deeply relevant might still be shown. The document will
   * have an upstream battle to get a fairly high ranking, but it is not blocked out completely.
   * Setting to 0.0 means no boost applied. The boosting condition is ignored.
   * @param boost boost or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpec setBoost(java.lang.Float boost) {
    this.boost = boost;
    return this;
  }

  /**
   * Optional. An expression which specifies a boost condition. The syntax and supported fields are
   * the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or
   * "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color:
   * ANY("Red","Blue"))
   * @return value or {@code null} for none
   */
  public java.lang.String getCondition() {
    return condition;
  }

  /**
   * Optional. An expression which specifies a boost condition. The syntax and supported fields are
   * the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or
   * "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color:
   * ANY("Red","Blue"))
   * @param condition condition or {@code null} for none
   */
  public GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpec setCondition(java.lang.String condition) {
    this.condition = condition;
    return this;
  }

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

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

}