Constructor
new EntityTypesClient(optionsopt)
Construct an instance of EntityTypesClient.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
The configuration object. See the subsequent parameters for more details. Properties
|
- Source:
Members
(static) apiEndpoint
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
- Source:
(static) port
The port for this API service.
- Source:
(static) scopes
The scopes needed to make gRPC calls for every method defined in this service.
- Source:
(static) servicePath
The DNS address for this API service.
- Source:
Methods
batchCreateEntities(request, optionsopt, callbackopt) → {Promise}
Creates multiple new entities in the specified entity type.
Operation <response: google.protobuf.Empty>
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is a gax.Operation object. |
- Source:
Example
const dialogflow = require('dialogflow');
const client = new dialogflow.v2beta1.EntityTypesClient({
// optional auth parameters.
});
const formattedParent = client.entityTypePath('[PROJECT]', '[ENTITY_TYPE]');
const entities = [];
const request = {
parent: formattedParent,
entities: entities,
};
// Handle the operation using the promise pattern.
client.batchCreateEntities(request)
.then(responses => {
const [operation, initialApiResponse] = responses;
// Operation#promise starts polling for the completion of the LRO.
return operation.promise();
})
.then(responses => {
const result = responses[0];
const metadata = responses[1];
const finalApiResponse = responses[2];
})
.catch(err => {
console.error(err);
});
const formattedParent = client.entityTypePath('[PROJECT]', '[ENTITY_TYPE]');
const entities = [];
const request = {
parent: formattedParent,
entities: entities,
};
// Handle the operation using the event emitter pattern.
client.batchCreateEntities(request)
.then(responses => {
const [operation, initialApiResponse] = responses;
// Adding a listener for the "complete" event starts polling for the
// completion of the operation.
operation.on('complete', (result, metadata, finalApiResponse) => {
// doSomethingWith(result);
});
// Adding a listener for the "progress" event causes the callback to be
// called on any change in metadata when the operation is polled.
operation.on('progress', (metadata, apiResponse) => {
// doSomethingWith(metadata)
});
// Adding a listener for the "error" event handles any errors found during polling.
operation.on('error', err => {
// throw(err);
});
})
.catch(err => {
console.error(err);
});
const formattedParent = client.entityTypePath('[PROJECT]', '[ENTITY_TYPE]');
const entities = [];
const request = {
parent: formattedParent,
entities: entities,
};
// Handle the operation using the await pattern.
const [operation] = await client.batchCreateEntities(request);
const [response] = await operation.promise();
batchDeleteEntities(request, optionsopt, callbackopt) → {Promise}
Deletes entities in the specified entity type.
Operation <response: google.protobuf.Empty>
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is a gax.Operation object. |
- Source:
Example
const dialogflow = require('dialogflow');
const client = new dialogflow.v2beta1.EntityTypesClient({
// optional auth parameters.
});
const formattedParent = client.entityTypePath('[PROJECT]', '[ENTITY_TYPE]');
const entityValues = [];
const request = {
parent: formattedParent,
entityValues: entityValues,
};
// Handle the operation using the promise pattern.
client.batchDeleteEntities(request)
.then(responses => {
const [operation, initialApiResponse] = responses;
// Operation#promise starts polling for the completion of the LRO.
return operation.promise();
})
.then(responses => {
const result = responses[0];
const metadata = responses[1];
const finalApiResponse = responses[2];
})
.catch(err => {
console.error(err);
});
const formattedParent = client.entityTypePath('[PROJECT]', '[ENTITY_TYPE]');
const entityValues = [];
const request = {
parent: formattedParent,
entityValues: entityValues,
};
// Handle the operation using the event emitter pattern.
client.batchDeleteEntities(request)
.then(responses => {
const [operation, initialApiResponse] = responses;
// Adding a listener for the "complete" event starts polling for the
// completion of the operation.
operation.on('complete', (result, metadata, finalApiResponse) => {
// doSomethingWith(result);
});
// Adding a listener for the "progress" event causes the callback to be
// called on any change in metadata when the operation is polled.
operation.on('progress', (metadata, apiResponse) => {
// doSomethingWith(metadata)
});
// Adding a listener for the "error" event handles any errors found during polling.
operation.on('error', err => {
// throw(err);
});
})
.catch(err => {
console.error(err);
});
const formattedParent = client.entityTypePath('[PROJECT]', '[ENTITY_TYPE]');
const entityValues = [];
const request = {
parent: formattedParent,
entityValues: entityValues,
};
// Handle the operation using the await pattern.
const [operation] = await client.batchDeleteEntities(request);
const [response] = await operation.promise();
batchDeleteEntityTypes(request, optionsopt, callbackopt) → {Promise}
Deletes entity types in the specified agent.
Operation <response: google.protobuf.Empty>
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
|||||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is a gax.Operation object. |
- Source:
Example
const dialogflow = require('dialogflow');
const client = new dialogflow.v2beta1.EntityTypesClient({
// optional auth parameters.
});
const formattedParent = client.projectAgentPath('[PROJECT]');
const entityTypeNames = [];
const request = {
parent: formattedParent,
entityTypeNames: entityTypeNames,
};
// Handle the operation using the promise pattern.
client.batchDeleteEntityTypes(request)
.then(responses => {
const [operation, initialApiResponse] = responses;
// Operation#promise starts polling for the completion of the LRO.
return operation.promise();
})
.then(responses => {
const result = responses[0];
const metadata = responses[1];
const finalApiResponse = responses[2];
})
.catch(err => {
console.error(err);
});
const formattedParent = client.projectAgentPath('[PROJECT]');
const entityTypeNames = [];
const request = {
parent: formattedParent,
entityTypeNames: entityTypeNames,
};
// Handle the operation using the event emitter pattern.
client.batchDeleteEntityTypes(request)
.then(responses => {
const [operation, initialApiResponse] = responses;
// Adding a listener for the "complete" event starts polling for the
// completion of the operation.
operation.on('complete', (result, metadata, finalApiResponse) => {
// doSomethingWith(result);
});
// Adding a listener for the "progress" event causes the callback to be
// called on any change in metadata when the operation is polled.
operation.on('progress', (metadata, apiResponse) => {
// doSomethingWith(metadata)
});
// Adding a listener for the "error" event handles any errors found during polling.
operation.on('error', err => {
// throw(err);
});
})
.catch(err => {
console.error(err);
});
const formattedParent = client.projectAgentPath('[PROJECT]');
const entityTypeNames = [];
const request = {
parent: formattedParent,
entityTypeNames: entityTypeNames,
};
// Handle the operation using the await pattern.
const [operation] = await client.batchDeleteEntityTypes(request);
const [response] = await operation.promise();
batchUpdateEntities(request, optionsopt, callbackopt) → {Promise}
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.
Operation <response: google.protobuf.Empty>
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is a gax.Operation object. |
- Source:
Example
const dialogflow = require('dialogflow');
const client = new dialogflow.v2beta1.EntityTypesClient({
// optional auth parameters.
});
const formattedParent = client.entityTypePath('[PROJECT]', '[ENTITY_TYPE]');
const entities = [];
const request = {
parent: formattedParent,
entities: entities,
};
// Handle the operation using the promise pattern.
client.batchUpdateEntities(request)
.then(responses => {
const [operation, initialApiResponse] = responses;
// Operation#promise starts polling for the completion of the LRO.
return operation.promise();
})
.then(responses => {
const result = responses[0];
const metadata = responses[1];
const finalApiResponse = responses[2];
})
.catch(err => {
console.error(err);
});
const formattedParent = client.entityTypePath('[PROJECT]', '[ENTITY_TYPE]');
const entities = [];
const request = {
parent: formattedParent,
entities: entities,
};
// Handle the operation using the event emitter pattern.
client.batchUpdateEntities(request)
.then(responses => {
const [operation, initialApiResponse] = responses;
// Adding a listener for the "complete" event starts polling for the
// completion of the operation.
operation.on('complete', (result, metadata, finalApiResponse) => {
// doSomethingWith(result);
});
// Adding a listener for the "progress" event causes the callback to be
// called on any change in metadata when the operation is polled.
operation.on('progress', (metadata, apiResponse) => {
// doSomethingWith(metadata)
});
// Adding a listener for the "error" event handles any errors found during polling.
operation.on('error', err => {
// throw(err);
});
})
.catch(err => {
console.error(err);
});
const formattedParent = client.entityTypePath('[PROJECT]', '[ENTITY_TYPE]');
const entities = [];
const request = {
parent: formattedParent,
entities: entities,
};
// Handle the operation using the await pattern.
const [operation] = await client.batchUpdateEntities(request);
const [response] = await operation.promise();
batchUpdateEntityTypes(request, optionsopt, callbackopt) → {Promise}
Updates/Creates multiple entity types in the specified agent.
Operation <response: BatchUpdateEntityTypesResponse>
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||||||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is a gax.Operation object. |
- Source:
Example
const dialogflow = require('dialogflow');
const client = new dialogflow.v2beta1.EntityTypesClient({
// optional auth parameters.
});
const formattedParent = client.projectAgentPath('[PROJECT]');
// Handle the operation using the promise pattern.
client.batchUpdateEntityTypes({parent: formattedParent})
.then(responses => {
const [operation, initialApiResponse] = responses;
// Operation#promise starts polling for the completion of the LRO.
return operation.promise();
})
.then(responses => {
const result = responses[0];
const metadata = responses[1];
const finalApiResponse = responses[2];
})
.catch(err => {
console.error(err);
});
const formattedParent = client.projectAgentPath('[PROJECT]');
// Handle the operation using the event emitter pattern.
client.batchUpdateEntityTypes({parent: formattedParent})
.then(responses => {
const [operation, initialApiResponse] = responses;
// Adding a listener for the "complete" event starts polling for the
// completion of the operation.
operation.on('complete', (result, metadata, finalApiResponse) => {
// doSomethingWith(result);
});
// Adding a listener for the "progress" event causes the callback to be
// called on any change in metadata when the operation is polled.
operation.on('progress', (metadata, apiResponse) => {
// doSomethingWith(metadata)
});
// Adding a listener for the "error" event handles any errors found during polling.
operation.on('error', err => {
// throw(err);
});
})
.catch(err => {
console.error(err);
});
const formattedParent = client.projectAgentPath('[PROJECT]');
// Handle the operation using the await pattern.
const [operation] = await client.batchUpdateEntityTypes({parent: formattedParent});
const [response] = await operation.promise();
createEntityType(request, optionsopt, callbackopt) → {Promise}
Creates an entity type in the specified agent.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing EntityType. |
- Source:
Example
const dialogflow = require('dialogflow');
const client = new dialogflow.v2beta1.EntityTypesClient({
// optional auth parameters.
});
const formattedParent = client.projectAgentPath('[PROJECT]');
const entityType = {};
const request = {
parent: formattedParent,
entityType: entityType,
};
client.createEntityType(request)
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});
deleteEntityType(request, optionsopt, callbackopt) → {Promise}
Deletes the specified entity type.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. |
- Source:
Example
const dialogflow = require('dialogflow');
const client = new dialogflow.v2beta1.EntityTypesClient({
// optional auth parameters.
});
const formattedName = client.entityTypePath('[PROJECT]', '[ENTITY_TYPE]');
client.deleteEntityType({name: formattedName}).catch(err => {
console.error(err);
});
entityTypePath(project, entityType) → {String}
Return a fully-qualified entity_type resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
String | |
entityType |
String |
- Source:
getEntityType(request, optionsopt, callbackopt) → {Promise}
Retrieves the specified entity type.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing EntityType. |
- Source:
Example
const dialogflow = require('dialogflow');
const client = new dialogflow.v2beta1.EntityTypesClient({
// optional auth parameters.
});
const formattedName = client.entityTypePath('[PROJECT]', '[ENTITY_TYPE]');
client.getEntityType({name: formattedName})
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});
getProjectId(callback)
Return the project ID used by this class.
Parameters:
Name | Type | Description |
---|---|---|
callback |
function |
the callback to be called with the current project Id. |
- Source:
listEntityTypes(request, optionsopt, callbackopt) → {Promise}
Returns the list of all entity types in the specified agent.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is Array of EntityType. When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListEntityTypesResponse. |
- Source:
Example
const dialogflow = require('dialogflow');
const client = new dialogflow.v2beta1.EntityTypesClient({
// optional auth parameters.
});
// Iterate over all elements.
const formattedParent = client.projectAgentPath('[PROJECT]');
client.listEntityTypes({parent: formattedParent})
.then(responses => {
const resources = responses[0];
for (const resource of resources) {
// doThingsWith(resource)
}
})
.catch(err => {
console.error(err);
});
// Or obtain the paged response.
const formattedParent = client.projectAgentPath('[PROJECT]');
const options = {autoPaginate: false};
const callback = responses => {
// The actual resources in a response.
const resources = responses[0];
// The next request if the response shows that there are more responses.
const nextRequest = responses[1];
// The actual response object, if necessary.
// const rawResponse = responses[2];
for (const resource of resources) {
// doThingsWith(resource);
}
if (nextRequest) {
// Fetch the next page.
return client.listEntityTypes(nextRequest, options).then(callback);
}
}
client.listEntityTypes({parent: formattedParent}, options)
.then(callback)
.catch(err => {
console.error(err);
});
listEntityTypesStream(request, optionsopt) → {Stream}
Equivalent to listEntityTypes, but returns a NodeJS Stream object.
This fetches the paged responses for listEntityTypes continuously and invokes the callback registered for 'data' event for each element in the responses.
The returned object has 'end' method when no more elements are required.
autoPaginate option will be ignored.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
Example
const dialogflow = require('dialogflow');
const client = new dialogflow.v2beta1.EntityTypesClient({
// optional auth parameters.
});
const formattedParent = client.projectAgentPath('[PROJECT]');
client.listEntityTypesStream({parent: formattedParent})
.on('data', element => {
// doThingsWith(element)
}).on('error', err => {
console.log(err);
});
matchEntityTypeFromEntityTypeName(entityTypeName) → {String}
Parse the entityTypeName from a entity_type resource.
Parameters:
Name | Type | Description |
---|---|---|
entityTypeName |
String |
A fully-qualified path representing a entity_type resources. |
- Source:
matchProjectFromEntityTypeName(entityTypeName) → {String}
Parse the entityTypeName from a entity_type resource.
Parameters:
Name | Type | Description |
---|---|---|
entityTypeName |
String |
A fully-qualified path representing a entity_type resources. |
- Source:
matchProjectFromProjectAgentName(projectAgentName) → {String}
Parse the projectAgentName from a project_agent resource.
Parameters:
Name | Type | Description |
---|---|---|
projectAgentName |
String |
A fully-qualified path representing a project_agent resources. |
- Source:
projectAgentPath(project) → {String}
Return a fully-qualified project_agent resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
String |
- Source:
updateEntityType(request, optionsopt, callbackopt) → {Promise}
Updates the specified entity type.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
Object |
<optional> |
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details. |
||||||||||||||||
callback |
function |
<optional> |
The function which will be called with the result of the API call. The second parameter to the callback is an object representing EntityType. |
- Source:
Example
const dialogflow = require('dialogflow');
const client = new dialogflow.v2beta1.EntityTypesClient({
// optional auth parameters.
});
const entityType = {};
client.updateEntityType({entityType: entityType})
.then(responses => {
const response = responses[0];
// doThingsWith(response)
})
.catch(err => {
console.error(err);
});