Manages a collection of models for human agent assistant. v2
Package
@google-cloud/dialogflowConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of ConversationModelsClient.
Parameters | |
---|---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of |
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth: gax.GoogleAuth;
conversationModelsStub
conversationModelsStub?: Promise<{
[name: string]: Function;
}>;
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.
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
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: ''});
checkCreateConversationModelEvaluationProgress(name)
checkCreateConversationModelEvaluationProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.v2.ConversationModelEvaluation, protos.google.cloud.dialogflow.v2.CreateConversationModelEvaluationOperationMetadata>>;
Check the status of the long running operation returned by createConversationModelEvaluation()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.dialogflow.v2.ConversationModelEvaluation, protos.google.cloud.dialogflow.v2.CreateConversationModelEvaluationOperationMetadata>> | {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 conversation model resource name. Format:
* `projects/
checkCreateConversationModelProgress(name)
checkCreateConversationModelProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.v2.ConversationModel, protos.google.cloud.dialogflow.v2.CreateConversationModelOperationMetadata>>;
Check the status of the long running operation returned by createConversationModel()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.cloud.dialogflow.v2.ConversationModel, protos.google.cloud.dialogflow.v2.CreateConversationModelOperationMetadata>> | {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.
*/
/**
* The project to create conversation model for. Format:
* `projects/
checkDeleteConversationModelProgress(name)
checkDeleteConversationModelProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.dialogflow.v2.DeleteConversationModelOperationMetadata>>;
Check the status of the long running operation returned by deleteConversationModel()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.dialogflow.v2.DeleteConversationModelOperationMetadata>> | {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 conversation model to delete. Format:
* `projects/
checkDeployConversationModelProgress(name)
checkDeployConversationModelProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.dialogflow.v2.DeployConversationModelOperationMetadata>>;
Check the status of the long running operation returned by deployConversationModel()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.dialogflow.v2.DeployConversationModelOperationMetadata>> | {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 conversation model to deploy. Format:
* `projects/
checkUndeployConversationModelProgress(name)
checkUndeployConversationModelProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.dialogflow.v2.UndeployConversationModelOperationMetadata>>;
Check the status of the long running operation returned by undeployConversationModel()
.
Parameter | |
---|---|
Name | Description |
name |
string
The operation name that will be passed. |
Returns | |
---|---|
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.dialogflow.v2.UndeployConversationModelOperationMetadata>> | {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 conversation model to undeploy. 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.
Returns | |
---|---|
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
conversationDatasetPath(project, location, conversationDataset)
conversationDatasetPath(project: string, location: string, conversationDataset: string): string;
Return a fully-qualified conversationDataset resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
conversationDataset |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
createConversationModel(request, options)
createConversationModel(request?: protos.google.cloud.dialogflow.v2.ICreateConversationModelRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.dialogflow.v2.IConversationModel, protos.google.cloud.dialogflow.v2.ICreateConversationModelOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates a model.
This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned Operation
type has the following method-specific fields:
metadata
: -response
:
Parameters | |
---|---|
Name | Description |
request |
ICreateConversationModelRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.dialogflow.v2.IConversationModel, protos.google.cloud.dialogflow.v2.ICreateConversationModelOperationMetadata>,
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 |
/**
* 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 project to create conversation model for. Format:
* `projects/
createConversationModel(request, options, callback)
createConversationModel(request: protos.google.cloud.dialogflow.v2.ICreateConversationModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2.IConversationModel, protos.google.cloud.dialogflow.v2.ICreateConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateConversationModelRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.dialogflow.v2.IConversationModel, protos.google.cloud.dialogflow.v2.ICreateConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createConversationModel(request, callback)
createConversationModel(request: protos.google.cloud.dialogflow.v2.ICreateConversationModelRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2.IConversationModel, protos.google.cloud.dialogflow.v2.ICreateConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateConversationModelRequest
|
callback |
Callback<LROperation<protos.google.cloud.dialogflow.v2.IConversationModel, protos.google.cloud.dialogflow.v2.ICreateConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createConversationModelEvaluation(request, options)
createConversationModelEvaluation(request?: protos.google.cloud.dialogflow.v2.ICreateConversationModelEvaluationRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.dialogflow.v2.IConversationModelEvaluation, protos.google.cloud.dialogflow.v2.ICreateConversationModelEvaluationOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Creates evaluation of a conversation model.
Parameters | |
---|---|
Name | Description |
request |
ICreateConversationModelEvaluationRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.cloud.dialogflow.v2.IConversationModelEvaluation, protos.google.cloud.dialogflow.v2.ICreateConversationModelEvaluationOperationMetadata>,
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 |
/**
* 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 conversation model resource name. Format:
* `projects/
createConversationModelEvaluation(request, options, callback)
createConversationModelEvaluation(request: protos.google.cloud.dialogflow.v2.ICreateConversationModelEvaluationRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2.IConversationModelEvaluation, protos.google.cloud.dialogflow.v2.ICreateConversationModelEvaluationOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateConversationModelEvaluationRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.dialogflow.v2.IConversationModelEvaluation, protos.google.cloud.dialogflow.v2.ICreateConversationModelEvaluationOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
createConversationModelEvaluation(request, callback)
createConversationModelEvaluation(request: protos.google.cloud.dialogflow.v2.ICreateConversationModelEvaluationRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2.IConversationModelEvaluation, protos.google.cloud.dialogflow.v2.ICreateConversationModelEvaluationOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ICreateConversationModelEvaluationRequest
|
callback |
Callback<LROperation<protos.google.cloud.dialogflow.v2.IConversationModelEvaluation, protos.google.cloud.dialogflow.v2.ICreateConversationModelEvaluationOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteConversationModel(request, options)
deleteConversationModel(request?: protos.google.cloud.dialogflow.v2.IDeleteConversationModelRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeleteConversationModelOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deletes a model.
This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned Operation
type has the following method-specific fields:
metadata
: DeleteConversationModelOperationMetadata -response
: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
Parameters | |
---|---|
Name | Description |
request |
IDeleteConversationModelRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeleteConversationModelOperationMetadata>,
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 |
/**
* 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 conversation model to delete. Format:
* `projects/
deleteConversationModel(request, options, callback)
deleteConversationModel(request: protos.google.cloud.dialogflow.v2.IDeleteConversationModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeleteConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteConversationModelRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeleteConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deleteConversationModel(request, callback)
deleteConversationModel(request: protos.google.cloud.dialogflow.v2.IDeleteConversationModelRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeleteConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeleteConversationModelRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeleteConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
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
.
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: ''});
deployConversationModel(request, options)
deployConversationModel(request?: protos.google.cloud.dialogflow.v2.IDeployConversationModelRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeployConversationModelOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
Deploys a model. If a model is already deployed, deploying it has no effect. A model can only serve prediction requests after it gets deployed. For article suggestion, custom model will not be used unless it is deployed.
This method is a [long-running operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The returned Operation
type has the following method-specific fields:
metadata
: DeployConversationModelOperationMetadata -response
: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
Parameters | |
---|---|
Name | Description |
request |
IDeployConversationModelRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeployConversationModelOperationMetadata>,
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 |
/**
* 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 conversation model to deploy. Format:
* `projects/
deployConversationModel(request, options, callback)
deployConversationModel(request: protos.google.cloud.dialogflow.v2.IDeployConversationModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeployConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeployConversationModelRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeployConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
deployConversationModel(request, callback)
deployConversationModel(request: protos.google.cloud.dialogflow.v2.IDeployConversationModelRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeployConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IDeployConversationModelRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeployConversationModelOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getConversationModel(request, options)
getConversationModel(request?: protos.google.cloud.dialogflow.v2.IGetConversationModelRequest, options?: CallOptions): Promise<[
protos.google.cloud.dialogflow.v2.IConversationModel,
(protos.google.cloud.dialogflow.v2.IGetConversationModelRequest | undefined),
{} | undefined
]>;
Gets conversation model.
Parameters | |
---|---|
Name | Description |
request |
IGetConversationModelRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.dialogflow.v2.IConversationModel,
(protos.google.cloud.dialogflow.v2.IGetConversationModelRequest | 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 conversation model to retrieve. Format:
* `projects/
getConversationModel(request, options, callback)
getConversationModel(request: protos.google.cloud.dialogflow.v2.IGetConversationModelRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2.IConversationModel, protos.google.cloud.dialogflow.v2.IGetConversationModelRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetConversationModelRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.dialogflow.v2.IConversationModel, protos.google.cloud.dialogflow.v2.IGetConversationModelRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getConversationModel(request, callback)
getConversationModel(request: protos.google.cloud.dialogflow.v2.IGetConversationModelRequest, callback: Callback<protos.google.cloud.dialogflow.v2.IConversationModel, protos.google.cloud.dialogflow.v2.IGetConversationModelRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetConversationModelRequest
|
callback |
Callback<protos.google.cloud.dialogflow.v2.IConversationModel, protos.google.cloud.dialogflow.v2.IGetConversationModelRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getConversationModelEvaluation(request, options)
getConversationModelEvaluation(request?: protos.google.cloud.dialogflow.v2.IGetConversationModelEvaluationRequest, options?: CallOptions): Promise<[
protos.google.cloud.dialogflow.v2.IConversationModelEvaluation,
(protos.google.cloud.dialogflow.v2.IGetConversationModelEvaluationRequest | undefined),
{} | undefined
]>;
Gets an evaluation of conversation model.
Parameters | |
---|---|
Name | Description |
request |
IGetConversationModelEvaluationRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.dialogflow.v2.IConversationModelEvaluation,
(protos.google.cloud.dialogflow.v2.IGetConversationModelEvaluationRequest | undefined),
{} | undefined
]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing ConversationModelEvaluation. 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 conversation model evaluation resource name. Format:
* `projects/
getConversationModelEvaluation(request, options, callback)
getConversationModelEvaluation(request: protos.google.cloud.dialogflow.v2.IGetConversationModelEvaluationRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2.IConversationModelEvaluation, protos.google.cloud.dialogflow.v2.IGetConversationModelEvaluationRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetConversationModelEvaluationRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.dialogflow.v2.IConversationModelEvaluation, protos.google.cloud.dialogflow.v2.IGetConversationModelEvaluationRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
getConversationModelEvaluation(request, callback)
getConversationModelEvaluation(request: protos.google.cloud.dialogflow.v2.IGetConversationModelEvaluationRequest, callback: Callback<protos.google.cloud.dialogflow.v2.IConversationModelEvaluation, protos.google.cloud.dialogflow.v2.IGetConversationModelEvaluationRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
IGetConversationModelEvaluationRequest
|
callback |
Callback<protos.google.cloud.dialogflow.v2.IConversationModelEvaluation, protos.google.cloud.dialogflow.v2.IGetConversationModelEvaluationRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
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.
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. |
listConversationModelEvaluations(request, options)
listConversationModelEvaluations(request?: protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsRequest, options?: CallOptions): Promise<[
protos.google.cloud.dialogflow.v2.IConversationModelEvaluation[],
protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsRequest | null,
protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsResponse
]>;
Lists evaluations of a conversation model.
Parameters | |
---|---|
Name | Description |
request |
IListConversationModelEvaluationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.dialogflow.v2.IConversationModelEvaluation[],
protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsRequest | null,
protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of ConversationModelEvaluation. 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 |
listConversationModelEvaluations(request, options, callback)
listConversationModelEvaluations(request: protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsRequest, protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IConversationModelEvaluation>): void;
Parameters | |
---|---|
Name | Description |
request |
IListConversationModelEvaluationsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsRequest, protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IConversationModelEvaluation>
|
Returns | |
---|---|
Type | Description |
void |
listConversationModelEvaluations(request, callback)
listConversationModelEvaluations(request: protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsRequest, protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IConversationModelEvaluation>): void;
Parameters | |
---|---|
Name | Description |
request |
IListConversationModelEvaluationsRequest
|
callback |
PaginationCallback<protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsRequest, protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IConversationModelEvaluation>
|
Returns | |
---|---|
Type | Description |
void |
listConversationModelEvaluationsAsync(request, options)
listConversationModelEvaluationsAsync(request?: protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.v2.IConversationModelEvaluation>;
Equivalent to listConversationModelEvaluations
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListConversationModelEvaluationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.dialogflow.v2.IConversationModelEvaluation> | {Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing ConversationModelEvaluation. 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 conversation model resource name. Format:
* `projects/
listConversationModelEvaluationsStream(request, options)
listConversationModelEvaluationsStream(request?: protos.google.cloud.dialogflow.v2.IListConversationModelEvaluationsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListConversationModelEvaluationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing ConversationModelEvaluation 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 |
listConversationModels(request, options)
listConversationModels(request?: protos.google.cloud.dialogflow.v2.IListConversationModelsRequest, options?: CallOptions): Promise<[
protos.google.cloud.dialogflow.v2.IConversationModel[],
protos.google.cloud.dialogflow.v2.IListConversationModelsRequest | null,
protos.google.cloud.dialogflow.v2.IListConversationModelsResponse
]>;
Lists conversation models.
Parameters | |
---|---|
Name | Description |
request |
IListConversationModelsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.dialogflow.v2.IConversationModel[],
protos.google.cloud.dialogflow.v2.IListConversationModelsRequest | null,
protos.google.cloud.dialogflow.v2.IListConversationModelsResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 |
listConversationModels(request, options, callback)
listConversationModels(request: protos.google.cloud.dialogflow.v2.IListConversationModelsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.v2.IListConversationModelsRequest, protos.google.cloud.dialogflow.v2.IListConversationModelsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IConversationModel>): void;
Parameters | |
---|---|
Name | Description |
request |
IListConversationModelsRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.dialogflow.v2.IListConversationModelsRequest, protos.google.cloud.dialogflow.v2.IListConversationModelsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IConversationModel>
|
Returns | |
---|---|
Type | Description |
void |
listConversationModels(request, callback)
listConversationModels(request: protos.google.cloud.dialogflow.v2.IListConversationModelsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.v2.IListConversationModelsRequest, protos.google.cloud.dialogflow.v2.IListConversationModelsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IConversationModel>): void;
Parameters | |
---|---|
Name | Description |
request |
IListConversationModelsRequest
|
callback |
PaginationCallback<protos.google.cloud.dialogflow.v2.IListConversationModelsRequest, protos.google.cloud.dialogflow.v2.IListConversationModelsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IConversationModel>
|
Returns | |
---|---|
Type | Description |
void |
listConversationModelsAsync(request, options)
listConversationModelsAsync(request?: protos.google.cloud.dialogflow.v2.IListConversationModelsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.v2.IConversationModel>;
Equivalent to listConversationModels
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
IListConversationModelsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.dialogflow.v2.IConversationModel> | {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. |
/**
* 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 project to list all conversation models for.
* Format: `projects/
listConversationModelsStream(request, options)
listConversationModelsStream(request?: protos.google.cloud.dialogflow.v2.IListConversationModelsRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
IListConversationModelsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing 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 |
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)
matchAnswerRecordFromProjectAnswerRecordName(projectAnswerRecordName)
matchAnswerRecordFromProjectAnswerRecordName(projectAnswerRecordName: string): string | number;
Parse the answer_record from ProjectAnswerRecord resource.
Parameter | |
---|---|
Name | Description |
projectAnswerRecordName |
string
A fully-qualified path representing project_answer_record resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the answer_record. |
matchAnswerRecordFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName)
matchAnswerRecordFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName: string): string | number;
Parse the answer_record from ProjectLocationAnswerRecord resource.
Parameter | |
---|---|
Name | Description |
projectLocationAnswerRecordName |
string
A fully-qualified path representing project_location_answer_record resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the answer_record. |
matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)
matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;
Parse the context from ProjectAgentEnvironmentUserSessionContext resource.
Parameter | |
---|---|
Name | Description |
projectAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_agent_environment_user_session_context resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the context. |
matchContextFromProjectAgentSessionContextName(projectAgentSessionContextName)
matchContextFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number;
Parse the context from ProjectAgentSessionContext resource.
Parameter | |
---|---|
Name | Description |
projectAgentSessionContextName |
string
A fully-qualified path representing project_agent_session_context resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the context. |
matchContextFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName)
matchContextFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName: string): string | number;
Parse the context from ProjectLocationAgentEnvironmentUserSessionContext resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_location_agent_environment_user_session_context resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the context. |
matchContextFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName)
matchContextFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName: string): string | number;
Parse the context from ProjectLocationAgentSessionContext resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentSessionContextName |
string
A fully-qualified path representing project_location_agent_session_context resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the context. |
matchConversationDatasetFromConversationDatasetName(conversationDatasetName)
matchConversationDatasetFromConversationDatasetName(conversationDatasetName: string): string | number;
Parse the conversation_dataset from ConversationDataset resource.
Parameter | |
---|---|
Name | Description |
conversationDatasetName |
string
A fully-qualified path representing ConversationDataset resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the conversation_dataset. |
matchConversationFromProjectConversationMessageName(projectConversationMessageName)
matchConversationFromProjectConversationMessageName(projectConversationMessageName: string): string | number;
Parse the conversation from ProjectConversationMessage resource.
Parameter | |
---|---|
Name | Description |
projectConversationMessageName |
string
A fully-qualified path representing project_conversation_message resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the conversation. |
matchConversationFromProjectConversationName(projectConversationName)
matchConversationFromProjectConversationName(projectConversationName: string): string | number;
Parse the conversation from ProjectConversation resource.
Parameter | |
---|---|
Name | Description |
projectConversationName |
string
A fully-qualified path representing project_conversation resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the conversation. |
matchConversationFromProjectConversationParticipantName(projectConversationParticipantName)
matchConversationFromProjectConversationParticipantName(projectConversationParticipantName: string): string | number;
Parse the conversation from ProjectConversationParticipant resource.
Parameter | |
---|---|
Name | Description |
projectConversationParticipantName |
string
A fully-qualified path representing project_conversation_participant resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the conversation. |
matchConversationFromProjectLocationConversationMessageName(projectLocationConversationMessageName)
matchConversationFromProjectLocationConversationMessageName(projectLocationConversationMessageName: string): string | number;
Parse the conversation from ProjectLocationConversationMessage resource.
Parameter | |
---|---|
Name | Description |
projectLocationConversationMessageName |
string
A fully-qualified path representing project_location_conversation_message resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the conversation. |
matchConversationFromProjectLocationConversationName(projectLocationConversationName)
matchConversationFromProjectLocationConversationName(projectLocationConversationName: string): string | number;
Parse the conversation from ProjectLocationConversation resource.
Parameter | |
---|---|
Name | Description |
projectLocationConversationName |
string
A fully-qualified path representing project_location_conversation resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the conversation. |
matchConversationFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName)
matchConversationFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName: string): string | number;
Parse the conversation from ProjectLocationConversationParticipant resource.
Parameter | |
---|---|
Name | Description |
projectLocationConversationParticipantName |
string
A fully-qualified path representing project_location_conversation_participant resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the conversation. |
matchConversationModelFromProjectConversationModelEvaluationName(projectConversationModelEvaluationName)
matchConversationModelFromProjectConversationModelEvaluationName(projectConversationModelEvaluationName: string): string | number;
Parse the conversation_model from ProjectConversationModelEvaluation resource.
Parameter | |
---|---|
Name | Description |
projectConversationModelEvaluationName |
string
A fully-qualified path representing project_conversation_model_evaluation resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the conversation_model. |
matchConversationModelFromProjectConversationModelName(projectConversationModelName)
matchConversationModelFromProjectConversationModelName(projectConversationModelName: string): string | number;
Parse the conversation_model from ProjectConversationModel resource.
Parameter | |
---|---|
Name | Description |
projectConversationModelName |
string
A fully-qualified path representing project_conversation_model resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the conversation_model. |
matchConversationModelFromProjectLocationConversationModelEvaluationName(projectLocationConversationModelEvaluationName)
matchConversationModelFromProjectLocationConversationModelEvaluationName(projectLocationConversationModelEvaluationName: string): string | number;
Parse the conversation_model from ProjectLocationConversationModelEvaluation resource.
Parameter | |
---|---|
Name | Description |
projectLocationConversationModelEvaluationName |
string
A fully-qualified path representing project_location_conversation_model_evaluation resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the conversation_model. |
matchConversationModelFromProjectLocationConversationModelName(projectLocationConversationModelName)
matchConversationModelFromProjectLocationConversationModelName(projectLocationConversationModelName: string): string | number;
Parse the conversation_model from ProjectLocationConversationModel resource.
Parameter | |
---|---|
Name | Description |
projectLocationConversationModelName |
string
A fully-qualified path representing project_location_conversation_model resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the conversation_model. |
matchConversationProfileFromProjectConversationProfileName(projectConversationProfileName)
matchConversationProfileFromProjectConversationProfileName(projectConversationProfileName: string): string | number;
Parse the conversation_profile from ProjectConversationProfile resource.
Parameter | |
---|---|
Name | Description |
projectConversationProfileName |
string
A fully-qualified path representing project_conversation_profile resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the conversation_profile. |
matchConversationProfileFromProjectLocationConversationProfileName(projectLocationConversationProfileName)
matchConversationProfileFromProjectLocationConversationProfileName(projectLocationConversationProfileName: string): string | number;
Parse the conversation_profile from ProjectLocationConversationProfile resource.
Parameter | |
---|---|
Name | Description |
projectLocationConversationProfileName |
string
A fully-qualified path representing project_location_conversation_profile resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the conversation_profile. |
matchDocumentFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName)
matchDocumentFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName: string): string | number;
Parse the document from ProjectKnowledgeBaseDocument resource.
Parameter | |
---|---|
Name | Description |
projectKnowledgeBaseDocumentName |
string
A fully-qualified path representing project_knowledge_base_document resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the document. |
matchDocumentFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName)
matchDocumentFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName: string): string | number;
Parse the document from ProjectLocationKnowledgeBaseDocument resource.
Parameter | |
---|---|
Name | Description |
projectLocationKnowledgeBaseDocumentName |
string
A fully-qualified path representing project_location_knowledge_base_document resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the document. |
matchEntityTypeFromProjectAgentEntityTypeName(projectAgentEntityTypeName)
matchEntityTypeFromProjectAgentEntityTypeName(projectAgentEntityTypeName: string): string | number;
Parse the entity_type from ProjectAgentEntityType resource.
Parameter | |
---|---|
Name | Description |
projectAgentEntityTypeName |
string
A fully-qualified path representing project_agent_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the entity_type. |
matchEntityTypeFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)
matchEntityTypeFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;
Parse the entity_type from ProjectAgentEnvironmentUserSessionEntityType resource.
Parameter | |
---|---|
Name | Description |
projectAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the entity_type. |
matchEntityTypeFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)
matchEntityTypeFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number;
Parse the entity_type from ProjectAgentSessionEntityType resource.
Parameter | |
---|---|
Name | Description |
projectAgentSessionEntityTypeName |
string
A fully-qualified path representing project_agent_session_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the entity_type. |
matchEntityTypeFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName)
matchEntityTypeFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName: string): string | number;
Parse the entity_type from ProjectLocationAgentEntityType resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEntityTypeName |
string
A fully-qualified path representing project_location_agent_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the entity_type. |
matchEntityTypeFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName)
matchEntityTypeFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName: string): string | number;
Parse the entity_type from ProjectLocationAgentEnvironmentUserSessionEntityType resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_user_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. |
matchEnvironmentFromProjectAgentEnvironmentName(projectAgentEnvironmentName)
matchEnvironmentFromProjectAgentEnvironmentName(projectAgentEnvironmentName: string): string | number;
Parse the environment from ProjectAgentEnvironment resource.
Parameter | |
---|---|
Name | Description |
projectAgentEnvironmentName |
string
A fully-qualified path representing project_agent_environment resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the environment. |
matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)
matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;
Parse the environment from ProjectAgentEnvironmentUserSessionContext resource.
Parameter | |
---|---|
Name | Description |
projectAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_agent_environment_user_session_context resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the environment. |
matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)
matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;
Parse the environment from ProjectAgentEnvironmentUserSessionEntityType resource.
Parameter | |
---|---|
Name | Description |
projectAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the environment. |
matchEnvironmentFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName)
matchEnvironmentFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName: string): string | number;
Parse the environment from ProjectLocationAgentEnvironment resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEnvironmentName |
string
A fully-qualified path representing project_location_agent_environment resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the environment. |
matchEnvironmentFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName)
matchEnvironmentFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName: string): string | number;
Parse the environment from ProjectLocationAgentEnvironmentUserSessionContext resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_location_agent_environment_user_session_context resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the environment. |
matchEnvironmentFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName)
matchEnvironmentFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName: string): string | number;
Parse the environment from ProjectLocationAgentEnvironmentUserSessionEntityType resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the environment. |
matchEvaluationFromProjectConversationModelEvaluationName(projectConversationModelEvaluationName)
matchEvaluationFromProjectConversationModelEvaluationName(projectConversationModelEvaluationName: string): string | number;
Parse the evaluation from ProjectConversationModelEvaluation resource.
Parameter | |
---|---|
Name | Description |
projectConversationModelEvaluationName |
string
A fully-qualified path representing project_conversation_model_evaluation resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the evaluation. |
matchEvaluationFromProjectLocationConversationModelEvaluationName(projectLocationConversationModelEvaluationName)
matchEvaluationFromProjectLocationConversationModelEvaluationName(projectLocationConversationModelEvaluationName: string): string | number;
Parse the evaluation from ProjectLocationConversationModelEvaluation resource.
Parameter | |
---|---|
Name | Description |
projectLocationConversationModelEvaluationName |
string
A fully-qualified path representing project_location_conversation_model_evaluation resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the evaluation. |
matchIntentFromProjectAgentIntentName(projectAgentIntentName)
matchIntentFromProjectAgentIntentName(projectAgentIntentName: string): string | number;
Parse the intent from ProjectAgentIntent resource.
Parameter | |
---|---|
Name | Description |
projectAgentIntentName |
string
A fully-qualified path representing project_agent_intent resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the intent. |
matchIntentFromProjectLocationAgentIntentName(projectLocationAgentIntentName)
matchIntentFromProjectLocationAgentIntentName(projectLocationAgentIntentName: string): string | number;
Parse the intent from ProjectLocationAgentIntent resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentIntentName |
string
A fully-qualified path representing project_location_agent_intent resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the intent. |
matchKnowledgeBaseFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName)
matchKnowledgeBaseFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName: string): string | number;
Parse the knowledge_base from ProjectKnowledgeBaseDocument resource.
Parameter | |
---|---|
Name | Description |
projectKnowledgeBaseDocumentName |
string
A fully-qualified path representing project_knowledge_base_document resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the knowledge_base. |
matchKnowledgeBaseFromProjectKnowledgeBaseName(projectKnowledgeBaseName)
matchKnowledgeBaseFromProjectKnowledgeBaseName(projectKnowledgeBaseName: string): string | number;
Parse the knowledge_base from ProjectKnowledgeBase resource.
Parameter | |
---|---|
Name | Description |
projectKnowledgeBaseName |
string
A fully-qualified path representing project_knowledge_base resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the knowledge_base. |
matchKnowledgeBaseFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName)
matchKnowledgeBaseFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName: string): string | number;
Parse the knowledge_base from ProjectLocationKnowledgeBaseDocument resource.
Parameter | |
---|---|
Name | Description |
projectLocationKnowledgeBaseDocumentName |
string
A fully-qualified path representing project_location_knowledge_base_document resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the knowledge_base. |
matchKnowledgeBaseFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName)
matchKnowledgeBaseFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName: string): string | number;
Parse the knowledge_base from ProjectLocationKnowledgeBase resource.
Parameter | |
---|---|
Name | Description |
projectLocationKnowledgeBaseName |
string
A fully-qualified path representing project_location_knowledge_base resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the knowledge_base. |
matchLocationFromConversationDatasetName(conversationDatasetName)
matchLocationFromConversationDatasetName(conversationDatasetName: string): string | number;
Parse the location from ConversationDataset resource.
Parameter | |
---|---|
Name | Description |
conversationDatasetName |
string
A fully-qualified path representing ConversationDataset resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName)
matchLocationFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName: string): string | number;
Parse the location from ProjectLocationAgentEntityType resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEntityTypeName |
string
A fully-qualified path representing project_location_agent_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName)
matchLocationFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName: string): string | number;
Parse the location from ProjectLocationAgentEnvironment resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEnvironmentName |
string
A fully-qualified path representing project_location_agent_environment resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName)
matchLocationFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName: string): string | number;
Parse the location from ProjectLocationAgentEnvironmentUserSessionContext resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_location_agent_environment_user_session_context resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName)
matchLocationFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName: string): string | number;
Parse the location from ProjectLocationAgentEnvironmentUserSessionEntityType resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentFulfillmentName(projectLocationAgentFulfillmentName)
matchLocationFromProjectLocationAgentFulfillmentName(projectLocationAgentFulfillmentName: string): string | number;
Parse the location from ProjectLocationAgentFulfillment resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentFulfillmentName |
string
A fully-qualified path representing project_location_agent_fulfillment resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentIntentName(projectLocationAgentIntentName)
matchLocationFromProjectLocationAgentIntentName(projectLocationAgentIntentName: string): string | number;
Parse the location from ProjectLocationAgentIntent resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentIntentName |
string
A fully-qualified path representing project_location_agent_intent resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentName(projectLocationAgentName)
matchLocationFromProjectLocationAgentName(projectLocationAgentName: string): string | number;
Parse the location from ProjectLocationAgent resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentName |
string
A fully-qualified path representing project_location_agent resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName)
matchLocationFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName: string): string | number;
Parse the location from ProjectLocationAgentSessionContext resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentSessionContextName |
string
A fully-qualified path representing project_location_agent_session_context 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. |
matchLocationFromProjectLocationAgentVersionName(projectLocationAgentVersionName)
matchLocationFromProjectLocationAgentVersionName(projectLocationAgentVersionName: string): string | number;
Parse the location from ProjectLocationAgentVersion resource.
Parameter | |
---|---|
Name | Description |
projectLocationAgentVersionName |
string
A fully-qualified path representing project_location_agent_version resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName)
matchLocationFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName: string): string | number;
Parse the location from ProjectLocationAnswerRecord resource.
Parameter | |
---|---|
Name | Description |
projectLocationAnswerRecordName |
string
A fully-qualified path representing project_location_answer_record resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationConversationMessageName(projectLocationConversationMessageName)
matchLocationFromProjectLocationConversationMessageName(projectLocationConversationMessageName: string): string | number;
Parse the location from ProjectLocationConversationMessage resource.
Parameter | |
---|---|
Name | Description |
projectLocationConversationMessageName |
string
A fully-qualified path representing project_location_conversation_message resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationConversationModelEvaluationName(projectLocationConversationModelEvaluationName)
matchLocationFromProjectLocationConversationModelEvaluationName(projectLocationConversationModelEvaluationName: string): string | number;
Parse the location from ProjectLocationConversationModelEvaluation resource.
Parameter | |
---|---|
Name | Description |
projectLocationConversationModelEvaluationName |
string
A fully-qualified path representing project_location_conversation_model_evaluation resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationConversationModelName(projectLocationConversationModelName)
matchLocationFromProjectLocationConversationModelName(projectLocationConversationModelName: string): string | number;
Parse the location from ProjectLocationConversationModel resource.
Parameter | |
---|---|
Name | Description |
projectLocationConversationModelName |
string
A fully-qualified path representing project_location_conversation_model resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationConversationName(projectLocationConversationName)
matchLocationFromProjectLocationConversationName(projectLocationConversationName: string): string | number;
Parse the location from ProjectLocationConversation resource.
Parameter | |
---|---|
Name | Description |
projectLocationConversationName |
string
A fully-qualified path representing project_location_conversation resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName)
matchLocationFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName: string): string | number;
Parse the location from ProjectLocationConversationParticipant resource.
Parameter | |
---|---|
Name | Description |
projectLocationConversationParticipantName |
string
A fully-qualified path representing project_location_conversation_participant resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationConversationProfileName(projectLocationConversationProfileName)
matchLocationFromProjectLocationConversationProfileName(projectLocationConversationProfileName: string): string | number;
Parse the location from ProjectLocationConversationProfile resource.
Parameter | |
---|---|
Name | Description |
projectLocationConversationProfileName |
string
A fully-qualified path representing project_location_conversation_profile resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName)
matchLocationFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName: string): string | number;
Parse the location from ProjectLocationKnowledgeBaseDocument resource.
Parameter | |
---|---|
Name | Description |
projectLocationKnowledgeBaseDocumentName |
string
A fully-qualified path representing project_location_knowledge_base_document resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName)
matchLocationFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName: string): string | number;
Parse the location from ProjectLocationKnowledgeBase resource.
Parameter | |
---|---|
Name | Description |
projectLocationKnowledgeBaseName |
string
A fully-qualified path representing project_location_knowledge_base resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchMessageFromProjectConversationMessageName(projectConversationMessageName)
matchMessageFromProjectConversationMessageName(projectConversationMessageName: string): string | number;
Parse the message from ProjectConversationMessage resource.
Parameter | |
---|---|
Name | Description |
projectConversationMessageName |
string
A fully-qualified path representing project_conversation_message resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the message. |
matchMessageFromProjectLocationConversationMessageName(projectLocationConversationMessageName)
matchMessageFromProjectLocationConversationMessageName(projectLocationConversationMessageName: string): string | number;
Parse the message from ProjectLocationConversationMessage resource.
Parameter | |
---|---|
Name | Description |
projectLocationConversationMessageName |
string
A fully-qualified path representing project_location_conversation_message resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the message. |
matchParticipantFromProjectConversationParticipantName(projectConversationParticipantName)
matchParticipantFromProjectConversationParticipantName(projectConversationParticipantName: string): string | number;
Parse the participant from ProjectConversationParticipant resource.
Parameter | |
---|---|
Name | Description |
projectConversationParticipantName |
string
A fully-qualified path representing project_conversation_participant resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the participant. |
matchParticipantFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName)
matchParticipantFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName: string): string | number;
Parse the participant from ProjectLocationConversationParticipant resource.
Parameter | |
---|---|
Name | Description |
projectLocationConversationParticipantName |
string
A fully-qualified path representing project_location_conversation_participant resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the participant. |
matchProjectFromConversationDatasetName(conversationDatasetName)
matchProjectFromConversationDatasetName(conversationDatasetName: string): string | number;
Parse the project from ConversationDataset resource.
Parameter | |
---|---|
Name | Description |
conversationDatasetName |
string
A fully-qualified path representing ConversationDataset resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectAgentEntityTypeName(projectAgentEntityTypeName)
matchProjectFromProjectAgentEntityTypeName(projectAgentEntityTypeName: string): string | number;
Parse the project from ProjectAgentEntityType resource.
Parameter | |
---|---|
Name | Description |
projectAgentEntityTypeName |
string
A fully-qualified path representing project_agent_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectAgentEnvironmentName(projectAgentEnvironmentName)
matchProjectFromProjectAgentEnvironmentName(projectAgentEnvironmentName: string): string | number;
Parse the project from ProjectAgentEnvironment resource.
Parameter | |
---|---|
Name | Description |
projectAgentEnvironmentName |
string
A fully-qualified path representing project_agent_environment resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)
matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;
Parse the project from ProjectAgentEnvironmentUserSessionContext resource.
Parameter | |
---|---|
Name | Description |
projectAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_agent_environment_user_session_context resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)
matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;
Parse the project from ProjectAgentEnvironmentUserSessionEntityType resource.
Parameter | |
---|---|
Name | Description |
projectAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectAgentFulfillmentName(projectAgentFulfillmentName)
matchProjectFromProjectAgentFulfillmentName(projectAgentFulfillmentName: string): string | number;
Parse the project from ProjectAgentFulfillment resource.
Parameter | |
---|---|
Name | Description |
projectAgentFulfillmentName |
string
A fully-qualified path representing project_agent_fulfillment resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectAgentIntentName(projectAgentIntentName)
matchProjectFromProjectAgentIntentName(projectAgentIntentName: string): string | number;
Parse the project from ProjectAgentIntent resource.
Parameter | |
---|---|
Name | Description |
projectAgentIntentName |
string
A fully-qualified path representing project_agent_intent resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |