Google Cloud Dialogflow V2 Client - Class GeneratorEvaluation (2.3.0)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class GeneratorEvaluation.

Represents evaluation result of a generator.

Generated from protobuf message google.cloud.dialogflow.v2.GeneratorEvaluation

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Output only. Identifier. The resource name of the evaluation. Format: projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>/ evaluations/<Evaluation ID>

↳ display_name
string

Optional. The display name of the generator evaluation. At most 64 bytes long.

↳ generator_evaluation_config
GeneratorEvaluationConfig

Required. The configuration of the evaluation task.

↳ create_time
Google\Protobuf\Timestamp

Output only. Creation time of this generator evaluation.

↳ complete_time
Google\Protobuf\Timestamp

Output only. Completion time of this generator evaluation.

↳ initial_generator
Generator

Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation.

↳ summarization_metrics
SummarizationEvaluationMetrics

Output only. Only available when the summarization generator is provided.

↳ evaluation_status
EvaluationStatus

Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message.

↳ satisfies_pzs
bool

Output only. A read only boolean field reflecting Zone Separation status of the model. The field is an aggregated value of ZS status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status

↳ satisfies_pzi
bool

Output only. A read only boolean field reflecting Zone Isolation status of the model. The field is an aggregated value of ZI status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status

getName

Output only. Identifier. The resource name of the evaluation. Format: projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>/ evaluations/<Evaluation ID>

Returns
Type
Description
string

setName

Output only. Identifier. The resource name of the evaluation. Format: projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>/ evaluations/<Evaluation ID>

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDisplayName

Optional. The display name of the generator evaluation. At most 64 bytes long.

Returns
Type
Description
string

setDisplayName

Optional. The display name of the generator evaluation. At most 64 bytes long.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getGeneratorEvaluationConfig

Required. The configuration of the evaluation task.

Returns
Type
Description

hasGeneratorEvaluationConfig

clearGeneratorEvaluationConfig

setGeneratorEvaluationConfig

Required. The configuration of the evaluation task.

Parameter
Name
Description
Returns
Type
Description
$this

getCreateTime

Output only. Creation time of this generator evaluation.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. Creation time of this generator evaluation.

Parameter
Name
Description
Returns
Type
Description
$this

getCompleteTime

Output only. Completion time of this generator evaluation.

Returns
Type
Description

hasCompleteTime

clearCompleteTime

setCompleteTime

Output only. Completion time of this generator evaluation.

Parameter
Name
Description
Returns
Type
Description
$this

getInitialGenerator

Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation.

Returns
Type
Description
Generator |null

hasInitialGenerator

clearInitialGenerator

setInitialGenerator

Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation.

Parameter
Name
Description
var
Returns
Type
Description
$this

getSummarizationMetrics

Output only. Only available when the summarization generator is provided.

Returns
Type
Description

hasSummarizationMetrics

setSummarizationMetrics

Output only. Only available when the summarization generator is provided.

Parameter
Name
Description
Returns
Type
Description
$this

getEvaluationStatus

Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message.

Returns
Type
Description

hasEvaluationStatus

clearEvaluationStatus

setEvaluationStatus

Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message.

Parameter
Name
Description
Returns
Type
Description
$this

getSatisfiesPzs

Output only. A read only boolean field reflecting Zone Separation status of the model. The field is an aggregated value of ZS status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status

Returns
Type
Description
bool

hasSatisfiesPzs

clearSatisfiesPzs

setSatisfiesPzs

Output only. A read only boolean field reflecting Zone Separation status of the model. The field is an aggregated value of ZS status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getSatisfiesPzi

Output only. A read only boolean field reflecting Zone Isolation status of the model. The field is an aggregated value of ZI status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status

Returns
Type
Description
bool

hasSatisfiesPzi

clearSatisfiesPzi

setSatisfiesPzi

Output only. A read only boolean field reflecting Zone Isolation status of the model. The field is an aggregated value of ZI status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getMetrics

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: