Class v2.EnvironmentsClient (6.12.0)

Service for managing . v2

Package

@google-cloud/dialogflow

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of EnvironmentsClient.

Parameters
Name Description
opts ClientOptions
gaxInstance typeof gax | typeof fallback

: 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 EnvironmentsClient({fallback: true}, gax); ```

Properties

apiEndpoint

get apiEndpoint(): string;

The DNS address for this API service.

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

environmentsStub

environmentsStub?: Promise<{
        [name: string]: Function;
    }>;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

locationsClient

locationsClient: LocationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

universeDomain

get universeDomain(): string;

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

close()

close(): Promise<void>;

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

{Promise} A promise that resolves when the client is closed.

conversationDatasetPath(project, location, conversationDataset)

conversationDatasetPath(project: string, location: string, conversationDataset: string): string;

Return a fully-qualified conversationDataset resource name string.

Parameters
Name Description
project string
location string
conversationDataset string
Returns
Type Description
string

{string} Resource name string.

createEnvironment(request, options)

createEnvironment(request?: protos.google.cloud.dialogflow.v2.ICreateEnvironmentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.v2.IEnvironment,
        protos.google.cloud.dialogflow.v2.ICreateEnvironmentRequest | undefined,
        {} | undefined
    ]>;

Creates an agent environment.

Parameters
Name Description
request ICreateEnvironmentRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.dialogflow.v2.IEnvironment, protos.google.cloud.dialogflow.v2.ICreateEnvironmentRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 agent to create an environment for.
   *  Supported formats:
   *  - `projects/

createEnvironment(request, options, callback)

createEnvironment(request: protos.google.cloud.dialogflow.v2.ICreateEnvironmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2.IEnvironment, protos.google.cloud.dialogflow.v2.ICreateEnvironmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateEnvironmentRequest
options CallOptions
callback Callback<protos.google.cloud.dialogflow.v2.IEnvironment, protos.google.cloud.dialogflow.v2.ICreateEnvironmentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createEnvironment(request, callback)

createEnvironment(request: protos.google.cloud.dialogflow.v2.ICreateEnvironmentRequest, callback: Callback<protos.google.cloud.dialogflow.v2.IEnvironment, protos.google.cloud.dialogflow.v2.ICreateEnvironmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateEnvironmentRequest
callback Callback<protos.google.cloud.dialogflow.v2.IEnvironment, protos.google.cloud.dialogflow.v2.ICreateEnvironmentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteEnvironment(request, options)

deleteEnvironment(request?: protos.google.cloud.dialogflow.v2.IDeleteEnvironmentRequest, options?: CallOptions): Promise<[
        protos.google.protobuf.IEmpty,
        protos.google.cloud.dialogflow.v2.IDeleteEnvironmentRequest | undefined,
        {} | undefined
    ]>;

Deletes the specified agent environment.

Parameters
Name Description
request IDeleteEnvironmentRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeleteEnvironmentRequest | undefined, {} | undefined ]>

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

  /**
   * 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 environment to delete.
   *  / Format:
   *  - `projects/

deleteEnvironment(request, options, callback)

deleteEnvironment(request: protos.google.cloud.dialogflow.v2.IDeleteEnvironmentRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeleteEnvironmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteEnvironmentRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeleteEnvironmentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteEnvironment(request, callback)

deleteEnvironment(request: protos.google.cloud.dialogflow.v2.IDeleteEnvironmentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeleteEnvironmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IDeleteEnvironmentRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2.IDeleteEnvironmentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

encryptionSpecPath(project, location)

encryptionSpecPath(project: string, location: string): string;

Return a fully-qualified encryptionSpec resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

generatorPath(project, location, generator)

generatorPath(project: string, location: string, generator: string): string;

Return a fully-qualified generator resource name string.

Parameters
Name Description
project string
location string
generator string
Returns
Type Description
string

{string} Resource name string.

getEnvironment(request, options)

getEnvironment(request?: protos.google.cloud.dialogflow.v2.IGetEnvironmentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.v2.IEnvironment,
        protos.google.cloud.dialogflow.v2.IGetEnvironmentRequest | undefined,
        {} | undefined
    ]>;

Retrieves the specified agent environment.

Parameters
Name Description
request IGetEnvironmentRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.dialogflow.v2.IEnvironment, protos.google.cloud.dialogflow.v2.IGetEnvironmentRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 environment.
   *  Supported formats:
   *  - `projects/

getEnvironment(request, options, callback)

getEnvironment(request: protos.google.cloud.dialogflow.v2.IGetEnvironmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2.IEnvironment, protos.google.cloud.dialogflow.v2.IGetEnvironmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetEnvironmentRequest
options CallOptions
callback Callback<protos.google.cloud.dialogflow.v2.IEnvironment, protos.google.cloud.dialogflow.v2.IGetEnvironmentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getEnvironment(request, callback)

getEnvironment(request: protos.google.cloud.dialogflow.v2.IGetEnvironmentRequest, callback: Callback<protos.google.cloud.dialogflow.v2.IEnvironment, protos.google.cloud.dialogflow.v2.IGetEnvironmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetEnvironmentRequest
callback Callback<protos.google.cloud.dialogflow.v2.IEnvironment, protos.google.cloud.dialogflow.v2.IGetEnvironmentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getEnvironmentHistory(request, options)

getEnvironmentHistory(request?: protos.google.cloud.dialogflow.v2.IGetEnvironmentHistoryRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.v2.EnvironmentHistory.IEntry[],
        protos.google.cloud.dialogflow.v2.IGetEnvironmentHistoryRequest | null,
        protos.google.cloud.dialogflow.v2.IEnvironmentHistory
    ]>;

Gets the history of the specified environment.

Parameters
Name Description
request IGetEnvironmentHistoryRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.dialogflow.v2.EnvironmentHistory.IEntry[], protos.google.cloud.dialogflow.v2.IGetEnvironmentHistoryRequest | null, protos.google.cloud.dialogflow.v2.IEnvironmentHistory ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using getEnvironmentHistoryAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

getEnvironmentHistory(request, options, callback)

getEnvironmentHistory(request: protos.google.cloud.dialogflow.v2.IGetEnvironmentHistoryRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.v2.IGetEnvironmentHistoryRequest, protos.google.cloud.dialogflow.v2.IEnvironmentHistory | null | undefined, protos.google.cloud.dialogflow.v2.EnvironmentHistory.IEntry>): void;
Parameters
Name Description
request IGetEnvironmentHistoryRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.dialogflow.v2.IGetEnvironmentHistoryRequest, protos.google.cloud.dialogflow.v2.IEnvironmentHistory | null | undefined, protos.google.cloud.dialogflow.v2.EnvironmentHistory.IEntry>
Returns
Type Description
void

getEnvironmentHistory(request, callback)

getEnvironmentHistory(request: protos.google.cloud.dialogflow.v2.IGetEnvironmentHistoryRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.v2.IGetEnvironmentHistoryRequest, protos.google.cloud.dialogflow.v2.IEnvironmentHistory | null | undefined, protos.google.cloud.dialogflow.v2.EnvironmentHistory.IEntry>): void;
Parameters
Name Description
request IGetEnvironmentHistoryRequest
callback PaginationCallback<protos.google.cloud.dialogflow.v2.IGetEnvironmentHistoryRequest, protos.google.cloud.dialogflow.v2.IEnvironmentHistory | null | undefined, protos.google.cloud.dialogflow.v2.EnvironmentHistory.IEntry>
Returns
Type Description
void

getEnvironmentHistoryAsync(request, options)

getEnvironmentHistoryAsync(request?: protos.google.cloud.dialogflow.v2.IGetEnvironmentHistoryRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.v2.EnvironmentHistory.IEntry>;

Equivalent to getEnvironmentHistory, but returns an iterable object.

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

Parameters
Name Description
request IGetEnvironmentHistoryRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.dialogflow.v2.EnvironmentHistory.IEntry>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 name of the environment to retrieve history for.
   *  Supported formats:
   *  - `projects/

getEnvironmentHistoryStream(request, options)

getEnvironmentHistoryStream(request?: protos.google.cloud.dialogflow.v2.IGetEnvironmentHistoryRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IGetEnvironmentHistoryRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

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

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
Name Description
request LocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.
options CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Call options. See CallOptions for more details.
callback Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
Promise<google.cloud.location.ILocation>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
Example 

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

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

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<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listEnvironments(request, options)

listEnvironments(request?: protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.v2.IEnvironment[],
        protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest | null,
        protos.google.cloud.dialogflow.v2.IListEnvironmentsResponse
    ]>;

Returns the list of all non-default environments of the specified agent.

Parameters
Name Description
request IListEnvironmentsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.dialogflow.v2.IEnvironment[], protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest | null, protos.google.cloud.dialogflow.v2.IListEnvironmentsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listEnvironmentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listEnvironments(request, options, callback)

listEnvironments(request: protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest, protos.google.cloud.dialogflow.v2.IListEnvironmentsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IEnvironment>): void;
Parameters
Name Description
request IListEnvironmentsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest, protos.google.cloud.dialogflow.v2.IListEnvironmentsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IEnvironment>
Returns
Type Description
void

listEnvironments(request, callback)

listEnvironments(request: protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest, protos.google.cloud.dialogflow.v2.IListEnvironmentsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IEnvironment>): void;
Parameters
Name Description
request IListEnvironmentsRequest
callback PaginationCallback<protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest, protos.google.cloud.dialogflow.v2.IListEnvironmentsResponse | null | undefined, protos.google.cloud.dialogflow.v2.IEnvironment>
Returns
Type Description
void

listEnvironmentsAsync(request, options)

listEnvironmentsAsync(request?: protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.v2.IEnvironment>;

Equivalent to listEnvironments, but returns an iterable object.

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

Parameters
Name Description
request IListEnvironmentsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.dialogflow.v2.IEnvironment>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 agent to list all environments from.
   *  Format:
   *  - `projects/

listEnvironmentsStream(request, options)

listEnvironmentsStream(request?: protos.google.cloud.dialogflow.v2.IListEnvironmentsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListEnvironmentsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

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

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

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 Description
request LocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<google.cloud.location.ILocation>

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

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

matchAnswerRecordFromProjectAnswerRecordName(projectAnswerRecordName)

matchAnswerRecordFromProjectAnswerRecordName(projectAnswerRecordName: string): string | number;

Parse the answer_record from ProjectAnswerRecord resource.

Parameter
Name Description
projectAnswerRecordName string

A fully-qualified path representing project_answer_record resource.
Returns
Type Description
string | number

{string} A string representing the answer_record.

matchAnswerRecordFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName)

matchAnswerRecordFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName: string): string | number;

Parse the answer_record from ProjectLocationAnswerRecord resource.

Parameter
Name Description
projectLocationAnswerRecordName string

A fully-qualified path representing project_location_answer_record resource.
Returns
Type Description
string | number

{string} A string representing the answer_record.

matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;

Parse the context from ProjectAgentEnvironmentUserSessionContext resource.

Parameter
Name Description
projectAgentEnvironmentUserSessionContextName string

A fully-qualified path representing project_agent_environment_user_session_context resource.
Returns
Type Description
string | number

{string} A string representing the context.

matchContextFromProjectAgentSessionContextName(projectAgentSessionContextName)

matchContextFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number;

Parse the context from ProjectAgentSessionContext resource.

Parameter
Name Description
projectAgentSessionContextName string

A fully-qualified path representing project_agent_session_context resource.
Returns
Type Description
string | number

{string} A string representing the context.

matchContextFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName)

matchContextFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName: string): string | number;

Parse the context from ProjectLocationAgentEnvironmentUserSessionContext resource.

Parameter
Name Description
projectLocationAgentEnvironmentUserSessionContextName string

A fully-qualified path representing project_location_agent_environment_user_session_context resource.
Returns
Type Description
string | number

{string} A string representing the context.

matchContextFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName)

matchContextFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName: string): string | number;

Parse the context from ProjectLocationAgentSessionContext resource.

Parameter
Name Description
projectLocationAgentSessionContextName string

A fully-qualified path representing project_location_agent_session_context resource.
Returns
Type Description
string | number

{string} A string representing the context.

matchConversationDatasetFromConversationDatasetName(conversationDatasetName)

matchConversationDatasetFromConversationDatasetName(conversationDatasetName: string): string | number;

Parse the conversation_dataset from ConversationDataset resource.

Parameter
Name Description
conversationDatasetName string

A fully-qualified path representing ConversationDataset resource.
Returns
Type Description
string | number

{string} A string representing the conversation_dataset.

matchConversationFromProjectConversationMessageName(projectConversationMessageName)

matchConversationFromProjectConversationMessageName(projectConversationMessageName: string): string | number;

Parse the conversation from ProjectConversationMessage resource.

Parameter
Name Description
projectConversationMessageName string

A fully-qualified path representing project_conversation_message resource.
Returns
Type Description
string | number

{string} A string representing the conversation.

matchConversationFromProjectConversationName(projectConversationName)

matchConversationFromProjectConversationName(projectConversationName: string): string | number;

Parse the conversation from ProjectConversation resource.

Parameter
Name Description
projectConversationName string

A fully-qualified path representing project_conversation resource.
Returns
Type Description
string | number

{string} A string representing the conversation.

matchConversationFromProjectConversationParticipantName(projectConversationParticipantName)

matchConversationFromProjectConversationParticipantName(projectConversationParticipantName: string): string | number;

Parse the conversation from ProjectConversationParticipant resource.

Parameter
Name Description
projectConversationParticipantName string

A fully-qualified path representing project_conversation_participant resource.
Returns
Type Description
string | number

{string} A string representing the conversation.

matchConversationFromProjectLocationConversationMessageName(projectLocationConversationMessageName)

matchConversationFromProjectLocationConversationMessageName(projectLocationConversationMessageName: string): string | number;

Parse the conversation from ProjectLocationConversationMessage resource.

Parameter
Name Description
projectLocationConversationMessageName string

A fully-qualified path representing project_location_conversation_message resource.
Returns
Type Description
string | number

{string} A string representing the conversation.

matchConversationFromProjectLocationConversationName(projectLocationConversationName)

matchConversationFromProjectLocationConversationName(projectLocationConversationName: string): string | number;

Parse the conversation from ProjectLocationConversation resource.

Parameter
Name Description
projectLocationConversationName string

A fully-qualified path representing project_location_conversation resource.
Returns
Type Description
string | number

{string} A string representing the conversation.

matchConversationFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName)

matchConversationFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName: string): string | number;

Parse the conversation from ProjectLocationConversationParticipant resource.

Parameter
Name Description
projectLocationConversationParticipantName string

A fully-qualified path representing project_location_conversation_participant resource.
Returns
Type Description
string | number

{string} A string representing the conversation.

matchConversationModelFromProjectConversationModelEvaluationName(projectConversationModelEvaluationName)

matchConversationModelFromProjectConversationModelEvaluationName(projectConversationModelEvaluationName: string): string | number;

Parse the conversation_model from ProjectConversationModelEvaluation resource.

Parameter
Name Description
projectConversationModelEvaluationName string

A fully-qualified path representing project_conversation_model_evaluation resource.
Returns
Type Description
string | number

{string} A string representing the conversation_model.

matchConversationModelFromProjectConversationModelName(projectConversationModelName)

matchConversationModelFromProjectConversationModelName(projectConversationModelName: string): string | number;

Parse the conversation_model from ProjectConversationModel resource.

Parameter
Name Description
projectConversationModelName string

A fully-qualified path representing project_conversation_model resource.
Returns
Type Description
string | number

{string} A string representing the conversation_model.

matchConversationModelFromProjectLocationConversationModelEvaluationName(projectLocationConversationModelEvaluationName)

matchConversationModelFromProjectLocationConversationModelEvaluationName(projectLocationConversationModelEvaluationName: string): string | number;

Parse the conversation_model from ProjectLocationConversationModelEvaluation resource.

Parameter
Name Description
projectLocationConversationModelEvaluationName string

A fully-qualified path representing project_location_conversation_model_evaluation resource.
Returns
Type Description
string | number

{string} A string representing the conversation_model.

matchConversationModelFromProjectLocationConversationModelName(projectLocationConversationModelName)

matchConversationModelFromProjectLocationConversationModelName(projectLocationConversationModelName: string): string | number;

Parse the conversation_model from ProjectLocationConversationModel resource.

Parameter
Name Description
projectLocationConversationModelName string

A fully-qualified path representing project_location_conversation_model resource.
Returns
Type Description
string | number

{string} A string representing the conversation_model.

matchConversationProfileFromProjectConversationProfileName(projectConversationProfileName)

matchConversationProfileFromProjectConversationProfileName(projectConversationProfileName: string): string | number;

Parse the conversation_profile from ProjectConversationProfile resource.

Parameter
Name Description
projectConversationProfileName string

A fully-qualified path representing project_conversation_profile resource.
Returns
Type Description
string | number

{string} A string representing the conversation_profile.

matchConversationProfileFromProjectLocationConversationProfileName(projectLocationConversationProfileName)

matchConversationProfileFromProjectLocationConversationProfileName(projectLocationConversationProfileName: string): string | number;

Parse the conversation_profile from ProjectLocationConversationProfile resource.

Parameter
Name Description
projectLocationConversationProfileName string

A fully-qualified path representing project_location_conversation_profile resource.
Returns
Type Description
string | number

{string} A string representing the conversation_profile.

matchDocumentFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName)

matchDocumentFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName: string): string | number;

Parse the document from ProjectKnowledgeBaseDocument resource.

Parameter
Name Description
projectKnowledgeBaseDocumentName string

A fully-qualified path representing project_knowledge_base_document resource.
Returns
Type Description
string | number

{string} A string representing the document.

matchDocumentFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName)

matchDocumentFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName: string): string | number;

Parse the document from ProjectLocationKnowledgeBaseDocument resource.

Parameter
Name Description
projectLocationKnowledgeBaseDocumentName string

A fully-qualified path representing project_location_knowledge_base_document resource.
Returns
Type Description
string | number

{string} A string representing the document.

matchEntityTypeFromProjectAgentEntityTypeName(projectAgentEntityTypeName)

matchEntityTypeFromProjectAgentEntityTypeName(projectAgentEntityTypeName: string): string | number;

Parse the entity_type from ProjectAgentEntityType resource.

Parameter
Name Description
projectAgentEntityTypeName string

A fully-qualified path representing project_agent_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the entity_type.

matchEntityTypeFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

matchEntityTypeFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the entity_type from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameter
Name Description
projectAgentEnvironmentUserSessionEntityTypeName string

A fully-qualified path representing project_agent_environment_user_session_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the entity_type.

matchEntityTypeFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)

matchEntityTypeFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number;

Parse the entity_type from ProjectAgentSessionEntityType resource.

Parameter
Name Description
projectAgentSessionEntityTypeName string

A fully-qualified path representing project_agent_session_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName)

matchEntityTypeFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName: string): string | number;

Parse the entity_type from ProjectLocationAgentEntityType resource.

Parameter
Name Description
projectLocationAgentEntityTypeName string

A fully-qualified path representing project_location_agent_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName)

matchEntityTypeFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the entity_type from ProjectLocationAgentEnvironmentUserSessionEntityType resource.

Parameter
Name Description
projectLocationAgentEnvironmentUserSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the entity_type from ProjectLocationAgentSessionEntityType resource.

Parameter
Name Description
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the entity_type.

matchEnvironmentFromProjectAgentEnvironmentName(projectAgentEnvironmentName)

matchEnvironmentFromProjectAgentEnvironmentName(projectAgentEnvironmentName: string): string | number;

Parse the environment from ProjectAgentEnvironment resource.

Parameter
Name Description
projectAgentEnvironmentName string

A fully-qualified path representing project_agent_environment resource.
Returns
Type Description
string | number

{string} A string representing the environment.

matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;

Parse the environment from ProjectAgentEnvironmentUserSessionContext resource.

Parameter
Name Description
projectAgentEnvironmentUserSessionContextName string

A fully-qualified path representing project_agent_environment_user_session_context resource.
Returns
Type Description
string | number

{string} A string representing the environment.

matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the environment from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameter
Name Description
projectAgentEnvironmentUserSessionEntityTypeName string

A fully-qualified path representing project_agent_environment_user_session_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the environment.

matchEnvironmentFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName)

matchEnvironmentFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName: string): string | number;

Parse the environment from ProjectLocationAgentEnvironment resource.

Parameter
Name Description
projectLocationAgentEnvironmentName string

A fully-qualified path representing project_location_agent_environment resource.
Returns
Type Description
string | number

{string} A string representing the environment.

matchEnvironmentFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName)

matchEnvironmentFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName: string): string | number;

Parse the environment from ProjectLocationAgentEnvironmentUserSessionContext resource.

Parameter
Name Description
projectLocationAgentEnvironmentUserSessionContextName string

A fully-qualified path representing project_location_agent_environment_user_session_context resource.
Returns
Type Description
string | number

{string} A string representing the environment.

matchEnvironmentFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName)

matchEnvironmentFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the environment from ProjectLocationAgentEnvironmentUserSessionEntityType resource.

Parameter
Name Description
projectLocationAgentEnvironmentUserSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the environment.

matchEvaluationFromProjectConversationModelEvaluationName(projectConversationModelEvaluationName)

matchEvaluationFromProjectConversationModelEvaluationName(projectConversationModelEvaluationName: string): string | number;

Parse the evaluation from ProjectConversationModelEvaluation resource.

Parameter
Name Description
projectConversationModelEvaluationName string

A fully-qualified path representing project_conversation_model_evaluation resource.
Returns
Type Description
string | number

{string} A string representing the evaluation.

matchEvaluationFromProjectLocationConversationModelEvaluationName(projectLocationConversationModelEvaluationName)

matchEvaluationFromProjectLocationConversationModelEvaluationName(projectLocationConversationModelEvaluationName: string): string | number;

Parse the evaluation from ProjectLocationConversationModelEvaluation resource.

Parameter
Name Description
projectLocationConversationModelEvaluationName string

A fully-qualified path representing project_location_conversation_model_evaluation resource.
Returns
Type Description
string | number

{string} A string representing the evaluation.

matchGeneratorFromGeneratorName(generatorName)

matchGeneratorFromGeneratorName(generatorName: string): string | number;

Parse the generator from Generator resource.

Parameter
Name Description
generatorName string

A fully-qualified path representing Generator resource.
Returns
Type Description
string | number

{string} A string representing the generator.

matchIntentFromProjectAgentIntentName(projectAgentIntentName)

matchIntentFromProjectAgentIntentName(projectAgentIntentName: string): string | number;

Parse the intent from ProjectAgentIntent resource.

Parameter
Name Description
projectAgentIntentName string

A fully-qualified path representing project_agent_intent resource.
Returns
Type Description
string | number

{string} A string representing the intent.

matchIntentFromProjectLocationAgentIntentName(projectLocationAgentIntentName)

matchIntentFromProjectLocationAgentIntentName(projectLocationAgentIntentName: string): string | number;

Parse the intent from ProjectLocationAgentIntent resource.

Parameter
Name Description
projectLocationAgentIntentName string

A fully-qualified path representing project_location_agent_intent resource.
Returns
Type Description
string | number

{string} A string representing the intent.

matchKnowledgeBaseFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName)

matchKnowledgeBaseFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName: string): string | number;

Parse the knowledge_base from ProjectKnowledgeBaseDocument resource.

Parameter
Name Description
projectKnowledgeBaseDocumentName string

A fully-qualified path representing project_knowledge_base_document resource.
Returns
Type Description
string | number

{string} A string representing the knowledge_base.

matchKnowledgeBaseFromProjectKnowledgeBaseName(projectKnowledgeBaseName)

matchKnowledgeBaseFromProjectKnowledgeBaseName(projectKnowledgeBaseName: string): string | number;

Parse the knowledge_base from ProjectKnowledgeBase resource.

Parameter
Name Description
projectKnowledgeBaseName string

A fully-qualified path representing project_knowledge_base resource.
Returns
Type Description
string | number

{string} A string representing the knowledge_base.

matchKnowledgeBaseFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName)

matchKnowledgeBaseFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName: string): string | number;

Parse the knowledge_base from ProjectLocationKnowledgeBaseDocument resource.

Parameter
Name Description
projectLocationKnowledgeBaseDocumentName string

A fully-qualified path representing project_location_knowledge_base_document resource.
Returns
Type Description
string | number

{string} A string representing the knowledge_base.

matchKnowledgeBaseFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName)

matchKnowledgeBaseFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName: string): string | number;

Parse the knowledge_base from ProjectLocationKnowledgeBase resource.

Parameter
Name Description
projectLocationKnowledgeBaseName string

A fully-qualified path representing project_location_knowledge_base resource.
Returns
Type Description
string | number

{string} A string representing the knowledge_base.

matchLocationFromConversationDatasetName(conversationDatasetName)

matchLocationFromConversationDatasetName(conversationDatasetName: string): string | number;

Parse the location from ConversationDataset resource.

Parameter
Name Description
conversationDatasetName string

A fully-qualified path representing ConversationDataset resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromEncryptionSpecName(encryptionSpecName)

matchLocationFromEncryptionSpecName(encryptionSpecName: string): string | number;

Parse the location from EncryptionSpec resource.

Parameter
Name Description
encryptionSpecName string

A fully-qualified path representing EncryptionSpec resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromGeneratorName(generatorName)

matchLocationFromGeneratorName(generatorName: string): string | number;

Parse the location from Generator resource.

Parameter
Name Description
generatorName string

A fully-qualified path representing Generator resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName)

matchLocationFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName: string): string | number;

Parse the location from ProjectLocationAgentEntityType resource.

Parameter
Name Description
projectLocationAgentEntityTypeName string

A fully-qualified path representing project_location_agent_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName)

matchLocationFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName: string): string | number;

Parse the location from ProjectLocationAgentEnvironment resource.

Parameter
Name Description
projectLocationAgentEnvironmentName string

A fully-qualified path representing project_location_agent_environment resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName)

matchLocationFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName: string): string | number;

Parse the location from ProjectLocationAgentEnvironmentUserSessionContext resource.

Parameter
Name Description
projectLocationAgentEnvironmentUserSessionContextName string

A fully-qualified path representing project_location_agent_environment_user_session_context resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName)

matchLocationFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the location from ProjectLocationAgentEnvironmentUserSessionEntityType resource.

Parameter
Name Description
projectLocationAgentEnvironmentUserSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAgentFulfillmentName(projectLocationAgentFulfillmentName)

matchLocationFromProjectLocationAgentFulfillmentName(projectLocationAgentFulfillmentName: string): string | number;

Parse the location from ProjectLocationAgentFulfillment resource.

Parameter
Name Description
projectLocationAgentFulfillmentName string

A fully-qualified path representing project_location_agent_fulfillment resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAgentIntentName(projectLocationAgentIntentName)

matchLocationFromProjectLocationAgentIntentName(projectLocationAgentIntentName: string): string | number;

Parse the location from ProjectLocationAgentIntent resource.

Parameter
Name Description
projectLocationAgentIntentName string

A fully-qualified path representing project_location_agent_intent resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAgentName(projectLocationAgentName)

matchLocationFromProjectLocationAgentName(projectLocationAgentName: string): string | number;

Parse the location from ProjectLocationAgent resource.

Parameter
Name Description
projectLocationAgentName string

A fully-qualified path representing project_location_agent resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName)

matchLocationFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName: string): string | number;

Parse the location from ProjectLocationAgentSessionContext resource.

Parameter
Name Description
projectLocationAgentSessionContextName string

A fully-qualified path representing project_location_agent_session_context resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the location from ProjectLocationAgentSessionEntityType resource.

Parameter
Name Description
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAgentVersionName(projectLocationAgentVersionName)

matchLocationFromProjectLocationAgentVersionName(projectLocationAgentVersionName: string): string | number;

Parse the location from ProjectLocationAgentVersion resource.

Parameter
Name Description
projectLocationAgentVersionName string

A fully-qualified path representing project_location_agent_version resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName)

matchLocationFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName: string): string | number;

Parse the location from ProjectLocationAnswerRecord resource.

Parameter
Name Description
projectLocationAnswerRecordName string

A fully-qualified path representing project_location_answer_record resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationConversationMessageName(projectLocationConversationMessageName)

matchLocationFromProjectLocationConversationMessageName(projectLocationConversationMessageName: string): string | number;

Parse the location from ProjectLocationConversationMessage resource.

Parameter
Name Description
projectLocationConversationMessageName string

A fully-qualified path representing project_location_conversation_message resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationConversationModelEvaluationName(projectLocationConversationModelEvaluationName)

matchLocationFromProjectLocationConversationModelEvaluationName(projectLocationConversationModelEvaluationName: string): string | number;

Parse the location from ProjectLocationConversationModelEvaluation resource.

Parameter
Name Description
projectLocationConversationModelEvaluationName string

A fully-qualified path representing project_location_conversation_model_evaluation resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationConversationModelName(projectLocationConversationModelName)

matchLocationFromProjectLocationConversationModelName(projectLocationConversationModelName: string): string | number;

Parse the location from ProjectLocationConversationModel resource.

Parameter
Name Description
projectLocationConversationModelName string

A fully-qualified path representing project_location_conversation_model resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationConversationName(projectLocationConversationName)

matchLocationFromProjectLocationConversationName(projectLocationConversationName: string): string | number;

Parse the location from ProjectLocationConversation resource.

Parameter
Name Description
projectLocationConversationName string

A fully-qualified path representing project_location_conversation resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName)

matchLocationFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName: string): string | number;

Parse the location from ProjectLocationConversationParticipant resource.

Parameter
Name Description
projectLocationConversationParticipantName string

A fully-qualified path representing project_location_conversation_participant resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationConversationProfileName(projectLocationConversationProfileName)

matchLocationFromProjectLocationConversationProfileName(projectLocationConversationProfileName: string): string | number;

Parse the location from ProjectLocationConversationProfile resource.

Parameter
Name Description
projectLocationConversationProfileName string

A fully-qualified path representing project_location_conversation_profile resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName)

matchLocationFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName: string): string | number;

Parse the location from ProjectLocationKnowledgeBaseDocument resource.

Parameter
Name Description
projectLocationKnowledgeBaseDocumentName string

A fully-qualified path representing project_location_knowledge_base_document resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName)

matchLocationFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName: string): string | number;

Parse the location from ProjectLocationKnowledgeBase resource.

Parameter
Name Description
projectLocationKnowledgeBaseName string

A fully-qualified path representing project_location_knowledge_base resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchMessageFromProjectConversationMessageName(projectConversationMessageName)

matchMessageFromProjectConversationMessageName(projectConversationMessageName: string): string | number;

Parse the message from ProjectConversationMessage resource.

Parameter
Name Description
projectConversationMessageName string

A fully-qualified path representing project_conversation_message resource.
Returns
Type Description
string | number

{string} A string representing the message.

matchMessageFromProjectLocationConversationMessageName(projectLocationConversationMessageName)

matchMessageFromProjectLocationConversationMessageName(projectLocationConversationMessageName: string): string | number;

Parse the message from ProjectLocationConversationMessage resource.

Parameter
Name Description
projectLocationConversationMessageName string

A fully-qualified path representing project_location_conversation_message resource.
Returns
Type Description
string | number

{string} A string representing the message.

matchParticipantFromProjectConversationParticipantName(projectConversationParticipantName)

matchParticipantFromProjectConversationParticipantName(projectConversationParticipantName: string): string | number;

Parse the participant from ProjectConversationParticipant resource.

Parameter
Name Description
projectConversationParticipantName string

A fully-qualified path representing project_conversation_participant resource.
Returns
Type Description
string | number

{string} A string representing the participant.

matchParticipantFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName)

matchParticipantFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName: string): string | number;

Parse the participant from ProjectLocationConversationParticipant resource.

Parameter
Name Description
projectLocationConversationParticipantName string

A fully-qualified path representing project_location_conversation_participant resource.
Returns
Type Description
string | number

{string} A string representing the participant.

matchProjectFromConversationDatasetName(conversationDatasetName)

matchProjectFromConversationDatasetName(conversationDatasetName: string): string | number;

Parse the project from ConversationDataset resource.

Parameter
Name Description
conversationDatasetName string

A fully-qualified path representing ConversationDataset resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromEncryptionSpecName(encryptionSpecName)

matchProjectFromEncryptionSpecName(encryptionSpecName: string): string | number;

Parse the project from EncryptionSpec resource.

Parameter
Name Description
encryptionSpecName string

A fully-qualified path representing EncryptionSpec resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromGeneratorName(generatorName)

matchProjectFromGeneratorName(generatorName: string): string | number;

Parse the project from Generator resource.

Parameter
Name Description
generatorName string

A fully-qualified path representing Generator resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectAgentEntityTypeName(projectAgentEntityTypeName)

matchProjectFromProjectAgentEntityTypeName(projectAgentEntityTypeName: string): string | number;

Parse the project from ProjectAgentEntityType resource.

Parameter
Name Description
projectAgentEntityTypeName string

A fully-qualified path representing project_agent_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectAgentEnvironmentName(projectAgentEnvironmentName)

matchProjectFromProjectAgentEnvironmentName(projectAgentEnvironmentName: string): string | number;

Parse the project from ProjectAgentEnvironment resource.

Parameter
Name Description
projectAgentEnvironmentName string

A fully-qualified path representing project_agent_environment resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;

Parse the project from ProjectAgentEnvironmentUserSessionContext resource.

Parameter
Name Description
projectAgentEnvironmentUserSessionContextName string

A fully-qualified path representing project_agent_environment_user_session_context resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the project from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameter
Name Description
projectAgentEnvironmentUserSessionEntityTypeName string

A fully-qualified path representing project_agent_environment_user_session_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectAgentFulfillmentName(projectAgentFulfillmentName)

matchProjectFromProjectAgentFulfillmentName(projectAgentFulfillmentName: string): string | number;

Parse the project from ProjectAgentFulfillment resource.

Parameter
Name Description
projectAgentFulfillmentName string

A fully-qualified path representing project_agent_fulfillment resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectAgentIntentName(projectAgentIntentName)

matchProjectFromProjectAgentIntentName(projectAgentIntentName: string): string | number;

Parse the project from ProjectAgentIntent resource.

Parameter
Name Description
projectAgentIntentName string

A fully-qualified path representing project_agent_intent resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectAgentName(projectAgentName)

matchProjectFromProjectAgentName(projectAgentName: string): string | number;

Parse the project from ProjectAgent resource.

Parameter
Name Description
projectAgentName string

A fully-qualified path representing project_agent resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectAgentSessionContextName(projectAgentSessionContextName)

matchProjectFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number;

Parse the project from ProjectAgentSessionContext resource.

Parameter
Name Description
projectAgentSessionContextName string

A fully-qualified path representing project_agent_session_context resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)

matchProjectFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number;

Parse the project from ProjectAgentSessionEntityType resource.

Parameter
Name Description
projectAgentSessionEntityTypeName string

A fully-qualified path representing project_agent_session_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectAgentVersionName(projectAgentVersionName)

matchProjectFromProjectAgentVersionName(projectAgentVersionName: string): string | number;

Parse the project from ProjectAgentVersion resource.

Parameter
Name Description
projectAgentVersionName string

A fully-qualified path representing project_agent_version resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectAnswerRecordName(projectAnswerRecordName)

matchProjectFromProjectAnswerRecordName(projectAnswerRecordName: string): string | number;

Parse the project from ProjectAnswerRecord resource.

Parameter
Name Description
projectAnswerRecordName string

A fully-qualified path representing project_answer_record resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectConversationMessageName(projectConversationMessageName)

matchProjectFromProjectConversationMessageName(projectConversationMessageName: string): string | number;

Parse the project from ProjectConversationMessage resource.

Parameter
Name Description
projectConversationMessageName string

A fully-qualified path representing project_conversation_message resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectConversationModelEvaluationName(projectConversationModelEvaluationName)

matchProjectFromProjectConversationModelEvaluationName(projectConversationModelEvaluationName: string): string | number;

Parse the project from ProjectConversationModelEvaluation resource.

Parameter
Name Description
projectConversationModelEvaluationName string

A fully-qualified path representing project_conversation_model_evaluation resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectConversationModelName(projectConversationModelName)

matchProjectFromProjectConversationModelName(projectConversationModelName: string): string | number;

Parse the project from ProjectConversationModel resource.

Parameter
Name Description
projectConversationModelName string

A fully-qualified path representing project_conversation_model resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectConversationName(projectConversationName)

matchProjectFromProjectConversationName(projectConversationName: string): string | number;

Parse the project from ProjectConversation resource.

Parameter
Name Description
projectConversationName string

A fully-qualified path representing project_conversation resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectConversationParticipantName(projectConversationParticipantName)

matchProjectFromProjectConversationParticipantName(projectConversationParticipantName: string): string | number;

Parse the project from ProjectConversationParticipant resource.

Parameter
Name Description
projectConversationParticipantName string

A fully-qualified path representing project_conversation_participant resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectConversationProfileName(projectConversationProfileName)

matchProjectFromProjectConversationProfileName(projectConversationProfileName: string): string | number;

Parse the project from ProjectConversationProfile resource.

Parameter
Name Description
projectConversationProfileName string

A fully-qualified path representing project_conversation_profile resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName)

matchProjectFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName: string): string | number;

Parse the project from ProjectKnowledgeBaseDocument resource.

Parameter
Name Description
projectKnowledgeBaseDocumentName string

A fully-qualified path representing project_knowledge_base_document resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectKnowledgeBaseName(projectKnowledgeBaseName)

matchProjectFromProjectKnowledgeBaseName(projectKnowledgeBaseName: string): string | number;

Parse the project from ProjectKnowledgeBase resource.

Parameter
Name Description
projectKnowledgeBaseName string

A fully-qualified path representing project_knowledge_base resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName)

matchProjectFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName: string): string | number;

Parse the project from ProjectLocationAgentEntityType resource.

Parameter
Name Description
projectLocationAgentEntityTypeName string

A fully-qualified path representing project_location_agent_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName)

matchProjectFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName: string): string | number;

Parse the project from ProjectLocationAgentEnvironment resource.

Parameter
Name Description
projectLocationAgentEnvironmentName string

A fully-qualified path representing project_location_agent_environment resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName)

matchProjectFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName: string): string | number;

Parse the project from ProjectLocationAgentEnvironmentUserSessionContext resource.

Parameter
Name Description
projectLocationAgentEnvironmentUserSessionContextName string

A fully-qualified path representing project_location_agent_environment_user_session_context resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName)

matchProjectFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the project from ProjectLocationAgentEnvironmentUserSessionEntityType resource.

Parameter
Name Description
projectLocationAgentEnvironmentUserSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAgentFulfillmentName(projectLocationAgentFulfillmentName)

matchProjectFromProjectLocationAgentFulfillmentName(projectLocationAgentFulfillmentName: string): string | number;

Parse the project from ProjectLocationAgentFulfillment resource.

Parameter
Name Description
projectLocationAgentFulfillmentName string

A fully-qualified path representing project_location_agent_fulfillment resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAgentIntentName(projectLocationAgentIntentName)

matchProjectFromProjectLocationAgentIntentName(projectLocationAgentIntentName: string): string | number;

Parse the project from ProjectLocationAgentIntent resource.

Parameter
Name Description
projectLocationAgentIntentName string

A fully-qualified path representing project_location_agent_intent resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAgentName(projectLocationAgentName)

matchProjectFromProjectLocationAgentName(projectLocationAgentName: string): string | number;

Parse the project from ProjectLocationAgent resource.

Parameter
Name Description
projectLocationAgentName string

A fully-qualified path representing project_location_agent resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName)

matchProjectFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName: string): string | number;

Parse the project from ProjectLocationAgentSessionContext resource.

Parameter
Name Description
projectLocationAgentSessionContextName string

A fully-qualified path representing project_location_agent_session_context resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the project from ProjectLocationAgentSessionEntityType resource.

Parameter
Name Description
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAgentVersionName(projectLocationAgentVersionName)

matchProjectFromProjectLocationAgentVersionName(projectLocationAgentVersionName: string): string | number;

Parse the project from ProjectLocationAgentVersion resource.

Parameter
Name Description
projectLocationAgentVersionName string

A fully-qualified path representing project_location_agent_version resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName)

matchProjectFromProjectLocationAnswerRecordName(projectLocationAnswerRecordName: string): string | number;

Parse the project from ProjectLocationAnswerRecord resource.

Parameter
Name Description
projectLocationAnswerRecordName string

A fully-qualified path representing project_location_answer_record resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationConversationMessageName(projectLocationConversationMessageName)

matchProjectFromProjectLocationConversationMessageName(projectLocationConversationMessageName: string): string | number;

Parse the project from ProjectLocationConversationMessage resource.

Parameter
Name Description
projectLocationConversationMessageName string

A fully-qualified path representing project_location_conversation_message resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationConversationModelEvaluationName(projectLocationConversationModelEvaluationName)

matchProjectFromProjectLocationConversationModelEvaluationName(projectLocationConversationModelEvaluationName: string): string | number;

Parse the project from ProjectLocationConversationModelEvaluation resource.

Parameter
Name Description
projectLocationConversationModelEvaluationName string

A fully-qualified path representing project_location_conversation_model_evaluation resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationConversationModelName(projectLocationConversationModelName)

matchProjectFromProjectLocationConversationModelName(projectLocationConversationModelName: string): string | number;

Parse the project from ProjectLocationConversationModel resource.

Parameter
Name Description
projectLocationConversationModelName string

A fully-qualified path representing project_location_conversation_model resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationConversationName(projectLocationConversationName)

matchProjectFromProjectLocationConversationName(projectLocationConversationName: string): string | number;

Parse the project from ProjectLocationConversation resource.

Parameter
Name Description
projectLocationConversationName string

A fully-qualified path representing project_location_conversation resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName)

matchProjectFromProjectLocationConversationParticipantName(projectLocationConversationParticipantName: string): string | number;

Parse the project from ProjectLocationConversationParticipant resource.

Parameter
Name Description
projectLocationConversationParticipantName string

A fully-qualified path representing project_location_conversation_participant resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationConversationProfileName(projectLocationConversationProfileName)

matchProjectFromProjectLocationConversationProfileName(projectLocationConversationProfileName: string): string | number;

Parse the project from ProjectLocationConversationProfile resource.

Parameter
Name Description
projectLocationConversationProfileName string

A fully-qualified path representing project_location_conversation_profile resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName)

matchProjectFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName: string): string | number;

Parse the project from ProjectLocationKnowledgeBaseDocument resource.

Parameter
Name Description
projectLocationKnowledgeBaseDocumentName string

A fully-qualified path representing project_location_knowledge_base_document resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName)

matchProjectFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName: string): string | number;

Parse the project from ProjectLocationKnowledgeBase resource.

Parameter
Name Description
projectLocationKnowledgeBaseName string

A fully-qualified path representing project_location_knowledge_base resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name Description
projectName string

A fully-qualified path representing Project resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchSessionFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

matchSessionFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;

Parse the session from ProjectAgentEnvironmentUserSessionContext resource.

Parameter
Name Description
projectAgentEnvironmentUserSessionContextName string

A fully-qualified path representing project_agent_environment_user_session_context resource.
Returns
Type Description
string | number

{string} A string representing the session.

matchSessionFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

matchSessionFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the session from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameter
Name Description
projectAgentEnvironmentUserSessionEntityTypeName string

A fully-qualified path representing project_agent_environment_user_session_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the session.

matchSessionFromProjectAgentSessionContextName(projectAgentSessionContextName)

matchSessionFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number;

Parse the session from ProjectAgentSessionContext resource.

Parameter
Name Description
projectAgentSessionContextName string

A fully-qualified path representing project_agent_session_context resource.
Returns
Type Description
string | number

{string} A string representing the session.

matchSessionFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)

matchSessionFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number;

Parse the session from ProjectAgentSessionEntityType resource.

Parameter
Name Description
projectAgentSessionEntityTypeName string

A fully-qualified path representing project_agent_session_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the session.

matchSessionFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName)

matchSessionFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName: string): string | number;

Parse the session from ProjectLocationAgentEnvironmentUserSessionContext resource.

Parameter
Name Description
projectLocationAgentEnvironmentUserSessionContextName string

A fully-qualified path representing project_location_agent_environment_user_session_context resource.
Returns
Type Description
string | number

{string} A string representing the session.

matchSessionFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName)

matchSessionFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the session from ProjectLocationAgentEnvironmentUserSessionEntityType resource.

Parameter
Name Description
projectLocationAgentEnvironmentUserSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the session.

matchSessionFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName)

matchSessionFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName: string): string | number;

Parse the session from ProjectLocationAgentSessionContext resource.

Parameter
Name Description
projectLocationAgentSessionContextName string

A fully-qualified path representing project_location_agent_session_context resource.
Returns
Type Description
string | number

{string} A string representing the session.

matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the session from ProjectLocationAgentSessionEntityType resource.

Parameter
Name Description
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the session.

matchUserFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

matchUserFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;

Parse the user from ProjectAgentEnvironmentUserSessionContext resource.

Parameter
Name Description
projectAgentEnvironmentUserSessionContextName string

A fully-qualified path representing project_agent_environment_user_session_context resource.
Returns
Type Description
string | number

{string} A string representing the user.

matchUserFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

matchUserFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the user from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameter
Name Description
projectAgentEnvironmentUserSessionEntityTypeName string

A fully-qualified path representing project_agent_environment_user_session_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the user.

matchUserFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName)

matchUserFromProjectLocationAgentEnvironmentUserSessionContextName(projectLocationAgentEnvironmentUserSessionContextName: string): string | number;

Parse the user from ProjectLocationAgentEnvironmentUserSessionContext resource.

Parameter
Name Description
projectLocationAgentEnvironmentUserSessionContextName string

A fully-qualified path representing project_location_agent_environment_user_session_context resource.
Returns
Type Description
string | number

{string} A string representing the user.

matchUserFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName)

matchUserFromProjectLocationAgentEnvironmentUserSessionEntityTypeName(projectLocationAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the user from ProjectLocationAgentEnvironmentUserSessionEntityType resource.

Parameter
Name Description
projectLocationAgentEnvironmentUserSessionEntityTypeName string

A fully-qualified path representing project_location_agent_environment_user_session_entity_type resource.
Returns
Type Description
string | number

{string} A string representing the user.

matchVersionFromProjectAgentVersionName(projectAgentVersionName)

matchVersionFromProjectAgentVersionName(projectAgentVersionName: string): string | number;

Parse the version from ProjectAgentVersion resource.

Parameter
Name Description
projectAgentVersionName string

A fully-qualified path representing project_agent_version resource.
Returns
Type Description
string | number

{string} A string representing the version.

matchVersionFromProjectLocationAgentVersionName(projectLocationAgentVersionName)

matchVersionFromProjectLocationAgentVersionName(projectLocationAgentVersionName: string): string | number;

Parse the version from ProjectLocationAgentVersion resource.

Parameter
Name Description
projectLocationAgentVersionName string

A fully-qualified path representing project_location_agent_version resource.
Returns
Type Description
string | number

{string} A string representing the version.

projectAgentEntityTypePath(project, entityType)

projectAgentEntityTypePath(project: string, entityType: string): string;

Return a fully-qualified projectAgentEntityType resource name string.

Parameters
Name Description
project string
entityType string
Returns
Type Description
string

{string} Resource name string.

projectAgentEnvironmentPath(project, environment)

projectAgentEnvironmentPath(project: string, environment: string): string;

Return a fully-qualified projectAgentEnvironment resource name string.

Parameters
Name Description
project string
environment string
Returns
Type Description
string

{string} Resource name string.

projectAgentEnvironmentUserSessionContextPath(project, environment, user, session, context)

projectAgentEnvironmentUserSessionContextPath(project: string, environment: string, user: string, session: string, context: string): string;

Return a fully-qualified projectAgentEnvironmentUserSessionContext resource name string.

Parameters
Name Description
project string
environment string
user string
session string
context string
Returns
Type Description
string

{string} Resource name string.

projectAgentEnvironmentUserSessionEntityTypePath(project, environment, user, session, entityType)

projectAgentEnvironmentUserSessionEntityTypePath(project: string, environment: string, user: string, session: string, entityType: string): string;

Return a fully-qualified projectAgentEnvironmentUserSessionEntityType resource name string.

Parameters
Name Description
project string
environment string
user string
session string
entityType string
Returns
Type Description
string

{string} Resource name string.

projectAgentFulfillmentPath(project)

projectAgentFulfillmentPath(project: string): string;

Return a fully-qualified projectAgentFulfillment resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

projectAgentIntentPath(project, intent)

projectAgentIntentPath(project: string, intent: string): string;

Return a fully-qualified projectAgentIntent resource name string.

Parameters
Name Description
project string
intent string
Returns
Type Description
string

{string} Resource name string.

projectAgentPath(project)

projectAgentPath(project: string): string;

Return a fully-qualified projectAgent resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

projectAgentSessionContextPath(project, session, context)

projectAgentSessionContextPath(project: string, session: string, context: string): string;

Return a fully-qualified projectAgentSessionContext resource name string.

Parameters
Name Description
project string
session string
context string
Returns
Type Description
string

{string} Resource name string.

projectAgentSessionEntityTypePath(project, session, entityType)

projectAgentSessionEntityTypePath(project: string, session: string, entityType: string): string;

Return a fully-qualified projectAgentSessionEntityType resource name string.

Parameters
Name Description
project string
session string
entityType string
Returns
Type Description
string

{string} Resource name string.

projectAgentVersionPath(project, version)

projectAgentVersionPath(project: string, version: string): string;

Return a fully-qualified projectAgentVersion resource name string.

Parameters
Name Description
project string
version string
Returns
Type Description
string

{string} Resource name string.

projectAnswerRecordPath(project, answerRecord)

projectAnswerRecordPath(project: string, answerRecord: string): string;

Return a fully-qualified projectAnswerRecord resource name string.

Parameters
Name Description
project string
answerRecord string
Returns
Type Description
string

{string} Resource name string.

projectConversationMessagePath(project, conversation, message)

projectConversationMessagePath(project: string, conversation: string, message: string): string;

Return a fully-qualified projectConversationMessage resource name string.

Parameters
Name Description
project string
conversation string
message string
Returns
Type Description
string

{string} Resource name string.

projectConversationModelEvaluationPath(project, conversationModel, evaluation)

projectConversationModelEvaluationPath(project: string, conversationModel: string, evaluation: string): string;

Return a fully-qualified projectConversationModelEvaluation resource name string.

Parameters
Name Description
project string
conversationModel string
evaluation string
Returns
Type Description
string

{string} Resource name string.

projectConversationModelPath(project, conversationModel)

projectConversationModelPath(project: string, conversationModel: string): string;

Return a fully-qualified projectConversationModel resource name string.

Parameters
Name Description
project string
conversationModel string
Returns
Type Description
string

{string} Resource name string.

projectConversationParticipantPath(project, conversation, participant)

projectConversationParticipantPath(project: string, conversation: string, participant: string): string;

Return a fully-qualified projectConversationParticipant resource name string.

Parameters
Name Description
project string
conversation string
participant string
Returns
Type Description
string

{string} Resource name string.

projectConversationPath(project, conversation)

projectConversationPath(project: string, conversation: string): string;

Return a fully-qualified projectConversation resource name string.

Parameters
Name Description
project string
conversation string
Returns
Type Description
string

{string} Resource name string.

projectConversationProfilePath(project, conversationProfile)

projectConversationProfilePath(project: string, conversationProfile: string): string;

Return a fully-qualified projectConversationProfile resource name string.

Parameters
Name Description
project string
conversationProfile string
Returns
Type Description
string

{string} Resource name string.

projectKnowledgeBaseDocumentPath(project, knowledgeBase, document)

projectKnowledgeBaseDocumentPath(project: string, knowledgeBase: string, document: string): string;

Return a fully-qualified projectKnowledgeBaseDocument resource name string.

Parameters
Name Description
project string
knowledgeBase string
document string
Returns
Type Description
string

{string} Resource name string.

projectKnowledgeBasePath(project, knowledgeBase)

projectKnowledgeBasePath(project: string, knowledgeBase: string): string;

Return a fully-qualified projectKnowledgeBase resource name string.

Parameters
Name Description
project string
knowledgeBase string
Returns
Type Description
string

{string} Resource name string.

projectLocationAgentEntityTypePath(project, location, entityType)

projectLocationAgentEntityTypePath(project: string, location: string, entityType: string): string;

Return a fully-qualified projectLocationAgentEntityType resource name string.

Parameters
Name Description
project string
location string
entityType string
Returns
Type Description
string

{string} Resource name string.

projectLocationAgentEnvironmentPath(project, location, environment)

projectLocationAgentEnvironmentPath(project: string, location: string, environment: string): string;

Return a fully-qualified projectLocationAgentEnvironment resource name string.

Parameters
Name Description
project string
location string
environment string
Returns
Type Description
string

{string} Resource name string.

projectLocationAgentEnvironmentUserSessionContextPath(project, location, environment, user, session, context)

projectLocationAgentEnvironmentUserSessionContextPath(project: string, location: string, environment: string, user: string, session: string, context: string): string;

Return a fully-qualified projectLocationAgentEnvironmentUserSessionContext resource name string.

Parameters
Name Description
project string
location string
environment string
user string
session string
context string
Returns
Type Description
string

{string} Resource name string.

projectLocationAgentEnvironmentUserSessionEntityTypePath(project, location, environment, user, session, entityType)

projectLocationAgentEnvironmentUserSessionEntityTypePath(project: string, location: string, environment: string, user: string, session: string, entityType: string): string;

Return a fully-qualified projectLocationAgentEnvironmentUserSessionEntityType resource name string.

Parameters
Name Description
project string
location string
environment string
user string
session string
entityType string
Returns
Type Description
string

{string} Resource name string.

projectLocationAgentFulfillmentPath(project, location)

projectLocationAgentFulfillmentPath(project: string, location: string): string;

Return a fully-qualified projectLocationAgentFulfillment resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

projectLocationAgentIntentPath(project, location, intent)

projectLocationAgentIntentPath(project: string, location: string, intent: string): string;

Return a fully-qualified projectLocationAgentIntent resource name string.

Parameters
Name Description
project string
location string
intent string
Returns
Type Description
string

{string} Resource name string.

projectLocationAgentPath(project, location)

projectLocationAgentPath(project: string, location: string): string;

Return a fully-qualified projectLocationAgent resource name string.

Parameters
Name Description
project string
location string
Returns
Type Description
string

{string} Resource name string.

projectLocationAgentSessionContextPath(project, location, session, context)

projectLocationAgentSessionContextPath(project: string, location: string, session: string, context: string): string;

Return a fully-qualified projectLocationAgentSessionContext resource name string.

Parameters
Name Description
project string
location string
session string
context string
Returns
Type Description
string

{string} Resource name string.

projectLocationAgentSessionEntityTypePath(project, location, session, entityType)

projectLocationAgentSessionEntityTypePath(project: string, location: string, session: string, entityType: string): string;

Return a fully-qualified projectLocationAgentSessionEntityType resource name string.

Parameters
Name Description
project string
location string
session string
entityType string
Returns
Type Description
string

{string} Resource name string.

projectLocationAgentVersionPath(project, location, version)

projectLocationAgentVersionPath(project: string, location: string, version: string): string;

Return a fully-qualified projectLocationAgentVersion resource name string.

Parameters
Name Description
project string
location string
version string
Returns
Type Description
string

{string} Resource name string.

projectLocationAnswerRecordPath(project, location, answerRecord)

projectLocationAnswerRecordPath(project: string, location: string, answerRecord: string): string;

Return a fully-qualified projectLocationAnswerRecord resource name string.

Parameters
Name Description
project string
location string
answerRecord string
Returns
Type Description
string

{string} Resource name string.

projectLocationConversationMessagePath(project, location, conversation, message)

projectLocationConversationMessagePath(project: string, location: string, conversation: string, message: string): string;

Return a fully-qualified projectLocationConversationMessage resource name string.

Parameters
Name Description
project string
location string
conversation string
message string
Returns
Type Description
string

{string} Resource name string.

projectLocationConversationModelEvaluationPath(project, location, conversationModel, evaluation)

projectLocationConversationModelEvaluationPath(project: string, location: string, conversationModel: string, evaluation: string): string;

Return a fully-qualified projectLocationConversationModelEvaluation resource name string.

Parameters
Name Description
project string
location string
conversationModel string
evaluation string
Returns
Type Description
string

{string} Resource name string.

projectLocationConversationModelPath(project, location, conversationModel)

projectLocationConversationModelPath(project: string, location: string, conversationModel: string): string;

Return a fully-qualified projectLocationConversationModel resource name string.

Parameters
Name Description
project string
location string
conversationModel string
Returns
Type Description
string

{string} Resource name string.

projectLocationConversationParticipantPath(project, location, conversation, participant)

projectLocationConversationParticipantPath(project: string, location: string, conversation: string, participant: string): string;

Return a fully-qualified projectLocationConversationParticipant resource name string.

Parameters
Name Description
project string
location string
conversation string
participant string
Returns
Type Description
string

{string} Resource name string.

projectLocationConversationPath(project, location, conversation)

projectLocationConversationPath(project: string, location: string, conversation: string): string;

Return a fully-qualified projectLocationConversation resource name string.

Parameters
Name Description
project string
location string
conversation string
Returns
Type Description
string

{string} Resource name string.

projectLocationConversationProfilePath(project, location, conversationProfile)

projectLocationConversationProfilePath(project: string, location: string, conversationProfile: string): string;

Return a fully-qualified projectLocationConversationProfile resource name string.

Parameters
Name Description
project string
location string
conversationProfile string
Returns
Type Description
string

{string} Resource name string.

projectLocationKnowledgeBaseDocumentPath(project, location, knowledgeBase, document)

projectLocationKnowledgeBaseDocumentPath(project: string, location: string, knowledgeBase: string, document: string): string;

Return a fully-qualified projectLocationKnowledgeBaseDocument resource name string.

Parameters
Name Description
project string
location string
knowledgeBase string
document string
Returns
Type Description
string

{string} Resource name string.

projectLocationKnowledgeBasePath(project, location, knowledgeBase)

projectLocationKnowledgeBasePath(project: string, location: string, knowledgeBase: string): string;

Return a fully-qualified projectLocationKnowledgeBase resource name string.

Parameters
Name Description
project string
location string
knowledgeBase string
Returns
Type Description
string

{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

updateEnvironment(request, options)

updateEnvironment(request?: protos.google.cloud.dialogflow.v2.IUpdateEnvironmentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.v2.IEnvironment,
        protos.google.cloud.dialogflow.v2.IUpdateEnvironmentRequest | undefined,
        {} | undefined
    ]>;

Updates the specified agent environment.

This method allows you to deploy new agent versions into the environment. When an environment is pointed to a new agent version by setting environment.agent_version, the environment is temporarily set to the LOADING state. During that time, the environment continues serving the previous version of the agent. After the new agent version is done loading, the environment is set back to the RUNNING state. You can use "-" as Environment ID in environment name to update an agent version in the default environment. WARNING: this will negate all recent changes to the draft agent and can't be undone. You may want to save the draft agent to a version before calling this method.

Parameters
Name Description
request IUpdateEnvironmentRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.dialogflow.v2.IEnvironment, protos.google.cloud.dialogflow.v2.IUpdateEnvironmentRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . 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 environment to update.
   */
  // const environment = {}
  /**
   *  Required. The mask to control which fields get updated.
   */
  // const updateMask = {}
  /**
   *  Optional. This field is used to prevent accidental overwrite of the default
   *  environment, which is an operation that cannot be undone. To confirm that
   *  the caller desires this overwrite, this field must be explicitly set to
   *  true when updating the default environment (environment ID = `-`).
   */
  // const allowLoadToDraftAndDiscardChanges = true

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

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

  async function callUpdateEnvironment() {
    // Construct request
    const request = {
      environment,
      updateMask,
    };

    // Run request
    const response = await dialogflowClient.updateEnvironment(request);
    console.log(response);
  }

  callUpdateEnvironment();

updateEnvironment(request, options, callback)

updateEnvironment(request: protos.google.cloud.dialogflow.v2.IUpdateEnvironmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2.IEnvironment, protos.google.cloud.dialogflow.v2.IUpdateEnvironmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateEnvironmentRequest
options CallOptions
callback Callback<protos.google.cloud.dialogflow.v2.IEnvironment, protos.google.cloud.dialogflow.v2.IUpdateEnvironmentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateEnvironment(request, callback)

updateEnvironment(request: protos.google.cloud.dialogflow.v2.IUpdateEnvironmentRequest, callback: Callback<protos.google.cloud.dialogflow.v2.IEnvironment, protos.google.cloud.dialogflow.v2.IUpdateEnvironmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateEnvironmentRequest
callback Callback<protos.google.cloud.dialogflow.v2.IEnvironment, protos.google.cloud.dialogflow.v2.IUpdateEnvironmentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void