Class protos.google.cloud.dialogflow.cx.v3.QueryResult (2.12.1)

Represents a QueryResult.

Package

@google-cloud/dialogflow-cx!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dialogflow.cx.v3.IQueryResult);

Constructs a new QueryResult.

Parameter

Name	Description
properties	`IQueryResult` Properties to set

Properties

currentPage

public currentPage?: (google.cloud.dialogflow.cx.v3.IPage|null);

QueryResult currentPage.

Property Value

Type	Description
(google.cloud.dialogflow.cx.v3.IPage\|null)

diagnosticInfo

public diagnosticInfo?: (google.protobuf.IStruct|null);

QueryResult diagnosticInfo.

Property Value

Type	Description
(google.protobuf.IStruct\|null)

intent

public intent?: (google.cloud.dialogflow.cx.v3.IIntent|null);

QueryResult intent.

Property Value

Type	Description
(google.cloud.dialogflow.cx.v3.IIntent\|null)

intentDetectionConfidence

public intentDetectionConfidence: number;

QueryResult intentDetectionConfidence.

Property Value

Type	Description
number

languageCode

public languageCode: string;

QueryResult languageCode.

Property Value

Type	Description
string

match

public match?: (google.cloud.dialogflow.cx.v3.IMatch|null);

QueryResult match.

Property Value

Type	Description
(google.cloud.dialogflow.cx.v3.IMatch\|null)

parameters

public parameters?: (google.protobuf.IStruct|null);

QueryResult parameters.

Property Value

Type	Description
(google.protobuf.IStruct\|null)

query

public query?: ("text"|"triggerIntent"|"transcript"|"triggerEvent");

QueryResult query.

Property Value

Type	Description
("text"\|"triggerIntent"\|"transcript"\|"triggerEvent")

responseMessages

public responseMessages: google.cloud.dialogflow.cx.v3.IResponseMessage[];

QueryResult responseMessages.

Property Value

Type	Description
google.cloud.dialogflow.cx.v3.IResponseMessage[]

sentimentAnalysisResult

public sentimentAnalysisResult?: (google.cloud.dialogflow.cx.v3.ISentimentAnalysisResult|null);

QueryResult sentimentAnalysisResult.

Property Value

Type	Description
(google.cloud.dialogflow.cx.v3.ISentimentAnalysisResult\|null)

text

public text?: (string|null);

QueryResult text.

Property Value

Type	Description
(string\|null)

transcript

public transcript?: (string|null);

QueryResult transcript.

Property Value

Type	Description
(string\|null)

triggerEvent

public triggerEvent?: (string|null);

QueryResult triggerEvent.

Property Value

Type	Description
(string\|null)

triggerIntent

public triggerIntent?: (string|null);

QueryResult triggerIntent.

Property Value

Type	Description
(string\|null)

webhookPayloads

public webhookPayloads: google.protobuf.IStruct[];

QueryResult webhookPayloads.

Property Value

Type	Description
google.protobuf.IStruct[]

webhookStatuses

public webhookStatuses: google.rpc.IStatus[];

QueryResult webhookStatuses.

Property Value

Type	Description
google.rpc.IStatus[]

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.cx.v3.IQueryResult): google.cloud.dialogflow.cx.v3.QueryResult;

Creates a new QueryResult instance using the specified properties.

Parameter

Name	Description
properties	`IQueryResult` Properties to set

Returns

Type	Description
google.cloud.dialogflow.cx.v3.QueryResult	QueryResult instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dialogflow.cx.v3.QueryResult;

Decodes a QueryResult message from the specified reader or buffer.

Parameters

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

Returns

Type	Description
google.cloud.dialogflow.cx.v3.QueryResult	QueryResult

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dialogflow.cx.v3.QueryResult;

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

Parameter

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

Returns

Type	Description
google.cloud.dialogflow.cx.v3.QueryResult	QueryResult

encode(message, writer)

public static encode(message: google.cloud.dialogflow.cx.v3.IQueryResult, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified QueryResult message. Does not implicitly messages.

Parameters

Name	Description
message	`IQueryResult` QueryResult message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.dialogflow.cx.v3.IQueryResult, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IQueryResult` QueryResult message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.dialogflow.cx.v3.QueryResult;

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

Parameter

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

Type	Description
google.cloud.dialogflow.cx.v3.QueryResult	QueryResult

toJSON()

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

Converts this QueryResult to JSON.

Returns

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

toObject(message, options)

public static toObject(message: google.cloud.dialogflow.cx.v3.QueryResult, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Name	Description
message	`google.cloud.dialogflow.cx.v3.QueryResult` QueryResult
options	`$protobuf.IConversionOptions` Conversion options

Returns

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

verify(message)

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

Verifies a QueryResult message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not