Class protos.google.cloud.vision.v1p1beta1.EntityAnnotation (3.0.1)

Version 3.0.1

• 4.3.2 (latest)
• 4.2.1
• 4.0.3
• 3.1.3
• 3.0.1
• 2.4.2
• 2.3.8

Represents an EntityAnnotation.

Package

@google-cloud/vision

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.vision.v1p1beta1.IEntityAnnotation);

Constructs a new EntityAnnotation.

Parameter

Name	Description
properties	IEntityAnnotation Properties to set

Properties

boundingPoly

public boundingPoly?: (google.cloud.vision.v1p1beta1.IBoundingPoly|null);

EntityAnnotation boundingPoly.

confidence

public confidence: number;

EntityAnnotation confidence.

description

public description: string;

EntityAnnotation description.

locale

public locale: string;

EntityAnnotation locale.

locations

public locations: google.cloud.vision.v1p1beta1.ILocationInfo[];

EntityAnnotation locations.

mid

public mid: string;

EntityAnnotation mid.

properties

public properties: google.cloud.vision.v1p1beta1.IProperty[];

EntityAnnotation properties.

score

public score: number;

EntityAnnotation score.

topicality

public topicality: number;

EntityAnnotation topicality.

Methods

create(properties)

public static create(properties?: google.cloud.vision.v1p1beta1.IEntityAnnotation): google.cloud.vision.v1p1beta1.EntityAnnotation;

Creates a new EntityAnnotation instance using the specified properties.

Parameter

Name	Description
properties	IEntityAnnotation Properties to set

Returns

Type	Description
google.cloud.vision.v1p1beta1.EntityAnnotation	EntityAnnotation instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.vision.v1p1beta1.EntityAnnotation;

Decodes an EntityAnnotation message from the specified reader or buffer.

Parameters

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from
length	number Message length if known beforehand

Returns

Type	Description
google.cloud.vision.v1p1beta1.EntityAnnotation	EntityAnnotation

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.vision.v1p1beta1.EntityAnnotation;

Decodes an EntityAnnotation message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from

Returns

Type	Description
google.cloud.vision.v1p1beta1.EntityAnnotation	EntityAnnotation

encode(message, writer)

public static encode(message: google.cloud.vision.v1p1beta1.IEntityAnnotation, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified EntityAnnotation message. Does not implicitly messages.

Parameters

Name	Description
message	IEntityAnnotation EntityAnnotation 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.vision.v1p1beta1.IEntityAnnotation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	IEntityAnnotation EntityAnnotation 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.vision.v1p1beta1.EntityAnnotation;

Creates an EntityAnnotation 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
google.cloud.vision.v1p1beta1.EntityAnnotation	EntityAnnotation

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for EntityAnnotation

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

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	google.cloud.vision.v1p1beta1.EntityAnnotation EntityAnnotation
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 an EntityAnnotation 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