Constructor
new VersionsClient(optionsopt)
Construct an instance of VersionsClient.
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
|
Members
apiEndpoint
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
port
The port for this API service.
scopes
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
The DNS address for this API service.
Methods
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. |
createVersion(request, optionsopt) → {Promise}
Creates an agent version.
The new version points to the agent instance in the "default" environment.
Parameters:
| Name | Type | Attributes | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
| Type | Description |
|---|---|
| Promise |
|
deleteVersion(request, optionsopt) → {Promise}
Delete the specified agent version.
Parameters:
| Name | Type | Attributes | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
| Type | Description |
|---|---|
| Promise |
|
getProjectId() → {Promise}
Return the project ID used by this class.
Returns:
| Type | Description |
|---|---|
| Promise |
A promise that resolves to string containing the project ID. |
getVersion(request, optionsopt) → {Promise}
Retrieves the specified agent version.
Parameters:
| Name | Type | Attributes | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
| Type | Description |
|---|---|
| Promise |
|
initialize() → {Promise}
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns:
| Type | Description |
|---|---|
| Promise |
A promise that resolves to an authenticated service stub. |
listVersions(request, optionsopt) → {Promise}
Returns the list of all versions of the specified agent.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
|||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
| Type | Description |
|---|---|
| Promise |
|
listVersionsAsync(request, optionsopt) → {Object}
Equivalent to listVersions, 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
|
|||||||||||||||||
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 Version. 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.listVersionsAsync(request);
for await (const response of iterable) {
// process response
}listVersionsStream(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
|
|||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
| Type | Description |
|---|---|
| Stream |
An object stream which emits an object representing Version on 'data' event.
The client library will perform auto-pagination by default: it will call the API as many
times as needed. Note that it can affect your quota.
We recommend using |
matchAnswerRecordFromProjectAnswerRecordName(projectAnswerRecordName) → {string}
Parse the answer_record from ProjectAnswerRecord resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAnswerRecordName |
string |
A fully-qualified path representing project_answer_record resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the answer_record. |
matchAnswerRecordFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName) → {string}
Parse the answer_record from ProjectLocationAnswerRecord resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAnswerRecordName |
string |
A fully-qualified path representing project_location_answer_record resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the answer_record. |
matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) → {string}
Parse the context from ProjectAgentEnvironmentUserSessionContext resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentEnvironmentUserSessionContextName |
string |
A fully-qualified path representing project_agent_environment_user_session_context resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the context. |
matchContextFromProjectAgentSessionContextName(projectAgentSessionContextName) → {string}
Parse the context from ProjectAgentSessionContext resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentSessionContextName |
string |
A fully-qualified path representing project_agent_session_context resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the context. |
matchContextFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName) → {string}
Parse the context from ProjectLocationAgentEnvironmentUserSessionContext resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentEnvironmentUserSessionContextName |
string |
A fully-qualified path representing project_location_agent_environment_user_session_context resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the context. |
matchContextFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName) → {string}
Parse the context from ProjectLocationAgentSessionContext resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentSessionContextName |
string |
A fully-qualified path representing project_location_agent_session_context resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the context. |
matchConversationFromProjectConversationMessageName(projectConversationMessageName) → {string}
Parse the conversation from ProjectConversationMessage resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectConversationMessageName |
string |
A fully-qualified path representing project_conversation_message resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the conversation. |
matchConversationFromProjectConversationName(projectConversationName) → {string}
Parse the conversation from ProjectConversation resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectConversationName |
string |
A fully-qualified path representing project_conversation resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the conversation. |
matchConversationFromProjectConversationParticipantName(projectConversationParticipantName) → {string}
Parse the conversation from ProjectConversationParticipant resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectConversationParticipantName |
string |
A fully-qualified path representing project_conversation_participant resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the conversation. |
matchConversationFromProjectLocationConversationMessageName(projectLocationConversationMessageName) → {string}
Parse the conversation from ProjectLocationConversationMessage resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationConversationMessageName |
string |
A fully-qualified path representing project_location_conversation_message resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the conversation. |
matchConversationFromProjectLocationConversationName(projectLocationConversationName) → {string}
Parse the conversation from ProjectLocationConversation resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationConversationName |
string |
A fully-qualified path representing project_location_conversation resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the conversation. |
matchConversationFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName) → {string}
Parse the conversation from ProjectLocationConversationParticipant resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationConversationParticipantName |
string |
A fully-qualified path representing project_location_conversation_participant resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the conversation. |
matchConversationProfileFromProjectConversationProfileName(projectConversationProfileName) → {string}
Parse the conversation_profile from ProjectConversationProfile resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectConversationProfileName |
string |
A fully-qualified path representing project_conversation_profile resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the conversation_profile. |
matchConversationProfileFromProjectLocationConversationProfileName(projectLocationConversationProfileName) → {string}
Parse the conversation_profile from ProjectLocationConversationProfile resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationConversationProfileName |
string |
A fully-qualified path representing project_location_conversation_profile resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the conversation_profile. |
matchDocumentFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName) → {string}
Parse the document from ProjectKnowledgeBaseDocument resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectKnowledgeBaseDocumentName |
string |
A fully-qualified path representing project_knowledge_base_document resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the document. |
matchDocumentFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName) → {string}
Parse the document from ProjectLocationKnowledgeBaseDocument resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationKnowledgeBaseDocumentName |
string |
A fully-qualified path representing project_location_knowledge_base_document resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the document. |
matchEntityTypeFromProjectAgentEntityTypeName(projectAgentEntityTypeName) → {string}
Parse the entity_type from ProjectAgentEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentEntityTypeName |
string |
A fully-qualified path representing project_agent_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the entity_type. |
matchEntityTypeFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName) → {string}
Parse the entity_type from ProjectAgentEnvironmentUserSessionEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentEnvironmentUserSessionEntityTypeName |
string |
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the entity_type. |
matchEntityTypeFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName) → {string}
Parse the entity_type from ProjectAgentSessionEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentSessionEntityTypeName |
string |
A fully-qualified path representing project_agent_session_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the entity_type. |
matchEntityTypeFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName) → {string}
Parse the entity_type from ProjectLocationAgentEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentEntityTypeName |
string |
A fully-qualified path representing project_location_agent_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the entity_type. |
matchEntityTypeFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName) → {string}
Parse the entity_type from ProjectLocationAgentEnvironmentUserSessionEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentEnvironmentUserSessionEntityTypeName |
string |
A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the entity_type. |
matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName) → {string}
Parse the entity_type from ProjectLocationAgentSessionEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentSessionEntityTypeName |
string |
A fully-qualified path representing project_location_agent_session_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the entity_type. |
matchEnvironmentFromProjectAgentEnvironmentName(projectAgentEnvironmentName) → {string}
Parse the environment from ProjectAgentEnvironment resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentEnvironmentName |
string |
A fully-qualified path representing project_agent_environment resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the environment. |
matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) → {string}
Parse the environment from ProjectAgentEnvironmentUserSessionContext resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentEnvironmentUserSessionContextName |
string |
A fully-qualified path representing project_agent_environment_user_session_context resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the environment. |
matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName) → {string}
Parse the environment from ProjectAgentEnvironmentUserSessionEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentEnvironmentUserSessionEntityTypeName |
string |
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the environment. |
matchEnvironmentFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName) → {string}
Parse the environment from ProjectLocationAgentEnvironment resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentEnvironmentName |
string |
A fully-qualified path representing project_location_agent_environment resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the environment. |
matchEnvironmentFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName) → {string}
Parse the environment from ProjectLocationAgentEnvironmentUserSessionContext resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentEnvironmentUserSessionContextName |
string |
A fully-qualified path representing project_location_agent_environment_user_session_context resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the environment. |
matchEnvironmentFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName) → {string}
Parse the environment from ProjectLocationAgentEnvironmentUserSessionEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentEnvironmentUserSessionEntityTypeName |
string |
A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the environment. |
matchIntentFromProjectAgentIntentName(projectAgentIntentName) → {string}
Parse the intent from ProjectAgentIntent resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentIntentName |
string |
A fully-qualified path representing project_agent_intent resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the intent. |
matchIntentFromProjectLocationAgentIntentName(projectLocationAgentIntentName) → {string}
Parse the intent from ProjectLocationAgentIntent resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentIntentName |
string |
A fully-qualified path representing project_location_agent_intent resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the intent. |
matchKnowledgeBaseFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName) → {string}
Parse the knowledge_base from ProjectKnowledgeBaseDocument resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectKnowledgeBaseDocumentName |
string |
A fully-qualified path representing project_knowledge_base_document resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the knowledge_base. |
matchKnowledgeBaseFromProjectKnowledgeBaseName(projectKnowledgeBaseName) → {string}
Parse the knowledge_base from ProjectKnowledgeBase resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectKnowledgeBaseName |
string |
A fully-qualified path representing project_knowledge_base resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the knowledge_base. |
matchKnowledgeBaseFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName) → {string}
Parse the knowledge_base from ProjectLocationKnowledgeBaseDocument resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationKnowledgeBaseDocumentName |
string |
A fully-qualified path representing project_location_knowledge_base_document resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the knowledge_base. |
matchKnowledgeBaseFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName) → {string}
Parse the knowledge_base from ProjectLocationKnowledgeBase resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationKnowledgeBaseName |
string |
A fully-qualified path representing project_location_knowledge_base resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the knowledge_base. |
matchLocationFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName) → {string}
Parse the location from ProjectLocationAgentEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentEntityTypeName |
string |
A fully-qualified path representing project_location_agent_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the location. |
matchLocationFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName) → {string}
Parse the location from ProjectLocationAgentEnvironment resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentEnvironmentName |
string |
A fully-qualified path representing project_location_agent_environment resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the location. |
matchLocationFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName) → {string}
Parse the location from ProjectLocationAgentEnvironmentUserSessionContext resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentEnvironmentUserSessionContextName |
string |
A fully-qualified path representing project_location_agent_environment_user_session_context resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the location. |
matchLocationFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName) → {string}
Parse the location from ProjectLocationAgentEnvironmentUserSessionEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentEnvironmentUserSessionEntityTypeName |
string |
A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the location. |
matchLocationFromProjectLocationAgentFulfillmentName(projectLocationAgentFulfillmentName) → {string}
Parse the location from ProjectLocationAgentFulfillment resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentFulfillmentName |
string |
A fully-qualified path representing project_location_agent_fulfillment resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the location. |
matchLocationFromProjectLocationAgentIntentName(projectLocationAgentIntentName) → {string}
Parse the location from ProjectLocationAgentIntent resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentIntentName |
string |
A fully-qualified path representing project_location_agent_intent resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the location. |
matchLocationFromProjectLocationAgentName(projectLocationAgentName) → {string}
Parse the location from ProjectLocationAgent resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentName |
string |
A fully-qualified path representing project_location_agent resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the location. |
matchLocationFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName) → {string}
Parse the location from ProjectLocationAgentSessionContext resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentSessionContextName |
string |
A fully-qualified path representing project_location_agent_session_context resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the location. |
matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName) → {string}
Parse the location from ProjectLocationAgentSessionEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentSessionEntityTypeName |
string |
A fully-qualified path representing project_location_agent_session_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the location. |
matchLocationFromProjectLocationAgentVersionName(projectLocationAgentVersionName) → {string}
Parse the location from ProjectLocationAgentVersion resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentVersionName |
string |
A fully-qualified path representing project_location_agent_version resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the location. |
matchLocationFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName) → {string}
Parse the location from ProjectLocationAnswerRecord resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAnswerRecordName |
string |
A fully-qualified path representing project_location_answer_record resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the location. |
matchLocationFromProjectLocationConversationMessageName(projectLocationConversationMessageName) → {string}
Parse the location from ProjectLocationConversationMessage resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationConversationMessageName |
string |
A fully-qualified path representing project_location_conversation_message resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the location. |
matchLocationFromProjectLocationConversationName(projectLocationConversationName) → {string}
Parse the location from ProjectLocationConversation resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationConversationName |
string |
A fully-qualified path representing project_location_conversation resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the location. |
matchLocationFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName) → {string}
Parse the location from ProjectLocationConversationParticipant resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationConversationParticipantName |
string |
A fully-qualified path representing project_location_conversation_participant resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the location. |
matchLocationFromProjectLocationConversationProfileName(projectLocationConversationProfileName) → {string}
Parse the location from ProjectLocationConversationProfile resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationConversationProfileName |
string |
A fully-qualified path representing project_location_conversation_profile resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the location. |
matchLocationFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName) → {string}
Parse the location from ProjectLocationKnowledgeBaseDocument resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationKnowledgeBaseDocumentName |
string |
A fully-qualified path representing project_location_knowledge_base_document resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the location. |
matchLocationFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName) → {string}
Parse the location from ProjectLocationKnowledgeBase resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationKnowledgeBaseName |
string |
A fully-qualified path representing project_location_knowledge_base resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the location. |
matchMessageFromProjectConversationMessageName(projectConversationMessageName) → {string}
Parse the message from ProjectConversationMessage resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectConversationMessageName |
string |
A fully-qualified path representing project_conversation_message resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the message. |
matchMessageFromProjectLocationConversationMessageName(projectLocationConversationMessageName) → {string}
Parse the message from ProjectLocationConversationMessage resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationConversationMessageName |
string |
A fully-qualified path representing project_location_conversation_message resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the message. |
matchParticipantFromProjectConversationParticipantName(projectConversationParticipantName) → {string}
Parse the participant from ProjectConversationParticipant resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectConversationParticipantName |
string |
A fully-qualified path representing project_conversation_participant resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the participant. |
matchParticipantFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName) → {string}
Parse the participant from ProjectLocationConversationParticipant resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationConversationParticipantName |
string |
A fully-qualified path representing project_location_conversation_participant resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the participant. |
matchProjectFromProjectAgentEntityTypeName(projectAgentEntityTypeName) → {string}
Parse the project from ProjectAgentEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentEntityTypeName |
string |
A fully-qualified path representing project_agent_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectAgentEnvironmentName(projectAgentEnvironmentName) → {string}
Parse the project from ProjectAgentEnvironment resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentEnvironmentName |
string |
A fully-qualified path representing project_agent_environment resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) → {string}
Parse the project from ProjectAgentEnvironmentUserSessionContext resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentEnvironmentUserSessionContextName |
string |
A fully-qualified path representing project_agent_environment_user_session_context resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName) → {string}
Parse the project from ProjectAgentEnvironmentUserSessionEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentEnvironmentUserSessionEntityTypeName |
string |
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectAgentFulfillmentName(projectAgentFulfillmentName) → {string}
Parse the project from ProjectAgentFulfillment resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentFulfillmentName |
string |
A fully-qualified path representing project_agent_fulfillment resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectAgentIntentName(projectAgentIntentName) → {string}
Parse the project from ProjectAgentIntent resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentIntentName |
string |
A fully-qualified path representing project_agent_intent resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectAgentName(projectAgentName) → {string}
Parse the project from ProjectAgent resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentName |
string |
A fully-qualified path representing project_agent resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectAgentSessionContextName(projectAgentSessionContextName) → {string}
Parse the project from ProjectAgentSessionContext resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentSessionContextName |
string |
A fully-qualified path representing project_agent_session_context resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName) → {string}
Parse the project from ProjectAgentSessionEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentSessionEntityTypeName |
string |
A fully-qualified path representing project_agent_session_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectAgentVersionName(projectAgentVersionName) → {string}
Parse the project from ProjectAgentVersion resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentVersionName |
string |
A fully-qualified path representing project_agent_version resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectAnswerRecordName(projectAnswerRecordName) → {string}
Parse the project from ProjectAnswerRecord resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAnswerRecordName |
string |
A fully-qualified path representing project_answer_record resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectConversationMessageName(projectConversationMessageName) → {string}
Parse the project from ProjectConversationMessage resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectConversationMessageName |
string |
A fully-qualified path representing project_conversation_message resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectConversationName(projectConversationName) → {string}
Parse the project from ProjectConversation resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectConversationName |
string |
A fully-qualified path representing project_conversation resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectConversationParticipantName(projectConversationParticipantName) → {string}
Parse the project from ProjectConversationParticipant resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectConversationParticipantName |
string |
A fully-qualified path representing project_conversation_participant resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectConversationProfileName(projectConversationProfileName) → {string}
Parse the project from ProjectConversationProfile resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectConversationProfileName |
string |
A fully-qualified path representing project_conversation_profile resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName) → {string}
Parse the project from ProjectKnowledgeBaseDocument resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectKnowledgeBaseDocumentName |
string |
A fully-qualified path representing project_knowledge_base_document resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectKnowledgeBaseName(projectKnowledgeBaseName) → {string}
Parse the project from ProjectKnowledgeBase resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectKnowledgeBaseName |
string |
A fully-qualified path representing project_knowledge_base resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName) → {string}
Parse the project from ProjectLocationAgentEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentEntityTypeName |
string |
A fully-qualified path representing project_location_agent_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName) → {string}
Parse the project from ProjectLocationAgentEnvironment resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentEnvironmentName |
string |
A fully-qualified path representing project_location_agent_environment resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName) → {string}
Parse the project from ProjectLocationAgentEnvironmentUserSessionContext resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentEnvironmentUserSessionContextName |
string |
A fully-qualified path representing project_location_agent_environment_user_session_context resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName) → {string}
Parse the project from ProjectLocationAgentEnvironmentUserSessionEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentEnvironmentUserSessionEntityTypeName |
string |
A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectLocationAgentFulfillmentName(projectLocationAgentFulfillmentName) → {string}
Parse the project from ProjectLocationAgentFulfillment resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentFulfillmentName |
string |
A fully-qualified path representing project_location_agent_fulfillment resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectLocationAgentIntentName(projectLocationAgentIntentName) → {string}
Parse the project from ProjectLocationAgentIntent resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentIntentName |
string |
A fully-qualified path representing project_location_agent_intent resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectLocationAgentName(projectLocationAgentName) → {string}
Parse the project from ProjectLocationAgent resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentName |
string |
A fully-qualified path representing project_location_agent resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName) → {string}
Parse the project from ProjectLocationAgentSessionContext resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentSessionContextName |
string |
A fully-qualified path representing project_location_agent_session_context resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName) → {string}
Parse the project from ProjectLocationAgentSessionEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentSessionEntityTypeName |
string |
A fully-qualified path representing project_location_agent_session_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectLocationAgentVersionName(projectLocationAgentVersionName) → {string}
Parse the project from ProjectLocationAgentVersion resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentVersionName |
string |
A fully-qualified path representing project_location_agent_version resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName) → {string}
Parse the project from ProjectLocationAnswerRecord resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAnswerRecordName |
string |
A fully-qualified path representing project_location_answer_record resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectLocationConversationMessageName(projectLocationConversationMessageName) → {string}
Parse the project from ProjectLocationConversationMessage resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationConversationMessageName |
string |
A fully-qualified path representing project_location_conversation_message resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectLocationConversationName(projectLocationConversationName) → {string}
Parse the project from ProjectLocationConversation resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationConversationName |
string |
A fully-qualified path representing project_location_conversation resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName) → {string}
Parse the project from ProjectLocationConversationParticipant resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationConversationParticipantName |
string |
A fully-qualified path representing project_location_conversation_participant resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectLocationConversationProfileName(projectLocationConversationProfileName) → {string}
Parse the project from ProjectLocationConversationProfile resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationConversationProfileName |
string |
A fully-qualified path representing project_location_conversation_profile resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName) → {string}
Parse the project from ProjectLocationKnowledgeBaseDocument resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationKnowledgeBaseDocumentName |
string |
A fully-qualified path representing project_location_knowledge_base_document resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName) → {string}
Parse the project from ProjectLocationKnowledgeBase resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationKnowledgeBaseName |
string |
A fully-qualified path representing project_location_knowledge_base resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchProjectFromProjectName(projectName) → {string}
Parse the project from Project resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectName |
string |
A fully-qualified path representing Project resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the project. |
matchSessionFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) → {string}
Parse the session from ProjectAgentEnvironmentUserSessionContext resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentEnvironmentUserSessionContextName |
string |
A fully-qualified path representing project_agent_environment_user_session_context resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the session. |
matchSessionFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName) → {string}
Parse the session from ProjectAgentEnvironmentUserSessionEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentEnvironmentUserSessionEntityTypeName |
string |
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the session. |
matchSessionFromProjectAgentSessionContextName(projectAgentSessionContextName) → {string}
Parse the session from ProjectAgentSessionContext resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentSessionContextName |
string |
A fully-qualified path representing project_agent_session_context resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the session. |
matchSessionFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName) → {string}
Parse the session from ProjectAgentSessionEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentSessionEntityTypeName |
string |
A fully-qualified path representing project_agent_session_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the session. |
matchSessionFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName) → {string}
Parse the session from ProjectLocationAgentEnvironmentUserSessionContext resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentEnvironmentUserSessionContextName |
string |
A fully-qualified path representing project_location_agent_environment_user_session_context resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the session. |
matchSessionFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName) → {string}
Parse the session from ProjectLocationAgentEnvironmentUserSessionEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentEnvironmentUserSessionEntityTypeName |
string |
A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the session. |
matchSessionFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName) → {string}
Parse the session from ProjectLocationAgentSessionContext resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentSessionContextName |
string |
A fully-qualified path representing project_location_agent_session_context resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the session. |
matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName) → {string}
Parse the session from ProjectLocationAgentSessionEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentSessionEntityTypeName |
string |
A fully-qualified path representing project_location_agent_session_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the session. |
matchUserFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName) → {string}
Parse the user from ProjectAgentEnvironmentUserSessionContext resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentEnvironmentUserSessionContextName |
string |
A fully-qualified path representing project_agent_environment_user_session_context resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the user. |
matchUserFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName) → {string}
Parse the user from ProjectAgentEnvironmentUserSessionEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentEnvironmentUserSessionEntityTypeName |
string |
A fully-qualified path representing project_agent_environment_user_session_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the user. |
matchUserFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName) → {string}
Parse the user from ProjectLocationAgentEnvironmentUserSessionContext resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentEnvironmentUserSessionContextName |
string |
A fully-qualified path representing project_location_agent_environment_user_session_context resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the user. |
matchUserFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName) → {string}
Parse the user from ProjectLocationAgentEnvironmentUserSessionEntityType resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentEnvironmentUserSessionEntityTypeName |
string |
A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the user. |
matchVersionFromProjectAgentVersionName(projectAgentVersionName) → {string}
Parse the version from ProjectAgentVersion resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectAgentVersionName |
string |
A fully-qualified path representing project_agent_version resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the version. |
matchVersionFromProjectLocationAgentVersionName(projectLocationAgentVersionName) → {string}
Parse the version from ProjectLocationAgentVersion resource.
Parameters:
| Name | Type | Description |
|---|---|---|
projectLocationAgentVersionName |
string |
A fully-qualified path representing project_location_agent_version resource. |
Returns:
| Type | Description |
|---|---|
| string |
A string representing the version. |
projectAgentEntityTypePath(project, entity_type) → {string}
Return a fully-qualified projectAgentEntityType resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
entity_type |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectAgentEnvironmentPath(project, environment) → {string}
Return a fully-qualified projectAgentEnvironment resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
environment |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectAgentEnvironmentUserSessionContextPath(project, environment, user, session, context) → {string}
Return a fully-qualified projectAgentEnvironmentUserSessionContext resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
environment |
string | |
user |
string | |
session |
string | |
context |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectAgentEnvironmentUserSessionEntityTypePath(project, environment, user, session, entity_type) → {string}
Return a fully-qualified projectAgentEnvironmentUserSessionEntityType resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
environment |
string | |
user |
string | |
session |
string | |
entity_type |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectAgentFulfillmentPath(project) → {string}
Return a fully-qualified projectAgentFulfillment resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectAgentIntentPath(project, intent) → {string}
Return a fully-qualified projectAgentIntent resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
intent |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectAgentPath(project) → {string}
Return a fully-qualified projectAgent resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectAgentSessionContextPath(project, session, context) → {string}
Return a fully-qualified projectAgentSessionContext resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
session |
string | |
context |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectAgentSessionEntityTypePath(project, session, entity_type) → {string}
Return a fully-qualified projectAgentSessionEntityType resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
session |
string | |
entity_type |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectAgentVersionPath(project, version) → {string}
Return a fully-qualified projectAgentVersion resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
version |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectAnswerRecordPath(project, answer_record) → {string}
Return a fully-qualified projectAnswerRecord resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
answer_record |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectConversationMessagePath(project, conversation, message) → {string}
Return a fully-qualified projectConversationMessage resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
conversation |
string | |
message |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectConversationParticipantPath(project, conversation, participant) → {string}
Return a fully-qualified projectConversationParticipant resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
conversation |
string | |
participant |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectConversationPath(project, conversation) → {string}
Return a fully-qualified projectConversation resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
conversation |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectConversationProfilePath(project, conversation_profile) → {string}
Return a fully-qualified projectConversationProfile resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
conversation_profile |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectKnowledgeBaseDocumentPath(project, knowledge_base, document) → {string}
Return a fully-qualified projectKnowledgeBaseDocument resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
knowledge_base |
string | |
document |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectKnowledgeBasePath(project, knowledge_base) → {string}
Return a fully-qualified projectKnowledgeBase resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
knowledge_base |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectLocationAgentEntityTypePath(project, location, entity_type) → {string}
Return a fully-qualified projectLocationAgentEntityType resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
location |
string | |
entity_type |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectLocationAgentEnvironmentPath(project, location, environment) → {string}
Return a fully-qualified projectLocationAgentEnvironment resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
location |
string | |
environment |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectLocationAgentEnvironmentUserSessionContextPath(project, location, environment, user, session, context) → {string}
Return a fully-qualified projectLocationAgentEnvironmentUserSessionContext resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
location |
string | |
environment |
string | |
user |
string | |
session |
string | |
context |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectLocationAgentEnvironmentUserSessionEntityTypePath(project, location, environment, user, session, entity_type) → {string}
Return a fully-qualified projectLocationAgentEnvironmentUserSessionEntityType resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
location |
string | |
environment |
string | |
user |
string | |
session |
string | |
entity_type |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectLocationAgentFulfillmentPath(project, location) → {string}
Return a fully-qualified projectLocationAgentFulfillment resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
location |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectLocationAgentIntentPath(project, location, intent) → {string}
Return a fully-qualified projectLocationAgentIntent resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
location |
string | |
intent |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectLocationAgentPath(project, location) → {string}
Return a fully-qualified projectLocationAgent resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
location |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectLocationAgentSessionContextPath(project, location, session, context) → {string}
Return a fully-qualified projectLocationAgentSessionContext resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
location |
string | |
session |
string | |
context |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectLocationAgentSessionEntityTypePath(project, location, session, entity_type) → {string}
Return a fully-qualified projectLocationAgentSessionEntityType resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
location |
string | |
session |
string | |
entity_type |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectLocationAgentVersionPath(project, location, version) → {string}
Return a fully-qualified projectLocationAgentVersion resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
location |
string | |
version |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectLocationAnswerRecordPath(project, location, answer_record) → {string}
Return a fully-qualified projectLocationAnswerRecord resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
location |
string | |
answer_record |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectLocationConversationMessagePath(project, location, conversation, message) → {string}
Return a fully-qualified projectLocationConversationMessage resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
location |
string | |
conversation |
string | |
message |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectLocationConversationParticipantPath(project, location, conversation, participant) → {string}
Return a fully-qualified projectLocationConversationParticipant resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
location |
string | |
conversation |
string | |
participant |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectLocationConversationPath(project, location, conversation) → {string}
Return a fully-qualified projectLocationConversation resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
location |
string | |
conversation |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectLocationConversationProfilePath(project, location, conversation_profile) → {string}
Return a fully-qualified projectLocationConversationProfile resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
location |
string | |
conversation_profile |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectLocationKnowledgeBaseDocumentPath(project, location, knowledge_base, document) → {string}
Return a fully-qualified projectLocationKnowledgeBaseDocument resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
location |
string | |
knowledge_base |
string | |
document |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectLocationKnowledgeBasePath(project, location, knowledge_base) → {string}
Return a fully-qualified projectLocationKnowledgeBase resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string | |
location |
string | |
knowledge_base |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
projectPath(project) → {string}
Return a fully-qualified project resource name string.
Parameters:
| Name | Type | Description |
|---|---|---|
project |
string |
Returns:
| Type | Description |
|---|---|
| string |
Resource name string. |
updateVersion(request, optionsopt) → {Promise}
Updates the specified agent version.
Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.
Parameters:
| Name | Type | Attributes | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
| Type | Description |
|---|---|
| Promise |
|