DocumentsClient

DocumentsClient

Service for managing knowledge Documents.

Constructor

new DocumentsClient(optionsopt, gaxInstanceopt)

Construct an instance of DocumentsClient.

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 DocumentsClient({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

cancelOperation(request, optionsopt, callbackopt) → {Promise}

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be cancelled.

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```

(async) checkCreateDocumentProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.

Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
  /**
   * 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 knowledge base to create a document for.
   *  Format: `projects/<Project ID>/locations/<Location
   *  ID>/knowledgeBases/<Knowledge Base ID>`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The document to create.
   */
  // const document = {}
  /**
   *  Whether to import custom metadata from Google Cloud Storage.
   *  Only valid when the document source is Google Cloud Storage URI.
   */
  // const importGcsCustomMetadata = true

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

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

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

    // Run request
    const [operation] = await dialogflowClient.createDocument(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateDocument();

(async) checkDeleteDocumentProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.

Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
  /**
   * 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 document to delete.
   *  Format: `projects/<Project ID>/locations/<Location
   *  ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
   */
  // const name = 'abc123'

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

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

  async function callDeleteDocument() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await dialogflowClient.deleteDocument(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteDocument();

(async) checkImportDocumentsProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.

Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
  /**
   * 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 knowledge base to import documents into.
   *  Format: `projects/<Project ID>/locations/<Location
   *  ID>/knowledgeBases/<Knowledge Base ID>`.
   */
  // const parent = 'abc123'
  /**
   *  Optional. The Google Cloud Storage location for the documents.
   *  The path can include a wildcard.
   *  These URIs may have the forms
   *  `gs://<bucket-name>/<object-name>`.
   *  `gs://<bucket-name>/<object-path>/*.<extension>`.
   */
  // const gcsSource = {}
  /**
   *  Required. Document template used for importing all the documents.
   */
  // const documentTemplate = {}
  /**
   *  Whether to import custom metadata from Google Cloud Storage.
   *  Only valid when the document source is Google Cloud Storage URI.
   */
  // const importGcsCustomMetadata = true

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

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

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

    // Run request
    const [operation] = await dialogflowClient.importDocuments(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callImportDocuments();

(async) checkReloadDocumentProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.

Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
  /**
   * 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 document to reload.
   *  Format: `projects/<Project ID>/locations/<Location
   *  ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`
   */
  // const name = 'abc123'
  /**
   *  The path for a Cloud Storage source file for reloading document content.
   *  If not provided, the Document's existing source will be reloaded.
   */
  // const gcsSource = {}
  /**
   *  Whether to import custom metadata from Google Cloud Storage.
   *  Only valid when the document source is Google Cloud Storage URI.
   */
  // const importGcsCustomMetadata = true

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

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

  async function callReloadDocument() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await dialogflowClient.reloadDocument(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callReloadDocument();

(async) checkUpdateDocumentProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.

Returns:
Type Description
Promise
  • The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the documentation for more details and examples.
Example
  /**
   * 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 document to update.
   */
  // const document = {}
  /**
   *  Optional. Not specified means `update all`.
   *  Currently, only `display_name` can be updated, an InvalidArgument will be
   *  returned for attempting to update other fields.
   */
  // const updateMask = {}

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

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

  async function callUpdateDocument() {
    // Construct request
    const request = {
      document,
    };

    // Run request
    const [operation] = await dialogflowClient.updateDocument(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateDocument();

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.

deleteOperation(request, optionsopt, callbackopt) → {Promise}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be deleted.

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```

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);
```

getOperation(request, optionsopt, callbackopt) → {Promise}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource.

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing google.longrunning.Operation.

Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing google.longrunning.Operation. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```

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.

listDocumentsAsync(request, optionsopt) → {Object}

Equivalent to listDocuments, but returns an iterable object.

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The knowledge base to list all documents for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.

pageSize number

The maximum number of items to return in a single page. By default 10 and at most 100.

pageToken string

The next_page_token value returned from a previous list request.

filter string

The filter expression used to filter documents returned by the list method. The expression has the following syntax:

<field> <operator> <value> [AND <field> <operator> <value>] ...

The following fields and operators are supported:

  • knowledge_types with has(:) operator
  • display_name with has(:) operator
  • state with equals(=) operator

Examples:

  • "knowledge_types:FAQ" matches documents with FAQ knowledge type.
  • "display_name:customer" matches documents whose display name contains "customer".
  • "state=ACTIVE" matches documents with ACTIVE state.
  • "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.

For more information about filtering, see API Filtering.

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 Document. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.

Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The knowledge base to list all documents for.
   *  Format: `projects/<Project ID>/locations/<Location
   *  ID>/knowledgeBases/<Knowledge Base ID>`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return in a single page. By
   *  default 10 and at most 100.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token value returned from a previous list request.
   */
  // const pageToken = 'abc123'
  /**
   *  The filter expression used to filter documents returned by the list method.
   *  The expression has the following syntax:
   *    <field> <operator> <value> AND <field> <operator> <value>  ...
   *  The following fields and operators are supported:
   *  * knowledge_types with has(:) operator
   *  * display_name with has(:) operator
   *  * state with equals(=) operator
   *  Examples:
   *  * "knowledge_types:FAQ" matches documents with FAQ knowledge type.
   *  * "display_name:customer" matches documents whose display name contains
   *    "customer".
   *  * "state=ACTIVE" matches documents with ACTIVE state.
   *  * "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.
   *  For more information about filtering, see
   *  API Filtering (https://aip.dev/160).
   */
  // const filter = 'abc123'

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

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

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

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

  callListDocuments();

listDocumentsStream(request, optionsopt) → {Stream}

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The knowledge base to list all documents for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.

pageSize number

The maximum number of items to return in a single page. By default 10 and at most 100.

pageToken string

The next_page_token value returned from a previous list request.

filter string

The filter expression used to filter documents returned by the list method. The expression has the following syntax:

<field> <operator> <value> [AND <field> <operator> <value>] ...

The following fields and operators are supported:

  • knowledge_types with has(:) operator
  • display_name with has(:) operator
  • state with equals(=) operator

Examples:

  • "knowledge_types:FAQ" matches documents with FAQ knowledge type.
  • "display_name:customer" matches documents whose display name contains "customer".
  • "state=ACTIVE" matches documents with ACTIVE state.
  • "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents.

For more information about filtering, see API Filtering.

options object <optional>

Call options. See CallOptions for more details.

Returns:
Type Description
Stream

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

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

listOperationsAsync(request, optionsopt) → {Object}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The name of the operation collection.

filter string

The standard list filter.

pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns:
Type Description
Object

An iterable Object that conforms to iteration protocols.

Example
```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(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.

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.