Package com.google.cloud.retail.v2alpha

Class GenerativeQuestionConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.retail.v2alpha.GenerativeQuestionConfig
All Implemented Interfaces:
GenerativeQuestionConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class GenerativeQuestionConfig extends com.google.protobuf.GeneratedMessage implements GenerativeQuestionConfigOrBuilder
 Configuration for a single generated question.
Protobuf type google.cloud.retail.v2alpha.GenerativeQuestionConfig
See Also:

  • Field Details

    • CATALOG_FIELD_NUMBER

      public static final int CATALOG_FIELD_NUMBER
      See Also:

    • FACET_FIELD_NUMBER

      public static final int FACET_FIELD_NUMBER
      See Also:

    • GENERATED_QUESTION_FIELD_NUMBER

      public static final int GENERATED_QUESTION_FIELD_NUMBER
      See Also:

    • FINAL_QUESTION_FIELD_NUMBER

      public static final int FINAL_QUESTION_FIELD_NUMBER
      See Also:

    • EXAMPLE_VALUES_FIELD_NUMBER

      public static final int EXAMPLE_VALUES_FIELD_NUMBER
      See Also:

    • FREQUENCY_FIELD_NUMBER

      public static final int FREQUENCY_FIELD_NUMBER
      See Also:

    • ALLOWED_IN_CONVERSATION_FIELD_NUMBER

      public static final int ALLOWED_IN_CONVERSATION_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getCatalog

      public String getCatalog()
       Required. Resource name of the catalog.
 Format: projects/{project}/locations/{location}/catalogs/{catalog}
      string catalog = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCatalog in interface GenerativeQuestionConfigOrBuilder
      Returns:
      The catalog.

    • getCatalogBytes

      public com.google.protobuf.ByteString getCatalogBytes()
       Required. Resource name of the catalog.
 Format: projects/{project}/locations/{location}/catalogs/{catalog}
      string catalog = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCatalogBytes in interface GenerativeQuestionConfigOrBuilder
      Returns:
      The bytes for catalog.

    • getFacet

      public String getFacet()
       Required. The facet to which the question is associated.
      string facet = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getFacet in interface GenerativeQuestionConfigOrBuilder
      Returns:
      The facet.

    • getFacetBytes

      public com.google.protobuf.ByteString getFacetBytes()
       Required. The facet to which the question is associated.
      string facet = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getFacetBytes in interface GenerativeQuestionConfigOrBuilder
      Returns:
      The bytes for facet.

    • getGeneratedQuestion

      public String getGeneratedQuestion()
       Output only. The LLM generated question.
      string generated_question = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGeneratedQuestion in interface GenerativeQuestionConfigOrBuilder
      Returns:
      The generatedQuestion.

    • getGeneratedQuestionBytes

      public com.google.protobuf.ByteString getGeneratedQuestionBytes()
       Output only. The LLM generated question.
      string generated_question = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getGeneratedQuestionBytes in interface GenerativeQuestionConfigOrBuilder
      Returns:
      The bytes for generatedQuestion.

    • getFinalQuestion

      public 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];
      Specified by:
      getFinalQuestion in interface GenerativeQuestionConfigOrBuilder
      Returns:
      The finalQuestion.

    • getFinalQuestionBytes

      public com.google.protobuf.ByteString getFinalQuestionBytes()
       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];
      Specified by:
      getFinalQuestionBytes in interface GenerativeQuestionConfigOrBuilder
      Returns:
      The bytes for finalQuestion.

    • getExampleValuesList

      public com.google.protobuf.ProtocolStringList getExampleValuesList()
       Output only. Values that can be used to answer the question.
      repeated string example_values = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getExampleValuesList in interface GenerativeQuestionConfigOrBuilder
      Returns:
      A list containing the exampleValues.

    • getExampleValuesCount

      public int getExampleValuesCount()
       Output only. Values that can be used to answer the question.
      repeated string example_values = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getExampleValuesCount in interface GenerativeQuestionConfigOrBuilder
      Returns:
      The count of exampleValues.

    • getExampleValues

      public 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];
      Specified by:
      getExampleValues in interface GenerativeQuestionConfigOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The exampleValues at the given index.

    • getExampleValuesBytes

      public com.google.protobuf.ByteString getExampleValuesBytes(int index)
       Output only. Values that can be used to answer the question.
      repeated string example_values = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getExampleValuesBytes in interface GenerativeQuestionConfigOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the exampleValues at the given index.

    • getFrequency

      public float getFrequency()
       Output only. The ratio of how often a question was asked.
      float frequency = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFrequency in interface GenerativeQuestionConfigOrBuilder
      Returns:
      The frequency.

    • getAllowedInConversation

      public boolean getAllowedInConversation()
       Optional. Whether the question is asked at serving time.
      bool allowed_in_conversation = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAllowedInConversation in interface GenerativeQuestionConfigOrBuilder
      Returns:
      The allowedInConversation.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static GenerativeQuestionConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerativeQuestionConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerativeQuestionConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerativeQuestionConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerativeQuestionConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerativeQuestionConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerativeQuestionConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GenerativeQuestionConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GenerativeQuestionConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GenerativeQuestionConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GenerativeQuestionConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GenerativeQuestionConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public GenerativeQuestionConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static GenerativeQuestionConfig.Builder newBuilder()

    • newBuilder

      public static GenerativeQuestionConfig.Builder newBuilder(GenerativeQuestionConfig prototype)

    • toBuilder

      public GenerativeQuestionConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected GenerativeQuestionConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static GenerativeQuestionConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<GenerativeQuestionConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<GenerativeQuestionConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public GenerativeQuestionConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder