com.google.api.services.firebaseml.v2beta.model.GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-firebaseml 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.firebaseml.v2beta.model;

/**
 * Config for Hybrid Search.
 *
 *  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 Firebase ML 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 GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch extends com.google.api.client.json.GenericJson {

  /**
   * Optional. Alpha value controls the weight between dense and sparse vector search results. The
   * range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only.
   * The default value is 0.5 which balances sparse and dense vector search equally.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float alpha;

  /**
   * Optional. Alpha value controls the weight between dense and sparse vector search results. The
   * range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only.
   * The default value is 0.5 which balances sparse and dense vector search equally.
   * @return value or {@code null} for none
   */
  public java.lang.Float getAlpha() {
    return alpha;
  }

  /**
   * Optional. Alpha value controls the weight between dense and sparse vector search results. The
   * range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only.
   * The default value is 0.5 which balances sparse and dense vector search equally.
   * @param alpha alpha or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch setAlpha(java.lang.Float alpha) {
    this.alpha = alpha;
    return this;
  }

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

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

}