com.google.cloud.contactcenterinsights.v1

Interface QaQuestionOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

QaQuestion, QaQuestion.Builder

public interface QaQuestionOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAbbreviation() Short, descriptive string, used in the UI where it's not practical to display the full question body.
com.google.protobuf.ByteString	getAbbreviationBytes() Short, descriptive string, used in the UI where it's not practical to display the full question body.
QaQuestion.AnswerChoice	getAnswerChoices(int index) A list of valid answers to the question, which the LLM must choose from.
int	getAnswerChoicesCount() A list of valid answers to the question, which the LLM must choose from.
List<QaQuestion.AnswerChoice>	getAnswerChoicesList() A list of valid answers to the question, which the LLM must choose from.
QaQuestion.AnswerChoiceOrBuilder	getAnswerChoicesOrBuilder(int index) A list of valid answers to the question, which the LLM must choose from.
List<? extends QaQuestion.AnswerChoiceOrBuilder>	getAnswerChoicesOrBuilderList() A list of valid answers to the question, which the LLM must choose from.
String	getAnswerInstructions() Instructions describing how to determine the answer.
com.google.protobuf.ByteString	getAnswerInstructionsBytes() Instructions describing how to determine the answer.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
QaQuestion.Metrics	getMetrics() Metrics of the underlying tuned LLM over a holdout/test set while fine tuning the underlying LLM for the given question.
QaQuestion.MetricsOrBuilder	getMetricsOrBuilder() Metrics of the underlying tuned LLM over a holdout/test set while fine tuning the underlying LLM for the given question.
String	getName() Identifier.
com.google.protobuf.ByteString	getNameBytes() Identifier.
int	getOrder() Defines the order of the question within its parent scorecard revision.
String	getQuestionBody() Question text.
com.google.protobuf.ByteString	getQuestionBodyBytes() Question text.
String	getTags(int index) User-defined list of arbitrary tags for the question.
com.google.protobuf.ByteString	getTagsBytes(int index) User-defined list of arbitrary tags for the question.
int	getTagsCount() User-defined list of arbitrary tags for the question.
List<String>	getTagsList() User-defined list of arbitrary tags for the question.
QaQuestion.TuningMetadata	getTuningMetadata() Metadata about the tuning operation for the question.This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.
QaQuestion.TuningMetadataOrBuilder	getTuningMetadataOrBuilder() Metadata about the tuning operation for the question.This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
boolean	hasMetrics() Metrics of the underlying tuned LLM over a holdout/test set while fine tuning the underlying LLM for the given question.
boolean	hasTuningMetadata() Metadata about the tuning operation for the question.This field will only be populated if and only if the question is part of a scorecard revision that has been tuned.
boolean	hasUpdateTime() 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

getName

String getName()

 Identifier. The resource name of the question.
 Format:
 projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}
 

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Identifier. The resource name of the question.
 Format:
 projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}
 

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns:

The bytes for name.

getAbbreviation

String getAbbreviation()

 Short, descriptive string, used in the UI where it's not practical
 to display the full question body. E.g., "Greeting".
 

string abbreviation = 2;

Returns:

The abbreviation.

getAbbreviationBytes

com.google.protobuf.ByteString getAbbreviationBytes()

 Short, descriptive string, used in the UI where it's not practical
 to display the full question body. E.g., "Greeting".
 

string abbreviation = 2;

Returns:

The bytes for abbreviation.

hasCreateTime

boolean hasCreateTime()

 Output only. The time at which this question was created.
 

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. The time at which this question was created.
 

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. The time at which this question was created.
 

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasUpdateTime

boolean hasUpdateTime()

 Output only. The most recent time at which the question was updated.
 

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.Timestamp getUpdateTime()

 Output only. The most recent time at which the question was updated.
 

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. The most recent time at which the question was updated.
 

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

getQuestionBody

String getQuestionBody()

 Question text. E.g., "Did the agent greet the customer?"
 

string question_body = 5;

Returns:

The questionBody.

getQuestionBodyBytes

com.google.protobuf.ByteString getQuestionBodyBytes()

 Question text. E.g., "Did the agent greet the customer?"
 

string question_body = 5;

Returns:

The bytes for questionBody.

getAnswerInstructions

String getAnswerInstructions()

 Instructions describing how to determine the answer.
 

string answer_instructions = 9;

Returns:

The answerInstructions.

getAnswerInstructionsBytes

com.google.protobuf.ByteString getAnswerInstructionsBytes()

 Instructions describing how to determine the answer.
 

string answer_instructions = 9;

Returns:

The bytes for answerInstructions.

getAnswerChoicesList

List<QaQuestion.AnswerChoice> getAnswerChoicesList()

 A list of valid answers to the question, which the LLM must choose from.
 

repeated .google.cloud.contactcenterinsights.v1.QaQuestion.AnswerChoice answer_choices = 6;

getAnswerChoices

QaQuestion.AnswerChoice getAnswerChoices(int index)

 A list of valid answers to the question, which the LLM must choose from.
 

repeated .google.cloud.contactcenterinsights.v1.QaQuestion.AnswerChoice answer_choices = 6;

getAnswerChoicesCount

int getAnswerChoicesCount()

 A list of valid answers to the question, which the LLM must choose from.
 

repeated .google.cloud.contactcenterinsights.v1.QaQuestion.AnswerChoice answer_choices = 6;

getAnswerChoicesOrBuilderList

List<? extends QaQuestion.AnswerChoiceOrBuilder> getAnswerChoicesOrBuilderList()

 A list of valid answers to the question, which the LLM must choose from.
 

repeated .google.cloud.contactcenterinsights.v1.QaQuestion.AnswerChoice answer_choices = 6;

getAnswerChoicesOrBuilder

QaQuestion.AnswerChoiceOrBuilder getAnswerChoicesOrBuilder(int index)

 A list of valid answers to the question, which the LLM must choose from.
 

repeated .google.cloud.contactcenterinsights.v1.QaQuestion.AnswerChoice answer_choices = 6;

getTagsList

List<String> getTagsList()

 User-defined list of arbitrary tags for the question. Used for
 grouping/organization and for weighting the score of each question.
 

repeated string tags = 7;

Returns:

A list containing the tags.

getTagsCount

int getTagsCount()

 User-defined list of arbitrary tags for the question. Used for
 grouping/organization and for weighting the score of each question.
 

repeated string tags = 7;

Returns:

The count of tags.

getTags

String getTags(int index)

 User-defined list of arbitrary tags for the question. Used for
 grouping/organization and for weighting the score of each question.
 

repeated string tags = 7;

Parameters:

index - The index of the element to return.

Returns:

The tags at the given index.

getTagsBytes

com.google.protobuf.ByteString getTagsBytes(int index)

 User-defined list of arbitrary tags for the question. Used for
 grouping/organization and for weighting the score of each question.
 

repeated string tags = 7;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the tags at the given index.

getOrder

int getOrder()

 Defines the order of the question within its parent scorecard revision.
 

int32 order = 8;

Returns:

The order.

hasMetrics

boolean hasMetrics()

 Metrics of the underlying tuned LLM over a holdout/test set while fine
 tuning the underlying LLM for the given question. This field will only be
 populated if and only if the question is part of a scorecard revision that
 has been tuned.
 

.google.cloud.contactcenterinsights.v1.QaQuestion.Metrics metrics = 10;

Returns:

Whether the metrics field is set.

getMetrics

QaQuestion.Metrics getMetrics()

 Metrics of the underlying tuned LLM over a holdout/test set while fine
 tuning the underlying LLM for the given question. This field will only be
 populated if and only if the question is part of a scorecard revision that
 has been tuned.
 

.google.cloud.contactcenterinsights.v1.QaQuestion.Metrics metrics = 10;

Returns:

The metrics.

getMetricsOrBuilder

QaQuestion.MetricsOrBuilder getMetricsOrBuilder()

 Metrics of the underlying tuned LLM over a holdout/test set while fine
 tuning the underlying LLM for the given question. This field will only be
 populated if and only if the question is part of a scorecard revision that
 has been tuned.
 

.google.cloud.contactcenterinsights.v1.QaQuestion.Metrics metrics = 10;

hasTuningMetadata

boolean hasTuningMetadata()

 Metadata about the tuning operation for the question.This field will only
 be populated if and only if the question is part of a scorecard revision
 that has been tuned.
 

.google.cloud.contactcenterinsights.v1.QaQuestion.TuningMetadata tuning_metadata = 11;

Returns:

Whether the tuningMetadata field is set.

getTuningMetadata

QaQuestion.TuningMetadata getTuningMetadata()

 Metadata about the tuning operation for the question.This field will only
 be populated if and only if the question is part of a scorecard revision
 that has been tuned.
 

.google.cloud.contactcenterinsights.v1.QaQuestion.TuningMetadata tuning_metadata = 11;

Returns:

The tuningMetadata.

getTuningMetadataOrBuilder

QaQuestion.TuningMetadataOrBuilder getTuningMetadataOrBuilder()

 Metadata about the tuning operation for the question.This field will only
 be populated if and only if the question is part of a scorecard revision
 that has been tuned.
 

.google.cloud.contactcenterinsights.v1.QaQuestion.TuningMetadata tuning_metadata = 11;