Class v2beta1.ParticipantsClient (6.13.0)

Service for managing . v2beta1

Package

@google-cloud/dialogflow

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of ParticipantsClient.

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 ParticipantsClient({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;

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

participantsStub

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

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

analyzeContent(request, options)

analyzeContent(request?: protos.google.cloud.dialogflow.v2beta1.IAnalyzeContentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.v2beta1.IAnalyzeContentResponse,
        protos.google.cloud.dialogflow.v2beta1.IAnalyzeContentRequest | undefined,
        {} | undefined
    ]>;

Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

Note: Always use agent versions for production traffic sent to virtual agents. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).

Parameters
Name Description
request IAnalyzeContentRequest

The request object that will be sent.
options CallOptions

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

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

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the participant this text comes from.
   *  Format: `projects/

analyzeContent(request, options, callback)

analyzeContent(request: protos.google.cloud.dialogflow.v2beta1.IAnalyzeContentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IAnalyzeContentResponse, protos.google.cloud.dialogflow.v2beta1.IAnalyzeContentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IAnalyzeContentRequest
options CallOptions
callback Callback<protos.google.cloud.dialogflow.v2beta1.IAnalyzeContentResponse, protos.google.cloud.dialogflow.v2beta1.IAnalyzeContentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

analyzeContent(request, callback)

analyzeContent(request: protos.google.cloud.dialogflow.v2beta1.IAnalyzeContentRequest, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IAnalyzeContentResponse, protos.google.cloud.dialogflow.v2beta1.IAnalyzeContentRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IAnalyzeContentRequest
callback Callback<protos.google.cloud.dialogflow.v2beta1.IAnalyzeContentResponse, protos.google.cloud.dialogflow.v2beta1.IAnalyzeContentRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

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.

compileSuggestion(request, options)

compileSuggestion(request?: protos.google.cloud.dialogflow.v2beta1.ICompileSuggestionRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.v2beta1.ICompileSuggestionResponse,
        (protos.google.cloud.dialogflow.v2beta1.ICompileSuggestionRequest | undefined),
        {} | undefined
    ]>;

Deprecated. use and instead.

Gets suggestions for a participant based on specific historical messages.

Note that will only list the auto-generated suggestions, while will try to compile suggestion based on the provided conversation context in the real time.

Parameters
Name Description
request ICompileSuggestionRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.dialogflow.v2beta1.ICompileSuggestionResponse, (protos.google.cloud.dialogflow.v2beta1.ICompileSuggestionRequest | undefined), {} | undefined ]>

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

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the participant to fetch suggestion for.
   *  Format: `projects/

compileSuggestion(request, options, callback)

compileSuggestion(request: protos.google.cloud.dialogflow.v2beta1.ICompileSuggestionRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2beta1.ICompileSuggestionResponse, protos.google.cloud.dialogflow.v2beta1.ICompileSuggestionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICompileSuggestionRequest
options CallOptions
callback Callback<protos.google.cloud.dialogflow.v2beta1.ICompileSuggestionResponse, protos.google.cloud.dialogflow.v2beta1.ICompileSuggestionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

compileSuggestion(request, callback)

compileSuggestion(request: protos.google.cloud.dialogflow.v2beta1.ICompileSuggestionRequest, callback: Callback<protos.google.cloud.dialogflow.v2beta1.ICompileSuggestionResponse, protos.google.cloud.dialogflow.v2beta1.ICompileSuggestionRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICompileSuggestionRequest
callback Callback<protos.google.cloud.dialogflow.v2beta1.ICompileSuggestionResponse, protos.google.cloud.dialogflow.v2beta1.ICompileSuggestionRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createParticipant(request, options)

createParticipant(request?: protos.google.cloud.dialogflow.v2beta1.ICreateParticipantRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.v2beta1.IParticipant,
        (protos.google.cloud.dialogflow.v2beta1.ICreateParticipantRequest | undefined),
        {} | undefined
    ]>;

Creates a new participant in a conversation.

Parameters
Name Description
request ICreateParticipantRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.dialogflow.v2beta1.IParticipant, (protos.google.cloud.dialogflow.v2beta1.ICreateParticipantRequest | 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. Resource identifier of the conversation adding the participant.
   *  Format: `projects/

createParticipant(request, options, callback)

createParticipant(request: protos.google.cloud.dialogflow.v2beta1.ICreateParticipantRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IParticipant, protos.google.cloud.dialogflow.v2beta1.ICreateParticipantRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateParticipantRequest
options CallOptions
callback Callback<protos.google.cloud.dialogflow.v2beta1.IParticipant, protos.google.cloud.dialogflow.v2beta1.ICreateParticipantRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

createParticipant(request, callback)

createParticipant(request: protos.google.cloud.dialogflow.v2beta1.ICreateParticipantRequest, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IParticipant, protos.google.cloud.dialogflow.v2beta1.ICreateParticipantRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ICreateParticipantRequest
callback Callback<protos.google.cloud.dialogflow.v2beta1.IParticipant, protos.google.cloud.dialogflow.v2beta1.ICreateParticipantRequest | 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.

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

getParticipant(request, options)

getParticipant(request?: protos.google.cloud.dialogflow.v2beta1.IGetParticipantRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.v2beta1.IParticipant,
        protos.google.cloud.dialogflow.v2beta1.IGetParticipantRequest | undefined,
        {} | undefined
    ]>;

Retrieves a conversation participant.

Parameters
Name Description
request IGetParticipantRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.dialogflow.v2beta1.IParticipant, protos.google.cloud.dialogflow.v2beta1.IGetParticipantRequest | 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 participant. Format:
   *  `projects/

getParticipant(request, options, callback)

getParticipant(request: protos.google.cloud.dialogflow.v2beta1.IGetParticipantRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IParticipant, protos.google.cloud.dialogflow.v2beta1.IGetParticipantRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetParticipantRequest
options CallOptions
callback Callback<protos.google.cloud.dialogflow.v2beta1.IParticipant, protos.google.cloud.dialogflow.v2beta1.IGetParticipantRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getParticipant(request, callback)

getParticipant(request: protos.google.cloud.dialogflow.v2beta1.IGetParticipantRequest, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IParticipant, protos.google.cloud.dialogflow.v2beta1.IGetParticipantRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetParticipantRequest
callback Callback<protos.google.cloud.dialogflow.v2beta1.IParticipant, protos.google.cloud.dialogflow.v2beta1.IGetParticipantRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

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.

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
}

listParticipants(request, options)

listParticipants(request?: protos.google.cloud.dialogflow.v2beta1.IListParticipantsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.v2beta1.IParticipant[],
        protos.google.cloud.dialogflow.v2beta1.IListParticipantsRequest | null,
        protos.google.cloud.dialogflow.v2beta1.IListParticipantsResponse
    ]>;

Returns the list of all participants in the specified conversation.

Parameters
Name Description
request IListParticipantsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.dialogflow.v2beta1.IParticipant[], protos.google.cloud.dialogflow.v2beta1.IListParticipantsRequest | null, protos.google.cloud.dialogflow.v2beta1.IListParticipantsResponse ]>

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

listParticipants(request, options, callback)

listParticipants(request: protos.google.cloud.dialogflow.v2beta1.IListParticipantsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.v2beta1.IListParticipantsRequest, protos.google.cloud.dialogflow.v2beta1.IListParticipantsResponse | null | undefined, protos.google.cloud.dialogflow.v2beta1.IParticipant>): void;
Parameters
Name Description
request IListParticipantsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.dialogflow.v2beta1.IListParticipantsRequest, protos.google.cloud.dialogflow.v2beta1.IListParticipantsResponse | null | undefined, protos.google.cloud.dialogflow.v2beta1.IParticipant>
Returns
Type Description
void

listParticipants(request, callback)

listParticipants(request: protos.google.cloud.dialogflow.v2beta1.IListParticipantsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.v2beta1.IListParticipantsRequest, protos.google.cloud.dialogflow.v2beta1.IListParticipantsResponse | null | undefined, protos.google.cloud.dialogflow.v2beta1.IParticipant>): void;
Parameters
Name Description
request IListParticipantsRequest
callback PaginationCallback<protos.google.cloud.dialogflow.v2beta1.IListParticipantsRequest, protos.google.cloud.dialogflow.v2beta1.IListParticipantsResponse | null | undefined, protos.google.cloud.dialogflow.v2beta1.IParticipant>
Returns
Type Description
void

listParticipantsAsync(request, options)

listParticipantsAsync(request?: protos.google.cloud.dialogflow.v2beta1.IListParticipantsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.v2beta1.IParticipant>;

Equivalent to listParticipants, but returns an iterable object.

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

Parameters
Name Description
request IListParticipantsRequest

The request object that will be sent.
options CallOptions

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

{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 conversation to list all participants from.
   *  Format: `projects/

listParticipantsStream(request, options)

listParticipantsStream(request?: protos.google.cloud.dialogflow.v2beta1.IListParticipantsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListParticipantsRequest

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

listSuggestions(request, options)

listSuggestions(request?: protos.google.cloud.dialogflow.v2beta1.IListSuggestionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.v2beta1.ISuggestion[],
        protos.google.cloud.dialogflow.v2beta1.IListSuggestionsRequest | null,
        protos.google.cloud.dialogflow.v2beta1.IListSuggestionsResponse
    ]>;

Deprecated: Use inline suggestion, event based suggestion or Suggestion* API instead. See for more details. Removal Date: 2020-09-01.

Retrieves suggestions for live agents.

This method should be used by human agent client software to fetch auto generated suggestions in real-time, while the conversation with an end user is in progress. The functionality is implemented in terms of the [list pagination](https://cloud.google.com/apis/design/design_patterns#list_pagination) design pattern. The client app should use the next_page_token field to fetch the next batch of suggestions. suggestions are sorted by create_time in descending order. To fetch latest suggestion, just set page_size to 1. To fetch new suggestions without duplication, send request with filter create_time_epoch_microseconds > [first item's create_time of previous request] and empty page_token.

Parameters
Name Description
request IListSuggestionsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.dialogflow.v2beta1.ISuggestion[], protos.google.cloud.dialogflow.v2beta1.IListSuggestionsRequest | null, protos.google.cloud.dialogflow.v2beta1.IListSuggestionsResponse ]>

{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 listSuggestionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listSuggestions(request, options, callback)

listSuggestions(request: protos.google.cloud.dialogflow.v2beta1.IListSuggestionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.v2beta1.IListSuggestionsRequest, protos.google.cloud.dialogflow.v2beta1.IListSuggestionsResponse | null | undefined, protos.google.cloud.dialogflow.v2beta1.ISuggestion>): void;
Parameters
Name Description
request IListSuggestionsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.dialogflow.v2beta1.IListSuggestionsRequest, protos.google.cloud.dialogflow.v2beta1.IListSuggestionsResponse | null | undefined, protos.google.cloud.dialogflow.v2beta1.ISuggestion>
Returns
Type Description
void

listSuggestions(request, callback)

listSuggestions(request: protos.google.cloud.dialogflow.v2beta1.IListSuggestionsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.v2beta1.IListSuggestionsRequest, protos.google.cloud.dialogflow.v2beta1.IListSuggestionsResponse | null | undefined, protos.google.cloud.dialogflow.v2beta1.ISuggestion>): void;
Parameters
Name Description
request IListSuggestionsRequest
callback PaginationCallback<protos.google.cloud.dialogflow.v2beta1.IListSuggestionsRequest, protos.google.cloud.dialogflow.v2beta1.IListSuggestionsResponse | null | undefined, protos.google.cloud.dialogflow.v2beta1.ISuggestion>
Returns
Type Description
void

listSuggestionsAsync(request, options)

listSuggestionsAsync(request?: protos.google.cloud.dialogflow.v2beta1.IListSuggestionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.v2beta1.ISuggestion>;

Equivalent to listSuggestions, but returns an iterable object.

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

Parameters
Name Description
request IListSuggestionsRequest

The request object that will be sent.
options CallOptions

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

{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 participant to fetch suggestions for.
   *  Format: `projects/

listSuggestionsStream(request, options)

listSuggestionsStream(request?: protos.google.cloud.dialogflow.v2beta1.IListSuggestionsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request IListSuggestionsRequest

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 listSuggestionsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

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.

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.

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.

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.

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.

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.

matchLocationFromSipTrunkName(sipTrunkName)

matchLocationFromSipTrunkName(sipTrunkName: string): string | number;

Parse the location from SipTrunk resource.

Parameter
Name Description
sipTrunkName string

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

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.

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.

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.

matchProjectFromSipTrunkName(sipTrunkName)

matchProjectFromSipTrunkName(sipTrunkName: string): string | number;

Parse the project from SipTrunk resource.

Parameter
Name Description
sipTrunkName string

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

matchSiptrunkFromSipTrunkName(sipTrunkName)

matchSiptrunkFromSipTrunkName(sipTrunkName: string): string | number;

Parse the siptrunk from SipTrunk resource.

Parameter
Name Description
sipTrunkName string

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

{string} A string representing the siptrunk.

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.

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.

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.

sipTrunkPath(project, location, siptrunk)

sipTrunkPath(project: string, location: string, siptrunk: string): string;

Return a fully-qualified sipTrunk resource name string.

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

{string} Resource name string.

streamingAnalyzeContent(options)

streamingAnalyzeContent(options?: CallOptions): gax.CancellableStream;

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

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

Note: Always use agent versions for production traffic sent to virtual agents. See [Versions and environments](https://cloud.google.com/dialogflow/es/docs/agents-versions).

Parameter
Name Description
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
gax.CancellableStream

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

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the participant this text comes from.
   *  Format: `projects/

suggestArticles(request, options)

suggestArticles(request?: protos.google.cloud.dialogflow.v2beta1.ISuggestArticlesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.v2beta1.ISuggestArticlesResponse,
        (protos.google.cloud.dialogflow.v2beta1.ISuggestArticlesRequest | undefined),
        {} | undefined
    ]>;

Gets suggested articles for a participant based on specific historical messages.

Note that will only list the auto-generated suggestions, while will try to compile suggestion based on the provided conversation context in the real time.

Parameters
Name Description
request ISuggestArticlesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.dialogflow.v2beta1.ISuggestArticlesResponse, (protos.google.cloud.dialogflow.v2beta1.ISuggestArticlesRequest | undefined), {} | undefined ]>

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

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the participant to fetch suggestion for.
   *  Format: `projects/

suggestArticles(request, options, callback)

suggestArticles(request: protos.google.cloud.dialogflow.v2beta1.ISuggestArticlesRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2beta1.ISuggestArticlesResponse, protos.google.cloud.dialogflow.v2beta1.ISuggestArticlesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ISuggestArticlesRequest
options CallOptions
callback Callback<protos.google.cloud.dialogflow.v2beta1.ISuggestArticlesResponse, protos.google.cloud.dialogflow.v2beta1.ISuggestArticlesRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

suggestArticles(request, callback)

suggestArticles(request: protos.google.cloud.dialogflow.v2beta1.ISuggestArticlesRequest, callback: Callback<protos.google.cloud.dialogflow.v2beta1.ISuggestArticlesResponse, protos.google.cloud.dialogflow.v2beta1.ISuggestArticlesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ISuggestArticlesRequest
callback Callback<protos.google.cloud.dialogflow.v2beta1.ISuggestArticlesResponse, protos.google.cloud.dialogflow.v2beta1.ISuggestArticlesRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

suggestFaqAnswers(request, options)

suggestFaqAnswers(request?: protos.google.cloud.dialogflow.v2beta1.ISuggestFaqAnswersRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.v2beta1.ISuggestFaqAnswersResponse,
        (protos.google.cloud.dialogflow.v2beta1.ISuggestFaqAnswersRequest | undefined),
        {} | undefined
    ]>;

Gets suggested faq answers for a participant based on specific historical messages.

Parameters
Name Description
request ISuggestFaqAnswersRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.dialogflow.v2beta1.ISuggestFaqAnswersResponse, (protos.google.cloud.dialogflow.v2beta1.ISuggestFaqAnswersRequest | undefined), {} | undefined ]>

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

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the participant to fetch suggestion for.
   *  Format: `projects/

suggestFaqAnswers(request, options, callback)

suggestFaqAnswers(request: protos.google.cloud.dialogflow.v2beta1.ISuggestFaqAnswersRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2beta1.ISuggestFaqAnswersResponse, protos.google.cloud.dialogflow.v2beta1.ISuggestFaqAnswersRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ISuggestFaqAnswersRequest
options CallOptions
callback Callback<protos.google.cloud.dialogflow.v2beta1.ISuggestFaqAnswersResponse, protos.google.cloud.dialogflow.v2beta1.ISuggestFaqAnswersRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

suggestFaqAnswers(request, callback)

suggestFaqAnswers(request: protos.google.cloud.dialogflow.v2beta1.ISuggestFaqAnswersRequest, callback: Callback<protos.google.cloud.dialogflow.v2beta1.ISuggestFaqAnswersResponse, protos.google.cloud.dialogflow.v2beta1.ISuggestFaqAnswersRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ISuggestFaqAnswersRequest
callback Callback<protos.google.cloud.dialogflow.v2beta1.ISuggestFaqAnswersResponse, protos.google.cloud.dialogflow.v2beta1.ISuggestFaqAnswersRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

suggestKnowledgeAssist(request, options)

suggestKnowledgeAssist(request?: protos.google.cloud.dialogflow.v2beta1.ISuggestKnowledgeAssistRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.v2beta1.ISuggestKnowledgeAssistResponse,
        (protos.google.cloud.dialogflow.v2beta1.ISuggestKnowledgeAssistRequest | undefined),
        {} | undefined
    ]>;

Gets knowledge assist suggestions based on historical messages.

Parameters
Name Description
request ISuggestKnowledgeAssistRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.dialogflow.v2beta1.ISuggestKnowledgeAssistResponse, (protos.google.cloud.dialogflow.v2beta1.ISuggestKnowledgeAssistRequest | undefined), {} | undefined ]>

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

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the participant to fetch suggestions for.
   *  Format: `projects/

suggestKnowledgeAssist(request, options, callback)

suggestKnowledgeAssist(request: protos.google.cloud.dialogflow.v2beta1.ISuggestKnowledgeAssistRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2beta1.ISuggestKnowledgeAssistResponse, protos.google.cloud.dialogflow.v2beta1.ISuggestKnowledgeAssistRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ISuggestKnowledgeAssistRequest
options CallOptions
callback Callback<protos.google.cloud.dialogflow.v2beta1.ISuggestKnowledgeAssistResponse, protos.google.cloud.dialogflow.v2beta1.ISuggestKnowledgeAssistRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

suggestKnowledgeAssist(request, callback)

suggestKnowledgeAssist(request: protos.google.cloud.dialogflow.v2beta1.ISuggestKnowledgeAssistRequest, callback: Callback<protos.google.cloud.dialogflow.v2beta1.ISuggestKnowledgeAssistResponse, protos.google.cloud.dialogflow.v2beta1.ISuggestKnowledgeAssistRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ISuggestKnowledgeAssistRequest
callback Callback<protos.google.cloud.dialogflow.v2beta1.ISuggestKnowledgeAssistResponse, protos.google.cloud.dialogflow.v2beta1.ISuggestKnowledgeAssistRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

suggestSmartReplies(request, options)

suggestSmartReplies(request?: protos.google.cloud.dialogflow.v2beta1.ISuggestSmartRepliesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.v2beta1.ISuggestSmartRepliesResponse,
        (protos.google.cloud.dialogflow.v2beta1.ISuggestSmartRepliesRequest | undefined),
        {} | undefined
    ]>;

Gets smart replies for a participant based on specific historical messages.

Parameters
Name Description
request ISuggestSmartRepliesRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.dialogflow.v2beta1.ISuggestSmartRepliesResponse, (protos.google.cloud.dialogflow.v2beta1.ISuggestSmartRepliesRequest | undefined), {} | undefined ]>

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

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the participant to fetch suggestion for.
   *  Format: `projects/

suggestSmartReplies(request, options, callback)

suggestSmartReplies(request: protos.google.cloud.dialogflow.v2beta1.ISuggestSmartRepliesRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2beta1.ISuggestSmartRepliesResponse, protos.google.cloud.dialogflow.v2beta1.ISuggestSmartRepliesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ISuggestSmartRepliesRequest
options CallOptions
callback Callback<protos.google.cloud.dialogflow.v2beta1.ISuggestSmartRepliesResponse, protos.google.cloud.dialogflow.v2beta1.ISuggestSmartRepliesRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

suggestSmartReplies(request, callback)

suggestSmartReplies(request: protos.google.cloud.dialogflow.v2beta1.ISuggestSmartRepliesRequest, callback: Callback<protos.google.cloud.dialogflow.v2beta1.ISuggestSmartRepliesResponse, protos.google.cloud.dialogflow.v2beta1.ISuggestSmartRepliesRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request ISuggestSmartRepliesRequest
callback Callback<protos.google.cloud.dialogflow.v2beta1.ISuggestSmartRepliesResponse, protos.google.cloud.dialogflow.v2beta1.ISuggestSmartRepliesRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateParticipant(request, options)

updateParticipant(request?: protos.google.cloud.dialogflow.v2beta1.IUpdateParticipantRequest, options?: CallOptions): Promise<[
        protos.google.cloud.dialogflow.v2beta1.IParticipant,
        (protos.google.cloud.dialogflow.v2beta1.IUpdateParticipantRequest | undefined),
        {} | undefined
    ]>;

Updates the specified participant.

Parameters
Name Description
request IUpdateParticipantRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.dialogflow.v2beta1.IParticipant, (protos.google.cloud.dialogflow.v2beta1.IUpdateParticipantRequest | 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 participant to update.
   */
  // const participant = {}
  /**
   *  Required. The mask to specify which fields to update.
   */
  // const updateMask = {}

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

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

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

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

  callUpdateParticipant();

updateParticipant(request, options, callback)

updateParticipant(request: protos.google.cloud.dialogflow.v2beta1.IUpdateParticipantRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IParticipant, protos.google.cloud.dialogflow.v2beta1.IUpdateParticipantRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateParticipantRequest
options CallOptions
callback Callback<protos.google.cloud.dialogflow.v2beta1.IParticipant, protos.google.cloud.dialogflow.v2beta1.IUpdateParticipantRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateParticipant(request, callback)

updateParticipant(request: protos.google.cloud.dialogflow.v2beta1.IUpdateParticipantRequest, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IParticipant, protos.google.cloud.dialogflow.v2beta1.IUpdateParticipantRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateParticipantRequest
callback Callback<protos.google.cloud.dialogflow.v2beta1.IParticipant, protos.google.cloud.dialogflow.v2beta1.IUpdateParticipantRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void