Represents a QueryResult.
Package
@google-cloud/dialogflow-cxConstructors
(constructor)(properties)
constructor(properties?: google.cloud.dialogflow.cx.v3beta1.IQueryResult);Constructs a new QueryResult.
| Parameter | |
|---|---|
| Name | Description |
properties |
IQueryResult
Properties to set |
Properties
advancedSettings
public advancedSettings?: (google.cloud.dialogflow.cx.v3beta1.IAdvancedSettings|null);QueryResult advancedSettings.
allowAnswerFeedback
public allowAnswerFeedback: boolean;QueryResult allowAnswerFeedback.
currentFlow
public currentFlow?: (google.cloud.dialogflow.cx.v3beta1.IFlow|null);QueryResult currentFlow.
currentPage
public currentPage?: (google.cloud.dialogflow.cx.v3beta1.IPage|null);QueryResult currentPage.
dataStoreConnectionSignals
public dataStoreConnectionSignals?: (google.cloud.dialogflow.cx.v3beta1.IDataStoreConnectionSignals|null);QueryResult dataStoreConnectionSignals.
diagnosticInfo
public diagnosticInfo?: (google.protobuf.IStruct|null);QueryResult diagnosticInfo.
dtmf
public dtmf?: (google.cloud.dialogflow.cx.v3beta1.IDtmfInput|null);QueryResult dtmf.
generativeInfo
public generativeInfo?: (google.cloud.dialogflow.cx.v3beta1.IGenerativeInfo|null);QueryResult generativeInfo.
intent
public intent?: (google.cloud.dialogflow.cx.v3beta1.IIntent|null);QueryResult intent.
intentDetectionConfidence
public intentDetectionConfidence: number;QueryResult intentDetectionConfidence.
languageCode
public languageCode: string;QueryResult languageCode.
match
public match?: (google.cloud.dialogflow.cx.v3beta1.IMatch|null);QueryResult match.
parameters
public parameters?: (google.protobuf.IStruct|null);QueryResult parameters.
query
public query?: ("text"|"triggerIntent"|"transcript"|"triggerEvent"|"dtmf");QueryResult query.
responseMessages
public responseMessages: google.cloud.dialogflow.cx.v3beta1.IResponseMessage[];QueryResult responseMessages.
sentimentAnalysisResult
public sentimentAnalysisResult?: (google.cloud.dialogflow.cx.v3beta1.ISentimentAnalysisResult|null);QueryResult sentimentAnalysisResult.
text
public text?: (string|null);QueryResult text.
transcript
public transcript?: (string|null);QueryResult transcript.
triggerEvent
public triggerEvent?: (string|null);QueryResult triggerEvent.
triggerIntent
public triggerIntent?: (string|null);QueryResult triggerIntent.
webhookDisplayNames
public webhookDisplayNames: string[];QueryResult webhookDisplayNames.
webhookIds
public webhookIds: string[];QueryResult webhookIds.
webhookLatencies
public webhookLatencies: google.protobuf.IDuration[];QueryResult webhookLatencies.
webhookPayloads
public webhookPayloads: google.protobuf.IStruct[];QueryResult webhookPayloads.
webhookStatuses
public webhookStatuses: google.rpc.IStatus[];QueryResult webhookStatuses.
webhookTags
public webhookTags: string[];QueryResult webhookTags.
Methods
create(properties)
public static create(properties?: google.cloud.dialogflow.cx.v3beta1.IQueryResult): google.cloud.dialogflow.cx.v3beta1.QueryResult;Creates a new QueryResult instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IQueryResult
Properties to set |
| Returns | |
|---|---|
| Type | Description |
QueryResult |
QueryResult instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dialogflow.cx.v3beta1.QueryResult;Decodes a QueryResult message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
QueryResult |
QueryResult |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dialogflow.cx.v3beta1.QueryResult;Decodes a QueryResult message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
QueryResult |
QueryResult |
encode(message, writer)
public static encode(message: google.cloud.dialogflow.cx.v3beta1.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.v3beta1.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.v3beta1.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 |
QueryResult |
QueryResult |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for QueryResult
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this QueryResult to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.dialogflow.cx.v3beta1.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 |
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) |
|