Class protos.google.cloud.automl.v1beta1.ModelEvaluation (4.0.1)

Represents a ModelEvaluation.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.automl.v1beta1.IModelEvaluation);

Constructs a new ModelEvaluation.

Parameter
Name	Description
`properties`	`IModelEvaluation` Properties to set

Properties

annotationSpecId

public annotationSpecId: string;

ModelEvaluation annotationSpecId.

classificationEvaluationMetrics

public classificationEvaluationMetrics?: (google.cloud.automl.v1beta1.IClassificationEvaluationMetrics|null);

ModelEvaluation classificationEvaluationMetrics.

createTime

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

ModelEvaluation createTime.

displayName

public displayName: string;

ModelEvaluation displayName.

evaluatedExampleCount

public evaluatedExampleCount: number;

ModelEvaluation evaluatedExampleCount.

imageObjectDetectionEvaluationMetrics

public imageObjectDetectionEvaluationMetrics?: (google.cloud.automl.v1beta1.IImageObjectDetectionEvaluationMetrics|null);

ModelEvaluation imageObjectDetectionEvaluationMetrics.

metrics

public metrics?: ("classificationEvaluationMetrics"|"regressionEvaluationMetrics"|"translationEvaluationMetrics"|"imageObjectDetectionEvaluationMetrics"|"videoObjectTrackingEvaluationMetrics"|"textSentimentEvaluationMetrics"|"textExtractionEvaluationMetrics");

ModelEvaluation metrics.

name

public name: string;

ModelEvaluation name.

regressionEvaluationMetrics

public regressionEvaluationMetrics?: (google.cloud.automl.v1beta1.IRegressionEvaluationMetrics|null);

ModelEvaluation regressionEvaluationMetrics.

textExtractionEvaluationMetrics

public textExtractionEvaluationMetrics?: (google.cloud.automl.v1beta1.ITextExtractionEvaluationMetrics|null);

ModelEvaluation textExtractionEvaluationMetrics.

textSentimentEvaluationMetrics

public textSentimentEvaluationMetrics?: (google.cloud.automl.v1beta1.ITextSentimentEvaluationMetrics|null);

ModelEvaluation textSentimentEvaluationMetrics.

translationEvaluationMetrics

public translationEvaluationMetrics?: (google.cloud.automl.v1beta1.ITranslationEvaluationMetrics|null);

ModelEvaluation translationEvaluationMetrics.

videoObjectTrackingEvaluationMetrics

public videoObjectTrackingEvaluationMetrics?: (google.cloud.automl.v1beta1.IVideoObjectTrackingEvaluationMetrics|null);

ModelEvaluation videoObjectTrackingEvaluationMetrics.

Methods

create(properties)

public static create(properties?: google.cloud.automl.v1beta1.IModelEvaluation): google.cloud.automl.v1beta1.ModelEvaluation;

Creates a new ModelEvaluation instance using the specified properties.

Parameter
Name	Description
`properties`	`IModelEvaluation` Properties to set

Returns
Type	Description
`ModelEvaluation`	ModelEvaluation instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.automl.v1beta1.ModelEvaluation;

Decodes a ModelEvaluation 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
`ModelEvaluation`	ModelEvaluation

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.automl.v1beta1.ModelEvaluation;

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

Parameter
Name	Description
`reader`	`(Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`ModelEvaluation`	ModelEvaluation

encode(message, writer)

public static encode(message: google.cloud.automl.v1beta1.IModelEvaluation, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ModelEvaluation message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IModelEvaluation` ModelEvaluation 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.automl.v1beta1.IModelEvaluation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IModelEvaluation` ModelEvaluation 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.automl.v1beta1.ModelEvaluation;

Creates a ModelEvaluation 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
`ModelEvaluation`	ModelEvaluation

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ModelEvaluation

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 ModelEvaluation to JSON.

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`ModelEvaluation` ModelEvaluation
`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 ModelEvaluation 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