Service for managing . v2beta1
Package
@google-cloud/dialogflowConstructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of EntityTypesClient.
Name | Description |
opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth: gax.GoogleAuth;
descriptors
descriptors: Descriptors;
entityTypesStub
entityTypesStub?: Promise<{
[name: string]: Function;
}>;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
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
batchCreateEntities(request, options)
batchCreateEntities(request?: protos.google.cloud.dialogflow.v2beta1.IBatchCreateEntitiesRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Creates multiple new entities in the specified entity type.
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
: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) -response
: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training).
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IBatchCreateEntitiesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the entity type to create entities in.
* Supported formats:
* - `projects/
batchCreateEntities(request, options, callback)
batchCreateEntities(request: protos.google.cloud.dialogflow.v2beta1.IBatchCreateEntitiesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IBatchCreateEntitiesRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
batchCreateEntities(request, callback)
batchCreateEntities(request: protos.google.cloud.dialogflow.v2beta1.IBatchCreateEntitiesRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IBatchCreateEntitiesRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
batchDeleteEntities(request, options)
batchDeleteEntities(request?: protos.google.cloud.dialogflow.v2beta1.IBatchDeleteEntitiesRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Deletes entities in the specified entity type.
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
: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) -response
: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training).
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IBatchDeleteEntitiesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the entity type to delete entries for.
* Supported formats:
* - `projects/
batchDeleteEntities(request, options, callback)
batchDeleteEntities(request: protos.google.cloud.dialogflow.v2beta1.IBatchDeleteEntitiesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IBatchDeleteEntitiesRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
batchDeleteEntities(request, callback)
batchDeleteEntities(request: protos.google.cloud.dialogflow.v2beta1.IBatchDeleteEntitiesRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IBatchDeleteEntitiesRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
batchDeleteEntityTypes(request, options)
batchDeleteEntityTypes(request?: protos.google.cloud.dialogflow.v2beta1.IBatchDeleteEntityTypesRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Deletes entity types in the specified agent.
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
: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) -response
: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training).
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IBatchDeleteEntityTypesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the agent to delete all entities types for.
* Supported formats:
* - `projects/
batchDeleteEntityTypes(request, options, callback)
batchDeleteEntityTypes(request: protos.google.cloud.dialogflow.v2beta1.IBatchDeleteEntityTypesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IBatchDeleteEntityTypesRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
batchDeleteEntityTypes(request, callback)
batchDeleteEntityTypes(request: protos.google.cloud.dialogflow.v2beta1.IBatchDeleteEntityTypesRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IBatchDeleteEntityTypesRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
batchUpdateEntities(request, options)
batchUpdateEntities(request?: protos.google.cloud.dialogflow.v2beta1.IBatchUpdateEntitiesRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request.
Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training).
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
: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) -response
: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IBatchUpdateEntitiesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the entity type to update or create entities in.
* Supported formats:
* - `projects/
batchUpdateEntities(request, options, callback)
batchUpdateEntities(request: protos.google.cloud.dialogflow.v2beta1.IBatchUpdateEntitiesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IBatchUpdateEntitiesRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
batchUpdateEntities(request, callback)
batchUpdateEntities(request: protos.google.cloud.dialogflow.v2beta1.IBatchUpdateEntitiesRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IBatchUpdateEntitiesRequest
|
callback |
Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
batchUpdateEntityTypes(request, options)
batchUpdateEntityTypes(request?: protos.google.cloud.dialogflow.v2beta1.IBatchUpdateEntityTypesRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.dialogflow.v2beta1.IBatchUpdateEntityTypesResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Updates/Creates multiple entity types in the specified agent.
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
: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) -response
:
Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training).
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IBatchUpdateEntityTypesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[LROperation<protos.google.cloud.dialogflow.v2beta1.IBatchUpdateEntityTypesResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the agent to update or create entity types in.
* Supported formats:
* - `projects/
batchUpdateEntityTypes(request, options, callback)
batchUpdateEntityTypes(request: protos.google.cloud.dialogflow.v2beta1.IBatchUpdateEntityTypesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2beta1.IBatchUpdateEntityTypesResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IBatchUpdateEntityTypesRequest
|
options |
CallOptions
|
callback |
Callback<LROperation<protos.google.cloud.dialogflow.v2beta1.IBatchUpdateEntityTypesResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
batchUpdateEntityTypes(request, callback)
batchUpdateEntityTypes(request: protos.google.cloud.dialogflow.v2beta1.IBatchUpdateEntityTypesRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2beta1.IBatchUpdateEntityTypesResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IBatchUpdateEntityTypesRequest
|
callback |
Callback<LROperation<protos.google.cloud.dialogflow.v2beta1.IBatchUpdateEntityTypesResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
|
Type | Description |
void |
checkBatchCreateEntitiesProgress(name)
checkBatchCreateEntitiesProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Struct>>;
Check the status of the long running operation returned by batchCreateEntities()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Struct>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the entity type to create entities in.
* Supported formats:
* - `projects/
checkBatchDeleteEntitiesProgress(name)
checkBatchDeleteEntitiesProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Struct>>;
Check the status of the long running operation returned by batchDeleteEntities()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Struct>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the entity type to delete entries for.
* Supported formats:
* - `projects/
checkBatchDeleteEntityTypesProgress(name)
checkBatchDeleteEntityTypesProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Struct>>;
Check the status of the long running operation returned by batchDeleteEntityTypes()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Struct>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the agent to delete all entities types for.
* Supported formats:
* - `projects/
checkBatchUpdateEntitiesProgress(name)
checkBatchUpdateEntitiesProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Struct>>;
Check the status of the long running operation returned by batchUpdateEntities()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Struct>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the entity type to update or create entities in.
* Supported formats:
* - `projects/
checkBatchUpdateEntityTypesProgress(name)
checkBatchUpdateEntityTypesProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesResponse, protos.google.protobuf.Struct>>;
Check the status of the long running operation returned by batchUpdateEntityTypes()
.
Name | Description |
name |
string
The operation name that will be passed. |
Type | Description |
Promise<LROperation<protos.google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesResponse, protos.google.protobuf.Struct>> | {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the agent to update or create entity types in.
* Supported formats:
* - `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.
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
createEntityType(request, options)
createEntityType(request?: protos.google.cloud.dialogflow.v2beta1.ICreateEntityTypeRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.v2beta1.IEntityType, (protos.google.cloud.dialogflow.v2beta1.ICreateEntityTypeRequest | undefined), {} | undefined]>;
Creates an entity type in the specified agent.
Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training).
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.ICreateEntityTypeRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[protos.google.cloud.dialogflow.v2beta1.IEntityType, (protos.google.cloud.dialogflow.v2beta1.ICreateEntityTypeRequest | undefined), {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [EntityType]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The agent to create a entity type for.
* Supported formats:
* - `projects/
createEntityType(request, options, callback)
createEntityType(request: protos.google.cloud.dialogflow.v2beta1.ICreateEntityTypeRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IEntityType, protos.google.cloud.dialogflow.v2beta1.ICreateEntityTypeRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.ICreateEntityTypeRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.dialogflow.v2beta1.IEntityType, protos.google.cloud.dialogflow.v2beta1.ICreateEntityTypeRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
createEntityType(request, callback)
createEntityType(request: protos.google.cloud.dialogflow.v2beta1.ICreateEntityTypeRequest, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IEntityType, protos.google.cloud.dialogflow.v2beta1.ICreateEntityTypeRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.ICreateEntityTypeRequest
|
callback |
Callback<protos.google.cloud.dialogflow.v2beta1.IEntityType, protos.google.cloud.dialogflow.v2beta1.ICreateEntityTypeRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deleteEntityType(request, options)
deleteEntityType(request?: protos.google.cloud.dialogflow.v2beta1.IDeleteEntityTypeRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.dialogflow.v2beta1.IDeleteEntityTypeRequest | undefined), {} | undefined]>;
Deletes the specified entity type.
Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training).
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IDeleteEntityTypeRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.dialogflow.v2beta1.IDeleteEntityTypeRequest | undefined), {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the entity type to delete.
* Supported formats:
* - `projects/
deleteEntityType(request, options, callback)
deleteEntityType(request: protos.google.cloud.dialogflow.v2beta1.IDeleteEntityTypeRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2beta1.IDeleteEntityTypeRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IDeleteEntityTypeRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2beta1.IDeleteEntityTypeRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
deleteEntityType(request, callback)
deleteEntityType(request: protos.google.cloud.dialogflow.v2beta1.IDeleteEntityTypeRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2beta1.IDeleteEntityTypeRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IDeleteEntityTypeRequest
|
callback |
Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2beta1.IDeleteEntityTypeRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getEntityType(request, options)
getEntityType(request?: protos.google.cloud.dialogflow.v2beta1.IGetEntityTypeRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.v2beta1.IEntityType, protos.google.cloud.dialogflow.v2beta1.IGetEntityTypeRequest | undefined, {} | undefined]>;
Retrieves the specified entity type.
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IGetEntityTypeRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[protos.google.cloud.dialogflow.v2beta1.IEntityType, protos.google.cloud.dialogflow.v2beta1.IGetEntityTypeRequest | undefined, {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [EntityType]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the entity type.
* Supported formats:
* - `projects/
getEntityType(request, options, callback)
getEntityType(request: protos.google.cloud.dialogflow.v2beta1.IGetEntityTypeRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IEntityType, protos.google.cloud.dialogflow.v2beta1.IGetEntityTypeRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IGetEntityTypeRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.dialogflow.v2beta1.IEntityType, protos.google.cloud.dialogflow.v2beta1.IGetEntityTypeRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getEntityType(request, callback)
getEntityType(request: protos.google.cloud.dialogflow.v2beta1.IGetEntityTypeRequest, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IEntityType, protos.google.cloud.dialogflow.v2beta1.IGetEntityTypeRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IGetEntityTypeRequest
|
callback |
Callback<protos.google.cloud.dialogflow.v2beta1.IEntityType, protos.google.cloud.dialogflow.v2beta1.IGetEntityTypeRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
getProjectId()
getProjectId(): Promise<string>;
Type | Description |
Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Name | Description |
callback |
Callback<string, undefined, undefined>
|
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.
Type | Description |
Promise<{ [name: string]: Function; }> | {Promise} A promise that resolves to an authenticated service stub. |
listEntityTypes(request, options)
listEntityTypes(request?: protos.google.cloud.dialogflow.v2beta1.IListEntityTypesRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.v2beta1.IEntityType[], protos.google.cloud.dialogflow.v2beta1.IListEntityTypesRequest | null, protos.google.cloud.dialogflow.v2beta1.IListEntityTypesResponse]>;
Returns the list of all entity types in the specified agent.
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IListEntityTypesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[protos.google.cloud.dialogflow.v2beta1.IEntityType[], protos.google.cloud.dialogflow.v2beta1.IListEntityTypesRequest | null, protos.google.cloud.dialogflow.v2beta1.IListEntityTypesResponse]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of [EntityType]. 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 |
listEntityTypes(request, options, callback)
listEntityTypes(request: protos.google.cloud.dialogflow.v2beta1.IListEntityTypesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.v2beta1.IListEntityTypesRequest, protos.google.cloud.dialogflow.v2beta1.IListEntityTypesResponse | null | undefined, protos.google.cloud.dialogflow.v2beta1.IEntityType>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IListEntityTypesRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.dialogflow.v2beta1.IListEntityTypesRequest, protos.google.cloud.dialogflow.v2beta1.IListEntityTypesResponse | null | undefined, protos.google.cloud.dialogflow.v2beta1.IEntityType>
|
Type | Description |
void |
listEntityTypes(request, callback)
listEntityTypes(request: protos.google.cloud.dialogflow.v2beta1.IListEntityTypesRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.v2beta1.IListEntityTypesRequest, protos.google.cloud.dialogflow.v2beta1.IListEntityTypesResponse | null | undefined, protos.google.cloud.dialogflow.v2beta1.IEntityType>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IListEntityTypesRequest
|
callback |
PaginationCallback<protos.google.cloud.dialogflow.v2beta1.IListEntityTypesRequest, protos.google.cloud.dialogflow.v2beta1.IListEntityTypesResponse | null | undefined, protos.google.cloud.dialogflow.v2beta1.IEntityType>
|
Type | Description |
void |
listEntityTypesAsync(request, options)
listEntityTypesAsync(request?: protos.google.cloud.dialogflow.v2beta1.IListEntityTypesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.v2beta1.IEntityType>;
Equivalent to listEntityTypes
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IListEntityTypesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
AsyncIterable<protos.google.cloud.dialogflow.v2beta1.IEntityType> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [EntityType]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The agent to list all entity types from.
* Supported formats:
* - `projects/
listEntityTypesStream(request, options)
listEntityTypesStream(request?: protos.google.cloud.dialogflow.v2beta1.IListEntityTypesRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IListEntityTypesRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Transform | {Stream} An object stream which emits an object representing [EntityType] 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 |
matchAnswerRecordFromProjectAnswerRecordName(projectAnswerRecordName)
matchAnswerRecordFromProjectAnswerRecordName(projectAnswerRecordName: string): string | number;
Parse the answer_record from ProjectAnswerRecord resource.
Name | Description |
projectAnswerRecordName |
string
A fully-qualified path representing project_answer_record resource. |
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.
Name | Description |
projectLocationAnswerRecordName |
string
A fully-qualified path representing project_location_answer_record resource. |
Type | Description |
string | number | {string} A string representing the answer_record. |
matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)
matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;
Parse the context from ProjectAgentEnvironmentUserSessionContext resource.
Name | Description |
projectAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_agent_environment_user_session_context resource. |
Type | Description |
string | number | {string} A string representing the context. |
matchContextFromProjectAgentSessionContextName(projectAgentSessionContextName)
matchContextFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number;
Parse the context from ProjectAgentSessionContext resource.
Name | Description |
projectAgentSessionContextName |
string
A fully-qualified path representing project_agent_session_context resource. |
Type | Description |
string | number | {string} A string representing the context. |
matchContextFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName)
matchContextFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName: string): string | number;
Parse the context from ProjectLocationAgentEnvironmentUserSessionContext resource.
Name | Description |
projectLocationAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_location_agent_environment_user_session_context resource. |
Type | Description |
string | number | {string} A string representing the context. |
matchContextFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName)
matchContextFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName: string): string | number;
Parse the context from ProjectLocationAgentSessionContext resource.
Name | Description |
projectLocationAgentSessionContextName |
string
A fully-qualified path representing project_location_agent_session_context resource. |
Type | Description |
string | number | {string} A string representing the context. |
matchConversationFromProjectConversationMessageName(projectConversationMessageName)
matchConversationFromProjectConversationMessageName(projectConversationMessageName: string): string | number;
Parse the conversation from ProjectConversationMessage resource.
Name | Description |
projectConversationMessageName |
string
A fully-qualified path representing project_conversation_message resource. |
Type | Description |
string | number | {string} A string representing the conversation. |
matchConversationFromProjectConversationName(projectConversationName)
matchConversationFromProjectConversationName(projectConversationName: string): string | number;
Parse the conversation from ProjectConversation resource.
Name | Description |
projectConversationName |
string
A fully-qualified path representing project_conversation resource. |
Type | Description |
string | number | {string} A string representing the conversation. |
matchConversationFromProjectConversationParticipantName(projectConversationParticipantName)
matchConversationFromProjectConversationParticipantName(projectConversationParticipantName: string): string | number;
Parse the conversation from ProjectConversationParticipant resource.
Name | Description |
projectConversationParticipantName |
string
A fully-qualified path representing project_conversation_participant resource. |
Type | Description |
string | number | {string} A string representing the conversation. |
matchConversationFromProjectLocationConversationMessageName(projectLocationConversationMessageName)
matchConversationFromProjectLocationConversationMessageName(projectLocationConversationMessageName: string): string | number;
Parse the conversation from ProjectLocationConversationMessage resource.
Name | Description |
projectLocationConversationMessageName |
string
A fully-qualified path representing project_location_conversation_message resource. |
Type | Description |
string | number | {string} A string representing the conversation. |
matchConversationFromProjectLocationConversationName(projectLocationConversationName)
matchConversationFromProjectLocationConversationName(projectLocationConversationName: string): string | number;
Parse the conversation from ProjectLocationConversation resource.
Name | Description |
projectLocationConversationName |
string
A fully-qualified path representing project_location_conversation resource. |
Type | Description |
string | number | {string} A string representing the conversation. |
matchConversationFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName)
matchConversationFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName: string): string | number;
Parse the conversation from ProjectLocationConversationParticipant resource.
Name | Description |
projectLocationConversationParticipantName |
string
A fully-qualified path representing project_location_conversation_participant resource. |
Type | Description |
string | number | {string} A string representing the conversation. |
matchConversationProfileFromProjectConversationProfileName(projectConversationProfileName)
matchConversationProfileFromProjectConversationProfileName(projectConversationProfileName: string): string | number;
Parse the conversation_profile from ProjectConversationProfile resource.
Name | Description |
projectConversationProfileName |
string
A fully-qualified path representing project_conversation_profile resource. |
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.
Name | Description |
projectLocationConversationProfileName |
string
A fully-qualified path representing project_location_conversation_profile resource. |
Type | Description |
string | number | {string} A string representing the conversation_profile. |
matchDocumentFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName)
matchDocumentFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName: string): string | number;
Parse the document from ProjectKnowledgeBaseDocument resource.
Name | Description |
projectKnowledgeBaseDocumentName |
string
A fully-qualified path representing project_knowledge_base_document resource. |
Type | Description |
string | number | {string} A string representing the document. |
matchDocumentFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName)
matchDocumentFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName: string): string | number;
Parse the document from ProjectLocationKnowledgeBaseDocument resource.
Name | Description |
projectLocationKnowledgeBaseDocumentName |
string
A fully-qualified path representing project_location_knowledge_base_document resource. |
Type | Description |
string | number | {string} A string representing the document. |
matchEntityTypeFromProjectAgentEntityTypeName(projectAgentEntityTypeName)
matchEntityTypeFromProjectAgentEntityTypeName(projectAgentEntityTypeName: string): string | number;
Parse the entity_type from ProjectAgentEntityType resource.
Name | Description |
projectAgentEntityTypeName |
string
A fully-qualified path representing project_agent_entity_type resource. |
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.
Name | Description |
projectAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
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.
Name | Description |
projectAgentSessionEntityTypeName |
string
A fully-qualified path representing project_agent_session_entity_type resource. |
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.
Name | Description |
projectLocationAgentEntityTypeName |
string
A fully-qualified path representing project_location_agent_entity_type resource. |
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.
Name | Description |
projectLocationAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource. |
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.
Name | Description |
projectLocationAgentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the entity_type. |
matchEnvironmentFromProjectAgentEnvironmentName(projectAgentEnvironmentName)
matchEnvironmentFromProjectAgentEnvironmentName(projectAgentEnvironmentName: string): string | number;
Parse the environment from ProjectAgentEnvironment resource.
Name | Description |
projectAgentEnvironmentName |
string
A fully-qualified path representing project_agent_environment resource. |
Type | Description |
string | number | {string} A string representing the environment. |
matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)
matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;
Parse the environment from ProjectAgentEnvironmentUserSessionContext resource.
Name | Description |
projectAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_agent_environment_user_session_context resource. |
Type | Description |
string | number | {string} A string representing the environment. |
matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)
matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;
Parse the environment from ProjectAgentEnvironmentUserSessionEntityType resource.
Name | Description |
projectAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the environment. |
matchEnvironmentFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName)
matchEnvironmentFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName: string): string | number;
Parse the environment from ProjectLocationAgentEnvironment resource.
Name | Description |
projectLocationAgentEnvironmentName |
string
A fully-qualified path representing project_location_agent_environment resource. |
Type | Description |
string | number | {string} A string representing the environment. |
matchEnvironmentFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName)
matchEnvironmentFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName: string): string | number;
Parse the environment from ProjectLocationAgentEnvironmentUserSessionContext resource.
Name | Description |
projectLocationAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_location_agent_environment_user_session_context resource. |
Type | Description |
string | number | {string} A string representing the environment. |
matchEnvironmentFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName)
matchEnvironmentFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName: string): string | number;
Parse the environment from ProjectLocationAgentEnvironmentUserSessionEntityType resource.
Name | Description |
projectLocationAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the environment. |
matchIntentFromProjectAgentIntentName(projectAgentIntentName)
matchIntentFromProjectAgentIntentName(projectAgentIntentName: string): string | number;
Parse the intent from ProjectAgentIntent resource.
Name | Description |
projectAgentIntentName |
string
A fully-qualified path representing project_agent_intent resource. |
Type | Description |
string | number | {string} A string representing the intent. |
matchIntentFromProjectLocationAgentIntentName(projectLocationAgentIntentName)
matchIntentFromProjectLocationAgentIntentName(projectLocationAgentIntentName: string): string | number;
Parse the intent from ProjectLocationAgentIntent resource.
Name | Description |
projectLocationAgentIntentName |
string
A fully-qualified path representing project_location_agent_intent resource. |
Type | Description |
string | number | {string} A string representing the intent. |
matchKnowledgeBaseFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName)
matchKnowledgeBaseFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName: string): string | number;
Parse the knowledge_base from ProjectKnowledgeBaseDocument resource.
Name | Description |
projectKnowledgeBaseDocumentName |
string
A fully-qualified path representing project_knowledge_base_document resource. |
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.
Name | Description |
projectKnowledgeBaseName |
string
A fully-qualified path representing project_knowledge_base resource. |
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.
Name | Description |
projectLocationKnowledgeBaseDocumentName |
string
A fully-qualified path representing project_location_knowledge_base_document resource. |
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.
Name | Description |
projectLocationKnowledgeBaseName |
string
A fully-qualified path representing project_location_knowledge_base resource. |
Type | Description |
string | number | {string} A string representing the knowledge_base. |
matchLocationFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName)
matchLocationFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName: string): string | number;
Parse the location from ProjectLocationAgentEntityType resource.
Name | Description |
projectLocationAgentEntityTypeName |
string
A fully-qualified path representing project_location_agent_entity_type resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName)
matchLocationFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName: string): string | number;
Parse the location from ProjectLocationAgentEnvironment resource.
Name | Description |
projectLocationAgentEnvironmentName |
string
A fully-qualified path representing project_location_agent_environment resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName)
matchLocationFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName: string): string | number;
Parse the location from ProjectLocationAgentEnvironmentUserSessionContext resource.
Name | Description |
projectLocationAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_location_agent_environment_user_session_context resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName)
matchLocationFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName: string): string | number;
Parse the location from ProjectLocationAgentEnvironmentUserSessionEntityType resource.
Name | Description |
projectLocationAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentFulfillmentName(projectLocationAgentFulfillmentName)
matchLocationFromProjectLocationAgentFulfillmentName(projectLocationAgentFulfillmentName: string): string | number;
Parse the location from ProjectLocationAgentFulfillment resource.
Name | Description |
projectLocationAgentFulfillmentName |
string
A fully-qualified path representing project_location_agent_fulfillment resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentIntentName(projectLocationAgentIntentName)
matchLocationFromProjectLocationAgentIntentName(projectLocationAgentIntentName: string): string | number;
Parse the location from ProjectLocationAgentIntent resource.
Name | Description |
projectLocationAgentIntentName |
string
A fully-qualified path representing project_location_agent_intent resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentName(projectLocationAgentName)
matchLocationFromProjectLocationAgentName(projectLocationAgentName: string): string | number;
Parse the location from ProjectLocationAgent resource.
Name | Description |
projectLocationAgentName |
string
A fully-qualified path representing project_location_agent resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName)
matchLocationFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName: string): string | number;
Parse the location from ProjectLocationAgentSessionContext resource.
Name | Description |
projectLocationAgentSessionContextName |
string
A fully-qualified path representing project_location_agent_session_context resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;
Parse the location from ProjectLocationAgentSessionEntityType resource.
Name | Description |
projectLocationAgentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAgentVersionName(projectLocationAgentVersionName)
matchLocationFromProjectLocationAgentVersionName(projectLocationAgentVersionName: string): string | number;
Parse the location from ProjectLocationAgentVersion resource.
Name | Description |
projectLocationAgentVersionName |
string
A fully-qualified path representing project_location_agent_version resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName)
matchLocationFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName: string): string | number;
Parse the location from ProjectLocationAnswerRecord resource.
Name | Description |
projectLocationAnswerRecordName |
string
A fully-qualified path representing project_location_answer_record resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationConversationMessageName(projectLocationConversationMessageName)
matchLocationFromProjectLocationConversationMessageName(projectLocationConversationMessageName: string): string | number;
Parse the location from ProjectLocationConversationMessage resource.
Name | Description |
projectLocationConversationMessageName |
string
A fully-qualified path representing project_location_conversation_message resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationConversationName(projectLocationConversationName)
matchLocationFromProjectLocationConversationName(projectLocationConversationName: string): string | number;
Parse the location from ProjectLocationConversation resource.
Name | Description |
projectLocationConversationName |
string
A fully-qualified path representing project_location_conversation resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName)
matchLocationFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName: string): string | number;
Parse the location from ProjectLocationConversationParticipant resource.
Name | Description |
projectLocationConversationParticipantName |
string
A fully-qualified path representing project_location_conversation_participant resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationConversationProfileName(projectLocationConversationProfileName)
matchLocationFromProjectLocationConversationProfileName(projectLocationConversationProfileName: string): string | number;
Parse the location from ProjectLocationConversationProfile resource.
Name | Description |
projectLocationConversationProfileName |
string
A fully-qualified path representing project_location_conversation_profile resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName)
matchLocationFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName: string): string | number;
Parse the location from ProjectLocationKnowledgeBaseDocument resource.
Name | Description |
projectLocationKnowledgeBaseDocumentName |
string
A fully-qualified path representing project_location_knowledge_base_document resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName)
matchLocationFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName: string): string | number;
Parse the location from ProjectLocationKnowledgeBase resource.
Name | Description |
projectLocationKnowledgeBaseName |
string
A fully-qualified path representing project_location_knowledge_base resource. |
Type | Description |
string | number | {string} A string representing the location. |
matchMessageFromProjectConversationMessageName(projectConversationMessageName)
matchMessageFromProjectConversationMessageName(projectConversationMessageName: string): string | number;
Parse the message from ProjectConversationMessage resource.
Name | Description |
projectConversationMessageName |
string
A fully-qualified path representing project_conversation_message resource. |
Type | Description |
string | number | {string} A string representing the message. |
matchMessageFromProjectLocationConversationMessageName(projectLocationConversationMessageName)
matchMessageFromProjectLocationConversationMessageName(projectLocationConversationMessageName: string): string | number;
Parse the message from ProjectLocationConversationMessage resource.
Name | Description |
projectLocationConversationMessageName |
string
A fully-qualified path representing project_location_conversation_message resource. |
Type | Description |
string | number | {string} A string representing the message. |
matchParticipantFromProjectConversationParticipantName(projectConversationParticipantName)
matchParticipantFromProjectConversationParticipantName(projectConversationParticipantName: string): string | number;
Parse the participant from ProjectConversationParticipant resource.
Name | Description |
projectConversationParticipantName |
string
A fully-qualified path representing project_conversation_participant resource. |
Type | Description |
string | number | {string} A string representing the participant. |
matchParticipantFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName)
matchParticipantFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName: string): string | number;
Parse the participant from ProjectLocationConversationParticipant resource.
Name | Description |
projectLocationConversationParticipantName |
string
A fully-qualified path representing project_location_conversation_participant resource. |
Type | Description |
string | number | {string} A string representing the participant. |
matchProjectFromProjectAgentEntityTypeName(projectAgentEntityTypeName)
matchProjectFromProjectAgentEntityTypeName(projectAgentEntityTypeName: string): string | number;
Parse the project from ProjectAgentEntityType resource.
Name | Description |
projectAgentEntityTypeName |
string
A fully-qualified path representing project_agent_entity_type resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectAgentEnvironmentName(projectAgentEnvironmentName)
matchProjectFromProjectAgentEnvironmentName(projectAgentEnvironmentName: string): string | number;
Parse the project from ProjectAgentEnvironment resource.
Name | Description |
projectAgentEnvironmentName |
string
A fully-qualified path representing project_agent_environment resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)
matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;
Parse the project from ProjectAgentEnvironmentUserSessionContext resource.
Name | Description |
projectAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_agent_environment_user_session_context resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)
matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;
Parse the project from ProjectAgentEnvironmentUserSessionEntityType resource.
Name | Description |
projectAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectAgentFulfillmentName(projectAgentFulfillmentName)
matchProjectFromProjectAgentFulfillmentName(projectAgentFulfillmentName: string): string | number;
Parse the project from ProjectAgentFulfillment resource.
Name | Description |
projectAgentFulfillmentName |
string
A fully-qualified path representing project_agent_fulfillment resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectAgentIntentName(projectAgentIntentName)
matchProjectFromProjectAgentIntentName(projectAgentIntentName: string): string | number;
Parse the project from ProjectAgentIntent resource.
Name | Description |
projectAgentIntentName |
string
A fully-qualified path representing project_agent_intent resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectAgentName(projectAgentName)
matchProjectFromProjectAgentName(projectAgentName: string): string | number;
Parse the project from ProjectAgent resource.
Name | Description |
projectAgentName |
string
A fully-qualified path representing project_agent resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectAgentSessionContextName(projectAgentSessionContextName)
matchProjectFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number;
Parse the project from ProjectAgentSessionContext resource.
Name | Description |
projectAgentSessionContextName |
string
A fully-qualified path representing project_agent_session_context resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)
matchProjectFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number;
Parse the project from ProjectAgentSessionEntityType resource.
Name | Description |
projectAgentSessionEntityTypeName |
string
A fully-qualified path representing project_agent_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectAgentVersionName(projectAgentVersionName)
matchProjectFromProjectAgentVersionName(projectAgentVersionName: string): string | number;
Parse the project from ProjectAgentVersion resource.
Name | Description |
projectAgentVersionName |
string
A fully-qualified path representing project_agent_version resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectAnswerRecordName(projectAnswerRecordName)
matchProjectFromProjectAnswerRecordName(projectAnswerRecordName: string): string | number;
Parse the project from ProjectAnswerRecord resource.
Name | Description |
projectAnswerRecordName |
string
A fully-qualified path representing project_answer_record resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectConversationMessageName(projectConversationMessageName)
matchProjectFromProjectConversationMessageName(projectConversationMessageName: string): string | number;
Parse the project from ProjectConversationMessage resource.
Name | Description |
projectConversationMessageName |
string
A fully-qualified path representing project_conversation_message resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectConversationName(projectConversationName)
matchProjectFromProjectConversationName(projectConversationName: string): string | number;
Parse the project from ProjectConversation resource.
Name | Description |
projectConversationName |
string
A fully-qualified path representing project_conversation resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectConversationParticipantName(projectConversationParticipantName)
matchProjectFromProjectConversationParticipantName(projectConversationParticipantName: string): string | number;
Parse the project from ProjectConversationParticipant resource.
Name | Description |
projectConversationParticipantName |
string
A fully-qualified path representing project_conversation_participant resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectConversationProfileName(projectConversationProfileName)
matchProjectFromProjectConversationProfileName(projectConversationProfileName: string): string | number;
Parse the project from ProjectConversationProfile resource.
Name | Description |
projectConversationProfileName |
string
A fully-qualified path representing project_conversation_profile resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName)
matchProjectFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName: string): string | number;
Parse the project from ProjectKnowledgeBaseDocument resource.
Name | Description |
projectKnowledgeBaseDocumentName |
string
A fully-qualified path representing project_knowledge_base_document resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectKnowledgeBaseName(projectKnowledgeBaseName)
matchProjectFromProjectKnowledgeBaseName(projectKnowledgeBaseName: string): string | number;
Parse the project from ProjectKnowledgeBase resource.
Name | Description |
projectKnowledgeBaseName |
string
A fully-qualified path representing project_knowledge_base resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName)
matchProjectFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName: string): string | number;
Parse the project from ProjectLocationAgentEntityType resource.
Name | Description |
projectLocationAgentEntityTypeName |
string
A fully-qualified path representing project_location_agent_entity_type resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName)
matchProjectFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName: string): string | number;
Parse the project from ProjectLocationAgentEnvironment resource.
Name | Description |
projectLocationAgentEnvironmentName |
string
A fully-qualified path representing project_location_agent_environment resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName)
matchProjectFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName: string): string | number;
Parse the project from ProjectLocationAgentEnvironmentUserSessionContext resource.
Name | Description |
projectLocationAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_location_agent_environment_user_session_context resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName)
matchProjectFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName: string): string | number;
Parse the project from ProjectLocationAgentEnvironmentUserSessionEntityType resource.
Name | Description |
projectLocationAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentFulfillmentName(projectLocationAgentFulfillmentName)
matchProjectFromProjectLocationAgentFulfillmentName(projectLocationAgentFulfillmentName: string): string | number;
Parse the project from ProjectLocationAgentFulfillment resource.
Name | Description |
projectLocationAgentFulfillmentName |
string
A fully-qualified path representing project_location_agent_fulfillment resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentIntentName(projectLocationAgentIntentName)
matchProjectFromProjectLocationAgentIntentName(projectLocationAgentIntentName: string): string | number;
Parse the project from ProjectLocationAgentIntent resource.
Name | Description |
projectLocationAgentIntentName |
string
A fully-qualified path representing project_location_agent_intent resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentName(projectLocationAgentName)
matchProjectFromProjectLocationAgentName(projectLocationAgentName: string): string | number;
Parse the project from ProjectLocationAgent resource.
Name | Description |
projectLocationAgentName |
string
A fully-qualified path representing project_location_agent resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName)
matchProjectFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName: string): string | number;
Parse the project from ProjectLocationAgentSessionContext resource.
Name | Description |
projectLocationAgentSessionContextName |
string
A fully-qualified path representing project_location_agent_session_context resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;
Parse the project from ProjectLocationAgentSessionEntityType resource.
Name | Description |
projectLocationAgentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAgentVersionName(projectLocationAgentVersionName)
matchProjectFromProjectLocationAgentVersionName(projectLocationAgentVersionName: string): string | number;
Parse the project from ProjectLocationAgentVersion resource.
Name | Description |
projectLocationAgentVersionName |
string
A fully-qualified path representing project_location_agent_version resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName)
matchProjectFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName: string): string | number;
Parse the project from ProjectLocationAnswerRecord resource.
Name | Description |
projectLocationAnswerRecordName |
string
A fully-qualified path representing project_location_answer_record resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationConversationMessageName(projectLocationConversationMessageName)
matchProjectFromProjectLocationConversationMessageName(projectLocationConversationMessageName: string): string | number;
Parse the project from ProjectLocationConversationMessage resource.
Name | Description |
projectLocationConversationMessageName |
string
A fully-qualified path representing project_location_conversation_message resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationConversationName(projectLocationConversationName)
matchProjectFromProjectLocationConversationName(projectLocationConversationName: string): string | number;
Parse the project from ProjectLocationConversation resource.
Name | Description |
projectLocationConversationName |
string
A fully-qualified path representing project_location_conversation resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName)
matchProjectFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName: string): string | number;
Parse the project from ProjectLocationConversationParticipant resource.
Name | Description |
projectLocationConversationParticipantName |
string
A fully-qualified path representing project_location_conversation_participant resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationConversationProfileName(projectLocationConversationProfileName)
matchProjectFromProjectLocationConversationProfileName(projectLocationConversationProfileName: string): string | number;
Parse the project from ProjectLocationConversationProfile resource.
Name | Description |
projectLocationConversationProfileName |
string
A fully-qualified path representing project_location_conversation_profile resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName)
matchProjectFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName: string): string | number;
Parse the project from ProjectLocationKnowledgeBaseDocument resource.
Name | Description |
projectLocationKnowledgeBaseDocumentName |
string
A fully-qualified path representing project_location_knowledge_base_document resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName)
matchProjectFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName: string): string | number;
Parse the project from ProjectLocationKnowledgeBase resource.
Name | Description |
projectLocationKnowledgeBaseName |
string
A fully-qualified path representing project_location_knowledge_base resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectName(projectName)
matchProjectFromProjectName(projectName: string): string | number;
Parse the project from Project resource.
Name | Description |
projectName |
string
A fully-qualified path representing Project resource. |
Type | Description |
string | number | {string} A string representing the project. |
matchSessionFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)
matchSessionFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;
Parse the session from ProjectAgentEnvironmentUserSessionContext resource.
Name | Description |
projectAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_agent_environment_user_session_context resource. |
Type | Description |
string | number | {string} A string representing the session. |
matchSessionFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)
matchSessionFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;
Parse the session from ProjectAgentEnvironmentUserSessionEntityType resource.
Name | Description |
projectAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the session. |
matchSessionFromProjectAgentSessionContextName(projectAgentSessionContextName)
matchSessionFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number;
Parse the session from ProjectAgentSessionContext resource.
Name | Description |
projectAgentSessionContextName |
string
A fully-qualified path representing project_agent_session_context resource. |
Type | Description |
string | number | {string} A string representing the session. |
matchSessionFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)
matchSessionFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number;
Parse the session from ProjectAgentSessionEntityType resource.
Name | Description |
projectAgentSessionEntityTypeName |
string
A fully-qualified path representing project_agent_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the session. |
matchSessionFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName)
matchSessionFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName: string): string | number;
Parse the session from ProjectLocationAgentEnvironmentUserSessionContext resource.
Name | Description |
projectLocationAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_location_agent_environment_user_session_context resource. |
Type | Description |
string | number | {string} A string representing the session. |
matchSessionFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName)
matchSessionFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName: string): string | number;
Parse the session from ProjectLocationAgentEnvironmentUserSessionEntityType resource.
Name | Description |
projectLocationAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the session. |
matchSessionFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName)
matchSessionFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName: string): string | number;
Parse the session from ProjectLocationAgentSessionContext resource.
Name | Description |
projectLocationAgentSessionContextName |
string
A fully-qualified path representing project_location_agent_session_context resource. |
Type | Description |
string | number | {string} A string representing the session. |
matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)
matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;
Parse the session from ProjectLocationAgentSessionEntityType resource.
Name | Description |
projectLocationAgentSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the session. |
matchUserFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)
matchUserFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;
Parse the user from ProjectAgentEnvironmentUserSessionContext resource.
Name | Description |
projectAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_agent_environment_user_session_context resource. |
Type | Description |
string | number | {string} A string representing the user. |
matchUserFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)
matchUserFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;
Parse the user from ProjectAgentEnvironmentUserSessionEntityType resource.
Name | Description |
projectAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the user. |
matchUserFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName)
matchUserFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName: string): string | number;
Parse the user from ProjectLocationAgentEnvironmentUserSessionContext resource.
Name | Description |
projectLocationAgentEnvironmentUserSessionContextName |
string
A fully-qualified path representing project_location_agent_environment_user_session_context resource. |
Type | Description |
string | number | {string} A string representing the user. |
matchUserFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName)
matchUserFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName: string): string | number;
Parse the user from ProjectLocationAgentEnvironmentUserSessionEntityType resource.
Name | Description |
projectLocationAgentEnvironmentUserSessionEntityTypeName |
string
A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource. |
Type | Description |
string | number | {string} A string representing the user. |
matchVersionFromProjectAgentVersionName(projectAgentVersionName)
matchVersionFromProjectAgentVersionName(projectAgentVersionName: string): string | number;
Parse the version from ProjectAgentVersion resource.
Name | Description |
projectAgentVersionName |
string
A fully-qualified path representing project_agent_version resource. |
Type | Description |
string | number | {string} A string representing the version. |
matchVersionFromProjectLocationAgentVersionName(projectLocationAgentVersionName)
matchVersionFromProjectLocationAgentVersionName(projectLocationAgentVersionName: string): string | number;
Parse the version from ProjectLocationAgentVersion resource.
Name | Description |
projectLocationAgentVersionName |
string
A fully-qualified path representing project_location_agent_version resource. |
Type | Description |
string | number | {string} A string representing the version. |
projectAgentEntityTypePath(project, entityType)
projectAgentEntityTypePath(project: string, entityType: string): string;
Return a fully-qualified projectAgentEntityType resource name string.
Name | Description |
project |
string
|
entityType |
string
|
Type | Description |
string | {string} Resource name string. |
projectAgentEnvironmentPath(project, environment)
projectAgentEnvironmentPath(project: string, environment: string): string;
Return a fully-qualified projectAgentEnvironment resource name string.
Name | Description |
project |
string
|
environment |
string
|
Type | Description |
string | {string} Resource name string. |
projectAgentEnvironmentUserSessionContextPath(project, environment, user, session, context)
projectAgentEnvironmentUserSessionContextPath(project: string, environment: string, user: string, session: string, context: string): string;
Return a fully-qualified projectAgentEnvironmentUserSessionContext resource name string.
Name | Description |
project |
string
|
environment |
string
|
user |
string
|
session |
string
|
context |
string
|
Type | Description |
string | {string} Resource name string. |
projectAgentEnvironmentUserSessionEntityTypePath(project, environment, user, session, entityType)
projectAgentEnvironmentUserSessionEntityTypePath(project: string, environment: string, user: string, session: string, entityType: string): string;
Return a fully-qualified projectAgentEnvironmentUserSessionEntityType resource name string.
Name | Description |
project |
string
|
environment |
string
|
user |
string
|
session |
string
|
entityType |
string
|
Type | Description |
string | {string} Resource name string. |
projectAgentFulfillmentPath(project)
projectAgentFulfillmentPath(project: string): string;
Return a fully-qualified projectAgentFulfillment resource name string.
Name | Description |
project |
string
|
Type | Description |
string | {string} Resource name string. |
projectAgentIntentPath(project, intent)
projectAgentIntentPath(project: string, intent: string): string;
Return a fully-qualified projectAgentIntent resource name string.
Name | Description |
project |
string
|
intent |
string
|
Type | Description |
string | {string} Resource name string. |
projectAgentPath(project)
projectAgentPath(project: string): string;
Return a fully-qualified projectAgent resource name string.
Name | Description |
project |
string
|
Type | Description |
string | {string} Resource name string. |
projectAgentSessionContextPath(project, session, context)
projectAgentSessionContextPath(project: string, session: string, context: string): string;
Return a fully-qualified projectAgentSessionContext resource name string.
Name | Description |
project |
string
|
session |
string
|
context |
string
|
Type | Description |
string | {string} Resource name string. |
projectAgentSessionEntityTypePath(project, session, entityType)
projectAgentSessionEntityTypePath(project: string, session: string, entityType: string): string;
Return a fully-qualified projectAgentSessionEntityType resource name string.
Name | Description |
project |
string
|
session |
string
|
entityType |
string
|
Type | Description |
string | {string} Resource name string. |
projectAgentVersionPath(project, version)
projectAgentVersionPath(project: string, version: string): string;
Return a fully-qualified projectAgentVersion resource name string.
Name | Description |
project |
string
|
version |
string
|
Type | Description |
string | {string} Resource name string. |
projectAnswerRecordPath(project, answerRecord)
projectAnswerRecordPath(project: string, answerRecord: string): string;
Return a fully-qualified projectAnswerRecord resource name string.
Name | Description |
project |
string
|
answerRecord |
string
|
Type | Description |
string | {string} Resource name string. |
projectConversationMessagePath(project, conversation, message)
projectConversationMessagePath(project: string, conversation: string, message: string): string;
Return a fully-qualified projectConversationMessage resource name string.
Name | Description |
project |
string
|
conversation |
string
|
message |
string
|
Type | Description |
string | {string} Resource name string. |
projectConversationParticipantPath(project, conversation, participant)
projectConversationParticipantPath(project: string, conversation: string, participant: string): string;
Return a fully-qualified projectConversationParticipant resource name string.
Name | Description |
project |
string
|
conversation |
string
|
participant |
string
|
Type | Description |
string | {string} Resource name string. |
projectConversationPath(project, conversation)
projectConversationPath(project: string, conversation: string): string;
Return a fully-qualified projectConversation resource name string.
Name | Description |
project |
string
|
conversation |
string
|
Type | Description |
string | {string} Resource name string. |
projectConversationProfilePath(project, conversationProfile)
projectConversationProfilePath(project: string, conversationProfile: string): string;
Return a fully-qualified projectConversationProfile resource name string.
Name | Description |
project |
string
|
conversationProfile |
string
|
Type | Description |
string | {string} Resource name string. |
projectKnowledgeBaseDocumentPath(project, knowledgeBase, document)
projectKnowledgeBaseDocumentPath(project: string, knowledgeBase: string, document: string): string;
Return a fully-qualified projectKnowledgeBaseDocument resource name string.
Name | Description |
project |
string
|
knowledgeBase |
string
|
document |
string
|
Type | Description |
string | {string} Resource name string. |
projectKnowledgeBasePath(project, knowledgeBase)
projectKnowledgeBasePath(project: string, knowledgeBase: string): string;
Return a fully-qualified projectKnowledgeBase resource name string.
Name | Description |
project |
string
|
knowledgeBase |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationAgentEntityTypePath(project, location, entityType)
projectLocationAgentEntityTypePath(project: string, location: string, entityType: string): string;
Return a fully-qualified projectLocationAgentEntityType resource name string.
Name | Description |
project |
string
|
location |
string
|
entityType |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationAgentEnvironmentPath(project, location, environment)
projectLocationAgentEnvironmentPath(project: string, location: string, environment: string): string;
Return a fully-qualified projectLocationAgentEnvironment resource name string.
Name | Description |
project |
string
|
location |
string
|
environment |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationAgentEnvironmentUserSessionContextPath(project, location, environment, user, session, context)
projectLocationAgentEnvironmentUserSessionContextPath(project: string, location: string, environment: string, user: string, session: string, context: string): string;
Return a fully-qualified projectLocationAgentEnvironmentUserSessionContext resource name string.
Name | Description |
project |
string
|
location |
string
|
environment |
string
|
user |
string
|
session |
string
|
context |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationAgentEnvironmentUserSessionEntityTypePath(project, location, environment, user, session, entityType)
projectLocationAgentEnvironmentUserSessionEntityTypePath(project: string, location: string, environment: string, user: string, session: string, entityType: string): string;
Return a fully-qualified projectLocationAgentEnvironmentUserSessionEntityType resource name string.
Name | Description |
project |
string
|
location |
string
|
environment |
string
|
user |
string
|
session |
string
|
entityType |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationAgentFulfillmentPath(project, location)
projectLocationAgentFulfillmentPath(project: string, location: string): string;
Return a fully-qualified projectLocationAgentFulfillment resource name string.
Name | Description |
project |
string
|
location |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationAgentIntentPath(project, location, intent)
projectLocationAgentIntentPath(project: string, location: string, intent: string): string;
Return a fully-qualified projectLocationAgentIntent resource name string.
Name | Description |
project |
string
|
location |
string
|
intent |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationAgentPath(project, location)
projectLocationAgentPath(project: string, location: string): string;
Return a fully-qualified projectLocationAgent resource name string.
Name | Description |
project |
string
|
location |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationAgentSessionContextPath(project, location, session, context)
projectLocationAgentSessionContextPath(project: string, location: string, session: string, context: string): string;
Return a fully-qualified projectLocationAgentSessionContext resource name string.
Name | Description |
project |
string
|
location |
string
|
session |
string
|
context |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationAgentSessionEntityTypePath(project, location, session, entityType)
projectLocationAgentSessionEntityTypePath(project: string, location: string, session: string, entityType: string): string;
Return a fully-qualified projectLocationAgentSessionEntityType resource name string.
Name | Description |
project |
string
|
location |
string
|
session |
string
|
entityType |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationAgentVersionPath(project, location, version)
projectLocationAgentVersionPath(project: string, location: string, version: string): string;
Return a fully-qualified projectLocationAgentVersion resource name string.
Name | Description |
project |
string
|
location |
string
|
version |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationAnswerRecordPath(project, location, answerRecord)
projectLocationAnswerRecordPath(project: string, location: string, answerRecord: string): string;
Return a fully-qualified projectLocationAnswerRecord resource name string.
Name | Description |
project |
string
|
location |
string
|
answerRecord |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationConversationMessagePath(project, location, conversation, message)
projectLocationConversationMessagePath(project: string, location: string, conversation: string, message: string): string;
Return a fully-qualified projectLocationConversationMessage resource name string.
Name | Description |
project |
string
|
location |
string
|
conversation |
string
|
message |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationConversationParticipantPath(project, location, conversation, participant)
projectLocationConversationParticipantPath(project: string, location: string, conversation: string, participant: string): string;
Return a fully-qualified projectLocationConversationParticipant resource name string.
Name | Description |
project |
string
|
location |
string
|
conversation |
string
|
participant |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationConversationPath(project, location, conversation)
projectLocationConversationPath(project: string, location: string, conversation: string): string;
Return a fully-qualified projectLocationConversation resource name string.
Name | Description |
project |
string
|
location |
string
|
conversation |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationConversationProfilePath(project, location, conversationProfile)
projectLocationConversationProfilePath(project: string, location: string, conversationProfile: string): string;
Return a fully-qualified projectLocationConversationProfile resource name string.
Name | Description |
project |
string
|
location |
string
|
conversationProfile |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationKnowledgeBaseDocumentPath(project, location, knowledgeBase, document)
projectLocationKnowledgeBaseDocumentPath(project: string, location: string, knowledgeBase: string, document: string): string;
Return a fully-qualified projectLocationKnowledgeBaseDocument resource name string.
Name | Description |
project |
string
|
location |
string
|
knowledgeBase |
string
|
document |
string
|
Type | Description |
string | {string} Resource name string. |
projectLocationKnowledgeBasePath(project, location, knowledgeBase)
projectLocationKnowledgeBasePath(project: string, location: string, knowledgeBase: string): string;
Return a fully-qualified projectLocationKnowledgeBase resource name string.
Name | Description |
project |
string
|
location |
string
|
knowledgeBase |
string
|
Type | Description |
string | {string} Resource name string. |
projectPath(project)
projectPath(project: string): string;
Return a fully-qualified project resource name string.
Name | Description |
project |
string
|
Type | Description |
string | {string} Resource name string. |
updateEntityType(request, options)
updateEntityType(request?: protos.google.cloud.dialogflow.v2beta1.IUpdateEntityTypeRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.v2beta1.IEntityType, (protos.google.cloud.dialogflow.v2beta1.IUpdateEntityTypeRequest | undefined), {} | undefined]>;
Updates the specified entity type.
Note: You should always train an agent prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/es/docs/training).
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IUpdateEntityTypeRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
Promise<[protos.google.cloud.dialogflow.v2beta1.IEntityType, (protos.google.cloud.dialogflow.v2beta1.IUpdateEntityTypeRequest | undefined), {} | undefined]> | {Promise} - The promise which resolves to an array. The first element of the array is an object representing [EntityType]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples. |
/**
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The entity type to update.
*/
// const entityType = {}
/**
* Optional. The language used to access language-specific data.
* If not specified, the agent's default language is used.
* For more information, see
* Multilingual intent and entity
* data (https://cloud.google.com/dialogflow/docs/agents-multilingual#intent-entity).
*/
// const languageCode = 'abc123'
/**
* Optional. The mask to control which fields get updated.
*/
// const updateMask = {}
// Imports the Dialogflow library
const {EntityTypesClient} = require('@google-cloud/dialogflow').v2beta1;
// Instantiates a client
const dialogflowClient = new EntityTypesClient();
async function callUpdateEntityType() {
// Construct request
const request = {
entityType,
};
// Run request
const response = await dialogflowClient.updateEntityType(request);
console.log(response);
}
callUpdateEntityType();
updateEntityType(request, options, callback)
updateEntityType(request: protos.google.cloud.dialogflow.v2beta1.IUpdateEntityTypeRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IEntityType, protos.google.cloud.dialogflow.v2beta1.IUpdateEntityTypeRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IUpdateEntityTypeRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.dialogflow.v2beta1.IEntityType, protos.google.cloud.dialogflow.v2beta1.IUpdateEntityTypeRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |
updateEntityType(request, callback)
updateEntityType(request: protos.google.cloud.dialogflow.v2beta1.IUpdateEntityTypeRequest, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IEntityType, protos.google.cloud.dialogflow.v2beta1.IUpdateEntityTypeRequest | null | undefined, {} | null | undefined>): void;
Name | Description |
request |
protos.google.cloud.dialogflow.v2beta1.IUpdateEntityTypeRequest
|
callback |
Callback<protos.google.cloud.dialogflow.v2beta1.IEntityType, protos.google.cloud.dialogflow.v2beta1.IUpdateEntityTypeRequest | null | undefined, {} | null | undefined>
|
Type | Description |
void |