@google-cloud/language
- Version 4.3.2
- Published
- 2.22 MB
- 1 dependency
- Apache-2.0 license
Install
npm i @google-cloud/language
yarn add @google-cloud/language
pnpm add @google-cloud/language
Overview
Google Cloud Natural Language API client for Node.js
Index
Variables
Type Aliases
Namespaces
protos.google.cloud.language.v1
- AnalyzeEntitiesRequest
- AnalyzeEntitiesResponse
- AnalyzeEntitySentimentRequest
- AnalyzeEntitySentimentResponse
- AnalyzeSentimentRequest
- AnalyzeSentimentResponse
- AnalyzeSyntaxRequest
- AnalyzeSyntaxResponse
- AnnotateTextRequest
- AnnotateTextResponse
- ClassificationCategory
- ClassifyTextRequest
- ClassifyTextResponse
- DependencyEdge
- Document
- EncodingType
- Entity
- EntityMention
- IAnalyzeEntitiesRequest
- IAnalyzeEntitiesResponse
- IAnalyzeEntitySentimentRequest
- IAnalyzeEntitySentimentResponse
- IAnalyzeSentimentRequest
- IAnalyzeSentimentResponse
- IAnalyzeSyntaxRequest
- IAnalyzeSyntaxResponse
- IAnnotateTextRequest
- IAnnotateTextResponse
- IClassificationCategory
- IClassifyTextRequest
- IClassifyTextResponse
- IDependencyEdge
- IDocument
- IEntity
- IEntityMention
- IPartOfSpeech
- ISentence
- ISentiment
- ITextSpan
- IToken
- LanguageService
- PartOfSpeech
- Sentence
- Sentiment
- TextSpan
- Token
protos.google.cloud.language.v1beta2
- AnalyzeEntitiesRequest
- AnalyzeEntitiesResponse
- AnalyzeEntitySentimentRequest
- AnalyzeEntitySentimentResponse
- AnalyzeSentimentRequest
- AnalyzeSentimentResponse
- AnalyzeSyntaxRequest
- AnalyzeSyntaxResponse
- AnnotateTextRequest
- AnnotateTextResponse
- ClassificationCategory
- ClassifyTextRequest
- ClassifyTextResponse
- DependencyEdge
- Document
- EncodingType
- Entity
- EntityMention
- IAnalyzeEntitiesRequest
- IAnalyzeEntitiesResponse
- IAnalyzeEntitySentimentRequest
- IAnalyzeEntitySentimentResponse
- IAnalyzeSentimentRequest
- IAnalyzeSentimentResponse
- IAnalyzeSyntaxRequest
- IAnalyzeSyntaxResponse
- IAnnotateTextRequest
- IAnnotateTextResponse
- IClassificationCategory
- IClassifyTextRequest
- IClassifyTextResponse
- IDependencyEdge
- IDocument
- IEntity
- IEntityMention
- IPartOfSpeech
- ISentence
- ISentiment
- ITextSpan
- IToken
- LanguageService
- PartOfSpeech
- Sentence
- Sentiment
- TextSpan
- Token
protos.google.protobuf
- DescriptorProto
- EnumDescriptorProto
- EnumOptions
- EnumValueDescriptorProto
- EnumValueOptions
- ExtensionRangeOptions
- FieldDescriptorProto
- FieldOptions
- FileDescriptorProto
- FileDescriptorSet
- FileOptions
- GeneratedCodeInfo
- IDescriptorProto
- IEnumDescriptorProto
- IEnumOptions
- IEnumValueDescriptorProto
- IEnumValueOptions
- IExtensionRangeOptions
- IFieldDescriptorProto
- IFieldOptions
- IFileDescriptorProto
- IFileDescriptorSet
- IFileOptions
- IGeneratedCodeInfo
- IMessageOptions
- IMethodDescriptorProto
- IMethodOptions
- IOneofDescriptorProto
- IOneofOptions
- IServiceDescriptorProto
- IServiceOptions
- ISourceCodeInfo
- ITimestamp
- IUninterpretedOption
- MessageOptions
- MethodDescriptorProto
- MethodOptions
- OneofDescriptorProto
- OneofOptions
- ServiceDescriptorProto
- ServiceOptions
- SourceCodeInfo
- Timestamp
- UninterpretedOption
Variables
variable _default
const _default: { v1: typeof v1; v1beta2: typeof v1beta2; LanguageServiceClient: typeof v1.LanguageServiceClient;};
variable LanguageServiceClient
const LanguageServiceClient: typeof v1.LanguageServiceClient;
Type Aliases
type LanguageServiceClient
type LanguageServiceClient = v1.LanguageServiceClient;
Namespaces
namespace protos
module 'build/protos/protos.d.ts' {}
Namespace google.
namespace protos.google
namespace protos.google {}
Namespace google.
namespace protos.google.api
namespace protos.google.api {}
Namespace api.
class CustomHttpPattern
class CustomHttpPattern implements ICustomHttpPattern {}
Represents a CustomHttpPattern.
constructor
constructor(properties?: ICustomHttpPattern);
Constructs a new CustomHttpPattern.
Parameter properties
Properties to set
property kind
kind: string;
CustomHttpPattern kind.
property path
path: string;
CustomHttpPattern path.
method create
static create: ( properties?: google.api.ICustomHttpPattern) => google.api.CustomHttpPattern;
Creates a new CustomHttpPattern instance using the specified properties.
Parameter properties
Properties to set
Returns
CustomHttpPattern instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.api.CustomHttpPattern;
Decodes a CustomHttpPattern message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
CustomHttpPattern
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.api.CustomHttpPattern;
Decodes a CustomHttpPattern message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
CustomHttpPattern
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.api.ICustomHttpPattern, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified CustomHttpPattern message. Does not implicitly verify messages.
Parameter message
CustomHttpPattern message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.api.ICustomHttpPattern, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified CustomHttpPattern message, length delimited. Does not implicitly verify messages.
Parameter message
CustomHttpPattern message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.api.CustomHttpPattern;
Creates a CustomHttpPattern message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
CustomHttpPattern
method toJSON
toJSON: () => { [k: string]: any };
Converts this CustomHttpPattern to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.api.CustomHttpPattern, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from a CustomHttpPattern message. Also converts values to other types if specified.
Parameter message
CustomHttpPattern
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies a CustomHttpPattern message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class Http
class Http implements IHttp {}
Represents a Http.
constructor
constructor(properties?: IHttp);
Constructs a new Http.
Parameter properties
Properties to set
property fullyDecodeReservedExpansion
fullyDecodeReservedExpansion: boolean;
Http fullyDecodeReservedExpansion.
property rules
rules: IHttpRule[];
Http rules.
method create
static create: (properties?: google.api.IHttp) => google.api.Http;
Creates a new Http instance using the specified properties.
Parameter properties
Properties to set
Returns
Http instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.api.Http;
Decodes a Http message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
Http
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.api.Http;
Decodes a Http message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
Http
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.api.IHttp, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified Http message. Does not implicitly verify messages.
Parameter message
Http message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.api.IHttp, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified Http message, length delimited. Does not implicitly verify messages.
Parameter message
Http message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any }) => google.api.Http;
Creates a Http message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
Http
method toJSON
toJSON: () => { [k: string]: any };
Converts this Http to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.api.Http, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from a Http message. Also converts values to other types if specified.
Parameter message
Http
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies a Http message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class HttpRule
class HttpRule implements IHttpRule {}
Represents a HttpRule.
constructor
constructor(properties?: IHttpRule);
Constructs a new HttpRule.
Parameter properties
Properties to set
property additionalBindings
additionalBindings: IHttpRule[];
HttpRule additionalBindings.
property body
body: string;
HttpRule body.
property custom
custom?: ICustomHttpPattern;
HttpRule custom.
property delete
delete?: string;
HttpRule delete.
property get
get?: string;
HttpRule get.
property patch
patch?: string;
HttpRule patch.
property pattern
pattern?: 'get' | 'put' | 'post' | 'delete' | 'patch' | 'custom';
HttpRule pattern.
property post
post?: string;
HttpRule post.
property put
put?: string;
HttpRule put.
property responseBody
responseBody: string;
HttpRule responseBody.
property selector
selector: string;
HttpRule selector.
method create
static create: (properties?: google.api.IHttpRule) => google.api.HttpRule;
Creates a new HttpRule instance using the specified properties.
Parameter properties
Properties to set
Returns
HttpRule instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.api.HttpRule;
Decodes a HttpRule message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
HttpRule
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.api.HttpRule;
Decodes a HttpRule message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
HttpRule
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.api.IHttpRule, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified HttpRule message. Does not implicitly verify messages.
Parameter message
HttpRule message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.api.IHttpRule, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified HttpRule message, length delimited. Does not implicitly verify messages.
Parameter message
HttpRule message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any }) => google.api.HttpRule;
Creates a HttpRule message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
HttpRule
method toJSON
toJSON: () => { [k: string]: any };
Converts this HttpRule to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.api.HttpRule, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from a HttpRule message. Also converts values to other types if specified.
Parameter message
HttpRule
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies a HttpRule message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
interface ICustomHttpPattern
interface ICustomHttpPattern {}
Properties of a CustomHttpPattern.
interface IHttp
interface IHttp {}
Properties of a Http.
property fullyDecodeReservedExpansion
fullyDecodeReservedExpansion?: boolean | null;
Http fullyDecodeReservedExpansion
property rules
rules?: google.api.IHttpRule[] | null;
Http rules
interface IHttpRule
interface IHttpRule {}
Properties of a HttpRule.
property "delete"
delete?: string | null;
HttpRule delete
property additionalBindings
additionalBindings?: google.api.IHttpRule[] | null;
HttpRule additionalBindings
property body
body?: string | null;
HttpRule body
property custom
custom?: google.api.ICustomHttpPattern | null;
HttpRule custom
property get
get?: string | null;
HttpRule get
property patch
patch?: string | null;
HttpRule patch
property post
post?: string | null;
HttpRule post
property put
put?: string | null;
HttpRule put
property responseBody
responseBody?: string | null;
HttpRule responseBody
property selector
selector?: string | null;
HttpRule selector
enum FieldBehavior
enum FieldBehavior { FIELD_BEHAVIOR_UNSPECIFIED = 0, OPTIONAL = 1, REQUIRED = 2, OUTPUT_ONLY = 3, INPUT_ONLY = 4, IMMUTABLE = 5, UNORDERED_LIST = 6, NON_EMPTY_DEFAULT = 7,}
FieldBehavior enum.
member FIELD_BEHAVIOR_UNSPECIFIED
FIELD_BEHAVIOR_UNSPECIFIED = 0
member IMMUTABLE
IMMUTABLE = 5
member INPUT_ONLY
INPUT_ONLY = 4
member NON_EMPTY_DEFAULT
NON_EMPTY_DEFAULT = 7
member OPTIONAL
OPTIONAL = 1
member OUTPUT_ONLY
OUTPUT_ONLY = 3
member REQUIRED
REQUIRED = 2
member UNORDERED_LIST
UNORDERED_LIST = 6
namespace protos.google.cloud
namespace protos.google.cloud {}
Namespace cloud.
namespace protos.google.cloud.language
namespace protos.google.cloud.language {}
Namespace language.
namespace protos.google.cloud.language.v1
namespace protos.google.cloud.language.v1 {}
Namespace v1.
class AnalyzeEntitiesRequest
class AnalyzeEntitiesRequest implements IAnalyzeEntitiesRequest {}
Represents an AnalyzeEntitiesRequest.
constructor
constructor(properties?: IAnalyzeEntitiesRequest);
Constructs a new AnalyzeEntitiesRequest.
Parameter properties
Properties to set
property document
document?: IDocument;
AnalyzeEntitiesRequest document.
property encodingType
encodingType: EncodingType | 'NONE' | 'UTF8' | 'UTF16' | 'UTF32';
AnalyzeEntitiesRequest encodingType.
method create
static create: ( properties?: google.cloud.language.v1.IAnalyzeEntitiesRequest) => google.cloud.language.v1.AnalyzeEntitiesRequest;
Creates a new AnalyzeEntitiesRequest instance using the specified properties.
Parameter properties
Properties to set
Returns
AnalyzeEntitiesRequest instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.AnalyzeEntitiesRequest;
Decodes an AnalyzeEntitiesRequest message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
AnalyzeEntitiesRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.AnalyzeEntitiesRequest;
Decodes an AnalyzeEntitiesRequest message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
AnalyzeEntitiesRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.IAnalyzeEntitiesRequest, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnalyzeEntitiesRequest message. Does not implicitly verify messages.
Parameter message
AnalyzeEntitiesRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.IAnalyzeEntitiesRequest, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnalyzeEntitiesRequest message, length delimited. Does not implicitly verify messages.
Parameter message
AnalyzeEntitiesRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.AnalyzeEntitiesRequest;
Creates an AnalyzeEntitiesRequest message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
AnalyzeEntitiesRequest
method toJSON
toJSON: () => { [k: string]: any };
Converts this AnalyzeEntitiesRequest to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.AnalyzeEntitiesRequest, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from an AnalyzeEntitiesRequest message. Also converts values to other types if specified.
Parameter message
AnalyzeEntitiesRequest
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies an AnalyzeEntitiesRequest message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class AnalyzeEntitiesResponse
class AnalyzeEntitiesResponse implements IAnalyzeEntitiesResponse {}
Represents an AnalyzeEntitiesResponse.
constructor
constructor(properties?: IAnalyzeEntitiesResponse);
Constructs a new AnalyzeEntitiesResponse.
Parameter properties
Properties to set
property entities
entities: IEntity[];
AnalyzeEntitiesResponse entities.
property language
language: string;
AnalyzeEntitiesResponse language.
method create
static create: ( properties?: google.cloud.language.v1.IAnalyzeEntitiesResponse) => google.cloud.language.v1.AnalyzeEntitiesResponse;
Creates a new AnalyzeEntitiesResponse instance using the specified properties.
Parameter properties
Properties to set
Returns
AnalyzeEntitiesResponse instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.AnalyzeEntitiesResponse;
Decodes an AnalyzeEntitiesResponse message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
AnalyzeEntitiesResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.AnalyzeEntitiesResponse;
Decodes an AnalyzeEntitiesResponse message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
AnalyzeEntitiesResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.IAnalyzeEntitiesResponse, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnalyzeEntitiesResponse message. Does not implicitly verify messages.
Parameter message
AnalyzeEntitiesResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.IAnalyzeEntitiesResponse, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnalyzeEntitiesResponse message, length delimited. Does not implicitly verify messages.
Parameter message
AnalyzeEntitiesResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.AnalyzeEntitiesResponse;
Creates an AnalyzeEntitiesResponse message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
AnalyzeEntitiesResponse
method toJSON
toJSON: () => { [k: string]: any };
Converts this AnalyzeEntitiesResponse to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.AnalyzeEntitiesResponse, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from an AnalyzeEntitiesResponse message. Also converts values to other types if specified.
Parameter message
AnalyzeEntitiesResponse
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies an AnalyzeEntitiesResponse message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class AnalyzeEntitySentimentRequest
class AnalyzeEntitySentimentRequest implements IAnalyzeEntitySentimentRequest {}
Represents an AnalyzeEntitySentimentRequest.
constructor
constructor(properties?: IAnalyzeEntitySentimentRequest);
Constructs a new AnalyzeEntitySentimentRequest.
Parameter properties
Properties to set
property document
document?: IDocument;
AnalyzeEntitySentimentRequest document.
property encodingType
encodingType: EncodingType | 'NONE' | 'UTF8' | 'UTF16' | 'UTF32';
AnalyzeEntitySentimentRequest encodingType.
method create
static create: ( properties?: google.cloud.language.v1.IAnalyzeEntitySentimentRequest) => google.cloud.language.v1.AnalyzeEntitySentimentRequest;
Creates a new AnalyzeEntitySentimentRequest instance using the specified properties.
Parameter properties
Properties to set
Returns
AnalyzeEntitySentimentRequest instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.AnalyzeEntitySentimentRequest;
Decodes an AnalyzeEntitySentimentRequest message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
AnalyzeEntitySentimentRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.AnalyzeEntitySentimentRequest;
Decodes an AnalyzeEntitySentimentRequest message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
AnalyzeEntitySentimentRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.IAnalyzeEntitySentimentRequest, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnalyzeEntitySentimentRequest message. Does not implicitly verify messages.
Parameter message
AnalyzeEntitySentimentRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.IAnalyzeEntitySentimentRequest, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnalyzeEntitySentimentRequest message, length delimited. Does not implicitly verify messages.
Parameter message
AnalyzeEntitySentimentRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.AnalyzeEntitySentimentRequest;
Creates an AnalyzeEntitySentimentRequest message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
AnalyzeEntitySentimentRequest
method toJSON
toJSON: () => { [k: string]: any };
Converts this AnalyzeEntitySentimentRequest to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.AnalyzeEntitySentimentRequest, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from an AnalyzeEntitySentimentRequest message. Also converts values to other types if specified.
Parameter message
AnalyzeEntitySentimentRequest
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies an AnalyzeEntitySentimentRequest message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class AnalyzeEntitySentimentResponse
class AnalyzeEntitySentimentResponse implements IAnalyzeEntitySentimentResponse {}
Represents an AnalyzeEntitySentimentResponse.
constructor
constructor(properties?: IAnalyzeEntitySentimentResponse);
Constructs a new AnalyzeEntitySentimentResponse.
Parameter properties
Properties to set
property entities
entities: IEntity[];
AnalyzeEntitySentimentResponse entities.
property language
language: string;
AnalyzeEntitySentimentResponse language.
method create
static create: ( properties?: google.cloud.language.v1.IAnalyzeEntitySentimentResponse) => google.cloud.language.v1.AnalyzeEntitySentimentResponse;
Creates a new AnalyzeEntitySentimentResponse instance using the specified properties.
Parameter properties
Properties to set
Returns
AnalyzeEntitySentimentResponse instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.AnalyzeEntitySentimentResponse;
Decodes an AnalyzeEntitySentimentResponse message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
AnalyzeEntitySentimentResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.AnalyzeEntitySentimentResponse;
Decodes an AnalyzeEntitySentimentResponse message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
AnalyzeEntitySentimentResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.IAnalyzeEntitySentimentResponse, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnalyzeEntitySentimentResponse message. Does not implicitly verify messages.
Parameter message
AnalyzeEntitySentimentResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.IAnalyzeEntitySentimentResponse, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnalyzeEntitySentimentResponse message, length delimited. Does not implicitly verify messages.
Parameter message
AnalyzeEntitySentimentResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.AnalyzeEntitySentimentResponse;
Creates an AnalyzeEntitySentimentResponse message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
AnalyzeEntitySentimentResponse
method toJSON
toJSON: () => { [k: string]: any };
Converts this AnalyzeEntitySentimentResponse to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.AnalyzeEntitySentimentResponse, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from an AnalyzeEntitySentimentResponse message. Also converts values to other types if specified.
Parameter message
AnalyzeEntitySentimentResponse
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies an AnalyzeEntitySentimentResponse message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class AnalyzeSentimentRequest
class AnalyzeSentimentRequest implements IAnalyzeSentimentRequest {}
Represents an AnalyzeSentimentRequest.
constructor
constructor(properties?: IAnalyzeSentimentRequest);
Constructs a new AnalyzeSentimentRequest.
Parameter properties
Properties to set
property document
document?: IDocument;
AnalyzeSentimentRequest document.
property encodingType
encodingType: EncodingType | 'NONE' | 'UTF8' | 'UTF16' | 'UTF32';
AnalyzeSentimentRequest encodingType.
method create
static create: ( properties?: google.cloud.language.v1.IAnalyzeSentimentRequest) => google.cloud.language.v1.AnalyzeSentimentRequest;
Creates a new AnalyzeSentimentRequest instance using the specified properties.
Parameter properties
Properties to set
Returns
AnalyzeSentimentRequest instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.AnalyzeSentimentRequest;
Decodes an AnalyzeSentimentRequest message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
AnalyzeSentimentRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.AnalyzeSentimentRequest;
Decodes an AnalyzeSentimentRequest message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
AnalyzeSentimentRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.IAnalyzeSentimentRequest, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnalyzeSentimentRequest message. Does not implicitly verify messages.
Parameter message
AnalyzeSentimentRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.IAnalyzeSentimentRequest, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnalyzeSentimentRequest message, length delimited. Does not implicitly verify messages.
Parameter message
AnalyzeSentimentRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.AnalyzeSentimentRequest;
Creates an AnalyzeSentimentRequest message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
AnalyzeSentimentRequest
method toJSON
toJSON: () => { [k: string]: any };
Converts this AnalyzeSentimentRequest to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.AnalyzeSentimentRequest, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from an AnalyzeSentimentRequest message. Also converts values to other types if specified.
Parameter message
AnalyzeSentimentRequest
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies an AnalyzeSentimentRequest message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class AnalyzeSentimentResponse
class AnalyzeSentimentResponse implements IAnalyzeSentimentResponse {}
Represents an AnalyzeSentimentResponse.
constructor
constructor(properties?: IAnalyzeSentimentResponse);
Constructs a new AnalyzeSentimentResponse.
Parameter properties
Properties to set
property documentSentiment
documentSentiment?: ISentiment;
AnalyzeSentimentResponse documentSentiment.
property language
language: string;
AnalyzeSentimentResponse language.
property sentences
sentences: ISentence[];
AnalyzeSentimentResponse sentences.
method create
static create: ( properties?: google.cloud.language.v1.IAnalyzeSentimentResponse) => google.cloud.language.v1.AnalyzeSentimentResponse;
Creates a new AnalyzeSentimentResponse instance using the specified properties.
Parameter properties
Properties to set
Returns
AnalyzeSentimentResponse instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.AnalyzeSentimentResponse;
Decodes an AnalyzeSentimentResponse message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
AnalyzeSentimentResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.AnalyzeSentimentResponse;
Decodes an AnalyzeSentimentResponse message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
AnalyzeSentimentResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.IAnalyzeSentimentResponse, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnalyzeSentimentResponse message. Does not implicitly verify messages.
Parameter message
AnalyzeSentimentResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.IAnalyzeSentimentResponse, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnalyzeSentimentResponse message, length delimited. Does not implicitly verify messages.
Parameter message
AnalyzeSentimentResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.AnalyzeSentimentResponse;
Creates an AnalyzeSentimentResponse message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
AnalyzeSentimentResponse
method toJSON
toJSON: () => { [k: string]: any };
Converts this AnalyzeSentimentResponse to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.AnalyzeSentimentResponse, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from an AnalyzeSentimentResponse message. Also converts values to other types if specified.
Parameter message
AnalyzeSentimentResponse
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies an AnalyzeSentimentResponse message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class AnalyzeSyntaxRequest
class AnalyzeSyntaxRequest implements IAnalyzeSyntaxRequest {}
Represents an AnalyzeSyntaxRequest.
constructor
constructor(properties?: IAnalyzeSyntaxRequest);
Constructs a new AnalyzeSyntaxRequest.
Parameter properties
Properties to set
property document
document?: IDocument;
AnalyzeSyntaxRequest document.
property encodingType
encodingType: EncodingType | 'NONE' | 'UTF8' | 'UTF16' | 'UTF32';
AnalyzeSyntaxRequest encodingType.
method create
static create: ( properties?: google.cloud.language.v1.IAnalyzeSyntaxRequest) => google.cloud.language.v1.AnalyzeSyntaxRequest;
Creates a new AnalyzeSyntaxRequest instance using the specified properties.
Parameter properties
Properties to set
Returns
AnalyzeSyntaxRequest instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.AnalyzeSyntaxRequest;
Decodes an AnalyzeSyntaxRequest message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
AnalyzeSyntaxRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.AnalyzeSyntaxRequest;
Decodes an AnalyzeSyntaxRequest message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
AnalyzeSyntaxRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.IAnalyzeSyntaxRequest, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnalyzeSyntaxRequest message. Does not implicitly verify messages.
Parameter message
AnalyzeSyntaxRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.IAnalyzeSyntaxRequest, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnalyzeSyntaxRequest message, length delimited. Does not implicitly verify messages.
Parameter message
AnalyzeSyntaxRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.AnalyzeSyntaxRequest;
Creates an AnalyzeSyntaxRequest message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
AnalyzeSyntaxRequest
method toJSON
toJSON: () => { [k: string]: any };
Converts this AnalyzeSyntaxRequest to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.AnalyzeSyntaxRequest, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from an AnalyzeSyntaxRequest message. Also converts values to other types if specified.
Parameter message
AnalyzeSyntaxRequest
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies an AnalyzeSyntaxRequest message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class AnalyzeSyntaxResponse
class AnalyzeSyntaxResponse implements IAnalyzeSyntaxResponse {}
Represents an AnalyzeSyntaxResponse.
constructor
constructor(properties?: IAnalyzeSyntaxResponse);
Constructs a new AnalyzeSyntaxResponse.
Parameter properties
Properties to set
property language
language: string;
AnalyzeSyntaxResponse language.
property sentences
sentences: ISentence[];
AnalyzeSyntaxResponse sentences.
property tokens
tokens: IToken[];
AnalyzeSyntaxResponse tokens.
method create
static create: ( properties?: google.cloud.language.v1.IAnalyzeSyntaxResponse) => google.cloud.language.v1.AnalyzeSyntaxResponse;
Creates a new AnalyzeSyntaxResponse instance using the specified properties.
Parameter properties
Properties to set
Returns
AnalyzeSyntaxResponse instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.AnalyzeSyntaxResponse;
Decodes an AnalyzeSyntaxResponse message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
AnalyzeSyntaxResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.AnalyzeSyntaxResponse;
Decodes an AnalyzeSyntaxResponse message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
AnalyzeSyntaxResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.IAnalyzeSyntaxResponse, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnalyzeSyntaxResponse message. Does not implicitly verify messages.
Parameter message
AnalyzeSyntaxResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.IAnalyzeSyntaxResponse, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnalyzeSyntaxResponse message, length delimited. Does not implicitly verify messages.
Parameter message
AnalyzeSyntaxResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.AnalyzeSyntaxResponse;
Creates an AnalyzeSyntaxResponse message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
AnalyzeSyntaxResponse
method toJSON
toJSON: () => { [k: string]: any };
Converts this AnalyzeSyntaxResponse to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.AnalyzeSyntaxResponse, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from an AnalyzeSyntaxResponse message. Also converts values to other types if specified.
Parameter message
AnalyzeSyntaxResponse
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies an AnalyzeSyntaxResponse message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class AnnotateTextRequest
class AnnotateTextRequest implements IAnnotateTextRequest {}
Represents an AnnotateTextRequest.
constructor
constructor(properties?: IAnnotateTextRequest);
Constructs a new AnnotateTextRequest.
Parameter properties
Properties to set
property document
document?: IDocument;
AnnotateTextRequest document.
property encodingType
encodingType: EncodingType | 'NONE' | 'UTF8' | 'UTF16' | 'UTF32';
AnnotateTextRequest encodingType.
property features
features?: AnnotateTextRequest.IFeatures;
AnnotateTextRequest features.
method create
static create: ( properties?: google.cloud.language.v1.IAnnotateTextRequest) => google.cloud.language.v1.AnnotateTextRequest;
Creates a new AnnotateTextRequest instance using the specified properties.
Parameter properties
Properties to set
Returns
AnnotateTextRequest instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.AnnotateTextRequest;
Decodes an AnnotateTextRequest message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
AnnotateTextRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.AnnotateTextRequest;
Decodes an AnnotateTextRequest message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
AnnotateTextRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.IAnnotateTextRequest, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnnotateTextRequest message. Does not implicitly verify messages.
Parameter message
AnnotateTextRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.IAnnotateTextRequest, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnnotateTextRequest message, length delimited. Does not implicitly verify messages.
Parameter message
AnnotateTextRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.AnnotateTextRequest;
Creates an AnnotateTextRequest message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
AnnotateTextRequest
method toJSON
toJSON: () => { [k: string]: any };
Converts this AnnotateTextRequest to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.AnnotateTextRequest, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from an AnnotateTextRequest message. Also converts values to other types if specified.
Parameter message
AnnotateTextRequest
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies an AnnotateTextRequest message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class AnnotateTextResponse
class AnnotateTextResponse implements IAnnotateTextResponse {}
Represents an AnnotateTextResponse.
constructor
constructor(properties?: IAnnotateTextResponse);
Constructs a new AnnotateTextResponse.
Parameter properties
Properties to set
property categories
categories: IClassificationCategory[];
AnnotateTextResponse categories.
property documentSentiment
documentSentiment?: ISentiment;
AnnotateTextResponse documentSentiment.
property entities
entities: IEntity[];
AnnotateTextResponse entities.
property language
language: string;
AnnotateTextResponse language.
property sentences
sentences: ISentence[];
AnnotateTextResponse sentences.
property tokens
tokens: IToken[];
AnnotateTextResponse tokens.
method create
static create: ( properties?: google.cloud.language.v1.IAnnotateTextResponse) => google.cloud.language.v1.AnnotateTextResponse;
Creates a new AnnotateTextResponse instance using the specified properties.
Parameter properties
Properties to set
Returns
AnnotateTextResponse instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.AnnotateTextResponse;
Decodes an AnnotateTextResponse message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
AnnotateTextResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.AnnotateTextResponse;
Decodes an AnnotateTextResponse message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
AnnotateTextResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.IAnnotateTextResponse, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnnotateTextResponse message. Does not implicitly verify messages.
Parameter message
AnnotateTextResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.IAnnotateTextResponse, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified AnnotateTextResponse message, length delimited. Does not implicitly verify messages.
Parameter message
AnnotateTextResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
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 object
Plain object
Returns
AnnotateTextResponse
method toJSON
toJSON: () => { [k: string]: any };
Converts this AnnotateTextResponse to JSON.
Returns
JSON object
method toObject
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.
Parameter message
AnnotateTextResponse
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies an AnnotateTextResponse message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class ClassificationCategory
class ClassificationCategory implements IClassificationCategory {}
Represents a ClassificationCategory.
constructor
constructor(properties?: IClassificationCategory);
Constructs a new ClassificationCategory.
Parameter properties
Properties to set
property confidence
confidence: number;
ClassificationCategory confidence.
property name
name: string;
ClassificationCategory name.
method create
static create: ( properties?: google.cloud.language.v1.IClassificationCategory) => google.cloud.language.v1.ClassificationCategory;
Creates a new ClassificationCategory instance using the specified properties.
Parameter properties
Properties to set
Returns
ClassificationCategory instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.ClassificationCategory;
Decodes a ClassificationCategory message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
ClassificationCategory
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.ClassificationCategory;
Decodes a ClassificationCategory message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
ClassificationCategory
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.IClassificationCategory, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified ClassificationCategory message. Does not implicitly verify messages.
Parameter message
ClassificationCategory message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.IClassificationCategory, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified ClassificationCategory message, length delimited. Does not implicitly verify messages.
Parameter message
ClassificationCategory message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.ClassificationCategory;
Creates a ClassificationCategory message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
ClassificationCategory
method toJSON
toJSON: () => { [k: string]: any };
Converts this ClassificationCategory to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.ClassificationCategory, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from a ClassificationCategory message. Also converts values to other types if specified.
Parameter message
ClassificationCategory
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies a ClassificationCategory message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class ClassifyTextRequest
class ClassifyTextRequest implements IClassifyTextRequest {}
Represents a ClassifyTextRequest.
constructor
constructor(properties?: IClassifyTextRequest);
Constructs a new ClassifyTextRequest.
Parameter properties
Properties to set
property document
document?: IDocument;
ClassifyTextRequest document.
method create
static create: ( properties?: google.cloud.language.v1.IClassifyTextRequest) => google.cloud.language.v1.ClassifyTextRequest;
Creates a new ClassifyTextRequest instance using the specified properties.
Parameter properties
Properties to set
Returns
ClassifyTextRequest instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.ClassifyTextRequest;
Decodes a ClassifyTextRequest message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
ClassifyTextRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.ClassifyTextRequest;
Decodes a ClassifyTextRequest message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
ClassifyTextRequest
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.IClassifyTextRequest, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified ClassifyTextRequest message. Does not implicitly verify messages.
Parameter message
ClassifyTextRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.IClassifyTextRequest, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified ClassifyTextRequest message, length delimited. Does not implicitly verify messages.
Parameter message
ClassifyTextRequest message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.ClassifyTextRequest;
Creates a ClassifyTextRequest message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
ClassifyTextRequest
method toJSON
toJSON: () => { [k: string]: any };
Converts this ClassifyTextRequest to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.ClassifyTextRequest, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from a ClassifyTextRequest message. Also converts values to other types if specified.
Parameter message
ClassifyTextRequest
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies a ClassifyTextRequest message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class ClassifyTextResponse
class ClassifyTextResponse implements IClassifyTextResponse {}
Represents a ClassifyTextResponse.
constructor
constructor(properties?: IClassifyTextResponse);
Constructs a new ClassifyTextResponse.
Parameter properties
Properties to set
property categories
categories: IClassificationCategory[];
ClassifyTextResponse categories.
method create
static create: ( properties?: google.cloud.language.v1.IClassifyTextResponse) => google.cloud.language.v1.ClassifyTextResponse;
Creates a new ClassifyTextResponse instance using the specified properties.
Parameter properties
Properties to set
Returns
ClassifyTextResponse instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.ClassifyTextResponse;
Decodes a ClassifyTextResponse message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
ClassifyTextResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.ClassifyTextResponse;
Decodes a ClassifyTextResponse message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
ClassifyTextResponse
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.IClassifyTextResponse, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified ClassifyTextResponse message. Does not implicitly verify messages.
Parameter message
ClassifyTextResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.IClassifyTextResponse, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified ClassifyTextResponse message, length delimited. Does not implicitly verify messages.
Parameter message
ClassifyTextResponse message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.ClassifyTextResponse;
Creates a ClassifyTextResponse message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
ClassifyTextResponse
method toJSON
toJSON: () => { [k: string]: any };
Converts this ClassifyTextResponse to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.ClassifyTextResponse, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from a ClassifyTextResponse message. Also converts values to other types if specified.
Parameter message
ClassifyTextResponse
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies a ClassifyTextResponse message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class DependencyEdge
class DependencyEdge implements IDependencyEdge {}
Represents a DependencyEdge.
constructor
constructor(properties?: IDependencyEdge);
Constructs a new DependencyEdge.
Parameter properties
Properties to set
property headTokenIndex
headTokenIndex: number;
DependencyEdge headTokenIndex.
property label
label: | 'UNKNOWN' | 'NUMBER' | 'CONJ' | 'DET' | 'NUM' | 'PRT' | 'VOCATIVE' | DependencyEdge.Label | 'ABBREV' | 'ACOMP' | 'ADVCL' | 'ADVMOD' | 'AMOD' | 'APPOS' | 'ATTR' | 'AUX' | 'AUXPASS' | 'CC' | 'CCOMP' | 'CSUBJ' | 'CSUBJPASS' | 'DEP' | 'DISCOURSE' | 'DOBJ' | 'EXPL' | 'GOESWITH' | 'IOBJ' | 'MARK' | 'MWE' | 'MWV' | 'NEG' | 'NN' | 'NPADVMOD' | 'NSUBJ' | 'NSUBJPASS' | 'P' | 'PARATAXIS' | 'PARTMOD' | 'PCOMP' | 'POBJ' | 'POSS' | 'POSTNEG' | 'PRECOMP' | 'PRECONJ' | 'PREDET' | 'PREF' | 'PREP' | 'PRONL' | 'PS' | 'QUANTMOD' | 'RCMOD' | 'RCMODREL' | 'RDROP' | 'REF' | 'REMNANT' | 'REPARANDUM' | 'ROOT' | 'SNUM' | 'SUFF' | 'TMOD' | 'TOPIC' | 'VMOD' | 'XCOMP' | 'SUFFIX' | 'TITLE' | 'ADVPHMOD' | 'AUXCAUS' | 'AUXVV' | 'DTMOD' | 'FOREIGN' | 'KW' | 'LIST' | 'NOMC' | 'NOMCSUBJ' | 'NOMCSUBJPASS' | 'NUMC' | 'COP' | 'DISLOCATED' | 'ASP' | 'GMOD' | 'GOBJ' | 'INFMOD' | 'MES' | 'NCOMP';
DependencyEdge label.
method create
static create: ( properties?: google.cloud.language.v1.IDependencyEdge) => google.cloud.language.v1.DependencyEdge;
Creates a new DependencyEdge instance using the specified properties.
Parameter properties
Properties to set
Returns
DependencyEdge instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.DependencyEdge;
Decodes a DependencyEdge message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
DependencyEdge
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.DependencyEdge;
Decodes a DependencyEdge message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
DependencyEdge
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.IDependencyEdge, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified DependencyEdge message. Does not implicitly verify messages.
Parameter message
DependencyEdge message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.IDependencyEdge, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified DependencyEdge message, length delimited. Does not implicitly verify messages.
Parameter message
DependencyEdge message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.DependencyEdge;
Creates a DependencyEdge message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
DependencyEdge
method toJSON
toJSON: () => { [k: string]: any };
Converts this DependencyEdge to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.DependencyEdge, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from a DependencyEdge message. Also converts values to other types if specified.
Parameter message
DependencyEdge
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies a DependencyEdge message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class Document
class Document implements IDocument {}
Represents a Document.
constructor
constructor(properties?: IDocument);
Constructs a new Document.
Parameter properties
Properties to set
property content
content?: string;
Document content.
property gcsContentUri
gcsContentUri?: string;
Document gcsContentUri.
property language
language: string;
Document language.
property source
source?: 'content' | 'gcsContentUri';
Document source.
property type
type: Document.Type | 'TYPE_UNSPECIFIED' | 'PLAIN_TEXT' | 'HTML';
Document type.
method create
static create: ( properties?: google.cloud.language.v1.IDocument) => google.cloud.language.v1.Document;
Creates a new Document instance using the specified properties.
Parameter properties
Properties to set
Returns
Document instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.Document;
Decodes a Document message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
Document
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.Document;
Decodes a Document message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
Document
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.IDocument, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified Document message. Does not implicitly verify messages.
Parameter message
Document message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.IDocument, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified Document message, length delimited. Does not implicitly verify messages.
Parameter message
Document message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.Document;
Creates a Document message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
Document
method toJSON
toJSON: () => { [k: string]: any };
Converts this Document to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.Document, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from a Document message. Also converts values to other types if specified.
Parameter message
Document
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies a Document message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class Entity
class Entity implements IEntity {}
Represents an Entity.
constructor
constructor(properties?: IEntity);
Constructs a new Entity.
Parameter properties
Properties to set
property mentions
mentions: IEntityMention[];
Entity mentions.
property metadata
metadata: { [k: string]: string };
Entity metadata.
property name
name: string;
Entity name.
property salience
salience: number;
Entity salience.
property sentiment
sentiment?: ISentiment;
Entity sentiment.
property type
type: | Entity.Type | 'UNKNOWN' | 'PERSON' | 'LOCATION' | 'ORGANIZATION' | 'EVENT' | 'WORK_OF_ART' | 'CONSUMER_GOOD' | 'OTHER' | 'PHONE_NUMBER' | 'ADDRESS' | 'DATE' | 'NUMBER' | 'PRICE';
Entity type.
method create
static create: ( properties?: google.cloud.language.v1.IEntity) => google.cloud.language.v1.Entity;
Creates a new Entity instance using the specified properties.
Parameter properties
Properties to set
Returns
Entity instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.Entity;
Decodes an Entity message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
Entity
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.Entity;
Decodes an Entity message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
Entity
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.IEntity, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified Entity message. Does not implicitly verify messages.
Parameter message
Entity message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.IEntity, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified Entity message, length delimited. Does not implicitly verify messages.
Parameter message
Entity message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.Entity;
Creates an Entity message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
Entity
method toJSON
toJSON: () => { [k: string]: any };
Converts this Entity to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.Entity, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from an Entity message. Also converts values to other types if specified.
Parameter message
Entity
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies an Entity message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class EntityMention
class EntityMention implements IEntityMention {}
Represents an EntityMention.
constructor
constructor(properties?: IEntityMention);
Constructs a new EntityMention.
Parameter properties
Properties to set
property sentiment
sentiment?: ISentiment;
EntityMention sentiment.
property text
text?: ITextSpan;
EntityMention text.
property type
type: 'PROPER' | EntityMention.Type | 'TYPE_UNKNOWN' | 'COMMON';
EntityMention type.
method create
static create: ( properties?: google.cloud.language.v1.IEntityMention) => google.cloud.language.v1.EntityMention;
Creates a new EntityMention instance using the specified properties.
Parameter properties
Properties to set
Returns
EntityMention instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.EntityMention;
Decodes an EntityMention message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
EntityMention
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.EntityMention;
Decodes an EntityMention message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
EntityMention
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.IEntityMention, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified EntityMention message. Does not implicitly verify messages.
Parameter message
EntityMention message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.IEntityMention, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified EntityMention message, length delimited. Does not implicitly verify messages.
Parameter message
EntityMention message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.EntityMention;
Creates an EntityMention message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
EntityMention
method toJSON
toJSON: () => { [k: string]: any };
Converts this EntityMention to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.EntityMention, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from an EntityMention message. Also converts values to other types if specified.
Parameter message
EntityMention
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies an EntityMention message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class LanguageService
class LanguageService extends $protobuf.rpc.Service {}
Represents a LanguageService
constructor
constructor( rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);
Constructs a new LanguageService service.
Parameter rpcImpl
RPC implementation
Parameter requestDelimited
Whether requests are length-delimited
Parameter responseDelimited
Whether responses are length-delimited
method analyzeEntities
analyzeEntities: { ( request: google.cloud.language.v1.IAnalyzeEntitiesRequest, callback: google.cloud.language.v1.LanguageService.AnalyzeEntitiesCallback ): void; (request: IAnalyzeEntitiesRequest): Promise<AnalyzeEntitiesResponse>;};
Calls AnalyzeEntities.
Parameter request
AnalyzeEntitiesRequest message or plain object
Parameter callback
Node-style callback called with the error, if any, and AnalyzeEntitiesResponse
Calls AnalyzeEntities.
Parameter request
AnalyzeEntitiesRequest message or plain object
Returns
Promise
method analyzeEntitySentiment
analyzeEntitySentiment: { ( request: google.cloud.language.v1.IAnalyzeEntitySentimentRequest, callback: google.cloud.language.v1.LanguageService.AnalyzeEntitySentimentCallback ): void; ( request: IAnalyzeEntitySentimentRequest ): Promise<AnalyzeEntitySentimentResponse>;};
Calls AnalyzeEntitySentiment.
Parameter request
AnalyzeEntitySentimentRequest message or plain object
Parameter callback
Node-style callback called with the error, if any, and AnalyzeEntitySentimentResponse
Calls AnalyzeEntitySentiment.
Parameter request
AnalyzeEntitySentimentRequest message or plain object
Returns
Promise
method analyzeSentiment
analyzeSentiment: { ( request: google.cloud.language.v1.IAnalyzeSentimentRequest, callback: google.cloud.language.v1.LanguageService.AnalyzeSentimentCallback ): void; (request: IAnalyzeSentimentRequest): Promise<AnalyzeSentimentResponse>;};
Calls AnalyzeSentiment.
Parameter request
AnalyzeSentimentRequest message or plain object
Parameter callback
Node-style callback called with the error, if any, and AnalyzeSentimentResponse
Calls AnalyzeSentiment.
Parameter request
AnalyzeSentimentRequest message or plain object
Returns
Promise
method analyzeSyntax
analyzeSyntax: { ( request: google.cloud.language.v1.IAnalyzeSyntaxRequest, callback: google.cloud.language.v1.LanguageService.AnalyzeSyntaxCallback ): void; (request: IAnalyzeSyntaxRequest): Promise<AnalyzeSyntaxResponse>;};
Calls AnalyzeSyntax.
Parameter request
AnalyzeSyntaxRequest message or plain object
Parameter callback
Node-style callback called with the error, if any, and AnalyzeSyntaxResponse
Calls AnalyzeSyntax.
Parameter request
AnalyzeSyntaxRequest message or plain object
Returns
Promise
method annotateText
annotateText: { ( request: google.cloud.language.v1.IAnnotateTextRequest, callback: google.cloud.language.v1.LanguageService.AnnotateTextCallback ): void; (request: IAnnotateTextRequest): Promise<AnnotateTextResponse>;};
Calls AnnotateText.
Parameter request
AnnotateTextRequest message or plain object
Parameter callback
Node-style callback called with the error, if any, and AnnotateTextResponse
Calls AnnotateText.
Parameter request
AnnotateTextRequest message or plain object
Returns
Promise
method classifyText
classifyText: { ( request: google.cloud.language.v1.IClassifyTextRequest, callback: google.cloud.language.v1.LanguageService.ClassifyTextCallback ): void; (request: IClassifyTextRequest): Promise<ClassifyTextResponse>;};
Calls ClassifyText.
Parameter request
ClassifyTextRequest message or plain object
Parameter callback
Node-style callback called with the error, if any, and ClassifyTextResponse
Calls ClassifyText.
Parameter request
ClassifyTextRequest message or plain object
Returns
Promise
method create
static create: ( rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean) => LanguageService;
Creates new LanguageService service using the specified rpc implementation.
Parameter rpcImpl
RPC implementation
Parameter requestDelimited
Whether requests are length-delimited
Parameter responseDelimited
Whether responses are length-delimited
Returns
RPC service. Useful where requests and/or responses are streamed.
class PartOfSpeech
class PartOfSpeech implements IPartOfSpeech {}
Represents a PartOfSpeech.
constructor
constructor(properties?: IPartOfSpeech);
Constructs a new PartOfSpeech.
Parameter properties
Properties to set
property aspect
aspect: | PartOfSpeech.Aspect | 'ASPECT_UNKNOWN' | 'PERFECTIVE' | 'IMPERFECTIVE' | 'PROGRESSIVE';
PartOfSpeech aspect.
property case
case: | PartOfSpeech.Case | 'CASE_UNKNOWN' | 'ACCUSATIVE' | 'ADVERBIAL' | 'COMPLEMENTIVE' | 'DATIVE' | 'GENITIVE' | 'INSTRUMENTAL' | 'LOCATIVE' | 'NOMINATIVE' | 'OBLIQUE' | 'PARTITIVE' | 'PREPOSITIONAL' | 'REFLEXIVE_CASE' | 'RELATIVE_CASE' | 'VOCATIVE';
PartOfSpeech case.
property form
form: | PartOfSpeech.Form | 'FORM_UNKNOWN' | 'ADNOMIAL' | 'AUXILIARY' | 'COMPLEMENTIZER' | 'FINAL_ENDING' | 'GERUND' | 'REALIS' | 'IRREALIS' | 'SHORT' | 'LONG' | 'ORDER' | 'SPECIFIC';
PartOfSpeech form.
property gender
gender: | PartOfSpeech.Gender | 'GENDER_UNKNOWN' | 'FEMININE' | 'MASCULINE' | 'NEUTER';
PartOfSpeech gender.
property mood
mood: | PartOfSpeech.Mood | 'MOOD_UNKNOWN' | 'CONDITIONAL_MOOD' | 'IMPERATIVE' | 'INDICATIVE' | 'INTERROGATIVE' | 'JUSSIVE' | 'SUBJUNCTIVE';
PartOfSpeech mood.
property number
number: PartOfSpeech.Number | 'NUMBER_UNKNOWN' | 'SINGULAR' | 'PLURAL' | 'DUAL';
PartOfSpeech number.
property person
person: | PartOfSpeech.Person | 'PERSON_UNKNOWN' | 'FIRST' | 'SECOND' | 'THIRD' | 'REFLEXIVE_PERSON';
PartOfSpeech person.
property proper
proper: PartOfSpeech.Proper | 'PROPER_UNKNOWN' | 'PROPER' | 'NOT_PROPER';
PartOfSpeech proper.
property reciprocity
reciprocity: | PartOfSpeech.Reciprocity | 'RECIPROCITY_UNKNOWN' | 'RECIPROCAL' | 'NON_RECIPROCAL';
PartOfSpeech reciprocity.
property tag
tag: | 'UNKNOWN' | PartOfSpeech.Tag | 'ADJ' | 'ADP' | 'ADV' | 'CONJ' | 'DET' | 'NOUN' | 'NUM' | 'PRON' | 'PRT' | 'PUNCT' | 'VERB' | 'X' | 'AFFIX';
PartOfSpeech tag.
property tense
tense: | PartOfSpeech.Tense | 'TENSE_UNKNOWN' | 'CONDITIONAL_TENSE' | 'FUTURE' | 'PAST' | 'PRESENT' | 'IMPERFECT' | 'PLUPERFECT';
PartOfSpeech tense.
property voice
voice: PartOfSpeech.Voice | 'VOICE_UNKNOWN' | 'ACTIVE' | 'CAUSATIVE' | 'PASSIVE';
PartOfSpeech voice.
method create
static create: ( properties?: google.cloud.language.v1.IPartOfSpeech) => google.cloud.language.v1.PartOfSpeech;
Creates a new PartOfSpeech instance using the specified properties.
Parameter properties
Properties to set
Returns
PartOfSpeech instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.PartOfSpeech;
Decodes a PartOfSpeech message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
PartOfSpeech
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.PartOfSpeech;
Decodes a PartOfSpeech message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
PartOfSpeech
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.IPartOfSpeech, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified PartOfSpeech message. Does not implicitly verify messages.
Parameter message
PartOfSpeech message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.IPartOfSpeech, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified PartOfSpeech message, length delimited. Does not implicitly verify messages.
Parameter message
PartOfSpeech message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.PartOfSpeech;
Creates a PartOfSpeech message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
PartOfSpeech
method toJSON
toJSON: () => { [k: string]: any };
Converts this PartOfSpeech to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.PartOfSpeech, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from a PartOfSpeech message. Also converts values to other types if specified.
Parameter message
PartOfSpeech
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies a PartOfSpeech message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class Sentence
class Sentence implements ISentence {}
Represents a Sentence.
constructor
constructor(properties?: ISentence);
Constructs a new Sentence.
Parameter properties
Properties to set
property sentiment
sentiment?: ISentiment;
Sentence sentiment.
property text
text?: ITextSpan;
Sentence text.
method create
static create: ( properties?: google.cloud.language.v1.ISentence) => google.cloud.language.v1.Sentence;
Creates a new Sentence instance using the specified properties.
Parameter properties
Properties to set
Returns
Sentence instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.Sentence;
Decodes a Sentence message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
Sentence
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.Sentence;
Decodes a Sentence message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
Sentence
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.ISentence, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified Sentence message. Does not implicitly verify messages.
Parameter message
Sentence message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.ISentence, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified Sentence message, length delimited. Does not implicitly verify messages.
Parameter message
Sentence message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.Sentence;
Creates a Sentence message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
Sentence
method toJSON
toJSON: () => { [k: string]: any };
Converts this Sentence to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.Sentence, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from a Sentence message. Also converts values to other types if specified.
Parameter message
Sentence
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies a Sentence message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class Sentiment
class Sentiment implements ISentiment {}
Represents a Sentiment.
constructor
constructor(properties?: ISentiment);
Constructs a new Sentiment.
Parameter properties
Properties to set
property magnitude
magnitude: number;
Sentiment magnitude.
property score
score: number;
Sentiment score.
method create
static create: ( properties?: google.cloud.language.v1.ISentiment) => google.cloud.language.v1.Sentiment;
Creates a new Sentiment instance using the specified properties.
Parameter properties
Properties to set
Returns
Sentiment instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.Sentiment;
Decodes a Sentiment message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
Sentiment
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.Sentiment;
Decodes a Sentiment message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
Sentiment
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.ISentiment, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified Sentiment message. Does not implicitly verify messages.
Parameter message
Sentiment message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.ISentiment, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified Sentiment message, length delimited. Does not implicitly verify messages.
Parameter message
Sentiment message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.Sentiment;
Creates a Sentiment message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
Sentiment
method toJSON
toJSON: () => { [k: string]: any };
Converts this Sentiment to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.Sentiment, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from a Sentiment message. Also converts values to other types if specified.
Parameter message
Sentiment
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies a Sentiment message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class TextSpan
class TextSpan implements ITextSpan {}
Represents a TextSpan.
constructor
constructor(properties?: ITextSpan);
Constructs a new TextSpan.
Parameter properties
Properties to set
property beginOffset
beginOffset: number;
TextSpan beginOffset.
property content
content: string;
TextSpan content.
method create
static create: ( properties?: google.cloud.language.v1.ITextSpan) => google.cloud.language.v1.TextSpan;
Creates a new TextSpan instance using the specified properties.
Parameter properties
Properties to set
Returns
TextSpan instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.TextSpan;
Decodes a TextSpan message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
TextSpan
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.TextSpan;
Decodes a TextSpan message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
TextSpan
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.ITextSpan, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified TextSpan message. Does not implicitly verify messages.
Parameter message
TextSpan message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method encodeDelimited
static encodeDelimited: ( message: google.cloud.language.v1.ITextSpan, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified TextSpan message, length delimited. Does not implicitly verify messages.
Parameter message
TextSpan message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer
method fromObject
static fromObject: (object: { [k: string]: any;}) => google.cloud.language.v1.TextSpan;
Creates a TextSpan message from a plain object. Also converts values to their respective internal types.
Parameter object
Plain object
Returns
TextSpan
method toJSON
toJSON: () => { [k: string]: any };
Converts this TextSpan to JSON.
Returns
JSON object
method toObject
static toObject: ( message: google.cloud.language.v1.TextSpan, options?: $protobuf.IConversionOptions) => { [k: string]: any };
Creates a plain object from a TextSpan message. Also converts values to other types if specified.
Parameter message
TextSpan
Parameter options
Conversion options
Returns
Plain object
method verify
static verify: (message: { [k: string]: any }) => string | null;
Verifies a TextSpan message.
Parameter message
Plain object to verify
Returns
null
if valid, otherwise the reason why it is not
class Token
class Token implements IToken {}
Represents a Token.
constructor
constructor(properties?: IToken);
Constructs a new Token.
Parameter properties
Properties to set
property dependencyEdge
dependencyEdge?: IDependencyEdge;
Token dependencyEdge.
property lemma
lemma: string;
Token lemma.
property partOfSpeech
partOfSpeech?: IPartOfSpeech;
Token partOfSpeech.
property text
text?: ITextSpan;
Token text.
method create
static create: ( properties?: google.cloud.language.v1.IToken) => google.cloud.language.v1.Token;
Creates a new Token instance using the specified properties.
Parameter properties
Properties to set
Returns
Token instance
method decode
static decode: ( reader: $protobuf.Reader | Uint8Array, length?: number) => google.cloud.language.v1.Token;
Decodes a Token message from the specified reader or buffer.
Parameter reader
Reader or buffer to decode from
Parameter length
Message length if known beforehand
Returns
Token
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method decodeDelimited
static decodeDelimited: ( reader: $protobuf.Reader | Uint8Array) => google.cloud.language.v1.Token;
Decodes a Token message from the specified reader or buffer, length delimited.
Parameter reader
Reader or buffer to decode from
Returns
Token
Throws
{Error} If the payload is not a reader or valid buffer
Throws
{$protobuf.util.ProtocolError} If required fields are missing
method encode
static encode: ( message: google.cloud.language.v1.IToken, writer?: $protobuf.Writer) => $protobuf.Writer;
Encodes the specified Token message. Does not implicitly verify messages.
Parameter message
Token message or plain object to encode
Parameter writer
Writer to encode to
Returns
Writer