Service for managing Flows . v3
Package
@google-cloud/dialogflow-cxConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of FlowsClient.
opts
ClientOptions
gaxInstance
typeof gax
| typeof fallback
: loaded instance of google-gax
. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new FlowsClient({fallback: 'rest'}, gax); ```
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth
:
gax
.
GoogleAuth
;
descriptors
descriptors
:
Descriptors
;
flowsStub
flowsStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
locationsClient
locationsClient
:
LocationsClient
;
operationsClient
operationsClient
:
gax
.
OperationsClient
;
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
port
static
get
port
()
:
number
;
The port for this API service.
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Methods
agentPath(project, location, agent)
agentPath
(
project
:
string
,
location
:
string
,
agent
:
string
)
:
string
;
Return a fully-qualified agent resource name string.
project
string
location
string
agent
string
string
{string} Resource name string.
agentValidationResultPath(project, location, agent)
agentValidationResultPath
(
project
:
string
,
location
:
string
,
agent
:
string
)
:
string
;
Return a fully-qualified agentValidationResult resource name string.
project
string
location
string
agent
string
string
{string} Resource name string.
cancelOperation(request, options, callback)
cancelOperation
(
request
:
protos
.
google
.
longrunning
.
CancelOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
CancelOperationRequest
,
{}
|
undefined
|
null
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
CancelOperationRequest
,
protos
.
google
.
protobuf
.
Empty
,
{}
|
undefined
|
null
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED
.
request
options
CallOptions
| Callback
< protos.google.protobuf.Empty
, protos.google.longrunning.CancelOperationRequest
, {} | undefined | null>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
< protos.google.longrunning.CancelOperationRequest
, protos.google.protobuf.Empty
, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
const
client
=
longrunning
.
operationsClient
();
await
client
.
cancelOperation
({
name
:
''
});
changelogPath(project, location, agent, changelog)
changelogPath
(
project
:
string
,
location
:
string
,
agent
:
string
,
changelog
:
string
)
:
string
;
Return a fully-qualified changelog resource name string.
project
string
location
string
agent
string
changelog
string
string
{string} Resource name string.
checkExportFlowProgress(name)
checkExportFlowProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
ExportFlowResponse
,
protos
.
google
.
protobuf
.
Struct
>> ;
Check the status of the long running operation returned by exportFlow()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.cloud.dialogflow.cx.v3.ExportFlowResponse
, protos.google.protobuf.Struct
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
*
Required
.
The
name
of
the
flow
to
export
.
*
Format
:
`projects/
checkImportFlowProgress(name)
checkImportFlowProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
ImportFlowResponse
,
protos
.
google
.
protobuf
.
Struct
>> ;
Check the status of the long running operation returned by importFlow()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.cloud.dialogflow.cx.v3.ImportFlowResponse
, protos.google.protobuf.Struct
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
*
Required
.
The
agent
to
import
the
flow
into
.
*
Format
:
`projects/
checkTrainFlowProgress(name)
checkTrainFlowProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
protobuf
.
Struct
>> ;
Check the status of the long running operation returned by trainFlow()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.protobuf.Empty
, protos.google.protobuf.Struct
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
*
Required
.
The
flow
to
train
.
*
Format
:
`projects/
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Promise
<void>
{Promise} A promise that resolves when the client is closed.
continuousTestResultPath(project, location, agent, environment, continuousTestResult)
continuousTestResultPath
(
project
:
string
,
location
:
string
,
agent
:
string
,
environment
:
string
,
continuousTestResult
:
string
)
:
string
;
Return a fully-qualified continuousTestResult resource name string.
project
string
location
string
agent
string
environment
string
continuousTestResult
string
string
{string} Resource name string.
createFlow(request, options)
createFlow
(
request
?:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
ICreateFlowRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IFlow
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
ICreateFlowRequest
|
undefined
,
{}
|
undefined
]>;
Creates a flow in the specified agent.
Note: You should always train a flow prior to sending it queries. See the [training documentation]( https://cloud.google.com/dialogflow/cx/docs/concept/training ).
request
options
Promise
<[ protos.google.cloud.dialogflow.cx.v3.IFlow
, protos.google.cloud.dialogflow.cx.v3.ICreateFlowRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Flow . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
*
Required
.
The
agent
to
create
a
flow
for
.
*
Format
:
`projects/
createFlow(request, options, callback)
createFlow
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
ICreateFlowRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IFlow
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
ICreateFlowRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.dialogflow.cx.v3.IFlow
, protos.google.cloud.dialogflow.cx.v3.ICreateFlowRequest
| null | undefined, {} | null | undefined>
void
createFlow(request, callback)
createFlow
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
ICreateFlowRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IFlow
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
ICreateFlowRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.dialogflow.cx.v3.IFlow
, protos.google.cloud.dialogflow.cx.v3.ICreateFlowRequest
| null | undefined, {} | null | undefined>
void
deleteFlow(request, options)
deleteFlow
(
request
?:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IDeleteFlowRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IDeleteFlowRequest
|
undefined
,
{}
|
undefined
]>;
Deletes a specified flow.
request
options
Promise
<[ protos.google.protobuf.IEmpty
, protos.google.cloud.dialogflow.cx.v3.IDeleteFlowRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Empty . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
*
Required
.
The
name
of
the
flow
to
delete
.
*
Format
:
`projects/
deleteFlow(request, options, callback)
deleteFlow
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IDeleteFlowRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IDeleteFlowRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dialogflow.cx.v3.IDeleteFlowRequest
| null | undefined, {} | null | undefined>
void
deleteFlow(request, callback)
deleteFlow
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IDeleteFlowRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IDeleteFlowRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.protobuf.IEmpty
, protos.google.cloud.dialogflow.cx.v3.IDeleteFlowRequest
| null | undefined, {} | null | undefined>
void
deleteOperation(request, options, callback)
deleteOperation
(
request
:
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
request
options
CallOptions
| Callback
< protos.google.protobuf.Empty
, protos.google.longrunning.DeleteOperationRequest
, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
< protos.google.protobuf.Empty
, protos.google.longrunning.DeleteOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
const
client
=
longrunning
.
operationsClient
();
await
client
.
deleteOperation
({
name
:
''
});
deploymentPath(project, location, agent, environment, deployment)
deploymentPath
(
project
:
string
,
location
:
string
,
agent
:
string
,
environment
:
string
,
deployment
:
string
)
:
string
;
Return a fully-qualified deployment resource name string.
project
string
location
string
agent
string
environment
string
deployment
string
string
{string} Resource name string.
entityTypePath(project, location, agent, entityType)
entityTypePath
(
project
:
string
,
location
:
string
,
agent
:
string
,
entityType
:
string
)
:
string
;
Return a fully-qualified entityType resource name string.
project
string
location
string
agent
string
entityType
string
string
{string} Resource name string.
environmentPath(project, location, agent, environment)
environmentPath
(
project
:
string
,
location
:
string
,
agent
:
string
,
environment
:
string
)
:
string
;
Return a fully-qualified environment resource name string.
project
string
location
string
agent
string
environment
string
string
{string} Resource name string.
experimentPath(project, location, agent, environment, experiment)
experimentPath
(
project
:
string
,
location
:
string
,
agent
:
string
,
environment
:
string
,
experiment
:
string
)
:
string
;
Return a fully-qualified experiment resource name string.
project
string
location
string
agent
string
environment
string
experiment
string
string
{string} Resource name string.
exportFlow(request, options)
exportFlow
(
request
?:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IExportFlowRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IExportFlowResponse
,
protos
.
google
.
protobuf
.
IStruct
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Exports the specified flow to a binary file.
This method is a [long-running operation]( https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation
). The returned Operation
type has the following method-specific fields:
-
metadata: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) -response: ExportFlowResponse
Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.
request
options
Promise
<[ LROperation
< protos.google.cloud.dialogflow.cx.v3.IExportFlowResponse
, protos.google.protobuf.IStruct
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
*
Required
.
The
name
of
the
flow
to
export
.
*
Format
:
`projects/
exportFlow(request, options, callback)
exportFlow
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IExportFlowRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IExportFlowResponse
,
protos
.
google
.
protobuf
.
IStruct
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.cloud.dialogflow.cx.v3.IExportFlowResponse
, protos.google.protobuf.IStruct
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
exportFlow(request, callback)
exportFlow
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IExportFlowRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IExportFlowResponse
,
protos
.
google
.
protobuf
.
IStruct
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.cloud.dialogflow.cx.v3.IExportFlowResponse
, protos.google.protobuf.IStruct
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
flowPath(project, location, agent, flow)
flowPath
(
project
:
string
,
location
:
string
,
agent
:
string
,
flow
:
string
)
:
string
;
Return a fully-qualified flow resource name string.
project
string
location
string
agent
string
flow
string
string
{string} Resource name string.
flowValidationResultPath(project, location, agent, flow)
flowValidationResultPath
(
project
:
string
,
location
:
string
,
agent
:
string
,
flow
:
string
)
:
string
;
Return a fully-qualified flowValidationResult resource name string.
project
string
location
string
agent
string
flow
string
string
{string} Resource name string.
getFlow(request, options)
getFlow
(
request
?:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IGetFlowRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IFlow
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IGetFlowRequest
|
undefined
,
{}
|
undefined
]>;
Retrieves the specified flow.
request
options
Promise
<[ protos.google.cloud.dialogflow.cx.v3.IFlow
, protos.google.cloud.dialogflow.cx.v3.IGetFlowRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Flow . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
*
Required
.
The
name
of
the
flow
to
get
.
*
Format
:
`projects/
getFlow(request, options, callback)
getFlow
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IGetFlowRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IFlow
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IGetFlowRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.dialogflow.cx.v3.IFlow
, protos.google.cloud.dialogflow.cx.v3.IGetFlowRequest
| null | undefined, {} | null | undefined>
void
getFlow(request, callback)
getFlow
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IGetFlowRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IFlow
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IGetFlowRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.dialogflow.cx.v3.IFlow
, protos.google.cloud.dialogflow.cx.v3.IGetFlowRequest
| null | undefined, {} | null | undefined>
void
getFlowValidationResult(request, options)
getFlowValidationResult
(
request
?:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IGetFlowValidationResultRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IFlowValidationResult
,
(
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IGetFlowValidationResultRequest
|
undefined
),
{}
|
undefined
]>;
Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called.
request
options
Promise
<[ protos.google.cloud.dialogflow.cx.v3.IFlowValidationResult
,
( protos.google.cloud.dialogflow.cx.v3.IGetFlowValidationResultRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing FlowValidationResult . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
*
Required
.
The
flow
name
.
*
Format
:
`projects/
getFlowValidationResult(request, options, callback)
getFlowValidationResult
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IGetFlowValidationResultRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IFlowValidationResult
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IGetFlowValidationResultRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.dialogflow.cx.v3.IFlowValidationResult
, protos.google.cloud.dialogflow.cx.v3.IGetFlowValidationResultRequest
| null | undefined, {} | null | undefined>
void
getFlowValidationResult(request, callback)
getFlowValidationResult
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IGetFlowValidationResultRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IFlowValidationResult
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IGetFlowValidationResultRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.dialogflow.cx.v3.IFlowValidationResult
, protos.google.cloud.dialogflow.cx.v3.IGetFlowValidationResultRequest
| null | undefined, {} | null | undefined>
void
getLocation(request, options, callback)
getLocation
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
,
options
?:
gax
.
CallOptions
|
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Gets information about a location.
request
LocationProtos.google.cloud.location.IGetLocationRequest
The request object that will be sent.
options
CallOptions
| Callback
< google.cloud.location.ILocation
, google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Call options. See CallOptions for more details.
callback
Callback
< google.cloud.location.ILocation
, google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Promise
< google.cloud.location.ILocation
>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
const
[
response
]
=
await
client
.
getLocation
(
request
);
getOperation(request, options, callback)
getOperation
(
request
:
protos
.
google
.
longrunning
.
GetOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise
< [
protos
.
google
.
longrunning
.
Operation
]>;
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
request
options
CallOptions
| Callback
< protos.google.longrunning.Operation
, protos.google.longrunning.GetOperationRequest
, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
< protos.google.longrunning.Operation
, protos.google.longrunning.GetOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
const
client
=
longrunning
.
operationsClient
();
const
name
=
''
;
const
[
response
]
=
await
client
.
getOperation
({
name
});
// doThingsWith(response)
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
importFlow(request, options)
importFlow
(
request
?:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IImportFlowRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IImportFlowResponse
,
protos
.
google
.
protobuf
.
IStruct
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Imports the specified flow to the specified agent from a binary file.
This method is a [long-running operation]( https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation
). The returned Operation
type has the following method-specific fields:
-
metadata: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) -response: ImportFlowResponse
Note: You should always train a flow prior to sending it queries. See the [training documentation]( https://cloud.google.com/dialogflow/cx/docs/concept/training ).
request
options
Promise
<[ LROperation
< protos.google.cloud.dialogflow.cx.v3.IImportFlowResponse
, protos.google.protobuf.IStruct
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
*
Required
.
The
agent
to
import
the
flow
into
.
*
Format
:
`projects/
importFlow(request, options, callback)
importFlow
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IImportFlowRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IImportFlowResponse
,
protos
.
google
.
protobuf
.
IStruct
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.cloud.dialogflow.cx.v3.IImportFlowResponse
, protos.google.protobuf.IStruct
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
importFlow(request, callback)
importFlow
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IImportFlowRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IImportFlowResponse
,
protos
.
google
.
protobuf
.
IStruct
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.cloud.dialogflow.cx.v3.IImportFlowResponse
, protos.google.protobuf.IStruct
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
intentPath(project, location, agent, intent)
intentPath
(
project
:
string
,
location
:
string
,
agent
:
string
,
intent
:
string
)
:
string
;
Return a fully-qualified intent resource name string.
project
string
location
string
agent
string
intent
string
string
{string} Resource name string.
listFlows(request, options)
listFlows
(
request
?:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IListFlowsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IFlow
[],
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IListFlowsRequest
|
null
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IListFlowsResponse
]>;
Returns the list of all flows in the specified agent.
request
options
Promise
<[ protos.google.cloud.dialogflow.cx.v3.IFlow
[], protos.google.cloud.dialogflow.cx.v3.IListFlowsRequest
| null, protos.google.cloud.dialogflow.cx.v3.IListFlowsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of Flow
. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listFlowsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listFlows(request, options, callback)
listFlows
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IListFlowsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IListFlowsRequest
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IListFlowsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IFlow
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.cloud.dialogflow.cx.v3.IListFlowsRequest
, protos.google.cloud.dialogflow.cx.v3.IListFlowsResponse
| null | undefined, protos.google.cloud.dialogflow.cx.v3.IFlow
>
void
listFlows(request, callback)
listFlows
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IListFlowsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IListFlowsRequest
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IListFlowsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IFlow
> )
:
void
;
request
callback
PaginationCallback
< protos.google.cloud.dialogflow.cx.v3.IListFlowsRequest
, protos.google.cloud.dialogflow.cx.v3.IListFlowsResponse
| null | undefined, protos.google.cloud.dialogflow.cx.v3.IFlow
>
void
listFlowsAsync(request, options)
listFlowsAsync
(
request
?:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IListFlowsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IFlow
> ;
Equivalent to listFlows
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.cloud.dialogflow.cx.v3.IFlow
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing Flow . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
*
Required
.
The
agent
containing
the
flows
.
*
Format
:
`projects/
listFlowsStream(request, options)
listFlowsStream
(
request
?:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IListFlowsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing Flow
on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listFlowsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listLocationsAsync(request, options)
listLocationsAsync
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IListLocationsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Lists information about the supported locations for this service. Returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent.
options
AsyncIterable
< google.cloud.location.ILocation
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
const
iterable
=
client
.
listLocationsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
// process response
}
listOperationsAsync(request, options)
listOperationsAsync
(
request
:
protos
.
google
.
longrunning
.
ListOperationsRequest
,
options
?:
gax
.
CallOptions
)
:
AsyncIterable<protos
.
google
.
longrunning
.
ListOperationsResponse
> ;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
request
options
CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
AsyncIterable
< protos.google.longrunning.ListOperationsResponse
>
{Object} An iterable Object that conforms to iteration protocols .
const
client
=
longrunning
.
operationsClient
();
for
await
(
const
response
of
client
.
listOperationsAsync
(
request
));
// doThingsWith(response)
locationPath(project, location)
locationPath
(
project
:
string
,
location
:
string
)
:
string
;
Return a fully-qualified location resource name string.
project
string
location
string
string
{string} Resource name string.
matchAgentFromAgentName(agentName)
matchAgentFromAgentName
(
agentName
:
string
)
:
string
|
number
;
Parse the agent from Agent resource.
agentName
string
A fully-qualified path representing Agent resource.
string | number
{string} A string representing the agent.
matchAgentFromAgentValidationResultName(agentValidationResultName)
matchAgentFromAgentValidationResultName
(
agentValidationResultName
:
string
)
:
string
|
number
;
Parse the agent from AgentValidationResult resource.
agentValidationResultName
string
A fully-qualified path representing AgentValidationResult resource.
string | number
{string} A string representing the agent.
matchAgentFromChangelogName(changelogName)
matchAgentFromChangelogName
(
changelogName
:
string
)
:
string
|
number
;
Parse the agent from Changelog resource.
changelogName
string
A fully-qualified path representing Changelog resource.
string | number
{string} A string representing the agent.
matchAgentFromContinuousTestResultName(continuousTestResultName)
matchAgentFromContinuousTestResultName
(
continuousTestResultName
:
string
)
:
string
|
number
;
Parse the agent from ContinuousTestResult resource.
continuousTestResultName
string
A fully-qualified path representing ContinuousTestResult resource.
string | number
{string} A string representing the agent.
matchAgentFromDeploymentName(deploymentName)
matchAgentFromDeploymentName
(
deploymentName
:
string
)
:
string
|
number
;
Parse the agent from Deployment resource.
deploymentName
string
A fully-qualified path representing Deployment resource.
string | number
{string} A string representing the agent.
matchAgentFromEntityTypeName(entityTypeName)
matchAgentFromEntityTypeName
(
entityTypeName
:
string
)
:
string
|
number
;
Parse the agent from EntityType resource.
entityTypeName
string
A fully-qualified path representing EntityType resource.
string | number
{string} A string representing the agent.
matchAgentFromEnvironmentName(environmentName)
matchAgentFromEnvironmentName
(
environmentName
:
string
)
:
string
|
number
;
Parse the agent from Environment resource.
environmentName
string
A fully-qualified path representing Environment resource.
string | number
{string} A string representing the agent.
matchAgentFromExperimentName(experimentName)
matchAgentFromExperimentName
(
experimentName
:
string
)
:
string
|
number
;
Parse the agent from Experiment resource.
experimentName
string
A fully-qualified path representing Experiment resource.
string | number
{string} A string representing the agent.
matchAgentFromFlowName(flowName)
matchAgentFromFlowName
(
flowName
:
string
)
:
string
|
number
;
Parse the agent from Flow resource.
flowName
string
A fully-qualified path representing Flow resource.
string | number
{string} A string representing the agent.
matchAgentFromFlowValidationResultName(flowValidationResultName)
matchAgentFromFlowValidationResultName
(
flowValidationResultName
:
string
)
:
string
|
number
;
Parse the agent from FlowValidationResult resource.
flowValidationResultName
string
A fully-qualified path representing FlowValidationResult resource.
string | number
{string} A string representing the agent.
matchAgentFromIntentName(intentName)
matchAgentFromIntentName
(
intentName
:
string
)
:
string
|
number
;
Parse the agent from Intent resource.
intentName
string
A fully-qualified path representing Intent resource.
string | number
{string} A string representing the agent.
matchAgentFromPageName(pageName)
matchAgentFromPageName
(
pageName
:
string
)
:
string
|
number
;
Parse the agent from Page resource.
pageName
string
A fully-qualified path representing Page resource.
string | number
{string} A string representing the agent.
matchAgentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)
matchAgentFromProjectLocationAgentEnvironmentSessionEntityTypeName
(
projectLocationAgentEnvironmentSessionEntityTypeName
:
string
)
:
string
|
number
;
Parse the agent from ProjectLocationAgentEnvironmentSessionEntityType resource.
projectLocationAgentEnvironmentSessionEntityTypeName
string
A fully-qualified path representing project_location_agent_environment_session_entity_type resource.
string | number
{string} A string representing the agent.
matchAgentFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName)
matchAgentFromProjectLocationAgentFlowTransitionRouteGroupName
(
projectLocationAgentFlowTransitionRouteGroupName
:
string
)
:
string
|
number
;
Parse the agent from ProjectLocationAgentFlowTransitionRouteGroup resource.
projectLocationAgentFlowTransitionRouteGroupName
string
A fully-qualified path representing project_location_agent_flow_transition_route_group resource.
string | number
{string} A string representing the agent.
matchAgentFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchAgentFromProjectLocationAgentSessionEntityTypeName
(
projectLocationAgentSessionEntityTypeName
:
string
)
:
string
|
number
;
Parse the agent from ProjectLocationAgentSessionEntityType resource.
projectLocationAgentSessionEntityTypeName
string
A fully-qualified path representing project_location_agent_session_entity_type resource.
string | number
{string} A string representing the agent.
matchAgentFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName)
matchAgentFromProjectLocationAgentTransitionRouteGroupName
(
projectLocationAgentTransitionRouteGroupName
:
string
)
:
string
|
number
;
Parse the agent from ProjectLocationAgentTransitionRouteGroup resource.
projectLocationAgentTransitionRouteGroupName
string
A fully-qualified path representing project_location_agent_transition_route_group resource.
string | number
{string} A string representing the agent.
matchAgentFromTestCaseName(testCaseName)
matchAgentFromTestCaseName
(
testCaseName
:
string
)
:
string
|
number
;
Parse the agent from TestCase resource.
testCaseName
string
A fully-qualified path representing TestCase resource.
string | number
{string} A string representing the agent.
matchAgentFromTestCaseResultName(testCaseResultName)
matchAgentFromTestCaseResultName
(
testCaseResultName
:
string
)
:
string
|
number
;
Parse the agent from TestCaseResult resource.
testCaseResultName
string
A fully-qualified path representing TestCaseResult resource.
string | number
{string} A string representing the agent.
matchAgentFromVersionName(versionName)
matchAgentFromVersionName
(
versionName
:
string
)
:
string
|
number
;
Parse the agent from Version resource.
versionName
string
A fully-qualified path representing Version resource.
string | number
{string} A string representing the agent.
matchAgentFromWebhookName(webhookName)
matchAgentFromWebhookName
(
webhookName
:
string
)
:
string
|
number
;
Parse the agent from Webhook resource.
webhookName
string
A fully-qualified path representing Webhook resource.
string | number
{string} A string representing the agent.
matchChangelogFromChangelogName(changelogName)
matchChangelogFromChangelogName
(
changelogName
:
string
)
:
string
|
number
;
Parse the changelog from Changelog resource.
changelogName
string
A fully-qualified path representing Changelog resource.
string | number
{string} A string representing the changelog.
matchContinuousTestResultFromContinuousTestResultName(continuousTestResultName)
matchContinuousTestResultFromContinuousTestResultName
(
continuousTestResultName
:
string
)
:
string
|
number
;
Parse the continuous_test_result from ContinuousTestResult resource.
continuousTestResultName
string
A fully-qualified path representing ContinuousTestResult resource.
string | number
{string} A string representing the continuous_test_result.
matchDeploymentFromDeploymentName(deploymentName)
matchDeploymentFromDeploymentName
(
deploymentName
:
string
)
:
string
|
number
;
Parse the deployment from Deployment resource.
deploymentName
string
A fully-qualified path representing Deployment resource.
string | number
{string} A string representing the deployment.
matchEntityTypeFromEntityTypeName(entityTypeName)
matchEntityTypeFromEntityTypeName
(
entityTypeName
:
string
)
:
string
|
number
;
Parse the entity_type from EntityType resource.
entityTypeName
string
A fully-qualified path representing EntityType resource.
string | number
{string} A string representing the entity_type.
matchEntityTypeFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)
matchEntityTypeFromProjectLocationAgentEnvironmentSessionEntityTypeName
(
projectLocationAgentEnvironmentSessionEntityTypeName
:
string
)
:
string
|
number
;
Parse the entity_type from ProjectLocationAgentEnvironmentSessionEntityType resource.
projectLocationAgentEnvironmentSessionEntityTypeName
string
A fully-qualified path representing project_location_agent_environment_session_entity_type resource.
string | number
{string} A string representing the entity_type.
matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchEntityTypeFromProjectLocationAgentSessionEntityTypeName
(
projectLocationAgentSessionEntityTypeName
:
string
)
:
string
|
number
;
Parse the entity_type from ProjectLocationAgentSessionEntityType resource.
projectLocationAgentSessionEntityTypeName
string
A fully-qualified path representing project_location_agent_session_entity_type resource.
string | number
{string} A string representing the entity_type.
matchEnvironmentFromContinuousTestResultName(continuousTestResultName)
matchEnvironmentFromContinuousTestResultName
(
continuousTestResultName
:
string
)
:
string
|
number
;
Parse the environment from ContinuousTestResult resource.
continuousTestResultName
string
A fully-qualified path representing ContinuousTestResult resource.
string | number
{string} A string representing the environment.
matchEnvironmentFromDeploymentName(deploymentName)
matchEnvironmentFromDeploymentName
(
deploymentName
:
string
)
:
string
|
number
;
Parse the environment from Deployment resource.
deploymentName
string
A fully-qualified path representing Deployment resource.
string | number
{string} A string representing the environment.
matchEnvironmentFromEnvironmentName(environmentName)
matchEnvironmentFromEnvironmentName
(
environmentName
:
string
)
:
string
|
number
;
Parse the environment from Environment resource.
environmentName
string
A fully-qualified path representing Environment resource.
string | number
{string} A string representing the environment.
matchEnvironmentFromExperimentName(experimentName)
matchEnvironmentFromExperimentName
(
experimentName
:
string
)
:
string
|
number
;
Parse the environment from Experiment resource.
experimentName
string
A fully-qualified path representing Experiment resource.
string | number
{string} A string representing the environment.
matchEnvironmentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)
matchEnvironmentFromProjectLocationAgentEnvironmentSessionEntityTypeName
(
projectLocationAgentEnvironmentSessionEntityTypeName
:
string
)
:
string
|
number
;
Parse the environment from ProjectLocationAgentEnvironmentSessionEntityType resource.
projectLocationAgentEnvironmentSessionEntityTypeName
string
A fully-qualified path representing project_location_agent_environment_session_entity_type resource.
string | number
{string} A string representing the environment.
matchExperimentFromExperimentName(experimentName)
matchExperimentFromExperimentName
(
experimentName
:
string
)
:
string
|
number
;
Parse the experiment from Experiment resource.
experimentName
string
A fully-qualified path representing Experiment resource.
string | number
{string} A string representing the experiment.
matchFlowFromFlowName(flowName)
matchFlowFromFlowName
(
flowName
:
string
)
:
string
|
number
;
Parse the flow from Flow resource.
flowName
string
A fully-qualified path representing Flow resource.
string | number
{string} A string representing the flow.
matchFlowFromFlowValidationResultName(flowValidationResultName)
matchFlowFromFlowValidationResultName
(
flowValidationResultName
:
string
)
:
string
|
number
;
Parse the flow from FlowValidationResult resource.
flowValidationResultName
string
A fully-qualified path representing FlowValidationResult resource.
string | number
{string} A string representing the flow.
matchFlowFromPageName(pageName)
matchFlowFromPageName
(
pageName
:
string
)
:
string
|
number
;
Parse the flow from Page resource.
pageName
string
A fully-qualified path representing Page resource.
string | number
{string} A string representing the flow.
matchFlowFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName)
matchFlowFromProjectLocationAgentFlowTransitionRouteGroupName
(
projectLocationAgentFlowTransitionRouteGroupName
:
string
)
:
string
|
number
;
Parse the flow from ProjectLocationAgentFlowTransitionRouteGroup resource.
projectLocationAgentFlowTransitionRouteGroupName
string
A fully-qualified path representing project_location_agent_flow_transition_route_group resource.
string | number
{string} A string representing the flow.
matchFlowFromVersionName(versionName)
matchFlowFromVersionName
(
versionName
:
string
)
:
string
|
number
;
Parse the flow from Version resource.
versionName
string
A fully-qualified path representing Version resource.
string | number
{string} A string representing the flow.
matchIntentFromIntentName(intentName)
matchIntentFromIntentName
(
intentName
:
string
)
:
string
|
number
;
Parse the intent from Intent resource.
intentName
string
A fully-qualified path representing Intent resource.
string | number
{string} A string representing the intent.
matchLocationFromAgentName(agentName)
matchLocationFromAgentName
(
agentName
:
string
)
:
string
|
number
;
Parse the location from Agent resource.
agentName
string
A fully-qualified path representing Agent resource.
string | number
{string} A string representing the location.
matchLocationFromAgentValidationResultName(agentValidationResultName)
matchLocationFromAgentValidationResultName
(
agentValidationResultName
:
string
)
:
string
|
number
;
Parse the location from AgentValidationResult resource.
agentValidationResultName
string
A fully-qualified path representing AgentValidationResult resource.
string | number
{string} A string representing the location.
matchLocationFromChangelogName(changelogName)
matchLocationFromChangelogName
(
changelogName
:
string
)
:
string
|
number
;
Parse the location from Changelog resource.
changelogName
string
A fully-qualified path representing Changelog resource.
string | number
{string} A string representing the location.
matchLocationFromContinuousTestResultName(continuousTestResultName)
matchLocationFromContinuousTestResultName
(
continuousTestResultName
:
string
)
:
string
|
number
;
Parse the location from ContinuousTestResult resource.
continuousTestResultName
string
A fully-qualified path representing ContinuousTestResult resource.
string | number
{string} A string representing the location.
matchLocationFromDeploymentName(deploymentName)
matchLocationFromDeploymentName
(
deploymentName
:
string
)
:
string
|
number
;
Parse the location from Deployment resource.
deploymentName
string
A fully-qualified path representing Deployment resource.
string | number
{string} A string representing the location.
matchLocationFromEntityTypeName(entityTypeName)
matchLocationFromEntityTypeName
(
entityTypeName
:
string
)
:
string
|
number
;
Parse the location from EntityType resource.
entityTypeName
string
A fully-qualified path representing EntityType resource.
string | number
{string} A string representing the location.
matchLocationFromEnvironmentName(environmentName)
matchLocationFromEnvironmentName
(
environmentName
:
string
)
:
string
|
number
;
Parse the location from Environment resource.
environmentName
string
A fully-qualified path representing Environment resource.
string | number
{string} A string representing the location.
matchLocationFromExperimentName(experimentName)
matchLocationFromExperimentName
(
experimentName
:
string
)
:
string
|
number
;
Parse the location from Experiment resource.
experimentName
string
A fully-qualified path representing Experiment resource.
string | number
{string} A string representing the location.
matchLocationFromFlowName(flowName)
matchLocationFromFlowName
(
flowName
:
string
)
:
string
|
number
;
Parse the location from Flow resource.
flowName
string
A fully-qualified path representing Flow resource.
string | number
{string} A string representing the location.
matchLocationFromFlowValidationResultName(flowValidationResultName)
matchLocationFromFlowValidationResultName
(
flowValidationResultName
:
string
)
:
string
|
number
;
Parse the location from FlowValidationResult resource.
flowValidationResultName
string
A fully-qualified path representing FlowValidationResult resource.
string | number
{string} A string representing the location.
matchLocationFromIntentName(intentName)
matchLocationFromIntentName
(
intentName
:
string
)
:
string
|
number
;
Parse the location from Intent resource.
intentName
string
A fully-qualified path representing Intent resource.
string | number
{string} A string representing the location.
matchLocationFromLocationName(locationName)
matchLocationFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the location from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the location.
matchLocationFromPageName(pageName)
matchLocationFromPageName
(
pageName
:
string
)
:
string
|
number
;
Parse the location from Page resource.
pageName
string
A fully-qualified path representing Page resource.
string | number
{string} A string representing the location.
matchLocationFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)
matchLocationFromProjectLocationAgentEnvironmentSessionEntityTypeName
(
projectLocationAgentEnvironmentSessionEntityTypeName
:
string
)
:
string
|
number
;
Parse the location from ProjectLocationAgentEnvironmentSessionEntityType resource.
projectLocationAgentEnvironmentSessionEntityTypeName
string
A fully-qualified path representing project_location_agent_environment_session_entity_type resource.
string | number
{string} A string representing the location.
matchLocationFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName)
matchLocationFromProjectLocationAgentFlowTransitionRouteGroupName
(
projectLocationAgentFlowTransitionRouteGroupName
:
string
)
:
string
|
number
;
Parse the location from ProjectLocationAgentFlowTransitionRouteGroup resource.
projectLocationAgentFlowTransitionRouteGroupName
string
A fully-qualified path representing project_location_agent_flow_transition_route_group resource.
string | number
{string} A string representing the location.
matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchLocationFromProjectLocationAgentSessionEntityTypeName
(
projectLocationAgentSessionEntityTypeName
:
string
)
:
string
|
number
;
Parse the location from ProjectLocationAgentSessionEntityType resource.
projectLocationAgentSessionEntityTypeName
string
A fully-qualified path representing project_location_agent_session_entity_type resource.
string | number
{string} A string representing the location.
matchLocationFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName)
matchLocationFromProjectLocationAgentTransitionRouteGroupName
(
projectLocationAgentTransitionRouteGroupName
:
string
)
:
string
|
number
;
Parse the location from ProjectLocationAgentTransitionRouteGroup resource.
projectLocationAgentTransitionRouteGroupName
string
A fully-qualified path representing project_location_agent_transition_route_group resource.
string | number
{string} A string representing the location.
matchLocationFromSecuritySettingsName(securitySettingsName)
matchLocationFromSecuritySettingsName
(
securitySettingsName
:
string
)
:
string
|
number
;
Parse the location from SecuritySettings resource.
securitySettingsName
string
A fully-qualified path representing SecuritySettings resource.
string | number
{string} A string representing the location.
matchLocationFromTestCaseName(testCaseName)
matchLocationFromTestCaseName
(
testCaseName
:
string
)
:
string
|
number
;
Parse the location from TestCase resource.
testCaseName
string
A fully-qualified path representing TestCase resource.
string | number
{string} A string representing the location.
matchLocationFromTestCaseResultName(testCaseResultName)
matchLocationFromTestCaseResultName
(
testCaseResultName
:
string
)
:
string
|
number
;
Parse the location from TestCaseResult resource.
testCaseResultName
string
A fully-qualified path representing TestCaseResult resource.
string | number
{string} A string representing the location.
matchLocationFromVersionName(versionName)
matchLocationFromVersionName
(
versionName
:
string
)
:
string
|
number
;
Parse the location from Version resource.
versionName
string
A fully-qualified path representing Version resource.
string | number
{string} A string representing the location.
matchLocationFromWebhookName(webhookName)
matchLocationFromWebhookName
(
webhookName
:
string
)
:
string
|
number
;
Parse the location from Webhook resource.
webhookName
string
A fully-qualified path representing Webhook resource.
string | number
{string} A string representing the location.
matchPageFromPageName(pageName)
matchPageFromPageName
(
pageName
:
string
)
:
string
|
number
;
Parse the page from Page resource.
pageName
string
A fully-qualified path representing Page resource.
string | number
{string} A string representing the page.
matchProjectFromAgentName(agentName)
matchProjectFromAgentName
(
agentName
:
string
)
:
string
|
number
;
Parse the project from Agent resource.
agentName
string
A fully-qualified path representing Agent resource.
string | number
{string} A string representing the project.
matchProjectFromAgentValidationResultName(agentValidationResultName)
matchProjectFromAgentValidationResultName
(
agentValidationResultName
:
string
)
:
string
|
number
;
Parse the project from AgentValidationResult resource.
agentValidationResultName
string
A fully-qualified path representing AgentValidationResult resource.
string | number
{string} A string representing the project.
matchProjectFromChangelogName(changelogName)
matchProjectFromChangelogName
(
changelogName
:
string
)
:
string
|
number
;
Parse the project from Changelog resource.
changelogName
string
A fully-qualified path representing Changelog resource.
string | number
{string} A string representing the project.
matchProjectFromContinuousTestResultName(continuousTestResultName)
matchProjectFromContinuousTestResultName
(
continuousTestResultName
:
string
)
:
string
|
number
;
Parse the project from ContinuousTestResult resource.
continuousTestResultName
string
A fully-qualified path representing ContinuousTestResult resource.
string | number
{string} A string representing the project.
matchProjectFromDeploymentName(deploymentName)
matchProjectFromDeploymentName
(
deploymentName
:
string
)
:
string
|
number
;
Parse the project from Deployment resource.
deploymentName
string
A fully-qualified path representing Deployment resource.
string | number
{string} A string representing the project.
matchProjectFromEntityTypeName(entityTypeName)
matchProjectFromEntityTypeName
(
entityTypeName
:
string
)
:
string
|
number
;
Parse the project from EntityType resource.
entityTypeName
string
A fully-qualified path representing EntityType resource.
string | number
{string} A string representing the project.
matchProjectFromEnvironmentName(environmentName)
matchProjectFromEnvironmentName
(
environmentName
:
string
)
:
string
|
number
;
Parse the project from Environment resource.
environmentName
string
A fully-qualified path representing Environment resource.
string | number
{string} A string representing the project.
matchProjectFromExperimentName(experimentName)
matchProjectFromExperimentName
(
experimentName
:
string
)
:
string
|
number
;
Parse the project from Experiment resource.
experimentName
string
A fully-qualified path representing Experiment resource.
string | number
{string} A string representing the project.
matchProjectFromFlowName(flowName)
matchProjectFromFlowName
(
flowName
:
string
)
:
string
|
number
;
Parse the project from Flow resource.
flowName
string
A fully-qualified path representing Flow resource.
string | number
{string} A string representing the project.
matchProjectFromFlowValidationResultName(flowValidationResultName)
matchProjectFromFlowValidationResultName
(
flowValidationResultName
:
string
)
:
string
|
number
;
Parse the project from FlowValidationResult resource.
flowValidationResultName
string
A fully-qualified path representing FlowValidationResult resource.
string | number
{string} A string representing the project.
matchProjectFromIntentName(intentName)
matchProjectFromIntentName
(
intentName
:
string
)
:
string
|
number
;
Parse the project from Intent resource.
intentName
string
A fully-qualified path representing Intent resource.
string | number
{string} A string representing the project.
matchProjectFromLocationName(locationName)
matchProjectFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the project from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the project.
matchProjectFromPageName(pageName)
matchProjectFromPageName
(
pageName
:
string
)
:
string
|
number
;
Parse the project from Page resource.
pageName
string
A fully-qualified path representing Page resource.
string | number
{string} A string representing the project.
matchProjectFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)
matchProjectFromProjectLocationAgentEnvironmentSessionEntityTypeName
(
projectLocationAgentEnvironmentSessionEntityTypeName
:
string
)
:
string
|
number
;
Parse the project from ProjectLocationAgentEnvironmentSessionEntityType resource.
projectLocationAgentEnvironmentSessionEntityTypeName
string
A fully-qualified path representing project_location_agent_environment_session_entity_type resource.
string | number
{string} A string representing the project.
matchProjectFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName)
matchProjectFromProjectLocationAgentFlowTransitionRouteGroupName
(
projectLocationAgentFlowTransitionRouteGroupName
:
string
)
:
string
|
number
;
Parse the project from ProjectLocationAgentFlowTransitionRouteGroup resource.
projectLocationAgentFlowTransitionRouteGroupName
string
A fully-qualified path representing project_location_agent_flow_transition_route_group resource.
string | number
{string} A string representing the project.
matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchProjectFromProjectLocationAgentSessionEntityTypeName
(
projectLocationAgentSessionEntityTypeName
:
string
)
:
string
|
number
;
Parse the project from ProjectLocationAgentSessionEntityType resource.
projectLocationAgentSessionEntityTypeName
string
A fully-qualified path representing project_location_agent_session_entity_type resource.
string | number
{string} A string representing the project.
matchProjectFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName)
matchProjectFromProjectLocationAgentTransitionRouteGroupName
(
projectLocationAgentTransitionRouteGroupName
:
string
)
:
string
|
number
;
Parse the project from ProjectLocationAgentTransitionRouteGroup resource.
projectLocationAgentTransitionRouteGroupName
string
A fully-qualified path representing project_location_agent_transition_route_group resource.
string | number
{string} A string representing the project.
matchProjectFromProjectName(projectName)
matchProjectFromProjectName
(
projectName
:
string
)
:
string
|
number
;
Parse the project from Project resource.
projectName
string
A fully-qualified path representing Project resource.
string | number
{string} A string representing the project.
matchProjectFromSecuritySettingsName(securitySettingsName)
matchProjectFromSecuritySettingsName
(
securitySettingsName
:
string
)
:
string
|
number
;
Parse the project from SecuritySettings resource.
securitySettingsName
string
A fully-qualified path representing SecuritySettings resource.
string | number
{string} A string representing the project.
matchProjectFromTestCaseName(testCaseName)
matchProjectFromTestCaseName
(
testCaseName
:
string
)
:
string
|
number
;
Parse the project from TestCase resource.
testCaseName
string
A fully-qualified path representing TestCase resource.
string | number
{string} A string representing the project.
matchProjectFromTestCaseResultName(testCaseResultName)
matchProjectFromTestCaseResultName
(
testCaseResultName
:
string
)
:
string
|
number
;
Parse the project from TestCaseResult resource.
testCaseResultName
string
A fully-qualified path representing TestCaseResult resource.
string | number
{string} A string representing the project.
matchProjectFromVersionName(versionName)
matchProjectFromVersionName
(
versionName
:
string
)
:
string
|
number
;
Parse the project from Version resource.
versionName
string
A fully-qualified path representing Version resource.
string | number
{string} A string representing the project.
matchProjectFromWebhookName(webhookName)
matchProjectFromWebhookName
(
webhookName
:
string
)
:
string
|
number
;
Parse the project from Webhook resource.
webhookName
string
A fully-qualified path representing Webhook resource.
string | number
{string} A string representing the project.
matchResultFromTestCaseResultName(testCaseResultName)
matchResultFromTestCaseResultName
(
testCaseResultName
:
string
)
:
string
|
number
;
Parse the result from TestCaseResult resource.
testCaseResultName
string
A fully-qualified path representing TestCaseResult resource.
string | number
{string} A string representing the result.
matchSecuritySettingsFromSecuritySettingsName(securitySettingsName)
matchSecuritySettingsFromSecuritySettingsName
(
securitySettingsName
:
string
)
:
string
|
number
;
Parse the security_settings from SecuritySettings resource.
securitySettingsName
string
A fully-qualified path representing SecuritySettings resource.
string | number
{string} A string representing the security_settings.
matchSessionFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)
matchSessionFromProjectLocationAgentEnvironmentSessionEntityTypeName
(
projectLocationAgentEnvironmentSessionEntityTypeName
:
string
)
:
string
|
number
;
Parse the session from ProjectLocationAgentEnvironmentSessionEntityType resource.
projectLocationAgentEnvironmentSessionEntityTypeName
string
A fully-qualified path representing project_location_agent_environment_session_entity_type resource.
string | number
{string} A string representing the session.
matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchSessionFromProjectLocationAgentSessionEntityTypeName
(
projectLocationAgentSessionEntityTypeName
:
string
)
:
string
|
number
;
Parse the session from ProjectLocationAgentSessionEntityType resource.
projectLocationAgentSessionEntityTypeName
string
A fully-qualified path representing project_location_agent_session_entity_type resource.
string | number
{string} A string representing the session.
matchTestCaseFromTestCaseName(testCaseName)
matchTestCaseFromTestCaseName
(
testCaseName
:
string
)
:
string
|
number
;
Parse the test_case from TestCase resource.
testCaseName
string
A fully-qualified path representing TestCase resource.
string | number
{string} A string representing the test_case.
matchTestCaseFromTestCaseResultName(testCaseResultName)
matchTestCaseFromTestCaseResultName
(
testCaseResultName
:
string
)
:
string
|
number
;
Parse the test_case from TestCaseResult resource.
testCaseResultName
string
A fully-qualified path representing TestCaseResult resource.
string | number
{string} A string representing the test_case.
matchTransitionRouteGroupFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName)
matchTransitionRouteGroupFromProjectLocationAgentFlowTransitionRouteGroupName
(
projectLocationAgentFlowTransitionRouteGroupName
:
string
)
:
string
|
number
;
Parse the transition_route_group from ProjectLocationAgentFlowTransitionRouteGroup resource.
projectLocationAgentFlowTransitionRouteGroupName
string
A fully-qualified path representing project_location_agent_flow_transition_route_group resource.
string | number
{string} A string representing the transition_route_group.
matchTransitionRouteGroupFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName)
matchTransitionRouteGroupFromProjectLocationAgentTransitionRouteGroupName
(
projectLocationAgentTransitionRouteGroupName
:
string
)
:
string
|
number
;
Parse the transition_route_group from ProjectLocationAgentTransitionRouteGroup resource.
projectLocationAgentTransitionRouteGroupName
string
A fully-qualified path representing project_location_agent_transition_route_group resource.
string | number
{string} A string representing the transition_route_group.
matchVersionFromVersionName(versionName)
matchVersionFromVersionName
(
versionName
:
string
)
:
string
|
number
;
Parse the version from Version resource.
versionName
string
A fully-qualified path representing Version resource.
string | number
{string} A string representing the version.
matchWebhookFromWebhookName(webhookName)
matchWebhookFromWebhookName
(
webhookName
:
string
)
:
string
|
number
;
Parse the webhook from Webhook resource.
webhookName
string
A fully-qualified path representing Webhook resource.
string | number
{string} A string representing the webhook.
pagePath(project, location, agent, flow, page)
pagePath
(
project
:
string
,
location
:
string
,
agent
:
string
,
flow
:
string
,
page
:
string
)
:
string
;
Return a fully-qualified page resource name string.
project
string
location
string
agent
string
flow
string
page
string
string
{string} Resource name string.
projectLocationAgentEnvironmentSessionEntityTypePath(project, location, agent, environment, session, entityType)
projectLocationAgentEnvironmentSessionEntityTypePath
(
project
:
string
,
location
:
string
,
agent
:
string
,
environment
:
string
,
session
:
string
,
entityType
:
string
)
:
string
;
Return a fully-qualified projectLocationAgentEnvironmentSessionEntityType resource name string.
project
string
location
string
agent
string
environment
string
session
string
entityType
string
string
{string} Resource name string.
projectLocationAgentFlowTransitionRouteGroupPath(project, location, agent, flow, transitionRouteGroup)
projectLocationAgentFlowTransitionRouteGroupPath
(
project
:
string
,
location
:
string
,
agent
:
string
,
flow
:
string
,
transitionRouteGroup
:
string
)
:
string
;
Return a fully-qualified projectLocationAgentFlowTransitionRouteGroup resource name string.
project
string
location
string
agent
string
flow
string
transitionRouteGroup
string
string
{string} Resource name string.
projectLocationAgentSessionEntityTypePath(project, location, agent, session, entityType)
projectLocationAgentSessionEntityTypePath
(
project
:
string
,
location
:
string
,
agent
:
string
,
session
:
string
,
entityType
:
string
)
:
string
;
Return a fully-qualified projectLocationAgentSessionEntityType resource name string.
project
string
location
string
agent
string
session
string
entityType
string
string
{string} Resource name string.
projectLocationAgentTransitionRouteGroupPath(project, location, agent, transitionRouteGroup)
projectLocationAgentTransitionRouteGroupPath
(
project
:
string
,
location
:
string
,
agent
:
string
,
transitionRouteGroup
:
string
)
:
string
;
Return a fully-qualified projectLocationAgentTransitionRouteGroup resource name string.
project
string
location
string
agent
string
transitionRouteGroup
string
string
{string} Resource name string.
projectPath(project)
projectPath
(
project
:
string
)
:
string
;
Return a fully-qualified project resource name string.
project
string
string
{string} Resource name string.
securitySettingsPath(project, location, securitySettings)
securitySettingsPath
(
project
:
string
,
location
:
string
,
securitySettings
:
string
)
:
string
;
Return a fully-qualified securitySettings resource name string.
project
string
location
string
securitySettings
string
string
{string} Resource name string.
testCasePath(project, location, agent, testCase)
testCasePath
(
project
:
string
,
location
:
string
,
agent
:
string
,
testCase
:
string
)
:
string
;
Return a fully-qualified testCase resource name string.
project
string
location
string
agent
string
testCase
string
string
{string} Resource name string.
testCaseResultPath(project, location, agent, testCase, result)
testCaseResultPath
(
project
:
string
,
location
:
string
,
agent
:
string
,
testCase
:
string
,
result
:
string
)
:
string
;
Return a fully-qualified testCaseResult resource name string.
project
string
location
string
agent
string
testCase
string
result
string
string
{string} Resource name string.
trainFlow(request, options)
trainFlow
(
request
?:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
ITrainFlowRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
protobuf
.
IStruct
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Trains the specified flow. Note that only the flow in 'draft' environment is trained.
This method is a [long-running operation]( https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation
). The returned Operation
type has the following method-specific fields:
-
metadata: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) -response: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
Note: You should always train a flow prior to sending it queries. See the [training documentation]( https://cloud.google.com/dialogflow/cx/docs/concept/training ).
request
options
Promise
<[ LROperation
< protos.google.protobuf.IEmpty
, protos.google.protobuf.IStruct
>, protos.google.longrunning.IOperation
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise()
method returns a promise you can await
for. Please see the documentation
for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
*
Required
.
The
flow
to
train
.
*
Format
:
`projects/
trainFlow(request, options, callback)
trainFlow
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
ITrainFlowRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
protobuf
.
IStruct
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.protobuf.IEmpty
, protos.google.protobuf.IStruct
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
trainFlow(request, callback)
trainFlow
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
ITrainFlowRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
protobuf
.
IStruct
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.protobuf.IEmpty
, protos.google.protobuf.IStruct
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
updateFlow(request, options)
updateFlow
(
request
?:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IUpdateFlowRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IFlow
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IUpdateFlowRequest
|
undefined
,
{}
|
undefined
]>;
Updates the specified flow.
Note: You should always train a flow prior to sending it queries. See the [training documentation]( https://cloud.google.com/dialogflow/cx/docs/concept/training ).
request
options
Promise
<[ protos.google.cloud.dialogflow.cx.v3.IFlow
, protos.google.cloud.dialogflow.cx.v3.IUpdateFlowRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Flow . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The flow to update.
*/
// const flow = {}
/**
* The mask to control which fields get updated. If the mask is not present,
* all fields will be updated.
*/
// const updateMask = {}
/**
* The language of the following fields in `flow`:
* * `Flow.event_handlers.trigger_fulfillment.messages`
* * `Flow.event_handlers.trigger_fulfillment.conditional_cases`
* * `Flow.transition_routes.trigger_fulfillment.messages`
* * `Flow.transition_routes.trigger_fulfillment.conditional_cases`
* If not specified, the agent's default language is used.
* Many
* languages (https://cloud.google.com/dialogflow/cx/docs/reference/language)
* are supported.
* Note: languages must be enabled in the agent before they can be used.
*/
// const languageCode = 'abc123'
// Imports the Cx library
const
{
FlowsClient
}
=
require
(
' @google-cloud/dialogflow-cx
'
).
v3
;
// Instantiates a client
const
cxClient
=
new
FlowsClient
();
async
function
callUpdateFlow
()
{
// Construct request
const
request
=
{
flow
,
};
// Run request
const
response
=
await
cxClient
.
updateFlow
(
request
);
console
.
log
(
response
);
}
callUpdateFlow
();
updateFlow(request, options, callback)
updateFlow
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IUpdateFlowRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IFlow
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IUpdateFlowRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.dialogflow.cx.v3.IFlow
, protos.google.cloud.dialogflow.cx.v3.IUpdateFlowRequest
| null | undefined, {} | null | undefined>
void
updateFlow(request, callback)
updateFlow
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IUpdateFlowRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IFlow
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IUpdateFlowRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.dialogflow.cx.v3.IFlow
, protos.google.cloud.dialogflow.cx.v3.IUpdateFlowRequest
| null | undefined, {} | null | undefined>
void
validateFlow(request, options)
validateFlow
(
request
?:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IValidateFlowRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IFlowValidationResult
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IValidateFlowRequest
|
undefined
,
{}
|
undefined
]>;
Validates the specified flow and creates or updates validation results. Please call this API after the training is completed to get the complete validation results.
request
options
Promise
<[ protos.google.cloud.dialogflow.cx.v3.IFlowValidationResult
, protos.google.cloud.dialogflow.cx.v3.IValidateFlowRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing FlowValidationResult . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
*
Required
.
The
flow
to
validate
.
*
Format
:
`projects/
validateFlow(request, options, callback)
validateFlow
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IValidateFlowRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IFlowValidationResult
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IValidateFlowRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.dialogflow.cx.v3.IFlowValidationResult
, protos.google.cloud.dialogflow.cx.v3.IValidateFlowRequest
| null | undefined, {} | null | undefined>
void
validateFlow(request, callback)
validateFlow
(
request
:
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IValidateFlowRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IFlowValidationResult
,
protos
.
google
.
cloud
.
dialogflow
.
cx
.
v3
.
IValidateFlowRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.dialogflow.cx.v3.IFlowValidationResult
, protos.google.cloud.dialogflow.cx.v3.IValidateFlowRequest
| null | undefined, {} | null | undefined>
void
versionPath(project, location, agent, flow, version)
versionPath
(
project
:
string
,
location
:
string
,
agent
:
string
,
flow
:
string
,
version
:
string
)
:
string
;
Return a fully-qualified version resource name string.
project
string
location
string
agent
string
flow
string
version
string
string
{string} Resource name string.
webhookPath(project, location, agent, webhook)
webhookPath
(
project
:
string
,
location
:
string
,
agent
:
string
,
webhook
:
string
)
:
string
;
Return a fully-qualified webhook resource name string.
project
string
location
string
agent
string
webhook
string
string
{string} Resource name string.
