ParticipantsClient

Service for managing Participants.

Constructor

new ParticipantsClient(optionsopt, gaxInstanceopt)

Construct an instance of ParticipantsClient.

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/1.1 REST mode. For more information, please check the documentation.

gaxInstance

gax

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new ParticipantsClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

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

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.

conversationDatasetPath(project, location, conversation_dataset) → {string}

Return a fully-qualified conversationDataset resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`conversation_dataset`	string

Returns:

Type	Description
string	Resource name string.

encryptionSpecPath(project, location) → {string}

Return a fully-qualified encryptionSpec resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string

Returns:

Type	Description
string	Resource name string.

generatorPath(project, location, generator) → {string}

Return a fully-qualified generator resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`generator`	string

Returns:

Type	Description
string	Resource name string.

getLocation(request, optionsopt) → {Promise}

Gets information about a location.

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	Resource name for the location.

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 Location. Please see the documentation for more details and examples.

Example

```
const [response] = await client.getLocation(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.

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.

listLocationsAsync(request, optionsopt) → {Object}

Lists information about the supported locations for this service. Returns an iterable object.

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

Parameters:

Name Type Attributes Description

request

Object

The request object that will be sent.

Properties

Name	Type	Description
`name`	string	The resource that owns the locations collection, if applicable.
`filter`	string	The standard list filter.
`pageSize`	number	The standard list page size.
`pageToken`	string	The standard list page token.

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 Location. 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.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}
```

listParticipantsAsync(request, optionsopt) → {Object}

Equivalent to listParticipants, 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 conversation to list all participants from. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>`.
`pageSize`	number	<optional>	Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
`pageToken`	string	<optional>	Optional. 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 Participant. 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

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The conversation to list all participants from.
   *  Format: `projects/<Project ID>/locations/<Location
   *  ID>/conversations/<Conversation ID>`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The maximum number of items to return in a single page. By
   *  default 100 and at most 1000.
   */
  // const pageSize = 1234
  /**
   *  Optional. The next_page_token value returned from a previous list request.
   */
  // const pageToken = 'abc123'

  // Imports the Dialogflow library
  const {ParticipantsClient} = require('@google-cloud/dialogflow').v2;

  // Instantiates a client
  const dialogflowClient = new ParticipantsClient();

  async function callListParticipants() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = dialogflowClient.listParticipantsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListParticipants();

listParticipantsStream(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 conversation to list all participants from. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>`.
`pageSize`	number	<optional>	Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
`pageToken`	string	<optional>	Optional. The next_page_token value returned from a previous list request.

options

object

Call options. See CallOptions for more details.

Returns:

Type Description

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

Stream

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

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.

matchConversationDatasetFromConversationDatasetName(conversationDatasetName) → {string}

Parse the conversation_dataset from ConversationDataset resource.

Parameters:

Name	Type	Description
`conversationDatasetName`	string	A fully-qualified path representing ConversationDataset resource.

Returns:

Type	Description
string	A string representing the conversation_dataset.

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.

matchConversationModelFromProjectConversationModelEvaluationName(projectConversationModelEvaluationName) → {string}

Parse the conversation_model from ProjectConversationModelEvaluation resource.

Parameters:

Name	Type	Description
`projectConversationModelEvaluationName`	string	A fully-qualified path representing project_conversation_model_evaluation resource.

Returns:

Type	Description
string	A string representing the conversation_model.

matchConversationModelFromProjectConversationModelName(projectConversationModelName) → {string}

Parse the conversation_model from ProjectConversationModel resource.

Parameters:

Name	Type	Description
`projectConversationModelName`	string	A fully-qualified path representing project_conversation_model resource.

Returns:

Type	Description
string	A string representing the conversation_model.

matchConversationModelFromProjectLocationConversationModelEvaluationName(projectLocationConversationModelEvaluationName) → {string}

Parse the conversation_model from ProjectLocationConversationModelEvaluation resource.

Parameters:

Name	Type	Description
`projectLocationConversationModelEvaluationName`	string	A fully-qualified path representing project_location_conversation_model_evaluation resource.

Returns:

Type	Description
string	A string representing the conversation_model.

matchConversationModelFromProjectLocationConversationModelName(projectLocationConversationModelName) → {string}

Parse the conversation_model from ProjectLocationConversationModel resource.

Parameters:

Name	Type	Description
`projectLocationConversationModelName`	string	A fully-qualified path representing project_location_conversation_model resource.

Returns:

Type	Description
string	A string representing the conversation_model.

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.

matchEvaluationFromProjectConversationModelEvaluationName(projectConversationModelEvaluationName) → {string}

Parse the evaluation from ProjectConversationModelEvaluation resource.

Parameters:

Name	Type	Description
`projectConversationModelEvaluationName`	string	A fully-qualified path representing project_conversation_model_evaluation resource.

Returns:

Type	Description
string	A string representing the evaluation.

matchEvaluationFromProjectLocationConversationModelEvaluationName(projectLocationConversationModelEvaluationName) → {string}

Parse the evaluation from ProjectLocationConversationModelEvaluation resource.

Parameters:

Name	Type	Description
`projectLocationConversationModelEvaluationName`	string	A fully-qualified path representing project_location_conversation_model_evaluation resource.

Returns:

Type	Description
string	A string representing the evaluation.

matchGeneratorFromGeneratorName(generatorName) → {string}

Parse the generator from Generator resource.

Parameters:

Name	Type	Description
`generatorName`	string	A fully-qualified path representing Generator resource.

Returns:

Type	Description
string	A string representing the generator.

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.

matchLocationFromConversationDatasetName(conversationDatasetName) → {string}

Parse the location from ConversationDataset resource.

Parameters:

Name	Type	Description
`conversationDatasetName`	string	A fully-qualified path representing ConversationDataset resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromEncryptionSpecName(encryptionSpecName) → {string}

Parse the location from EncryptionSpec resource.

Parameters:

Name	Type	Description
`encryptionSpecName`	string	A fully-qualified path representing EncryptionSpec resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromGeneratorName(generatorName) → {string}

Parse the location from Generator resource.

Parameters:

Name	Type	Description
`generatorName`	string	A fully-qualified path representing Generator resource.

Returns:

Type	Description
string	A string representing the location.

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.

matchLocationFromProjectLocationConversationModelEvaluationName(projectLocationConversationModelEvaluationName) → {string}

Parse the location from ProjectLocationConversationModelEvaluation resource.

Parameters:

Name	Type	Description
`projectLocationConversationModelEvaluationName`	string	A fully-qualified path representing project_location_conversation_model_evaluation resource.

Returns:

Type	Description
string	A string representing the location.

matchLocationFromProjectLocationConversationModelName(projectLocationConversationModelName) → {string}

Parse the location from ProjectLocationConversationModel resource.

Parameters:

Name	Type	Description
`projectLocationConversationModelName`	string	A fully-qualified path representing project_location_conversation_model 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.

matchProjectFromConversationDatasetName(conversationDatasetName) → {string}

Parse the project from ConversationDataset resource.

Parameters:

Name	Type	Description
`conversationDatasetName`	string	A fully-qualified path representing ConversationDataset resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromEncryptionSpecName(encryptionSpecName) → {string}

Parse the project from EncryptionSpec resource.

Parameters:

Name	Type	Description
`encryptionSpecName`	string	A fully-qualified path representing EncryptionSpec resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromGeneratorName(generatorName) → {string}

Parse the project from Generator resource.

Parameters:

Name	Type	Description
`generatorName`	string	A fully-qualified path representing Generator resource.

Returns:

Type	Description
string	A string representing the project.

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.

matchProjectFromProjectConversationModelEvaluationName(projectConversationModelEvaluationName) → {string}

Parse the project from ProjectConversationModelEvaluation resource.

Parameters:

Name	Type	Description
`projectConversationModelEvaluationName`	string	A fully-qualified path representing project_conversation_model_evaluation resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectConversationModelName(projectConversationModelName) → {string}

Parse the project from ProjectConversationModel resource.

Parameters:

Name	Type	Description
`projectConversationModelName`	string	A fully-qualified path representing project_conversation_model 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.

matchProjectFromProjectLocationConversationModelEvaluationName(projectLocationConversationModelEvaluationName) → {string}

Parse the project from ProjectLocationConversationModelEvaluation resource.

Parameters:

Name	Type	Description
`projectLocationConversationModelEvaluationName`	string	A fully-qualified path representing project_location_conversation_model_evaluation resource.

Returns:

Type	Description
string	A string representing the project.

matchProjectFromProjectLocationConversationModelName(projectLocationConversationModelName) → {string}

Parse the project from ProjectLocationConversationModel resource.

Parameters:

Name	Type	Description
`projectLocationConversationModelName`	string	A fully-qualified path representing project_location_conversation_model 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.

projectConversationModelEvaluationPath(project, conversation_model, evaluation) → {string}

Return a fully-qualified projectConversationModelEvaluation resource name string.

Parameters:

Name	Type	Description
`project`	string
`conversation_model`	string
`evaluation`	string

Returns:

Type	Description
string	Resource name string.

projectConversationModelPath(project, conversation_model) → {string}

Return a fully-qualified projectConversationModel resource name string.

Parameters:

Name	Type	Description
`project`	string
`conversation_model`	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.

projectLocationConversationModelEvaluationPath(project, location, conversation_model, evaluation) → {string}

Return a fully-qualified projectLocationConversationModelEvaluation resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`conversation_model`	string
`evaluation`	string

Returns:

Type	Description
string	Resource name string.

projectLocationConversationModelPath(project, location, conversation_model) → {string}

Return a fully-qualified projectLocationConversationModel resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`conversation_model`	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.

streamingAnalyzeContent(optionsopt) → {Stream}

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation. Note: This method is only available through the gRPC API (not REST).

The top-level message sent to the client by the server is StreamingAnalyzeContentResponse. Multiple response messages can be returned in order. The first one or more messages contain the recognition_result field. Each result represents a more complete transcript of what the user said. The next message contains the reply_text field and potentially the reply_audio field. The message can also contain the automated_agent_reply field.

Note: Always use agent versions for production traffic sent to virtual agents. See Versions and environments.

Parameters:

Name	Type	Attributes	Description
`options`	object	<optional>	Call options. See CallOptions for more details.

Returns:

Type	Description
Stream	An object stream which is both readable and writable. It accepts objects representing StreamingAnalyzeContentRequest for write() method, and will emit objects representing StreamingAnalyzeContentResponse on 'data' event asynchronously. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the participant this text comes from.
   *  Format: `projects/<Project ID>/locations/<Location
   *  ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
   */
  // const participant = 'abc123'
  /**
   *  Instructs the speech recognizer how to process the speech audio.
   */
  // const audioConfig = {}
  /**
   *  The natural language text to be processed.
   */
  // const textConfig = {}
  /**
   *  Speech synthesis configuration.
   *  The speech synthesis settings for a virtual agent that may be configured
   *  for the associated conversation profile are not used when calling
   *  StreamingAnalyzeContent. If this configuration is not supplied, speech
   *  synthesis is disabled.
   */
  // const replyAudioConfig = {}
  /**
   *  The input audio content to be recognized. Must be sent if `audio_config`
   *  is set in the first message. The complete audio over all streaming
   *  messages must not exceed 1 minute.
   */
  // const inputAudio = Buffer.from('string')
  /**
   *  The UTF-8 encoded natural language text to be processed. Must be sent if
   *  `text_config` is set in the first message. Text length must not exceed
   *  256 bytes for virtual agent interactions. The `input_text` field can be
   *  only sent once, and would cancel the speech recognition if any ongoing.
   */
  // const inputText = 'abc123'
  /**
   *  The DTMF digits used to invoke intent and fill in parameter value.
   *  This input is ignored if the previous response indicated that DTMF input
   *  is not accepted.
   */
  // const inputDtmf = {}
  /**
   *  Parameters for a Dialogflow virtual-agent query.
   */
  // const queryParams = {}
  /**
   *  Parameters for a human assist query.
   */
  // const assistQueryParams = {}
  /**
   *  Additional parameters to be put into Dialogflow CX session parameters. To
   *  remove a parameter from the session, clients should explicitly set the
   *  parameter value to null.
   *  Note: this field should only be used if you are connecting to a Dialogflow
   *  CX agent.
   */
  // const cxParameters = {}
  /**
   *  Optional. Enable full bidirectional streaming. You can keep streaming the
   *  audio until timeout, and there's no need to half close the stream to get
   *  the response.
   *  Restrictions:
   *  - Timeout: 3 mins.
   *  - Audio Encoding: only supports
   *  AudioEncoding.AUDIO_ENCODING_LINEAR_16 google.cloud.dialogflow.v2.AudioEncoding.AUDIO_ENCODING_LINEAR_16 
   *  and
   *  AudioEncoding.AUDIO_ENCODING_MULAW google.cloud.dialogflow.v2.AudioEncoding.AUDIO_ENCODING_MULAW 
   *  - Lifecycle: conversation should be in `Assist Stage`, go to
   *    Conversation.CreateConversation   for more information.
   *  InvalidArgument Error will be returned if the one of restriction checks
   *  failed.
   *  You can find more details in
   *  https://cloud.google.com/agent-assist/docs/extended-streaming
   */
  // const enableExtendedStreaming = true
  /**
   *  Enable partial virtual agent responses. If this flag is not enabled,
   *  response stream still contains only one final response even if some
   *  `Fulfillment`s in Dialogflow virtual agent have been configured to return
   *  partial responses.
   */
  // const enablePartialAutomatedAgentReply = true
  /**
   *  If true, `StreamingAnalyzeContentResponse.debugging_info` will get
   *  populated.
   */
  // const enableDebuggingInfo = true

  // Imports the Dialogflow library
  const {ParticipantsClient} = require('@google-cloud/dialogflow').v2;

  // Instantiates a client
  const dialogflowClient = new ParticipantsClient();

  async function callStreamingAnalyzeContent() {
    // Construct request
    const request = {
      participant,
    };

    // Run request
    const stream = await dialogflowClient.streamingAnalyzeContent();
    stream.on('data', (response) => { console.log(response) });
    stream.on('error', (err) => { throw(err) });
    stream.on('end', () => { /* API call completed */ });
    stream.write(request);
    stream.end();
  }

  callStreamingAnalyzeContent();