SessionsClient

SessionsClient

A service used for session interactions.

For more information, see the API interactions guide.

Constructor

new SessionsClient(optionsopt, gaxInstanceopt)

Construct an instance of SessionsClient.

Parameters:
Name Type Attributes Description
options object <optional>

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 <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

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

keyFilename string <optional>

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 <optional>

The port on which to connect to the remote host.

projectId string <optional>

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 <optional>

The domain name of the API remote host.

clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.

fallback boolean <optional>

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance gax <optional>

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 SessionsClient({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.

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 <optional>

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 <optional>

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
}
```

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.

matchEnvironmentFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName) → {string}

Parse the environment from ProjectAgentEnvironmentUserSession resource.

Parameters:
Name Type Description
projectAgentEnvironmentUserSessionName string

A fully-qualified path representing project_agent_environment_user_session 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.

matchEnvironmentFromProjectLocationAgentEnvironmentUserSessionName(projectLocationAgentEnvironmentUserSessionName) → {string}

Parse the environment from ProjectLocationAgentEnvironmentUserSession resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentUserSessionName string

A fully-qualified path representing project_location_agent_environment_user_session resource.

Returns:
Type Description
string

A string representing the environment.

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.

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.

matchLocationFromProjectLocationAgentEnvironmentUserSessionName(projectLocationAgentEnvironmentUserSessionName) → {string}

Parse the location from ProjectLocationAgentEnvironmentUserSession resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentUserSessionName string

A fully-qualified path representing project_location_agent_environment_user_session 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.

matchLocationFromProjectLocationAgentSessionName(projectLocationAgentSessionName) → {string}

Parse the location from ProjectLocationAgentSession resource.

Parameters:
Name Type Description
projectLocationAgentSessionName string

A fully-qualified path representing project_location_agent_session 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.

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.

matchProjectFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName) → {string}

Parse the project from ProjectAgentEnvironmentUserSession resource.

Parameters:
Name Type Description
projectAgentEnvironmentUserSessionName string

A fully-qualified path representing project_agent_environment_user_session 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.

matchProjectFromProjectAgentSessionName(projectAgentSessionName) → {string}

Parse the project from ProjectAgentSession resource.

Parameters:
Name Type Description
projectAgentSessionName string

A fully-qualified path representing project_agent_session 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.

matchProjectFromProjectLocationAgentEnvironmentUserSessionName(projectLocationAgentEnvironmentUserSessionName) → {string}

Parse the project from ProjectLocationAgentEnvironmentUserSession resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentUserSessionName string

A fully-qualified path representing project_location_agent_environment_user_session 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.

matchProjectFromProjectLocationAgentSessionName(projectLocationAgentSessionName) → {string}

Parse the project from ProjectLocationAgentSession resource.

Parameters:
Name Type Description
projectLocationAgentSessionName string

A fully-qualified path representing project_location_agent_session 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.

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.

matchSessionFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName) → {string}

Parse the session from ProjectAgentEnvironmentUserSession resource.

Parameters:
Name Type Description
projectAgentEnvironmentUserSessionName string

A fully-qualified path representing project_agent_environment_user_session 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.

matchSessionFromProjectAgentSessionName(projectAgentSessionName) → {string}

Parse the session from ProjectAgentSession resource.

Parameters:
Name Type Description
projectAgentSessionName string

A fully-qualified path representing project_agent_session 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.

matchSessionFromProjectLocationAgentEnvironmentUserSessionName(projectLocationAgentEnvironmentUserSessionName) → {string}

Parse the session from ProjectLocationAgentEnvironmentUserSession resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentUserSessionName string

A fully-qualified path representing project_location_agent_environment_user_session 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.

matchSessionFromProjectLocationAgentSessionName(projectLocationAgentSessionName) → {string}

Parse the session from ProjectLocationAgentSession resource.

Parameters:
Name Type Description
projectLocationAgentSessionName string

A fully-qualified path representing project_location_agent_session 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.

matchUserFromProjectAgentEnvironmentUserSessionName(projectAgentEnvironmentUserSessionName) → {string}

Parse the user from ProjectAgentEnvironmentUserSession resource.

Parameters:
Name Type Description
projectAgentEnvironmentUserSessionName string

A fully-qualified path representing project_agent_environment_user_session 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.

matchUserFromProjectLocationAgentEnvironmentUserSessionName(projectLocationAgentEnvironmentUserSessionName) → {string}

Parse the user from ProjectLocationAgentEnvironmentUserSession resource.

Parameters:
Name Type Description
projectLocationAgentEnvironmentUserSessionName string

A fully-qualified path representing project_location_agent_environment_user_session 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.

projectAgentEnvironmentUserSessionPath(project, environment, user, session) → {string}

Return a fully-qualified projectAgentEnvironmentUserSession resource name string.

Parameters:
Name Type Description
project string
environment string
user string
session 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.

projectAgentSessionPath(project, session) → {string}

Return a fully-qualified projectAgentSession resource name string.

Parameters:
Name Type Description
project string
session 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.

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

Return a fully-qualified projectLocationAgentEnvironmentUserSession resource name string.

Parameters:
Name Type Description
project string
location string
environment string
user string
session 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.

projectLocationAgentSessionPath(project, location, session) → {string}

Return a fully-qualified projectLocationAgentSession resource name string.

Parameters:
Name Type Description
project string
location string
session 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.

streamingDetectIntent(optionsopt) → {Stream}

Processes a natural language query in audio format in a streaming fashion and returns structured, actionable data as a result. This method is only available via the gRPC API (not REST).

If you might use Agent Assist or other CCAI products now or in the future, consider using StreamingAnalyzeContent instead of StreamingDetectIntent. StreamingAnalyzeContent has additional functionality for Agent Assist and other CCAI products.

Note: Always use agent versions for production traffic. 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 StreamingDetectIntentRequest for write() method, and will emit objects representing StreamingDetectIntentResponse 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 session the query is sent to.
   *  Supported formats:
   *  - `projects/<Project ID>/agent/sessions/<Session ID>,
   *  - `projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session
   *    ID>`,
   *  - `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
   *    ID>/sessions/<Session ID>`,
   *  - `projects/<Project ID>/locations/<Location
   *    ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session
   *    ID>`,
   *  If `Location ID` is not specified we assume default 'us' location. If
   *  `Environment ID` is not specified, we assume default 'draft' environment.
   *  If `User ID` is not specified, we are using "-". It's up to the API caller
   *  to choose an appropriate `Session ID` and `User Id`. They can be a random
   *  number or some type of user and session identifiers (preferably hashed).
   *  The length of the `Session ID` and `User ID` must not exceed 36 characters.
   *  For more information, see the API interactions
   *  guide (https://cloud.google.com/dialogflow/docs/api-overview).
   *  Note: Always use agent versions for production traffic.
   *  See Versions and
   *  environments (https://cloud.google.com/dialogflow/es/docs/agents-versions).
   */
  // const session = 'abc123'
  /**
   *  The parameters of this query.
   */
  // const queryParams = {}
  /**
   *  Required. The input specification. It can be set to:
   *  1. an audio config which instructs the speech recognizer how to process
   *  the speech audio,
   *  2. a conversational query in the form of text, or
   *  3. an event that specifies which intent to trigger.
   */
  // const queryInput = {}
  /**
   *  DEPRECATED. Please use
   *  InputAudioConfig.single_utterance google.cloud.dialogflow.v2beta1.InputAudioConfig.single_utterance 
   *  instead. If `false` (default), recognition does not cease until the client
   *  closes the stream. If `true`, the recognizer will detect a single spoken
   *  utterance in input audio. Recognition ceases when it detects the audio's
   *  voice has stopped or paused. In this case, once a detected intent is
   *  received, the client should close the stream and start a new request with a
   *  new stream as needed. This setting is ignored when `query_input` is a piece
   *  of text or an event.
   */
  // const singleUtterance = true
  /**
   *  Instructs the speech synthesizer how to generate the output
   *  audio. If this field is not set and agent-level speech synthesizer is not
   *  configured, no output audio is generated.
   */
  // const outputAudioConfig = {}
  /**
   *  Mask for
   *  output_audio_config google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config 
   *  indicating which settings in this request-level config should override
   *  speech synthesizer settings defined at agent-level.
   *  If unspecified or empty,
   *  output_audio_config google.cloud.dialogflow.v2beta1.StreamingDetectIntentRequest.output_audio_config 
   *  replaces the agent-level config in its entirety.
   */
  // const outputAudioConfigMask = {}
  /**
   *  The input audio content to be recognized. Must be sent if
   *  `query_input` was set to a streaming input audio config. The complete audio
   *  over all streaming messages must not exceed 1 minute.
   */
  // const inputAudio = Buffer.from('string')
  /**
   *  If true, `StreamingDetectIntentResponse.debugging_info` will get populated.
   */
  // const enableDebuggingInfo = true

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

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

  async function callStreamingDetectIntent() {
    // Construct request
    const request = {
      session,
      queryInput,
    };

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

  callStreamingDetectIntent();