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

Go to download
/*
 * 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;

/**
 * Metadata related to retrieval in the grounding flow.
 *
 *  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 GoogleCloudAiplatformV1beta1RetrievalMetadata extends com.google.api.client.json.GenericJson {

  /**
   * Optional. Score indicating how likely information from Google Search could help answer the
   * prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most
   * likely. This score is only populated when Google Search grounding and dynamic retrieval is
   * enabled. It will be compared to the threshold to determine whether to trigger Google Search.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Float googleSearchDynamicRetrievalScore;

  /**
   * Optional. Score indicating how likely information from Google Search could help answer the
   * prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most
   * likely. This score is only populated when Google Search grounding and dynamic retrieval is
   * enabled. It will be compared to the threshold to determine whether to trigger Google Search.
   * @return value or {@code null} for none
   */
  public java.lang.Float getGoogleSearchDynamicRetrievalScore() {
    return googleSearchDynamicRetrievalScore;
  }

  /**
   * Optional. Score indicating how likely information from Google Search could help answer the
   * prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most
   * likely. This score is only populated when Google Search grounding and dynamic retrieval is
   * enabled. It will be compared to the threshold to determine whether to trigger Google Search.
   * @param googleSearchDynamicRetrievalScore googleSearchDynamicRetrievalScore or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1RetrievalMetadata setGoogleSearchDynamicRetrievalScore(java.lang.Float googleSearchDynamicRetrievalScore) {
    this.googleSearchDynamicRetrievalScore = googleSearchDynamicRetrievalScore;
    return this;
  }

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

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

}