com.google.cloud.retail.v2alpha.GenerativeQuestionConfigOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-retail-v2alpha Show documentation
Proto library for google-cloud-retail
There is a newer version: 2.55.0
Show newest version
/*
 * Copyright 2024 Google LLC
 *
 * 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
 *
 *     https://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.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/retail/v2alpha/generative_question.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.retail.v2alpha;

public interface GenerativeQuestionConfigOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.retail.v2alpha.GenerativeQuestionConfig)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Required. Resource name of the catalog.
   * Format: projects/{project}/locations/{location}/catalogs/{catalog}
   * 
   *
   * string catalog = 1 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The catalog.
   */
  java.lang.String getCatalog();
  /**
   *
   *
   *    * Required. Resource name of the catalog.
   * Format: projects/{project}/locations/{location}/catalogs/{catalog}
   * 
   *
   * string catalog = 1 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for catalog.
   */
  com.google.protobuf.ByteString getCatalogBytes();

  /**
   *
   *
   *    * Required. The facet to which the question is associated.
   * 
   *
   * string facet = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The facet.
   */
  java.lang.String getFacet();
  /**
   *
   *
   *    * Required. The facet to which the question is associated.
   * 
   *
   * string facet = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for facet.
   */
  com.google.protobuf.ByteString getFacetBytes();

  /**
   *
   *
   *    * Output only. The LLM generated question.
   * 
   *
   * string generated_question = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The generatedQuestion.
   */
  java.lang.String getGeneratedQuestion();
  /**
   *
   *
   *    * Output only. The LLM generated question.
   * 
   *
   * string generated_question = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The bytes for generatedQuestion.
   */
  com.google.protobuf.ByteString getGeneratedQuestionBytes();

  /**
   *
   *
   *    * Optional. The question that will be used at serving time.
   * Question can have a max length of 300 bytes.
   * When not populated, generated_question should be used.
   * 
   *
   * string final_question = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The finalQuestion.
   */
  java.lang.String getFinalQuestion();
  /**
   *
   *
   *    * Optional. The question that will be used at serving time.
   * Question can have a max length of 300 bytes.
   * When not populated, generated_question should be used.
   * 
   *
   * string final_question = 4 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for finalQuestion.
   */
  com.google.protobuf.ByteString getFinalQuestionBytes();

  /**
   *
   *
   *    * Output only. Values that can be used to answer the question.
   * 
   *
   * repeated string example_values = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return A list containing the exampleValues.
   */
  java.util.List getExampleValuesList();
  /**
   *
   *
   *    * Output only. Values that can be used to answer the question.
   * 
   *
   * repeated string example_values = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The count of exampleValues.
   */
  int getExampleValuesCount();
  /**
   *
   *
   *    * Output only. Values that can be used to answer the question.
   * 
   *
   * repeated string example_values = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @param index The index of the element to return.
   * @return The exampleValues at the given index.
   */
  java.lang.String getExampleValues(int index);
  /**
   *
   *
   *    * Output only. Values that can be used to answer the question.
   * 
   *
   * repeated string example_values = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @param index The index of the value to return.
   * @return The bytes of the exampleValues at the given index.
   */
  com.google.protobuf.ByteString getExampleValuesBytes(int index);

  /**
   *
   *
   *    * Output only. The ratio of how often a question was asked.
   * 
   *
   * float frequency = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
   *
   * @return The frequency.
   */
  float getFrequency();

  /**
   *
   *
   *    * Optional. Whether the question is asked at serving time.
   * 
   *
   * bool allowed_in_conversation = 7 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The allowedInConversation.
   */
  boolean getAllowedInConversation();
}