A session represents an interaction with a user. You retrieve user input and pass it to the method to determine user intent and respond. v3
Package
@google-cloud/dialogflow-cxConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of SessionsClient.
Parameters | |
---|---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of |
Properties
apiEndpoint
get apiEndpoint(): string;
The DNS address for this API service.
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath.
auth
auth: gax.GoogleAuth;
descriptors
descriptors: Descriptors;
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.
sessionsStub
sessionsStub?: Promise<{
[name: string]: Function;
}>;
universeDomain
get universeDomain(): string;
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
agentGenerativeSettingsPath(project, location, agent)
agentGenerativeSettingsPath(project: string, location: string, agent: string): string;
Return a fully-qualified agentGenerativeSettings resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
agentPath(project, location, agent)
agentPath(project: string, location: string, agent: string): string;
Return a fully-qualified agent resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
Returns | |
---|---|
Type | Description |
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.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
Returns | |
---|---|
Type | Description |
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
.
Parameters | |
---|---|
Name | Description |
request |
CancelOperationRequest
The request object that will be sent. |
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. |
Returns | |
---|---|
Type | Description |
Promise<protos.google.protobuf.Empty> |
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.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
changelog |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
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.
Returns | |
---|---|
Type | Description |
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.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
environment |
string
|
continuousTestResult |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
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
.
Parameters | |
---|---|
Name | Description |
request |
DeleteOperationRequest
The request object that will be sent. |
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. |
Returns | |
---|---|
Type | Description |
Promise<protos.google.protobuf.Empty> |
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.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
environment |
string
|
deployment |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
detectIntent(request, options)
detectIntent(request?: protos.google.cloud.dialogflow.cx.v3.IDetectIntentRequest, options?: CallOptions): Promise<[
protos.google.cloud.dialogflow.cx.v3.IDetectIntentResponse,
protos.google.cloud.dialogflow.cx.v3.IDetectIntentRequest | undefined,
{} | undefined
]>;
Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries.
Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
Parameters | |
---|---|
Name | Description |
request |
IDetectIntentRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.dialogflow.cx.v3.IDetectIntentResponse,
protos.google.cloud.dialogflow.cx.v3.IDetectIntentRequest | undefined,
{} | undefined
]> |
{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. |
/**
* 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 session this query is sent to.
* Format:
* `projects/
detectIntent(request, options, callback)
detectIntent(request: protos.google.cloud.dialogflow.cx.v3.IDetectIntentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IDetectIntentResponse, protos.google.cloud.dialogflow.cx.v3.IDetectIntentRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDetectIntentRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.dialogflow.cx.v3.IDetectIntentResponse, protos.google.cloud.dialogflow.cx.v3.IDetectIntentRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
detectIntent(request, callback)
detectIntent(request: protos.google.cloud.dialogflow.cx.v3.IDetectIntentRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IDetectIntentResponse, protos.google.cloud.dialogflow.cx.v3.IDetectIntentRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDetectIntentRequest
|
callback |
Callback<protos.google.cloud.dialogflow.cx.v3.IDetectIntentResponse, protos.google.cloud.dialogflow.cx.v3.IDetectIntentRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
entityTypePath(project, location, agent, entityType)
entityTypePath(project: string, location: string, agent: string, entityType: string): string;
Return a fully-qualified entityType resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
entityType |
string
|
Returns | |
---|---|
Type | Description |
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.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
environment |
string
|
Returns | |
---|---|
Type | Description |
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.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
environment |
string
|
experiment |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
flowPath(project, location, agent, flow)
flowPath(project: string, location: string, agent: string, flow: string): string;
Return a fully-qualified flow resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
flow |
string
|
Returns | |
---|---|
Type | Description |
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.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
flow |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
fulfillIntent(request, options)
fulfillIntent(request?: protos.google.cloud.dialogflow.cx.v3.IFulfillIntentRequest, options?: CallOptions): Promise<[
protos.google.cloud.dialogflow.cx.v3.IFulfillIntentResponse,
protos.google.cloud.dialogflow.cx.v3.IFulfillIntentRequest | undefined,
{} | undefined
]>;
Fulfills a matched intent returned by . Must be called after , with input from MatchIntentResponse. Otherwise, the behavior is undefined.
Parameters | |
---|---|
Name | Description |
request |
IFulfillIntentRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.dialogflow.cx.v3.IFulfillIntentResponse,
protos.google.cloud.dialogflow.cx.v3.IFulfillIntentRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing FulfillIntentResponse. 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.
*/
/**
* Must be same as the corresponding MatchIntent request, otherwise the
* behavior is undefined.
*/
// const matchIntentRequest = {}
/**
* The matched intent/event to fulfill.
*/
// const match = {}
/**
* Instructs the speech synthesizer how to generate output audio.
*/
// const outputAudioConfig = {}
// Imports the Cx library
const {SessionsClient} = require('@google-cloud/dialogflow-cx').v3;
// Instantiates a client
const cxClient = new SessionsClient();
async function callFulfillIntent() {
// Construct request
const request = {
};
// Run request
const response = await cxClient.fulfillIntent(request);
console.log(response);
}
callFulfillIntent();
fulfillIntent(request, options, callback)
fulfillIntent(request: protos.google.cloud.dialogflow.cx.v3.IFulfillIntentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IFulfillIntentResponse, protos.google.cloud.dialogflow.cx.v3.IFulfillIntentRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IFulfillIntentRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.dialogflow.cx.v3.IFulfillIntentResponse, protos.google.cloud.dialogflow.cx.v3.IFulfillIntentRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
fulfillIntent(request, callback)
fulfillIntent(request: protos.google.cloud.dialogflow.cx.v3.IFulfillIntentRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IFulfillIntentResponse, protos.google.cloud.dialogflow.cx.v3.IFulfillIntentRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IFulfillIntentRequest
|
callback |
Callback<protos.google.cloud.dialogflow.cx.v3.IFulfillIntentResponse, protos.google.cloud.dialogflow.cx.v3.IFulfillIntentRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
generatorPath(project, location, agent, generator)
generatorPath(project: string, location: string, agent: string, generator: string): string;
Return a fully-qualified generator resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
generator |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
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.
Parameters | |
---|---|
Name | Description |
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>
|
Returns | |
---|---|
Type | Description |
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.
Parameters | |
---|---|
Name | Description |
request |
GetOperationRequest
The request object that will be sent. |
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. |
Returns | |
---|---|
Type | Description |
Promise<[protos.google.longrunning.Operation]> |
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
getProjectId()
getProjectId(): Promise<string>;
Returns | |
---|---|
Type | Description |
Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter | |
---|---|
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns | |
---|---|
Type | Description |
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.
Returns | |
---|---|
Type | Description |
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.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
intent |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
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.
Parameters | |
---|---|
Name | Description |
request |
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
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.
Parameters | |
---|---|
Name | Description |
request |
ListOperationsRequest
The request object that will be sent. |
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. |
Returns | |
---|---|
Type | Description |
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)
matchAgentFromAgentGenerativeSettingsName(agentGenerativeSettingsName)
matchAgentFromAgentGenerativeSettingsName(agentGenerativeSettingsName: string): string | number;
Parse the agent from AgentGenerativeSettings resource.
Parameter | |
---|---|
Name | Description |
agentGenerativeSettingsName |
string
A fully-qualified path representing AgentGenerativeSettings resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromAgentName(agentName)
matchAgentFromAgentName(agentName: string): string | number;
Parse the agent from Agent resource.
Parameter | |
---|---|
Name | Description |
agentName |
string
A fully-qualified path representing Agent resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromAgentValidationResultName(agentValidationResultName)
matchAgentFromAgentValidationResultName(agentValidationResultName: string): string | number;
Parse the agent from AgentValidationResult resource.
Parameter | |
---|---|
Name | Description |
agentValidationResultName |
string
A fully-qualified path representing AgentValidationResult resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromChangelogName(changelogName)
matchAgentFromChangelogName(changelogName: string): string | number;
Parse the agent from Changelog resource.
Parameter | |
---|---|
Name | Description |
changelogName |
string
A fully-qualified path representing Changelog resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromContinuousTestResultName(continuousTestResultName)
matchAgentFromContinuousTestResultName(continuousTestResultName: string): string | number;
Parse the agent from ContinuousTestResult resource.
Parameter | |
---|---|
Name | Description |
continuousTestResultName |
string
A fully-qualified path representing ContinuousTestResult resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromDeploymentName(deploymentName)
matchAgentFromDeploymentName(deploymentName: string): string | number;
Parse the agent from Deployment resource.
Parameter | |
---|---|
Name | Description |
deploymentName |
string
A fully-qualified path representing Deployment resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromEntityTypeName(entityTypeName)
matchAgentFromEntityTypeName(entityTypeName: string): string | number;
Parse the agent from EntityType resource.
Parameter | |
---|---|
Name | Description |
entityTypeName |
string
A fully-qualified path representing EntityType resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromEnvironmentName(environmentName)
matchAgentFromEnvironmentName(environmentName: string): string | number;
Parse the agent from Environment resource.
Parameter | |
---|---|
Name | Description |
environmentName |
string
A fully-qualified path representing Environment resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromExperimentName(experimentName)
matchAgentFromExperimentName(experimentName: string): string | number;
Parse the agent from Experiment resource.
Parameter | |
---|---|
Name | Description |
experimentName |
string
A fully-qualified path representing Experiment resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromFlowName(flowName)
matchAgentFromFlowName(flowName: string): string | number;
Parse the agent from Flow resource.
Parameter | |
---|---|
Name | Description |
flowName |
string
A fully-qualified path representing Flow resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromFlowValidationResultName(flowValidationResultName)
matchAgentFromFlowValidationResultName(flowValidationResultName: string): string | number;
Parse the agent from FlowValidationResult resource.
Parameter | |
---|---|
Name | Description |
flowValidationResultName |
string
A fully-qualified path representing FlowValidationResult resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromGeneratorName(generatorName)
matchAgentFromGeneratorName(generatorName: string): string | number;
Parse the agent from Generator resource.
Parameter | |
---|---|
Name | Description |
generatorName |
string
A fully-qualified path representing Generator resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromIntentName(intentName)
matchAgentFromIntentName(intentName: string): string | number;
Parse the agent from Intent resource.
Parameter | |
---|---|
Name | Description |
intentName |
string
A fully-qualified path representing Intent resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromPageName(pageName)
matchAgentFromPageName(pageName: string): string | number;
Parse the agent from Page resource.
Parameter | |
---|---|
Name | Description |
pageName |
string
A fully-qualified path representing Page resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)
matchAgentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;
Parse the agent from ProjectLocationAgentEnvironmentSessionEntityType resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEnvironmentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_session_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName)
matchAgentFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName: string): string | number;
Parse the agent from ProjectLocationAgentEnvironmentSession resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEnvironmentSessionName |
string
A fully-qualified path representing project_location_agent_environment_session resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName)
matchAgentFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName: string): string | number;
Parse the agent from ProjectLocationAgentFlowTransitionRouteGroup resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentFlowTransitionRouteGroupName |
string
A fully-qualified path representing project_location_agent_flow_transition_route_group resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchAgentFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;
Parse the agent from ProjectLocationAgentSessionEntityType resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_session_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromProjectLocationAgentSessionName(projectLocationAgentSessionName)
matchAgentFromProjectLocationAgentSessionName(projectLocationAgentSessionName: string): string | number;
Parse the agent from ProjectLocationAgentSession resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentSessionName |
string
A fully-qualified path representing project_location_agent_session resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName)
matchAgentFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName: string): string | number;
Parse the agent from ProjectLocationAgentTransitionRouteGroup resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentTransitionRouteGroupName |
string
A fully-qualified path representing project_location_agent_transition_route_group resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromTestCaseName(testCaseName)
matchAgentFromTestCaseName(testCaseName: string): string | number;
Parse the agent from TestCase resource.
Parameter | |
---|---|
Name | Description |
testCaseName |
string
A fully-qualified path representing TestCase resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromTestCaseResultName(testCaseResultName)
matchAgentFromTestCaseResultName(testCaseResultName: string): string | number;
Parse the agent from TestCaseResult resource.
Parameter | |
---|---|
Name | Description |
testCaseResultName |
string
A fully-qualified path representing TestCaseResult resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromVersionName(versionName)
matchAgentFromVersionName(versionName: string): string | number;
Parse the agent from Version resource.
Parameter | |
---|---|
Name | Description |
versionName |
string
A fully-qualified path representing Version resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchAgentFromWebhookName(webhookName)
matchAgentFromWebhookName(webhookName: string): string | number;
Parse the agent from Webhook resource.
Parameter | |
---|---|
Name | Description |
webhookName |
string
A fully-qualified path representing Webhook resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the agent. |
matchChangelogFromChangelogName(changelogName)
matchChangelogFromChangelogName(changelogName: string): string | number;
Parse the changelog from Changelog resource.
Parameter | |
---|---|
Name | Description |
changelogName |
string
A fully-qualified path representing Changelog resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the changelog. |
matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)
matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
Parse the collection from ProjectLocationCollectionDataStore resource.
Parameter | |
---|---|
Name | Description |
projectLocationCollectionDataStoreName |
string
A fully-qualified path representing project_location_collection_data_store resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the collection. |
matchContinuousTestResultFromContinuousTestResultName(continuousTestResultName)
matchContinuousTestResultFromContinuousTestResultName(continuousTestResultName: string): string | number;
Parse the continuous_test_result from ContinuousTestResult resource.
Parameter | |
---|---|
Name | Description |
continuousTestResultName |
string
A fully-qualified path representing ContinuousTestResult resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the continuous_test_result. |
matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)
matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
Parse the data_store from ProjectLocationCollectionDataStore resource.
Parameter | |
---|---|
Name | Description |
projectLocationCollectionDataStoreName |
string
A fully-qualified path representing project_location_collection_data_store resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the data_store. |
matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName)
matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
Parse the data_store from ProjectLocationDataStore resource.
Parameter | |
---|---|
Name | Description |
projectLocationDataStoreName |
string
A fully-qualified path representing project_location_data_store resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the data_store. |
matchDeploymentFromDeploymentName(deploymentName)
matchDeploymentFromDeploymentName(deploymentName: string): string | number;
Parse the deployment from Deployment resource.
Parameter | |
---|---|
Name | Description |
deploymentName |
string
A fully-qualified path representing Deployment resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the deployment. |
matchEntityTypeFromEntityTypeName(entityTypeName)
matchEntityTypeFromEntityTypeName(entityTypeName: string): string | number;
Parse the entity_type from EntityType resource.
Parameter | |
---|---|
Name | Description |
entityTypeName |
string
A fully-qualified path representing EntityType resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the entity_type. |
matchEntityTypeFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)
matchEntityTypeFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;
Parse the entity_type from ProjectLocationAgentEnvironmentSessionEntityType resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEnvironmentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_session_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the entity_type. |
matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;
Parse the entity_type from ProjectLocationAgentSessionEntityType resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_session_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the entity_type. |
matchEnvironmentFromContinuousTestResultName(continuousTestResultName)
matchEnvironmentFromContinuousTestResultName(continuousTestResultName: string): string | number;
Parse the environment from ContinuousTestResult resource.
Parameter | |
---|---|
Name | Description |
continuousTestResultName |
string
A fully-qualified path representing ContinuousTestResult resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the environment. |
matchEnvironmentFromDeploymentName(deploymentName)
matchEnvironmentFromDeploymentName(deploymentName: string): string | number;
Parse the environment from Deployment resource.
Parameter | |
---|---|
Name | Description |
deploymentName |
string
A fully-qualified path representing Deployment resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the environment. |
matchEnvironmentFromEnvironmentName(environmentName)
matchEnvironmentFromEnvironmentName(environmentName: string): string | number;
Parse the environment from Environment resource.
Parameter | |
---|---|
Name | Description |
environmentName |
string
A fully-qualified path representing Environment resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the environment. |
matchEnvironmentFromExperimentName(experimentName)
matchEnvironmentFromExperimentName(experimentName: string): string | number;
Parse the environment from Experiment resource.
Parameter | |
---|---|
Name | Description |
experimentName |
string
A fully-qualified path representing Experiment resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the environment. |
matchEnvironmentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)
matchEnvironmentFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;
Parse the environment from ProjectLocationAgentEnvironmentSessionEntityType resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEnvironmentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_session_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the environment. |
matchEnvironmentFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName)
matchEnvironmentFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName: string): string | number;
Parse the environment from ProjectLocationAgentEnvironmentSession resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEnvironmentSessionName |
string
A fully-qualified path representing project_location_agent_environment_session resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the environment. |
matchExperimentFromExperimentName(experimentName)
matchExperimentFromExperimentName(experimentName: string): string | number;
Parse the experiment from Experiment resource.
Parameter | |
---|---|
Name | Description |
experimentName |
string
A fully-qualified path representing Experiment resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the experiment. |
matchFlowFromFlowName(flowName)
matchFlowFromFlowName(flowName: string): string | number;
Parse the flow from Flow resource.
Parameter | |
---|---|
Name | Description |
flowName |
string
A fully-qualified path representing Flow resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the flow. |
matchFlowFromFlowValidationResultName(flowValidationResultName)
matchFlowFromFlowValidationResultName(flowValidationResultName: string): string | number;
Parse the flow from FlowValidationResult resource.
Parameter | |
---|---|
Name | Description |
flowValidationResultName |
string
A fully-qualified path representing FlowValidationResult resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the flow. |
matchFlowFromPageName(pageName)
matchFlowFromPageName(pageName: string): string | number;
Parse the flow from Page resource.
Parameter | |
---|---|
Name | Description |
pageName |
string
A fully-qualified path representing Page resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the flow. |
matchFlowFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName)
matchFlowFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName: string): string | number;
Parse the flow from ProjectLocationAgentFlowTransitionRouteGroup resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentFlowTransitionRouteGroupName |
string
A fully-qualified path representing project_location_agent_flow_transition_route_group resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the flow. |
matchFlowFromVersionName(versionName)
matchFlowFromVersionName(versionName: string): string | number;
Parse the flow from Version resource.
Parameter | |
---|---|
Name | Description |
versionName |
string
A fully-qualified path representing Version resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the flow. |
matchGeneratorFromGeneratorName(generatorName)
matchGeneratorFromGeneratorName(generatorName: string): string | number;
Parse the generator from Generator resource.
Parameter | |
---|---|
Name | Description |
generatorName |
string
A fully-qualified path representing Generator resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the generator. |
matchIntent(request, options)
matchIntent(request?: protos.google.cloud.dialogflow.cx.v3.IMatchIntentRequest, options?: CallOptions): Promise<[
protos.google.cloud.dialogflow.cx.v3.IMatchIntentResponse,
protos.google.cloud.dialogflow.cx.v3.IMatchIntentRequest | undefined,
{} | undefined
]>;
Returns preliminary intent match results, doesn't change the session status.
Parameters | |
---|---|
Name | Description |
request |
IMatchIntentRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.dialogflow.cx.v3.IMatchIntentResponse,
protos.google.cloud.dialogflow.cx.v3.IMatchIntentRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing MatchIntentResponse. 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 session this query is sent to.
* Format:
* `projects/
matchIntent(request, options, callback)
matchIntent(request: protos.google.cloud.dialogflow.cx.v3.IMatchIntentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IMatchIntentResponse, protos.google.cloud.dialogflow.cx.v3.IMatchIntentRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IMatchIntentRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.dialogflow.cx.v3.IMatchIntentResponse, protos.google.cloud.dialogflow.cx.v3.IMatchIntentRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
matchIntent(request, callback)
matchIntent(request: protos.google.cloud.dialogflow.cx.v3.IMatchIntentRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IMatchIntentResponse, protos.google.cloud.dialogflow.cx.v3.IMatchIntentRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IMatchIntentRequest
|
callback |
Callback<protos.google.cloud.dialogflow.cx.v3.IMatchIntentResponse, protos.google.cloud.dialogflow.cx.v3.IMatchIntentRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
matchIntentFromIntentName(intentName)
matchIntentFromIntentName(intentName: string): string | number;
Parse the intent from Intent resource.
Parameter | |
---|---|
Name | Description |
intentName |
string
A fully-qualified path representing Intent resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the intent. |
matchLocationFromAgentGenerativeSettingsName(agentGenerativeSettingsName)
matchLocationFromAgentGenerativeSettingsName(agentGenerativeSettingsName: string): string | number;
Parse the location from AgentGenerativeSettings resource.
Parameter | |
---|---|
Name | Description |
agentGenerativeSettingsName |
string
A fully-qualified path representing AgentGenerativeSettings resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromAgentName(agentName)
matchLocationFromAgentName(agentName: string): string | number;
Parse the location from Agent resource.
Parameter | |
---|---|
Name | Description |
agentName |
string
A fully-qualified path representing Agent resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromAgentValidationResultName(agentValidationResultName)
matchLocationFromAgentValidationResultName(agentValidationResultName: string): string | number;
Parse the location from AgentValidationResult resource.
Parameter | |
---|---|
Name | Description |
agentValidationResultName |
string
A fully-qualified path representing AgentValidationResult resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromChangelogName(changelogName)
matchLocationFromChangelogName(changelogName: string): string | number;
Parse the location from Changelog resource.
Parameter | |
---|---|
Name | Description |
changelogName |
string
A fully-qualified path representing Changelog resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromContinuousTestResultName(continuousTestResultName)
matchLocationFromContinuousTestResultName(continuousTestResultName: string): string | number;
Parse the location from ContinuousTestResult resource.
Parameter | |
---|---|
Name | Description |
continuousTestResultName |
string
A fully-qualified path representing ContinuousTestResult resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromDeploymentName(deploymentName)
matchLocationFromDeploymentName(deploymentName: string): string | number;
Parse the location from Deployment resource.
Parameter | |
---|---|
Name | Description |
deploymentName |
string
A fully-qualified path representing Deployment resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromEntityTypeName(entityTypeName)
matchLocationFromEntityTypeName(entityTypeName: string): string | number;
Parse the location from EntityType resource.
Parameter | |
---|---|
Name | Description |
entityTypeName |
string
A fully-qualified path representing EntityType resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromEnvironmentName(environmentName)
matchLocationFromEnvironmentName(environmentName: string): string | number;
Parse the location from Environment resource.
Parameter | |
---|---|
Name | Description |
environmentName |
string
A fully-qualified path representing Environment resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromExperimentName(experimentName)
matchLocationFromExperimentName(experimentName: string): string | number;
Parse the location from Experiment resource.
Parameter | |
---|---|
Name | Description |
experimentName |
string
A fully-qualified path representing Experiment resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromFlowName(flowName)
matchLocationFromFlowName(flowName: string): string | number;
Parse the location from Flow resource.
Parameter | |
---|---|
Name | Description |
flowName |
string
A fully-qualified path representing Flow resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromFlowValidationResultName(flowValidationResultName)
matchLocationFromFlowValidationResultName(flowValidationResultName: string): string | number;
Parse the location from FlowValidationResult resource.
Parameter | |
---|---|
Name | Description |
flowValidationResultName |
string
A fully-qualified path representing FlowValidationResult resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromGeneratorName(generatorName)
matchLocationFromGeneratorName(generatorName: string): string | number;
Parse the location from Generator resource.
Parameter | |
---|---|
Name | Description |
generatorName |
string
A fully-qualified path representing Generator resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromIntentName(intentName)
matchLocationFromIntentName(intentName: string): string | number;
Parse the location from Intent resource.
Parameter | |
---|---|
Name | Description |
intentName |
string
A fully-qualified path representing Intent resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromPageName(pageName)
matchLocationFromPageName(pageName: string): string | number;
Parse the location from Page resource.
Parameter | |
---|---|
Name | Description |
pageName |
string
A fully-qualified path representing Page resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)
matchLocationFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;
Parse the location from ProjectLocationAgentEnvironmentSessionEntityType resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEnvironmentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_session_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName)
matchLocationFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName: string): string | number;
Parse the location from ProjectLocationAgentEnvironmentSession resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEnvironmentSessionName |
string
A fully-qualified path representing project_location_agent_environment_session resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName)
matchLocationFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName: string): string | number;
Parse the location from ProjectLocationAgentFlowTransitionRouteGroup resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentFlowTransitionRouteGroupName |
string
A fully-qualified path representing project_location_agent_flow_transition_route_group resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;
Parse the location from ProjectLocationAgentSessionEntityType resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_session_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromProjectLocationAgentSessionName(projectLocationAgentSessionName)
matchLocationFromProjectLocationAgentSessionName(projectLocationAgentSessionName: string): string | number;
Parse the location from ProjectLocationAgentSession resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentSessionName |
string
A fully-qualified path representing project_location_agent_session resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName)
matchLocationFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName: string): string | number;
Parse the location from ProjectLocationAgentTransitionRouteGroup resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentTransitionRouteGroupName |
string
A fully-qualified path representing project_location_agent_transition_route_group resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)
matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
Parse the location from ProjectLocationCollectionDataStore resource.
Parameter | |
---|---|
Name | Description |
projectLocationCollectionDataStoreName |
string
A fully-qualified path representing project_location_collection_data_store resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName)
matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
Parse the location from ProjectLocationDataStore resource.
Parameter | |
---|---|
Name | Description |
projectLocationDataStoreName |
string
A fully-qualified path representing project_location_data_store resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromSecuritySettingsName(securitySettingsName)
matchLocationFromSecuritySettingsName(securitySettingsName: string): string | number;
Parse the location from SecuritySettings resource.
Parameter | |
---|---|
Name | Description |
securitySettingsName |
string
A fully-qualified path representing SecuritySettings resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromTestCaseName(testCaseName)
matchLocationFromTestCaseName(testCaseName: string): string | number;
Parse the location from TestCase resource.
Parameter | |
---|---|
Name | Description |
testCaseName |
string
A fully-qualified path representing TestCase resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromTestCaseResultName(testCaseResultName)
matchLocationFromTestCaseResultName(testCaseResultName: string): string | number;
Parse the location from TestCaseResult resource.
Parameter | |
---|---|
Name | Description |
testCaseResultName |
string
A fully-qualified path representing TestCaseResult resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromVersionName(versionName)
matchLocationFromVersionName(versionName: string): string | number;
Parse the location from Version resource.
Parameter | |
---|---|
Name | Description |
versionName |
string
A fully-qualified path representing Version resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchLocationFromWebhookName(webhookName)
matchLocationFromWebhookName(webhookName: string): string | number;
Parse the location from Webhook resource.
Parameter | |
---|---|
Name | Description |
webhookName |
string
A fully-qualified path representing Webhook resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the location. |
matchPageFromPageName(pageName)
matchPageFromPageName(pageName: string): string | number;
Parse the page from Page resource.
Parameter | |
---|---|
Name | Description |
pageName |
string
A fully-qualified path representing Page resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the page. |
matchProjectFromAgentGenerativeSettingsName(agentGenerativeSettingsName)
matchProjectFromAgentGenerativeSettingsName(agentGenerativeSettingsName: string): string | number;
Parse the project from AgentGenerativeSettings resource.
Parameter | |
---|---|
Name | Description |
agentGenerativeSettingsName |
string
A fully-qualified path representing AgentGenerativeSettings resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromAgentName(agentName)
matchProjectFromAgentName(agentName: string): string | number;
Parse the project from Agent resource.
Parameter | |
---|---|
Name | Description |
agentName |
string
A fully-qualified path representing Agent resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromAgentValidationResultName(agentValidationResultName)
matchProjectFromAgentValidationResultName(agentValidationResultName: string): string | number;
Parse the project from AgentValidationResult resource.
Parameter | |
---|---|
Name | Description |
agentValidationResultName |
string
A fully-qualified path representing AgentValidationResult resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromChangelogName(changelogName)
matchProjectFromChangelogName(changelogName: string): string | number;
Parse the project from Changelog resource.
Parameter | |
---|---|
Name | Description |
changelogName |
string
A fully-qualified path representing Changelog resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromContinuousTestResultName(continuousTestResultName)
matchProjectFromContinuousTestResultName(continuousTestResultName: string): string | number;
Parse the project from ContinuousTestResult resource.
Parameter | |
---|---|
Name | Description |
continuousTestResultName |
string
A fully-qualified path representing ContinuousTestResult resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromDeploymentName(deploymentName)
matchProjectFromDeploymentName(deploymentName: string): string | number;
Parse the project from Deployment resource.
Parameter | |
---|---|
Name | Description |
deploymentName |
string
A fully-qualified path representing Deployment resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromEntityTypeName(entityTypeName)
matchProjectFromEntityTypeName(entityTypeName: string): string | number;
Parse the project from EntityType resource.
Parameter | |
---|---|
Name | Description |
entityTypeName |
string
A fully-qualified path representing EntityType resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromEnvironmentName(environmentName)
matchProjectFromEnvironmentName(environmentName: string): string | number;
Parse the project from Environment resource.
Parameter | |
---|---|
Name | Description |
environmentName |
string
A fully-qualified path representing Environment resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromExperimentName(experimentName)
matchProjectFromExperimentName(experimentName: string): string | number;
Parse the project from Experiment resource.
Parameter | |
---|---|
Name | Description |
experimentName |
string
A fully-qualified path representing Experiment resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromFlowName(flowName)
matchProjectFromFlowName(flowName: string): string | number;
Parse the project from Flow resource.
Parameter | |
---|---|
Name | Description |
flowName |
string
A fully-qualified path representing Flow resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromFlowValidationResultName(flowValidationResultName)
matchProjectFromFlowValidationResultName(flowValidationResultName: string): string | number;
Parse the project from FlowValidationResult resource.
Parameter | |
---|---|
Name | Description |
flowValidationResultName |
string
A fully-qualified path representing FlowValidationResult resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromGeneratorName(generatorName)
matchProjectFromGeneratorName(generatorName: string): string | number;
Parse the project from Generator resource.
Parameter | |
---|---|
Name | Description |
generatorName |
string
A fully-qualified path representing Generator resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromIntentName(intentName)
matchProjectFromIntentName(intentName: string): string | number;
Parse the project from Intent resource.
Parameter | |
---|---|
Name | Description |
intentName |
string
A fully-qualified path representing Intent resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromPageName(pageName)
matchProjectFromPageName(pageName: string): string | number;
Parse the project from Page resource.
Parameter | |
---|---|
Name | Description |
pageName |
string
A fully-qualified path representing Page resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)
matchProjectFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;
Parse the project from ProjectLocationAgentEnvironmentSessionEntityType resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEnvironmentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_session_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName)
matchProjectFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName: string): string | number;
Parse the project from ProjectLocationAgentEnvironmentSession resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEnvironmentSessionName |
string
A fully-qualified path representing project_location_agent_environment_session resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName)
matchProjectFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName: string): string | number;
Parse the project from ProjectLocationAgentFlowTransitionRouteGroup resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentFlowTransitionRouteGroupName |
string
A fully-qualified path representing project_location_agent_flow_transition_route_group resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;
Parse the project from ProjectLocationAgentSessionEntityType resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_session_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromProjectLocationAgentSessionName(projectLocationAgentSessionName)
matchProjectFromProjectLocationAgentSessionName(projectLocationAgentSessionName: string): string | number;
Parse the project from ProjectLocationAgentSession resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentSessionName |
string
A fully-qualified path representing project_location_agent_session resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName)
matchProjectFromProjectLocationAgentTransitionRouteGroupName(projectLocationAgentTransitionRouteGroupName: string): string | number;
Parse the project from ProjectLocationAgentTransitionRouteGroup resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentTransitionRouteGroupName |
string
A fully-qualified path representing project_location_agent_transition_route_group resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName)
matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
Parse the project from ProjectLocationCollectionDataStore resource.
Parameter | |
---|---|
Name | Description |
projectLocationCollectionDataStoreName |
string
A fully-qualified path representing project_location_collection_data_store resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName)
matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
Parse the project from ProjectLocationDataStore resource.
Parameter | |
---|---|
Name | Description |
projectLocationDataStoreName |
string
A fully-qualified path representing project_location_data_store resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromSecuritySettingsName(securitySettingsName)
matchProjectFromSecuritySettingsName(securitySettingsName: string): string | number;
Parse the project from SecuritySettings resource.
Parameter | |
---|---|
Name | Description |
securitySettingsName |
string
A fully-qualified path representing SecuritySettings resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromTestCaseName(testCaseName)
matchProjectFromTestCaseName(testCaseName: string): string | number;
Parse the project from TestCase resource.
Parameter | |
---|---|
Name | Description |
testCaseName |
string
A fully-qualified path representing TestCase resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromTestCaseResultName(testCaseResultName)
matchProjectFromTestCaseResultName(testCaseResultName: string): string | number;
Parse the project from TestCaseResult resource.
Parameter | |
---|---|
Name | Description |
testCaseResultName |
string
A fully-qualified path representing TestCaseResult resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromVersionName(versionName)
matchProjectFromVersionName(versionName: string): string | number;
Parse the project from Version resource.
Parameter | |
---|---|
Name | Description |
versionName |
string
A fully-qualified path representing Version resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchProjectFromWebhookName(webhookName)
matchProjectFromWebhookName(webhookName: string): string | number;
Parse the project from Webhook resource.
Parameter | |
---|---|
Name | Description |
webhookName |
string
A fully-qualified path representing Webhook resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the project. |
matchResultFromTestCaseResultName(testCaseResultName)
matchResultFromTestCaseResultName(testCaseResultName: string): string | number;
Parse the result from TestCaseResult resource.
Parameter | |
---|---|
Name | Description |
testCaseResultName |
string
A fully-qualified path representing TestCaseResult resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the result. |
matchSecuritySettingsFromSecuritySettingsName(securitySettingsName)
matchSecuritySettingsFromSecuritySettingsName(securitySettingsName: string): string | number;
Parse the security_settings from SecuritySettings resource.
Parameter | |
---|---|
Name | Description |
securitySettingsName |
string
A fully-qualified path representing SecuritySettings resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the security_settings. |
matchSessionFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName)
matchSessionFromProjectLocationAgentEnvironmentSessionEntityTypeName(projectLocationAgentEnvironmentSessionEntityTypeName: string): string | number;
Parse the session from ProjectLocationAgentEnvironmentSessionEntityType resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEnvironmentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_session_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the session. |
matchSessionFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName)
matchSessionFromProjectLocationAgentEnvironmentSessionName(projectLocationAgentEnvironmentSessionName: string): string | number;
Parse the session from ProjectLocationAgentEnvironmentSession resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEnvironmentSessionName |
string
A fully-qualified path representing project_location_agent_environment_session resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the session. |
matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;
Parse the session from ProjectLocationAgentSessionEntityType resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_session_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the session. |
matchSessionFromProjectLocationAgentSessionName(projectLocationAgentSessionName)
matchSessionFromProjectLocationAgentSessionName(projectLocationAgentSessionName: string): string | number;
Parse the session from ProjectLocationAgentSession resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentSessionName |
string
A fully-qualified path representing project_location_agent_session resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the session. |
matchTestCaseFromTestCaseName(testCaseName)
matchTestCaseFromTestCaseName(testCaseName: string): string | number;
Parse the test_case from TestCase resource.
Parameter | |
---|---|
Name | Description |
testCaseName |
string
A fully-qualified path representing TestCase resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the test_case. |
matchTestCaseFromTestCaseResultName(testCaseResultName)
matchTestCaseFromTestCaseResultName(testCaseResultName: string): string | number;
Parse the test_case from TestCaseResult resource.
Parameter | |
---|---|
Name | Description |
testCaseResultName |
string
A fully-qualified path representing TestCaseResult resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the test_case. |
matchTransitionRouteGroupFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName)
matchTransitionRouteGroupFromProjectLocationAgentFlowTransitionRouteGroupName(projectLocationAgentFlowTransitionRouteGroupName: string): string | number;
Parse the transition_route_group from ProjectLocationAgentFlowTransitionRouteGroup resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentFlowTransitionRouteGroupName |
string
A fully-qualified path representing project_location_agent_flow_transition_route_group resource. |
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
projectLocationAgentTransitionRouteGroupName |
string
A fully-qualified path representing project_location_agent_transition_route_group resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the transition_route_group. |
matchVersionFromVersionName(versionName)
matchVersionFromVersionName(versionName: string): string | number;
Parse the version from Version resource.
Parameter | |
---|---|
Name | Description |
versionName |
string
A fully-qualified path representing Version resource. |
Returns | |
---|---|
Type | Description |
string | number |
{string} A string representing the version. |
matchWebhookFromWebhookName(webhookName)
matchWebhookFromWebhookName(webhookName: string): string | number;
Parse the webhook from Webhook resource.
Parameter | |
---|---|
Name | Description |
webhookName |
string
A fully-qualified path representing Webhook resource. |
Returns | |
---|---|
Type | Description |
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.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
flow |
string
|
page |
string
|
Returns | |
---|---|
Type | Description |
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.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
environment |
string
|
session |
string
|
entityType |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
projectLocationAgentEnvironmentSessionPath(project, location, agent, environment, session)
projectLocationAgentEnvironmentSessionPath(project: string, location: string, agent: string, environment: string, session: string): string;
Return a fully-qualified projectLocationAgentEnvironmentSession resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
environment |
string
|
session |
string
|
Returns | |
---|---|
Type | Description |
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.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
flow |
string
|
transitionRouteGroup |
string
|
Returns | |
---|---|
Type | Description |
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.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
session |
string
|
entityType |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
projectLocationAgentSessionPath(project, location, agent, session)
projectLocationAgentSessionPath(project: string, location: string, agent: string, session: string): string;
Return a fully-qualified projectLocationAgentSession resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
session |
string
|
Returns | |
---|---|
Type | Description |
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.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
transitionRouteGroup |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
projectLocationCollectionDataStorePath(project, location, collection, dataStore)
projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
Return a fully-qualified projectLocationCollectionDataStore resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
collection |
string
|
dataStore |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
projectLocationDataStorePath(project, location, dataStore)
projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
Return a fully-qualified projectLocationDataStore resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
dataStore |
string
|
Returns | |
---|---|
Type | Description |
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.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
securitySettings |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
serverStreamingDetectIntent(request, options)
serverStreamingDetectIntent(request?: protos.google.cloud.dialogflow.cx.v3.IDetectIntentRequest, options?: CallOptions): gax.CancellableStream;
Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send [partial responses](https://cloud.google.com/dialogflow/cx/docs/concept/fulfillment#partial-response) earlier in a single request.
Parameters | |
---|---|
Name | Description |
request |
IDetectIntentRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
gax.CancellableStream |
{Stream} An object stream which emits on 'data' event. 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 session this query is sent to.
* Format:
* `projects/
streamingDetectIntent(options)
streamingDetectIntent(options?: CallOptions): gax.CancellableStream;
Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).
Note: Always use agent versions for production traffic. See [Versions and environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
Parameter | |
---|---|
Name | Description |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
gax.CancellableStream |
{Stream} An object stream which is both readable and writable. It accepts objects representing StreamingDetectIntentRequest for write() method, and will emit objects representing StreamingDetectIntentResponse on 'data' event asynchronously. 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.
*/
/**
* The name of the session this query is sent to.
* Format:
* `projects/
submitAnswerFeedback(request, options)
submitAnswerFeedback(request?: protos.google.cloud.dialogflow.cx.v3.ISubmitAnswerFeedbackRequest, options?: CallOptions): Promise<[
protos.google.cloud.dialogflow.cx.v3.IAnswerFeedback,
(protos.google.cloud.dialogflow.cx.v3.ISubmitAnswerFeedbackRequest | undefined),
{} | undefined
]>;
Updates the feedback received from the user for a single turn of the bot response.
Parameters | |
---|---|
Name | Description |
request |
ISubmitAnswerFeedbackRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.dialogflow.cx.v3.IAnswerFeedback,
(protos.google.cloud.dialogflow.cx.v3.ISubmitAnswerFeedbackRequest | undefined),
{} | undefined
]> |
{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. |
/**
* 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 session the feedback was sent to.
*/
// const session = 'abc123'
/**
* Required. ID of the response to update its feedback. This is the same as
* DetectIntentResponse.response_id.
*/
// const responseId = 'abc123'
/**
* Required. Feedback provided for a bot answer.
*/
// const answerFeedback = {}
/**
* Optional. The mask to control which fields to update. If the mask is not
* present, all fields will be updated.
*/
// const updateMask = {}
// Imports the Cx library
const {SessionsClient} = require('@google-cloud/dialogflow-cx').v3;
// Instantiates a client
const cxClient = new SessionsClient();
async function callSubmitAnswerFeedback() {
// Construct request
const request = {
session,
responseId,
answerFeedback,
};
// Run request
const response = await cxClient.submitAnswerFeedback(request);
console.log(response);
}
callSubmitAnswerFeedback();
submitAnswerFeedback(request, options, callback)
submitAnswerFeedback(request: protos.google.cloud.dialogflow.cx.v3.ISubmitAnswerFeedbackRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IAnswerFeedback, protos.google.cloud.dialogflow.cx.v3.ISubmitAnswerFeedbackRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ISubmitAnswerFeedbackRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.dialogflow.cx.v3.IAnswerFeedback, protos.google.cloud.dialogflow.cx.v3.ISubmitAnswerFeedbackRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
submitAnswerFeedback(request, callback)
submitAnswerFeedback(request: protos.google.cloud.dialogflow.cx.v3.ISubmitAnswerFeedbackRequest, callback: Callback<protos.google.cloud.dialogflow.cx.v3.IAnswerFeedback, protos.google.cloud.dialogflow.cx.v3.ISubmitAnswerFeedbackRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ISubmitAnswerFeedbackRequest
|
callback |
Callback<protos.google.cloud.dialogflow.cx.v3.IAnswerFeedback, protos.google.cloud.dialogflow.cx.v3.ISubmitAnswerFeedbackRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
testCasePath(project, location, agent, testCase)
testCasePath(project: string, location: string, agent: string, testCase: string): string;
Return a fully-qualified testCase resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
testCase |
string
|
Returns | |
---|---|
Type | Description |
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.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
testCase |
string
|
result |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |
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.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
flow |
string
|
version |
string
|
Returns | |
---|---|
Type | Description |
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.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
agent |
string
|
webhook |
string
|
Returns | |
---|---|
Type | Description |
string |
{string} Resource name string. |