com.google.api.services.firebaseml.v2beta.model.GoogleCloudAiplatformV1beta1RagRetrievalConfig 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;

/**
 * Specifies the context retrieval config.
 *
 *  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 GoogleCloudAiplatformV1beta1RagRetrievalConfig extends com.google.api.client.json.GenericJson {

  /**
   * Optional. Config for filters.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudAiplatformV1beta1RagRetrievalConfigFilter filter;

  /**
   * Optional. Config for Hybrid Search.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch hybridSearch;

  /**
   * Optional. Config for ranking and reranking.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private GoogleCloudAiplatformV1beta1RagRetrievalConfigRanking ranking;

  /**
   * Optional. The number of contexts to retrieve.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Integer topK;

  /**
   * Optional. Config for filters.
   * @return value or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1RagRetrievalConfigFilter getFilter() {
    return filter;
  }

  /**
   * Optional. Config for filters.
   * @param filter filter or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1RagRetrievalConfig setFilter(GoogleCloudAiplatformV1beta1RagRetrievalConfigFilter filter) {
    this.filter = filter;
    return this;
  }

  /**
   * Optional. Config for Hybrid Search.
   * @return value or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch getHybridSearch() {
    return hybridSearch;
  }

  /**
   * Optional. Config for Hybrid Search.
   * @param hybridSearch hybridSearch or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1RagRetrievalConfig setHybridSearch(GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch hybridSearch) {
    this.hybridSearch = hybridSearch;
    return this;
  }

  /**
   * Optional. Config for ranking and reranking.
   * @return value or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1RagRetrievalConfigRanking getRanking() {
    return ranking;
  }

  /**
   * Optional. Config for ranking and reranking.
   * @param ranking ranking or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1RagRetrievalConfig setRanking(GoogleCloudAiplatformV1beta1RagRetrievalConfigRanking ranking) {
    this.ranking = ranking;
    return this;
  }

  /**
   * Optional. The number of contexts to retrieve.
   * @return value or {@code null} for none
   */
  public java.lang.Integer getTopK() {
    return topK;
  }

  /**
   * Optional. The number of contexts to retrieve.
   * @param topK topK or {@code null} for none
   */
  public GoogleCloudAiplatformV1beta1RagRetrievalConfig setTopK(java.lang.Integer topK) {
    this.topK = topK;
    return this;
  }

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

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

}