Google Cloud Contact Center Insights V1 Client - Class QaQuestion (2.2.0)

Reference documentation and code samples for the Google Cloud Contact Center Insights V1 Client class QaQuestion.

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

Generated from protobuf message google.cloud.contactcenterinsights.v1.QaQuestion

Namespace

Google \ Cloud \ ContactCenterInsights \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

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

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

Output only. The time at which this question was created.
↳ update_time Google\Protobuf\Timestamp

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

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

Instructions describing how to determine the answer.
↳ answer_choices array<QaQuestion\AnswerChoice>

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

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

Defines the order of the question within its parent scorecard revision.
↳ metrics QaQuestion\Metrics

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.
↳ tuning_metadata QaQuestion\TuningMetadata

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.

getName

Identifier. The resource name of the question.

Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}

Returns
Type Description
string

setName

Identifier. The resource name of the question.

Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}/qaQuestions/{qa_question}

Parameter
Name Description
var string
Returns
Type Description
$this

getAbbreviation

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

Returns
Type Description
string

setAbbreviation

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

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

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

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getQuestionBody

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

Returns
Type Description
string

setQuestionBody

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

Parameter
Name Description
var string
Returns
Type Description
$this

getAnswerInstructions

Instructions describing how to determine the answer.

Returns
Type Description
string

setAnswerInstructions

Instructions describing how to determine the answer.

Parameter
Name Description
var string
Returns
Type Description
$this

getAnswerChoices

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAnswerChoices

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

Parameter
Name Description
var array<QaQuestion\AnswerChoice>
Returns
Type Description
$this

getTags

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTags

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

Parameter
Name Description
var string[]
Returns
Type Description
$this

getOrder

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

Returns
Type Description
int

setOrder

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

Parameter
Name Description
var int
Returns
Type Description
$this

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.

Returns
Type Description
QaQuestion\Metrics|null

hasMetrics

clearMetrics

setMetrics

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.

Parameter
Name Description
var QaQuestion\Metrics
Returns
Type Description
$this

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.

Returns
Type Description
QaQuestion\TuningMetadata|null

hasTuningMetadata

clearTuningMetadata

setTuningMetadata

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.

Parameter
Name Description
var QaQuestion\TuningMetadata
Returns
Type Description
$this