Interface QaQuestionOrBuilder (2.55.0) 

public interface QaQuestionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAbbreviation()

public abstract 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
Type Description
String

The abbreviation.

getAbbreviationBytes()

public abstract 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
Type Description
ByteString

The bytes for abbreviation.

getAnswerChoices(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
QaQuestion.AnswerChoice

getAnswerChoicesCount()

public abstract 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;

Returns
Type Description
int

getAnswerChoicesList()

public abstract 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;

Returns
Type Description
List<AnswerChoice>

getAnswerChoicesOrBuilder(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
QaQuestion.AnswerChoiceOrBuilder

getAnswerChoicesOrBuilderList()

public abstract 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;

Returns
Type Description
List<? extends com.google.cloud.contactcenterinsights.v1.QaQuestion.AnswerChoiceOrBuilder>

getAnswerInstructions()

public abstract String getAnswerInstructions()

Instructions describing how to determine the answer.

string answer_instructions = 9;

Returns
Type Description
String

The answerInstructions.

getAnswerInstructionsBytes()

public abstract ByteString getAnswerInstructionsBytes()

Instructions describing how to determine the answer.

string answer_instructions = 9;

Returns
Type Description
ByteString

The bytes for answerInstructions.

getCreateTime()

public abstract 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
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

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

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

Returns
Type Description
TimestampOrBuilder

getMetrics()

public abstract 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
Type Description
QaQuestion.Metrics

The metrics.

getMetricsOrBuilder()

public abstract 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;

Returns
Type Description
QaQuestion.MetricsOrBuilder

getName()

public abstract 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
Type Description
String

The name.

getNameBytes()

public abstract 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
Type Description
ByteString

The bytes for name.

getOrder()

public abstract int getOrder()

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

int32 order = 8;

Returns
Type Description
int

The order.

getQuestionBody()

public abstract String getQuestionBody()

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

string question_body = 5;

Returns
Type Description
String

The questionBody.

getQuestionBodyBytes()

public abstract ByteString getQuestionBodyBytes()

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

string question_body = 5;

Returns
Type Description
ByteString

The bytes for questionBody.

getTags(int index)

public abstract 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;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The tags at the given index.

getTagsBytes(int index)

public abstract 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;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the tags at the given index.

getTagsCount()

public abstract 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
Type Description
int

The count of tags.

getTagsList()

public abstract 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
Type Description
List<String>

A list containing the tags.

getTuningMetadata()

public abstract 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
Type Description
QaQuestion.TuningMetadata

The tuningMetadata.

getTuningMetadataOrBuilder()

public abstract 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;

Returns
Type Description
QaQuestion.TuningMetadataOrBuilder

getUpdateTime()

public abstract 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
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public abstract 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
Type Description
boolean

Whether the createTime field is set.

hasMetrics()

public abstract 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
Type Description
boolean

Whether the metrics field is set.

hasTuningMetadata()

public abstract 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
Type Description
boolean

Whether the tuningMetadata field is set.

hasUpdateTime()

public abstract 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
Type Description
boolean

Whether the updateTime field is set.