Class protos.google.cloud.dataqna.v1alpha.Interpretation

Represents an Interpretation.

Package

@google-cloud/data-qna

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dataqna.v1alpha.IInterpretation);

Constructs a new Interpretation.

Parameter
NameDescription
properties IInterpretation

Properties to set

Properties

confidence

public confidence: number;

Interpretation confidence.

dataQuery

public dataQuery?: (google.cloud.dataqna.v1alpha.IDataQuery|null);

Interpretation dataQuery.

dataSources

public dataSources: string[];

Interpretation dataSources.

executionInfo

public executionInfo?: (google.cloud.dataqna.v1alpha.IExecutionInfo|null);

Interpretation executionInfo.

humanReadable

public humanReadable?: (google.cloud.dataqna.v1alpha.IHumanReadable|null);

Interpretation humanReadable.

interpretationStructure

public interpretationStructure?: (google.cloud.dataqna.v1alpha.IInterpretationStructure|null);

Interpretation interpretationStructure.

unusedPhrases

public unusedPhrases: string[];

Interpretation unusedPhrases.

Methods

create(properties)

public static create(properties?: google.cloud.dataqna.v1alpha.IInterpretation): google.cloud.dataqna.v1alpha.Interpretation;

Creates a new Interpretation instance using the specified properties.

Parameter
NameDescription
properties IInterpretation

Properties to set

Returns
TypeDescription
google.cloud.dataqna.v1alpha.Interpretation

Interpretation instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dataqna.v1alpha.Interpretation;

Decodes an Interpretation message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.dataqna.v1alpha.Interpretation

Interpretation

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dataqna.v1alpha.Interpretation;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.dataqna.v1alpha.Interpretation

Interpretation

encode(message, writer)

public static encode(message: google.cloud.dataqna.v1alpha.IInterpretation, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Interpretation message. Does not implicitly messages.

Parameters
NameDescription
message IInterpretation

Interpretation message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.dataqna.v1alpha.IInterpretation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IInterpretation

Interpretation message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.dataqna.v1alpha.Interpretation;

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

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

Plain object

Returns
TypeDescription
google.cloud.dataqna.v1alpha.Interpretation

Interpretation

toJSON()

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

Converts this Interpretation to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.dataqna.v1alpha.Interpretation

Interpretation

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an Interpretation message.

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

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not