AgentsClient

Service for managing Agents.

Constructor

new AgentsClient(optionsopt)

Construct an instance of AgentsClient.

Parameters:

Name Type Attributes Description

options

object

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties

Name Type Attributes Description

credentials

object

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.

port

number

The port on which to connect to the remote host.

projectId

string

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.

apiEndpoint

string

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

Members

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

port

The port for this API service.

scopes

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

The DNS address for this API service.

Methods

(async) checkExportAgentProgress(name) → {Promise}

Check the status of the long running operation returned by exportAgent().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

const decodedOperation = await checkExportAgentProgress(name);
console.log(decodedOperation.result);
console.log(decodedOperation.done);
console.log(decodedOperation.metadata);

(async) checkImportAgentProgress(name) → {Promise}

Check the status of the long running operation returned by importAgent().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

const decodedOperation = await checkImportAgentProgress(name);
console.log(decodedOperation.result);
console.log(decodedOperation.done);
console.log(decodedOperation.metadata);

(async) checkRestoreAgentProgress(name) → {Promise}

Check the status of the long running operation returned by restoreAgent().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

const decodedOperation = await checkRestoreAgentProgress(name);
console.log(decodedOperation.result);
console.log(decodedOperation.done);
console.log(decodedOperation.metadata);

(async) checkTrainAgentProgress(name) → {Promise}

Check the status of the long running operation returned by trainAgent().

Parameters:

Name	Type	Description
`name`	String	The operation name that will be passed.

Returns:

Type	Description
Promise	The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.

Example

const decodedOperation = await checkTrainAgentProgress(name);
console.log(decodedOperation.result);
console.log(decodedOperation.done);
console.log(decodedOperation.metadata);

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:

Type	Description
Promise	A promise that resolves when the client is closed.

deleteAgent(request, optionsopt) → {Promise}

Deletes the specified agent.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The project that the agent to delete is associated with. Format: `projects/<Project ID>`.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.

Example

const [response] = await client.deleteAgent(request);

exportAgent(request, optionsopt) → {Promise}

Exports the specified agent to a ZIP file.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: An empty Struct message
response: ExportAgentResponse

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The project that the agent to export is associated with. Format: `projects/<Project ID>`.
`agentUri`	string	Required. The Google Cloud Storage URI to export the agent to. The format of this URI must be `gs://<bucket-name>/<object-name>`. If left unspecified, the serialized agent is returned inline.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example

const [operation] = await client.exportAgent(request);
const [response] = await operation.promise();

getAgent(request, optionsopt) → {Promise}

Retrieves the specified agent.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The project that the agent to fetch is associated with. Format: `projects/<Project ID>`.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing Agent. Please see the documentation for more details and examples.

Example

const [response] = await client.getAgent(request);

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:

Type	Description
Promise	A promise that resolves to string containing the project ID.

getValidationResult(request, optionsopt) → {Promise}

Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`parent`	string		Required. The project that the agent is associated with. Format: `projects/<Project ID>`.
`languageCode`	string	<optional>	Optional. The language for which you want a validation result. If not specified, the agent's default language is used. Many languages are supported. Note: languages must be enabled in the agent before they can be used.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing ValidationResult. Please see the documentation for more details and examples.

Example

const [response] = await client.getValidationResult(request);

importAgent(request, optionsopt) → {Promise}

Imports the specified agent from a ZIP file.

Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: An empty Struct message
response: An Empty message

The operation only tracks when importing is complete, not when it is done training.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The project that the agent to import is associated with. Format: `projects/<Project ID>`.
`agentUri`	string	The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with "gs://".
`agentContent`	Buffer	Zip compressed raw byte content for agent.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example

const [operation] = await client.importAgent(request);
const [response] = await operation.promise();

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:

Type	Description
Promise	A promise that resolves to an authenticated service stub.

matchAnswerRecordFromProjectAnswerRecordName(projectAnswerRecordName) → {string}

Parse the answer_record from ProjectAnswerRecord resource.

Parameters:

Name	Type	Description
`projectAnswerRecordName`	string	A fully-qualified path representing project_answer_record resource.

Returns:

Type	Description
string	A string representing the answer_record.

matchAnswerRecordFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName) → {string}

Parse the answer_record from ProjectLocationAnswerRecord resource.

Parameters:

Name	Type	Description
`projectLocationAnswerRecordName`	string	A fully-qualified path representing project_location_answer_record resource.

Returns:

Type	Description
string	A string representing the answer_record.

matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) → {string}

Parse the context from ProjectAgentEnvironmentUserSessionContext resource.

Parameters:

Name	Type	Description
`projectAgentEnvironmentUserSessionContextName`	string	A fully-qualified path representing project_agent_environment_user_session_context resource.

Returns:

Type	Description
string	A string representing the context.

matchContextFromProjectAgentSessionContextName(projectAgentSessionContextName) → {string}

Parse the context from ProjectAgentSessionContext resource.

Parameters:

Name	Type	Description
`projectAgentSessionContextName`	string	A fully-qualified path representing project_agent_session_context resource.

Returns:

Type	Description
string	A string representing the context.

matchContextFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName) → {string}

Parse the context from ProjectLocationAgentEnvironmentUserSessionContext resource.

Parameters:

Name	Type	Description
`projectLocationAgentEnvironmentUserSessionContextName`	string	A fully-qualified path representing project_location_agent_environment_user_session_context resource.

Returns:

Type	Description
string	A string representing the context.

matchContextFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName) → {string}

Parse the context from ProjectLocationAgentSessionContext resource.

Parameters:

Name	Type	Description
`projectLocationAgentSessionContextName`	string	A fully-qualified path representing project_location_agent_session_context resource.

Returns:

Type	Description
string	A string representing the context.

matchConversationFromProjectConversationMessageName(projectConversationMessageName) → {string}

Parse the conversation from ProjectConversationMessage resource.

Parameters:

Name	Type	Description
`projectConversationMessageName`	string	A fully-qualified path representing project_conversation_message resource.

Returns:

Type	Description
string	A string representing the conversation.

matchConversationFromProjectConversationName(projectConversationName) → {string}

Parse the conversation from ProjectConversation resource.

Parameters:

Name	Type	Description
`projectConversationName`	string	A fully-qualified path representing project_conversation resource.

Returns:

Type	Description
string	A string representing the conversation.

matchConversationFromProjectConversationParticipantName(projectConversationParticipantName) → {string}

Parse the conversation from ProjectConversationParticipant resource.

Parameters:

Name	Type	Description
`projectConversationParticipantName`	string	A fully-qualified path representing project_conversation_participant resource.

Returns:

Type	Description
string	A string representing the conversation.

matchConversationFromProjectLocationConversationMessageName(projectLocationConversationMessageName) → {string}

Parse the conversation from ProjectLocationConversationMessage resource.

Parameters:

Name	Type	Description
`projectLocationConversationMessageName`	string	A fully-qualified path representing project_location_conversation_message resource.

Returns:

Type	Description
string	A string representing the conversation.

matchConversationFromProjectLocationConversationName(projectLocationConversationName) → {string}

Parse the conversation from ProjectLocationConversation resource.

Parameters:

Name	Type	Description
`projectLocationConversationName`	string	A fully-qualified path representing project_location_conversation resource.

Returns:

Type	Description
string	A string representing the conversation.

matchConversationFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName) → {string}

Parse the conversation from ProjectLocationConversationParticipant resource.

Parameters:

Name	Type	Description
`projectLocationConversationParticipantName`	string	A fully-qualified path representing project_location_conversation_participant resource.

Returns:

Type	Description
string	A string representing the conversation.

matchConversationProfileFromProjectConversationProfileName(projectConversationProfileName) → {string}

Parse the conversation_profile from ProjectConversationProfile resource.

Parameters:

Name	Type	Description
`projectConversationProfileName`	string	A fully-qualified path representing project_conversation_profile resource.

Returns:

Type	Description
string	A string representing the conversation_profile.

matchConversationProfileFromProjectLocationConversationProfileName(projectLocationConversationProfileName) → {string}

Parse the conversation_profile from ProjectLocationConversationProfile resource.

Parameters:

Name	Type	Description
`projectLocationConversationProfileName`	string	A fully-qualified path representing project_location_conversation_profile resource.

Returns:

Type	Description
string	A string representing the conversation_profile.

matchDocumentFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName) → {string}

Parse the document from ProjectKnowledgeBaseDocument resource.

Parameters:

Name	Type	Description
`projectKnowledgeBaseDocumentName`	string	A fully-qualified path representing project_knowledge_base_document resource.

Returns:

Type	Description
string	A string representing the document.

matchDocumentFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName) → {string}

Parse the document from ProjectLocationKnowledgeBaseDocument resource.

Parameters:

Name	Type	Description
`projectLocationKnowledgeBaseDocumentName`	string	A fully-qualified path representing project_location_knowledge_base_document resource.

Returns:

Type	Description
string	A string representing the document.

matchEntityTypeFromProjectAgentEntityTypeName(projectAgentEntityTypeName) → {string}

Parse the entity_type from ProjectAgentEntityType resource.

Parameters:

Name	Type	Description
`projectAgentEntityTypeName`	string	A fully-qualified path representing project_agent_entity_type resource.

Returns:

Type	Description
string	A string representing the entity_type.

matchEntityTypeFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName) → {string}

Parse the entity_type from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameters:

Name	Type	Description
`projectAgentEnvironmentUserSessionEntityTypeName`	string	A fully-qualified path representing project_agent_environment_user_session_entity_type resource.

Returns:

Type	Description
string	A string representing the entity_type.

matchEntityTypeFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName) → {string}

Parse the entity_type from ProjectAgentSessionEntityType resource.

Parameters:

Name	Type	Description
`projectAgentSessionEntityTypeName`	string	A fully-qualified path representing project_agent_session_entity_type resource.

Returns:

Type	Description
string	A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName) → {string}

Parse the entity_type from ProjectLocationAgentEntityType resource.

Parameters:

Name	Type	Description
`projectLocationAgentEntityTypeName`	string	A fully-qualified path representing project_location_agent_entity_type resource.

Returns:

Type	Description
string	A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName) → {string}

Parse the entity_type from ProjectLocationAgentEnvironmentUserSessionEntityType resource.

Parameters:

Name	Type	Description
`projectLocationAgentEnvironmentUserSessionEntityTypeName`	string	A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource.

Returns:

Type	Description
string	A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName) → {string}

Parse the entity_type from ProjectLocationAgentSessionEntityType resource.

Parameters:

Name	Type	Description
`projectLocationAgentSessionEntityTypeName`	string	A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns:

Type	Description
string	A string representing the entity_type.

matchEnvironmentFromProjectAgentEnvironmentName(projectAgentEnvironmentName) → {string}

Parse the environment from ProjectAgentEnvironment resource.

Parameters:

Name	Type	Description
`projectAgentEnvironmentName`	string	A fully-qualified path representing project_agent_environment resource.

Returns:

Type	Description
string	A string representing the environment.

matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) → {string}

Parse the environment from ProjectAgentEnvironmentUserSessionContext resource.

Parameters:

Name	Type	Description
`projectAgentEnvironmentUserSessionContextName`	string	A fully-qualified path representing project_agent_environment_user_session_context resource.

Returns:

Type	Description
string	A string representing the environment.

matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName) → {string}

Parse the environment from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameters:

Name	Type	Description
`projectAgentEnvironmentUserSessionEntityTypeName`	string	A fully-qualified path representing project_agent_environment_user_session_entity_type resource.

Returns:

Type	Description
string	A string representing the environment.

matchEnvironmentFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName) → {string}

Parse the environment from ProjectLocationAgentEnvironment resource.

Parameters:

Name	Type	Description
`projectLocationAgentEnvironmentName`	string	A fully-qualified path representing project_location_agent_environment resource.

Returns:

Type	Description
string	A string representing the environment.

matchEnvironmentFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName) → {string}

Parse the environment from ProjectLocationAgentEnvironmentUserSessionContext resource.

Parameters:

Name	Type	Description
`projectLocationAgentEnvironmentUserSessionContextName`	string	A fully-qualified path representing project_location_agent_environment_user_session_context resource.

Returns:

Type	Description
string	A string representing the environment.

matchEnvironmentFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName) → {string}

Parse the environment from ProjectLocationAgentEnvironmentUserSessionEntityType resource.

Parameters:

Name	Type	Description
`projectLocationAgentEnvironmentUserSessionEntityTypeName`	string	A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource.

Returns:

Type	Description
string	A string representing the environment.

matchIntentFromProjectAgentIntentName(projectAgentIntentName) → {string}

Parse the intent from ProjectAgentIntent resource.

Parameters:

Name	Type	Description
`projectAgentIntentName`	string	A fully-qualified path representing project_agent_intent resource.

Returns:

Type	Description
string	A string representing the intent.

matchIntentFromProjectLocationAgentIntentName(projectLocationAgentIntentName) → {string}

Parse the intent from ProjectLocationAgentIntent resource.

Parameters:

Name	Type	Description
`projectLocationAgentIntentName`	string	A fully-qualified path representing project_location_agent_intent resource.

Returns:

Type	Description
string	A string representing the intent.

matchKnowledgeBaseFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName) → {string}

Parse the knowledge_base from ProjectKnowledgeBaseDocument resource.

Parameters:

Name	Type	Description
`projectKnowledgeBaseDocumentName`	string	A fully-qualified path representing project_knowledge_base_document resource.

Returns:

Type	Description
string	A string representing the knowledge_base.

matchKnowledgeBaseFromProjectKnowledgeBaseName(projectKnowledgeBaseName) → {string}

Parse the knowledge_base from ProjectKnowledgeBase resource.

Parameters:

Name	Type	Description
`projectKnowledgeBaseName`	string	A fully-qualified path representing project_knowledge_base resource.

Returns:

Type	Description
string	A string representing the knowledge_base.

matchKnowledgeBaseFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName) → {string}

Parse the knowledge_base from ProjectLocationKnowledgeBaseDocument resource.

Parameters:

Name	Type	Description
`projectLocationKnowledgeBaseDocumentName`	string	A fully-qualified path representing project_location_knowledge_base_document resource.

Returns:

Type	Description
string	A string representing the knowledge_base.

matchKnowledgeBaseFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName) → {string}

Parse the knowledge_base from ProjectLocationKnowledgeBase resource.

Parameters:

Name	Type	Description
`projectLocationKnowledgeBaseName`	string	A fully-qualified path representing project_location_knowledge_base resource.

Returns:

Type	Description
string	A string representing the knowledge_base.

matchLocationFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName) → {string}

Parse the location from ProjectLocationAgentEntityType resource.

Parameters:

Name	Type	Description
`projectLocationAgentEntityTypeName`	string	A fully-qualified path representing project_location_agent_entity_type resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName) → {string}

Parse the location from ProjectLocationAgentEnvironment resource.

Parameters:

Name	Type	Description
`projectLocationAgentEnvironmentName`	string	A fully-qualified path representing project_location_agent_environment resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName) → {string}

Parse the location from ProjectLocationAgentEnvironmentUserSessionContext resource.

Parameters:

Name	Type	Description
`projectLocationAgentEnvironmentUserSessionContextName`	string	A fully-qualified path representing project_location_agent_environment_user_session_context resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName) → {string}

Parse the location from ProjectLocationAgentEnvironmentUserSessionEntityType resource.

Parameters:

Name	Type	Description
`projectLocationAgentEnvironmentUserSessionEntityTypeName`	string	A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationAgentFulfillmentName(projectLocationAgentFulfillmentName) → {string}

Parse the location from ProjectLocationAgentFulfillment resource.

Parameters:

Name	Type	Description
`projectLocationAgentFulfillmentName`	string	A fully-qualified path representing project_location_agent_fulfillment resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationAgentIntentName(projectLocationAgentIntentName) → {string}

Parse the location from ProjectLocationAgentIntent resource.

Parameters:

Name	Type	Description
`projectLocationAgentIntentName`	string	A fully-qualified path representing project_location_agent_intent resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationAgentName(projectLocationAgentName) → {string}

Parse the location from ProjectLocationAgent resource.

Parameters:

Name	Type	Description
`projectLocationAgentName`	string	A fully-qualified path representing project_location_agent resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName) → {string}

Parse the location from ProjectLocationAgentSessionContext resource.

Parameters:

Name	Type	Description
`projectLocationAgentSessionContextName`	string	A fully-qualified path representing project_location_agent_session_context resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName) → {string}

Parse the location from ProjectLocationAgentSessionEntityType resource.

Parameters:

Name	Type	Description
`projectLocationAgentSessionEntityTypeName`	string	A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationAgentVersionName(projectLocationAgentVersionName) → {string}

Parse the location from ProjectLocationAgentVersion resource.

Parameters:

Name	Type	Description
`projectLocationAgentVersionName`	string	A fully-qualified path representing project_location_agent_version resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName) → {string}

Parse the location from ProjectLocationAnswerRecord resource.

Parameters:

Name	Type	Description
`projectLocationAnswerRecordName`	string	A fully-qualified path representing project_location_answer_record resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationConversationMessageName(projectLocationConversationMessageName) → {string}

Parse the location from ProjectLocationConversationMessage resource.

Parameters:

Name	Type	Description
`projectLocationConversationMessageName`	string	A fully-qualified path representing project_location_conversation_message resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationConversationName(projectLocationConversationName) → {string}

Parse the location from ProjectLocationConversation resource.

Parameters:

Name	Type	Description
`projectLocationConversationName`	string	A fully-qualified path representing project_location_conversation resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName) → {string}

Parse the location from ProjectLocationConversationParticipant resource.

Parameters:

Name	Type	Description
`projectLocationConversationParticipantName`	string	A fully-qualified path representing project_location_conversation_participant resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationConversationProfileName(projectLocationConversationProfileName) → {string}

Parse the location from ProjectLocationConversationProfile resource.

Parameters:

Name	Type	Description
`projectLocationConversationProfileName`	string	A fully-qualified path representing project_location_conversation_profile resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName) → {string}

Parse the location from ProjectLocationKnowledgeBaseDocument resource.

Parameters:

Name	Type	Description
`projectLocationKnowledgeBaseDocumentName`	string	A fully-qualified path representing project_location_knowledge_base_document resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName) → {string}

Parse the location from ProjectLocationKnowledgeBase resource.

Parameters:

Name	Type	Description
`projectLocationKnowledgeBaseName`	string	A fully-qualified path representing project_location_knowledge_base resource.

Returns:

Type	Description
string	A string representing the location.

matchMessageFromProjectConversationMessageName(projectConversationMessageName) → {string}

Parse the message from ProjectConversationMessage resource.

Parameters:

Name	Type	Description
`projectConversationMessageName`	string	A fully-qualified path representing project_conversation_message resource.

Returns:

Type	Description
string	A string representing the message.

matchMessageFromProjectLocationConversationMessageName(projectLocationConversationMessageName) → {string}

Parse the message from ProjectLocationConversationMessage resource.

Parameters:

Name	Type	Description
`projectLocationConversationMessageName`	string	A fully-qualified path representing project_location_conversation_message resource.

Returns:

Type	Description
string	A string representing the message.

matchParticipantFromProjectConversationParticipantName(projectConversationParticipantName) → {string}

Parse the participant from ProjectConversationParticipant resource.

Parameters:

Name	Type	Description
`projectConversationParticipantName`	string	A fully-qualified path representing project_conversation_participant resource.

Returns:

Type	Description
string	A string representing the participant.

matchParticipantFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName) → {string}

Parse the participant from ProjectLocationConversationParticipant resource.

Parameters:

Name	Type	Description
`projectLocationConversationParticipantName`	string	A fully-qualified path representing project_location_conversation_participant resource.

Returns:

Type	Description
string	A string representing the participant.

matchProjectFromProjectAgentEntityTypeName(projectAgentEntityTypeName) → {string}

Parse the project from ProjectAgentEntityType resource.

Parameters:

Name	Type	Description
`projectAgentEntityTypeName`	string	A fully-qualified path representing project_agent_entity_type resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectAgentEnvironmentName(projectAgentEnvironmentName) → {string}

Parse the project from ProjectAgentEnvironment resource.

Parameters:

Name	Type	Description
`projectAgentEnvironmentName`	string	A fully-qualified path representing project_agent_environment resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) → {string}

Parse the project from ProjectAgentEnvironmentUserSessionContext resource.

Parameters:

Name	Type	Description
`projectAgentEnvironmentUserSessionContextName`	string	A fully-qualified path representing project_agent_environment_user_session_context resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName) → {string}

Parse the project from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameters:

Name	Type	Description
`projectAgentEnvironmentUserSessionEntityTypeName`	string	A fully-qualified path representing project_agent_environment_user_session_entity_type resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectAgentFulfillmentName(projectAgentFulfillmentName) → {string}

Parse the project from ProjectAgentFulfillment resource.

Parameters:

Name	Type	Description
`projectAgentFulfillmentName`	string	A fully-qualified path representing project_agent_fulfillment resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectAgentIntentName(projectAgentIntentName) → {string}

Parse the project from ProjectAgentIntent resource.

Parameters:

Name	Type	Description
`projectAgentIntentName`	string	A fully-qualified path representing project_agent_intent resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectAgentName(projectAgentName) → {string}

Parse the project from ProjectAgent resource.

Parameters:

Name	Type	Description
`projectAgentName`	string	A fully-qualified path representing project_agent resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectAgentSessionContextName(projectAgentSessionContextName) → {string}

Parse the project from ProjectAgentSessionContext resource.

Parameters:

Name	Type	Description
`projectAgentSessionContextName`	string	A fully-qualified path representing project_agent_session_context resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName) → {string}

Parse the project from ProjectAgentSessionEntityType resource.

Parameters:

Name	Type	Description
`projectAgentSessionEntityTypeName`	string	A fully-qualified path representing project_agent_session_entity_type resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectAgentVersionName(projectAgentVersionName) → {string}

Parse the project from ProjectAgentVersion resource.

Parameters:

Name	Type	Description
`projectAgentVersionName`	string	A fully-qualified path representing project_agent_version resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectAnswerRecordName(projectAnswerRecordName) → {string}

Parse the project from ProjectAnswerRecord resource.

Parameters:

Name	Type	Description
`projectAnswerRecordName`	string	A fully-qualified path representing project_answer_record resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectConversationMessageName(projectConversationMessageName) → {string}

Parse the project from ProjectConversationMessage resource.

Parameters:

Name	Type	Description
`projectConversationMessageName`	string	A fully-qualified path representing project_conversation_message resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectConversationName(projectConversationName) → {string}

Parse the project from ProjectConversation resource.

Parameters:

Name	Type	Description
`projectConversationName`	string	A fully-qualified path representing project_conversation resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectConversationParticipantName(projectConversationParticipantName) → {string}

Parse the project from ProjectConversationParticipant resource.

Parameters:

Name	Type	Description
`projectConversationParticipantName`	string	A fully-qualified path representing project_conversation_participant resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectConversationProfileName(projectConversationProfileName) → {string}

Parse the project from ProjectConversationProfile resource.

Parameters:

Name	Type	Description
`projectConversationProfileName`	string	A fully-qualified path representing project_conversation_profile resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName) → {string}

Parse the project from ProjectKnowledgeBaseDocument resource.

Parameters:

Name	Type	Description
`projectKnowledgeBaseDocumentName`	string	A fully-qualified path representing project_knowledge_base_document resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectKnowledgeBaseName(projectKnowledgeBaseName) → {string}

Parse the project from ProjectKnowledgeBase resource.

Parameters:

Name	Type	Description
`projectKnowledgeBaseName`	string	A fully-qualified path representing project_knowledge_base resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName) → {string}

Parse the project from ProjectLocationAgentEntityType resource.

Parameters:

Name	Type	Description
`projectLocationAgentEntityTypeName`	string	A fully-qualified path representing project_location_agent_entity_type resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName) → {string}

Parse the project from ProjectLocationAgentEnvironment resource.

Parameters:

Name	Type	Description
`projectLocationAgentEnvironmentName`	string	A fully-qualified path representing project_location_agent_environment resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName) → {string}

Parse the project from ProjectLocationAgentEnvironmentUserSessionContext resource.

Parameters:

Name	Type	Description
`projectLocationAgentEnvironmentUserSessionContextName`	string	A fully-qualified path representing project_location_agent_environment_user_session_context resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName) → {string}

Parse the project from ProjectLocationAgentEnvironmentUserSessionEntityType resource.

Parameters:

Name	Type	Description
`projectLocationAgentEnvironmentUserSessionEntityTypeName`	string	A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationAgentFulfillmentName(projectLocationAgentFulfillmentName) → {string}

Parse the project from ProjectLocationAgentFulfillment resource.

Parameters:

Name	Type	Description
`projectLocationAgentFulfillmentName`	string	A fully-qualified path representing project_location_agent_fulfillment resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationAgentIntentName(projectLocationAgentIntentName) → {string}

Parse the project from ProjectLocationAgentIntent resource.

Parameters:

Name	Type	Description
`projectLocationAgentIntentName`	string	A fully-qualified path representing project_location_agent_intent resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationAgentName(projectLocationAgentName) → {string}

Parse the project from ProjectLocationAgent resource.

Parameters:

Name	Type	Description
`projectLocationAgentName`	string	A fully-qualified path representing project_location_agent resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName) → {string}

Parse the project from ProjectLocationAgentSessionContext resource.

Parameters:

Name	Type	Description
`projectLocationAgentSessionContextName`	string	A fully-qualified path representing project_location_agent_session_context resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName) → {string}

Parse the project from ProjectLocationAgentSessionEntityType resource.

Parameters:

Name	Type	Description
`projectLocationAgentSessionEntityTypeName`	string	A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationAgentVersionName(projectLocationAgentVersionName) → {string}

Parse the project from ProjectLocationAgentVersion resource.

Parameters:

Name	Type	Description
`projectLocationAgentVersionName`	string	A fully-qualified path representing project_location_agent_version resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName) → {string}

Parse the project from ProjectLocationAnswerRecord resource.

Parameters:

Name	Type	Description
`projectLocationAnswerRecordName`	string	A fully-qualified path representing project_location_answer_record resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationConversationMessageName(projectLocationConversationMessageName) → {string}

Parse the project from ProjectLocationConversationMessage resource.

Parameters:

Name	Type	Description
`projectLocationConversationMessageName`	string	A fully-qualified path representing project_location_conversation_message resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationConversationName(projectLocationConversationName) → {string}

Parse the project from ProjectLocationConversation resource.

Parameters:

Name	Type	Description
`projectLocationConversationName`	string	A fully-qualified path representing project_location_conversation resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName) → {string}

Parse the project from ProjectLocationConversationParticipant resource.

Parameters:

Name	Type	Description
`projectLocationConversationParticipantName`	string	A fully-qualified path representing project_location_conversation_participant resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationConversationProfileName(projectLocationConversationProfileName) → {string}

Parse the project from ProjectLocationConversationProfile resource.

Parameters:

Name	Type	Description
`projectLocationConversationProfileName`	string	A fully-qualified path representing project_location_conversation_profile resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName) → {string}

Parse the project from ProjectLocationKnowledgeBaseDocument resource.

Parameters:

Name	Type	Description
`projectLocationKnowledgeBaseDocumentName`	string	A fully-qualified path representing project_location_knowledge_base_document resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName) → {string}

Parse the project from ProjectLocationKnowledgeBase resource.

Parameters:

Name	Type	Description
`projectLocationKnowledgeBaseName`	string	A fully-qualified path representing project_location_knowledge_base resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:

Name	Type	Description
`projectName`	string	A fully-qualified path representing Project resource.

Returns:

Type	Description
string	A string representing the project.

matchSessionFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) → {string}

Parse the session from ProjectAgentEnvironmentUserSessionContext resource.

Parameters:

Name	Type	Description
`projectAgentEnvironmentUserSessionContextName`	string	A fully-qualified path representing project_agent_environment_user_session_context resource.

Returns:

Type	Description
string	A string representing the session.

matchSessionFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName) → {string}

Parse the session from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameters:

Name	Type	Description
`projectAgentEnvironmentUserSessionEntityTypeName`	string	A fully-qualified path representing project_agent_environment_user_session_entity_type resource.

Returns:

Type	Description
string	A string representing the session.

matchSessionFromProjectAgentSessionContextName(projectAgentSessionContextName) → {string}

Parse the session from ProjectAgentSessionContext resource.

Parameters:

Name	Type	Description
`projectAgentSessionContextName`	string	A fully-qualified path representing project_agent_session_context resource.

Returns:

Type	Description
string	A string representing the session.

matchSessionFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName) → {string}

Parse the session from ProjectAgentSessionEntityType resource.

Parameters:

Name	Type	Description
`projectAgentSessionEntityTypeName`	string	A fully-qualified path representing project_agent_session_entity_type resource.

Returns:

Type	Description
string	A string representing the session.

matchSessionFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName) → {string}

Parse the session from ProjectLocationAgentEnvironmentUserSessionContext resource.

Parameters:

Name	Type	Description
`projectLocationAgentEnvironmentUserSessionContextName`	string	A fully-qualified path representing project_location_agent_environment_user_session_context resource.

Returns:

Type	Description
string	A string representing the session.

matchSessionFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName) → {string}

Parse the session from ProjectLocationAgentEnvironmentUserSessionEntityType resource.

Parameters:

Name	Type	Description
`projectLocationAgentEnvironmentUserSessionEntityTypeName`	string	A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource.

Returns:

Type	Description
string	A string representing the session.

matchSessionFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName) → {string}

Parse the session from ProjectLocationAgentSessionContext resource.

Parameters:

Name	Type	Description
`projectLocationAgentSessionContextName`	string	A fully-qualified path representing project_location_agent_session_context resource.

Returns:

Type	Description
string	A string representing the session.

matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName) → {string}

Parse the session from ProjectLocationAgentSessionEntityType resource.

Parameters:

Name	Type	Description
`projectLocationAgentSessionEntityTypeName`	string	A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns:

Type	Description
string	A string representing the session.

matchUserFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) → {string}

Parse the user from ProjectAgentEnvironmentUserSessionContext resource.

Parameters:

Name	Type	Description
`projectAgentEnvironmentUserSessionContextName`	string	A fully-qualified path representing project_agent_environment_user_session_context resource.

Returns:

Type	Description
string	A string representing the user.

matchUserFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName) → {string}

Parse the user from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameters:

Name	Type	Description
`projectAgentEnvironmentUserSessionEntityTypeName`	string	A fully-qualified path representing project_agent_environment_user_session_entity_type resource.

Returns:

Type	Description
string	A string representing the user.

matchUserFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName) → {string}

Parse the user from ProjectLocationAgentEnvironmentUserSessionContext resource.

Parameters:

Name	Type	Description
`projectLocationAgentEnvironmentUserSessionContextName`	string	A fully-qualified path representing project_location_agent_environment_user_session_context resource.

Returns:

Type	Description
string	A string representing the user.

matchUserFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName) → {string}

Parse the user from ProjectLocationAgentEnvironmentUserSessionEntityType resource.

Parameters:

Name	Type	Description
`projectLocationAgentEnvironmentUserSessionEntityTypeName`	string	A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource.

Returns:

Type	Description
string	A string representing the user.

matchVersionFromProjectAgentVersionName(projectAgentVersionName) → {string}

Parse the version from ProjectAgentVersion resource.

Parameters:

Name	Type	Description
`projectAgentVersionName`	string	A fully-qualified path representing project_agent_version resource.

Returns:

Type	Description
string	A string representing the version.

matchVersionFromProjectLocationAgentVersionName(projectLocationAgentVersionName) → {string}

Parse the version from ProjectLocationAgentVersion resource.

Parameters:

Name	Type	Description
`projectLocationAgentVersionName`	string	A fully-qualified path representing project_location_agent_version resource.

Returns:

Type	Description
string	A string representing the version.

projectAgentEntityTypePath(project, entity_type) → {string}

Return a fully-qualified projectAgentEntityType resource name string.

Parameters:

Name	Type	Description
`project`	string
`entity_type`	string

Returns:

Type	Description
string	Resource name string.

projectAgentEnvironmentPath(project, environment) → {string}

Return a fully-qualified projectAgentEnvironment resource name string.

Parameters:

Name	Type	Description
`project`	string
`environment`	string

Returns:

Type	Description
string	Resource name string.

projectAgentEnvironmentUserSessionContextPath(project, environment, user, session, context) → {string}

Return a fully-qualified projectAgentEnvironmentUserSessionContext resource name string.

Parameters:

Name	Type	Description
`project`	string
`environment`	string
`user`	string
`session`	string
`context`	string

Returns:

Type	Description
string	Resource name string.

projectAgentEnvironmentUserSessionEntityTypePath(project, environment, user, session, entity_type) → {string}

Return a fully-qualified projectAgentEnvironmentUserSessionEntityType resource name string.

Parameters:

Name	Type	Description
`project`	string
`environment`	string
`user`	string
`session`	string
`entity_type`	string

Returns:

Type	Description
string	Resource name string.

projectAgentFulfillmentPath(project) → {string}

Return a fully-qualified projectAgentFulfillment resource name string.

Parameters:

Name	Type	Description
`project`	string

Returns:

Type	Description
string	Resource name string.

projectAgentIntentPath(project, intent) → {string}

Return a fully-qualified projectAgentIntent resource name string.

Parameters:

Name	Type	Description
`project`	string
`intent`	string

Returns:

Type	Description
string	Resource name string.

projectAgentPath(project) → {string}

Return a fully-qualified projectAgent resource name string.

Parameters:

Name	Type	Description
`project`	string

Returns:

Type	Description
string	Resource name string.

projectAgentSessionContextPath(project, session, context) → {string}

Return a fully-qualified projectAgentSessionContext resource name string.

Parameters:

Name	Type	Description
`project`	string
`session`	string
`context`	string

Returns:

Type	Description
string	Resource name string.

projectAgentSessionEntityTypePath(project, session, entity_type) → {string}

Return a fully-qualified projectAgentSessionEntityType resource name string.

Parameters:

Name	Type	Description
`project`	string
`session`	string
`entity_type`	string

Returns:

Type	Description
string	Resource name string.

projectAgentVersionPath(project, version) → {string}

Return a fully-qualified projectAgentVersion resource name string.

Parameters:

Name	Type	Description
`project`	string
`version`	string

Returns:

Type	Description
string	Resource name string.

projectAnswerRecordPath(project, answer_record) → {string}

Return a fully-qualified projectAnswerRecord resource name string.

Parameters:

Name	Type	Description
`project`	string
`answer_record`	string

Returns:

Type	Description
string	Resource name string.

projectConversationMessagePath(project, conversation, message) → {string}

Return a fully-qualified projectConversationMessage resource name string.

Parameters:

Name	Type	Description
`project`	string
`conversation`	string
`message`	string

Returns:

Type	Description
string	Resource name string.

projectConversationParticipantPath(project, conversation, participant) → {string}

Return a fully-qualified projectConversationParticipant resource name string.

Parameters:

Name	Type	Description
`project`	string
`conversation`	string
`participant`	string

Returns:

Type	Description
string	Resource name string.

projectConversationPath(project, conversation) → {string}

Return a fully-qualified projectConversation resource name string.

Parameters:

Name	Type	Description
`project`	string
`conversation`	string

Returns:

Type	Description
string	Resource name string.

projectConversationProfilePath(project, conversation_profile) → {string}

Return a fully-qualified projectConversationProfile resource name string.

Parameters:

Name	Type	Description
`project`	string
`conversation_profile`	string

Returns:

Type	Description
string	Resource name string.

projectKnowledgeBaseDocumentPath(project, knowledge_base, document) → {string}

Return a fully-qualified projectKnowledgeBaseDocument resource name string.

Parameters:

Name	Type	Description
`project`	string
`knowledge_base`	string
`document`	string

Returns:

Type	Description
string	Resource name string.

projectKnowledgeBasePath(project, knowledge_base) → {string}

Return a fully-qualified projectKnowledgeBase resource name string.

Parameters:

Name	Type	Description
`project`	string
`knowledge_base`	string

Returns:

Type	Description
string	Resource name string.

projectLocationAgentEntityTypePath(project, location, entity_type) → {string}

Return a fully-qualified projectLocationAgentEntityType resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`entity_type`	string

Returns:

Type	Description
string	Resource name string.

projectLocationAgentEnvironmentPath(project, location, environment) → {string}

Return a fully-qualified projectLocationAgentEnvironment resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`environment`	string

Returns:

Type	Description
string	Resource name string.

projectLocationAgentEnvironmentUserSessionContextPath(project, location, environment, user, session, context) → {string}

Return a fully-qualified projectLocationAgentEnvironmentUserSessionContext resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`environment`	string
`user`	string
`session`	string
`context`	string

Returns:

Type	Description
string	Resource name string.

projectLocationAgentEnvironmentUserSessionEntityTypePath(project, location, environment, user, session, entity_type) → {string}

Return a fully-qualified projectLocationAgentEnvironmentUserSessionEntityType resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`environment`	string
`user`	string
`session`	string
`entity_type`	string

Returns:

Type	Description
string	Resource name string.

projectLocationAgentFulfillmentPath(project, location) → {string}

Return a fully-qualified projectLocationAgentFulfillment resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string

Returns:

Type	Description
string	Resource name string.

projectLocationAgentIntentPath(project, location, intent) → {string}

Return a fully-qualified projectLocationAgentIntent resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`intent`	string

Returns:

Type	Description
string	Resource name string.

projectLocationAgentPath(project, location) → {string}

Return a fully-qualified projectLocationAgent resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string

Returns:

Type	Description
string	Resource name string.

projectLocationAgentSessionContextPath(project, location, session, context) → {string}

Return a fully-qualified projectLocationAgentSessionContext resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`session`	string
`context`	string

Returns:

Type	Description
string	Resource name string.

projectLocationAgentSessionEntityTypePath(project, location, session, entity_type) → {string}

Return a fully-qualified projectLocationAgentSessionEntityType resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`session`	string
`entity_type`	string

Returns:

Type	Description
string	Resource name string.

projectLocationAgentVersionPath(project, location, version) → {string}

Return a fully-qualified projectLocationAgentVersion resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`version`	string

Returns:

Type	Description
string	Resource name string.

projectLocationAnswerRecordPath(project, location, answer_record) → {string}

Return a fully-qualified projectLocationAnswerRecord resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`answer_record`	string

Returns:

Type	Description
string	Resource name string.

projectLocationConversationMessagePath(project, location, conversation, message) → {string}

Return a fully-qualified projectLocationConversationMessage resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`conversation`	string
`message`	string

Returns:

Type	Description
string	Resource name string.

projectLocationConversationParticipantPath(project, location, conversation, participant) → {string}

Return a fully-qualified projectLocationConversationParticipant resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`conversation`	string
`participant`	string

Returns:

Type	Description
string	Resource name string.

projectLocationConversationPath(project, location, conversation) → {string}

Return a fully-qualified projectLocationConversation resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`conversation`	string

Returns:

Type	Description
string	Resource name string.

projectLocationConversationProfilePath(project, location, conversation_profile) → {string}

Return a fully-qualified projectLocationConversationProfile resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`conversation_profile`	string

Returns:

Type	Description
string	Resource name string.

projectLocationKnowledgeBaseDocumentPath(project, location, knowledge_base, document) → {string}

Return a fully-qualified projectLocationKnowledgeBaseDocument resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`knowledge_base`	string
`document`	string

Returns:

Type	Description
string	Resource name string.

projectLocationKnowledgeBasePath(project, location, knowledge_base) → {string}

Return a fully-qualified projectLocationKnowledgeBase resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`knowledge_base`	string

Returns:

Type	Description
string	Resource name string.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

Parameters:

Name	Type	Description
`project`	string

Returns:

Type	Description
string	Resource name string.

restoreAgent(request, optionsopt) → {Promise}

Restores the specified agent from a ZIP file.

Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: An empty Struct message
response: An Empty message

The operation only tracks when restoring is complete, not when it is done training.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The project that the agent to restore is associated with. Format: `projects/<Project ID>`.
`agentUri`	string	The URI to a Google Cloud Storage file containing the agent to restore. Note: The URI must start with "gs://".
`agentContent`	Buffer	Zip compressed raw byte content for agent.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example

const [operation] = await client.restoreAgent(request);
const [response] = await operation.promise();

searchAgents(request, optionsopt) → {Promise}

Returns the list of agents.

Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`parent`	string		Required. The project to list agents from. Format: `projects/<Project ID or '-'>`.
`pageSize`	number	<optional>	Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
`pageToken`	string		The next_page_token value returned from a previous list request.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

Promise

The promise which resolves to an array. The first element of the array is Array of Agent. 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 searchAgentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

searchAgentsAsync(request, optionsopt) → {Object}

Equivalent to searchAgents, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`parent`	string		Required. The project to list agents from. Format: `projects/<Project ID or '-'>`.
`pageSize`	number	<optional>	Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
`pageToken`	string		The next_page_token value returned from a previous list request.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Object	An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Agent. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example

const iterable = client.searchAgentsAsync(request);
for await (const response of iterable) {
  // process response
}

searchAgentsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`parent`	string		Required. The project to list agents from. Format: `projects/<Project ID or '-'>`.
`pageSize`	number	<optional>	Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
`pageToken`	string		The next_page_token value returned from a previous list request.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which emits an object representing Agent 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 `searchAgentsAsync()` method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

setAgent(request, optionsopt) → {Promise}

Creates/updates the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Attributes	Description
`agent`	google.cloud.dialogflow.v2.Agent		Required. The agent to update.
`updateMask`	google.protobuf.FieldMask	<optional>	Optional. The mask to control which fields get updated.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing Agent. Please see the documentation for more details and examples.

Example

const [response] = await client.setAgent(request);

trainAgent(request, optionsopt) → {Promise}

Trains the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

metadata: An empty Struct message
response: An Empty message

Note: You should always train an agent prior to sending it queries. See the training documentation.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`parent`	string	Required. The project that the agent to train is associated with. Format: `projects/<Project ID>`.

options

object

Call options. See CallOptions for more details.

Returns:

Type	Description
Promise	The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the documentation for more details and examples.

Example

const [operation] = await client.trainAgent(request);
const [response] = await operation.promise();