com.google.cloud.retail.v2

Interface GenerativeQuestionConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

GenerativeQuestionConfig, GenerativeQuestionConfig.Builder

public interface GenerativeQuestionConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getAllowedInConversation() Optional.
String	getCatalog() Required.
com.google.protobuf.ByteString	getCatalogBytes() Required.
String	getExampleValues(int index) Output only.
com.google.protobuf.ByteString	getExampleValuesBytes(int index) Output only.
int	getExampleValuesCount() Output only.
List<String>	getExampleValuesList() Output only.
String	getFacet() Required.
com.google.protobuf.ByteString	getFacetBytes() Required.
String	getFinalQuestion() Optional.
com.google.protobuf.ByteString	getFinalQuestionBytes() Optional.
float	getFrequency() Output only.
String	getGeneratedQuestion() Output only.
com.google.protobuf.ByteString	getGeneratedQuestionBytes() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getCatalog

String getCatalog()

 Required. Resource name of the catalog.
 Format: projects/{project}/locations/{location}/catalogs/{catalog}
 

string catalog = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The catalog.

getCatalogBytes

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];

Returns:

The bytes for catalog.

getFacet

String getFacet()

 Required. The facet to which the question is associated.
 

string facet = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The facet.

getFacetBytes

com.google.protobuf.ByteString getFacetBytes()

 Required. The facet to which the question is associated.
 

string facet = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for facet.

getGeneratedQuestion

String getGeneratedQuestion()

 Output only. The LLM generated question.
 

string generated_question = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The generatedQuestion.

getGeneratedQuestionBytes

com.google.protobuf.ByteString getGeneratedQuestionBytes()

 Output only. The LLM generated question.
 

string generated_question = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for generatedQuestion.

getFinalQuestion

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];

Returns:

The finalQuestion.

getFinalQuestionBytes

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];

Returns:

The bytes for finalQuestion.

getExampleValuesList

List<String> getExampleValuesList()

 Output only. Values that can be used to answer the question.
 

repeated string example_values = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

A list containing the exampleValues.

getExampleValuesCount

int getExampleValuesCount()

 Output only. Values that can be used to answer the question.
 

repeated string example_values = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The count of exampleValues.

getExampleValues

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];

Parameters:

index - The index of the element to return.

Returns:

The exampleValues at the given index.

getExampleValuesBytes

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];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the exampleValues at the given index.

getFrequency

float getFrequency()

 Output only. The ratio of how often a question was asked.
 

float frequency = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The frequency.

getAllowedInConversation

boolean getAllowedInConversation()

 Optional. Whether the question is asked at serving time.
 

bool allowed_in_conversation = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The allowedInConversation.