Class QaQuestion (2.55.0)

public final class QaQuestion extends GeneratedMessageV3 implements QaQuestionOrBuilder

A single question to be scored by the Insights QA feature.

Protobuf type google.cloud.contactcenterinsights.v1.QaQuestion

Implements

QaQuestionOrBuilder

Static Fields

ABBREVIATION_FIELD_NUMBER

public static final int ABBREVIATION_FIELD_NUMBER
Field Value
Type Description
int

ANSWER_CHOICES_FIELD_NUMBER

public static final int ANSWER_CHOICES_FIELD_NUMBER
Field Value
Type Description
int

ANSWER_INSTRUCTIONS_FIELD_NUMBER

public static final int ANSWER_INSTRUCTIONS_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

ORDER_FIELD_NUMBER

public static final int ORDER_FIELD_NUMBER
Field Value
Type Description
int

QUESTION_BODY_FIELD_NUMBER

public static final int QUESTION_BODY_FIELD_NUMBER
Field Value
Type Description
int

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER
Field Value
Type Description
int

TUNING_METADATA_FIELD_NUMBER

public static final int TUNING_METADATA_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static QaQuestion getDefaultInstance()
Returns
Type Description
QaQuestion

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static QaQuestion.Builder newBuilder()
Returns
Type Description
QaQuestion.Builder

newBuilder(QaQuestion prototype)

public static QaQuestion.Builder newBuilder(QaQuestion prototype)
Parameter
Name Description
prototype QaQuestion
Returns
Type Description
QaQuestion.Builder

parseDelimitedFrom(InputStream input)

public static QaQuestion parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QaQuestion
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QaQuestion parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QaQuestion
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static QaQuestion parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
QaQuestion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static QaQuestion parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QaQuestion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static QaQuestion parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
QaQuestion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static QaQuestion parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QaQuestion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static QaQuestion parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
QaQuestion
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static QaQuestion parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QaQuestion
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static QaQuestion parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QaQuestion
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QaQuestion parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QaQuestion
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static QaQuestion parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
QaQuestion
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static QaQuestion parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QaQuestion
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<QaQuestion> parser()
Returns
Type Description
Parser<QaQuestion>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAbbreviation()

public 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 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 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 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 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 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 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 String getAnswerInstructions()

Instructions describing how to determine the answer.

string answer_instructions = 9;

Returns
Type Description
String

The answerInstructions.

getAnswerInstructionsBytes()

public ByteString getAnswerInstructionsBytes()

Instructions describing how to determine the answer.

string answer_instructions = 9;

Returns
Type Description
ByteString

The bytes for answerInstructions.

getCreateTime()

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

getDefaultInstanceForType()

public QaQuestion getDefaultInstanceForType()
Returns
Type Description
QaQuestion

getMetrics()

public 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 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 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 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 int getOrder()

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

int32 order = 8;

Returns
Type Description
int

The order.

getParserForType()

public Parser<QaQuestion> getParserForType()
Returns
Type Description
Parser<QaQuestion>
Overrides

getQuestionBody()

public String getQuestionBody()

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

string question_body = 5;

Returns
Type Description
String

The questionBody.

getQuestionBodyBytes()

public ByteString getQuestionBodyBytes()

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

string question_body = 5;

Returns
Type Description
ByteString

The bytes for questionBody.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTags(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList

A list containing the tags.

getTuningMetadata()

public 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 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 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 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 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public QaQuestion.Builder newBuilderForType()
Returns
Type Description
QaQuestion.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected QaQuestion.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
QaQuestion.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public QaQuestion.Builder toBuilder()
Returns
Type Description
QaQuestion.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException