Class protos.google.cloud.automl.v1.TextSentimentEvaluationMetrics (4.0.1)

Represents a TextSentimentEvaluationMetrics.

Package

@google-cloud/automl

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.automl.v1.ITextSentimentEvaluationMetrics);

Constructs a new TextSentimentEvaluationMetrics.

Parameter
NameDescription
properties ITextSentimentEvaluationMetrics

Properties to set

Properties

confusionMatrix

public confusionMatrix?: (google.cloud.automl.v1.ClassificationEvaluationMetrics.IConfusionMatrix|null);

TextSentimentEvaluationMetrics confusionMatrix.

f1Score

public f1Score: number;

TextSentimentEvaluationMetrics f1Score.

linearKappa

public linearKappa: number;

TextSentimentEvaluationMetrics linearKappa.

meanAbsoluteError

public meanAbsoluteError: number;

TextSentimentEvaluationMetrics meanAbsoluteError.

meanSquaredError

public meanSquaredError: number;

TextSentimentEvaluationMetrics meanSquaredError.

precision

public precision: number;

TextSentimentEvaluationMetrics precision.

quadraticKappa

public quadraticKappa: number;

TextSentimentEvaluationMetrics quadraticKappa.

recall

public recall: number;

TextSentimentEvaluationMetrics recall.

Methods

create(properties)

public static create(properties?: google.cloud.automl.v1.ITextSentimentEvaluationMetrics): google.cloud.automl.v1.TextSentimentEvaluationMetrics;

Creates a new TextSentimentEvaluationMetrics instance using the specified properties.

Parameter
NameDescription
properties ITextSentimentEvaluationMetrics

Properties to set

Returns
TypeDescription
TextSentimentEvaluationMetrics

TextSentimentEvaluationMetrics instance

decode(reader, length)

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

Decodes a TextSentimentEvaluationMetrics message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
TextSentimentEvaluationMetrics

TextSentimentEvaluationMetrics

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
TextSentimentEvaluationMetrics

TextSentimentEvaluationMetrics

encode(message, writer)

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

Encodes the specified TextSentimentEvaluationMetrics message. Does not implicitly messages.

Parameters
NameDescription
message ITextSentimentEvaluationMetrics

TextSentimentEvaluationMetrics message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.automl.v1.ITextSentimentEvaluationMetrics, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ITextSentimentEvaluationMetrics

TextSentimentEvaluationMetrics message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.automl.v1.TextSentimentEvaluationMetrics;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
TextSentimentEvaluationMetrics

TextSentimentEvaluationMetrics

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for TextSentimentEvaluationMetrics

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this TextSentimentEvaluationMetrics to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message TextSentimentEvaluationMetrics

TextSentimentEvaluationMetrics

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a TextSentimentEvaluationMetrics message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not