Class protos.google.cloud.language.v1.AnnotateTextResponse (5.1.2)

Version 5.1.2

• 6.5.0 (latest)
• 5.2.2
• 5.1.2
• 5.0.2
• 4.3.2
• 4.2.9

Represents an AnnotateTextResponse.

Package

@google-cloud/language

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.language.v1.IAnnotateTextResponse);

Constructs a new AnnotateTextResponse.

Parameter

Name	Description
properties	IAnnotateTextResponse Properties to set

Properties

categories

public categories: google.cloud.language.v1.IClassificationCategory[];

AnnotateTextResponse categories.

documentSentiment

public documentSentiment?: (google.cloud.language.v1.ISentiment|null);

AnnotateTextResponse documentSentiment.

entities

public entities: google.cloud.language.v1.IEntity[];

AnnotateTextResponse entities.

language

public language: string;

AnnotateTextResponse language.

sentences

public sentences: google.cloud.language.v1.ISentence[];

AnnotateTextResponse sentences.

tokens

public tokens: google.cloud.language.v1.IToken[];

AnnotateTextResponse tokens.

Methods

create(properties)

public static create(properties?: google.cloud.language.v1.IAnnotateTextResponse): google.cloud.language.v1.AnnotateTextResponse;

Creates a new AnnotateTextResponse instance using the specified properties.

Parameter

Name	Description
properties	IAnnotateTextResponse Properties to set

Returns

Type	Description
google.cloud.language.v1.AnnotateTextResponse	AnnotateTextResponse instance

decode(reader, length)

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

Decodes an AnnotateTextResponse 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.language.v1.AnnotateTextResponse	AnnotateTextResponse

decodeDelimited(reader)

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

Decodes an AnnotateTextResponse 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.language.v1.AnnotateTextResponse	AnnotateTextResponse

encode(message, writer)

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

Encodes the specified AnnotateTextResponse message. Does not implicitly messages.

Parameters

Name	Description
message	IAnnotateTextResponse AnnotateTextResponse 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.language.v1.IAnnotateTextResponse, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	IAnnotateTextResponse AnnotateTextResponse 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.language.v1.AnnotateTextResponse;

Creates an AnnotateTextResponse 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.language.v1.AnnotateTextResponse	AnnotateTextResponse

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AnnotateTextResponse

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

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	google.cloud.language.v1.AnnotateTextResponse AnnotateTextResponse
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 AnnotateTextResponse 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