Class protos.google.cloud.dialogflow.v2.GeneratorEvaluation (7.5.0)

Represents a GeneratorEvaluation.

Package

@google-cloud/dialogflow

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dialogflow.v2.IGeneratorEvaluation);

Constructs a new GeneratorEvaluation.

Parameter
Name Description
properties IGeneratorEvaluation

Properties to set

Properties

completeTime

public completeTime?: (google.protobuf.ITimestamp|null);

GeneratorEvaluation completeTime.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

GeneratorEvaluation createTime.

displayName

public displayName: string;

GeneratorEvaluation displayName.

evaluationStatus

public evaluationStatus?: (google.cloud.dialogflow.v2.IEvaluationStatus|null);

GeneratorEvaluation evaluationStatus.

generatorEvaluationConfig

public generatorEvaluationConfig?: (google.cloud.dialogflow.v2.IGeneratorEvaluationConfig|null);

GeneratorEvaluation generatorEvaluationConfig.

initialGenerator

public initialGenerator?: (google.cloud.dialogflow.v2.IGenerator|null);

GeneratorEvaluation initialGenerator.

metrics

public metrics?: "summarizationMetrics";

GeneratorEvaluation metrics.

name

public name: string;

GeneratorEvaluation name.

satisfiesPzi

public satisfiesPzi?: (boolean|null);

GeneratorEvaluation satisfiesPzi.

satisfiesPzs

public satisfiesPzs?: (boolean|null);

GeneratorEvaluation satisfiesPzs.

summarizationMetrics

public summarizationMetrics?: (google.cloud.dialogflow.v2.ISummarizationEvaluationMetrics|null);

GeneratorEvaluation summarizationMetrics.

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.v2.IGeneratorEvaluation): google.cloud.dialogflow.v2.GeneratorEvaluation;

Creates a new GeneratorEvaluation instance using the specified properties.

Parameter
Name Description
properties IGeneratorEvaluation

Properties to set

Returns
Type Description
GeneratorEvaluation

GeneratorEvaluation instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dialogflow.v2.GeneratorEvaluation;

Decodes a GeneratorEvaluation message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
GeneratorEvaluation

GeneratorEvaluation

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dialogflow.v2.GeneratorEvaluation;

Decodes a GeneratorEvaluation message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
GeneratorEvaluation

GeneratorEvaluation

encode(message, writer)

public static encode(message: google.cloud.dialogflow.v2.IGeneratorEvaluation, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GeneratorEvaluation message. Does not implicitly messages.

Parameters
Name Description
message IGeneratorEvaluation

GeneratorEvaluation message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.dialogflow.v2.IGeneratorEvaluation, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GeneratorEvaluation message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IGeneratorEvaluation

GeneratorEvaluation message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.dialogflow.v2.GeneratorEvaluation;

Creates a GeneratorEvaluation message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
GeneratorEvaluation

GeneratorEvaluation

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for GeneratorEvaluation

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this GeneratorEvaluation to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.dialogflow.v2.GeneratorEvaluation, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a GeneratorEvaluation message. Also converts values to other types if specified.

Parameters
Name Description
message GeneratorEvaluation

GeneratorEvaluation

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a GeneratorEvaluation message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not