Class v2beta1.AgentsClient (3.3.0)

Service for managing . v2beta1

Package

@google-cloud/dialogflow!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of AgentsClient.

Parameter
NameDescription
opts ClientOptions

Properties

agentsStub

agentsStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
TypeDescription
Promise<{ [name: string]: Function; }>

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
TypeDescription
string

auth

auth: gax.GoogleAuth;
Property Value
TypeDescription
gax.GoogleAuth

descriptors

descriptors: Descriptors;
Property Value
TypeDescription
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
TypeDescription
{ [name: string]: Function; }

operationsClient

operationsClient: gax.OperationsClient;
Property Value
TypeDescription
gax.OperationsClient

pathTemplates

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

port

static get port(): number;

The port for this API service.

Property Value
TypeDescription
number

scopes

static get scopes(): string[];

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

Property Value
TypeDescription
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
TypeDescription
string

Methods

checkExportAgentProgress(name)

checkExportAgentProgress(name: string): Promise<LROperation<protos.google.cloud.dialogflow.v2beta1.ExportAgentResponse, protos.google.protobuf.Struct>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.dialogflow.v2beta1.ExportAgentResponse, protos.google.protobuf.Struct>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkImportAgentProgress(name)

checkImportAgentProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Struct>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Struct>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkRestoreAgentProgress(name)

checkRestoreAgentProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Struct>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Struct>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkTrainAgentProgress(name)

checkTrainAgentProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Struct>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.protobuf.Struct>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

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

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

deleteAgent(request, options)

deleteAgent(request: protos.google.cloud.dialogflow.v2beta1.IDeleteAgentRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2beta1.IDeleteAgentRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.IDeleteAgentRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2beta1.IDeleteAgentRequest | undefined, {} | undefined]>

deleteAgent(request, options, callback)

deleteAgent(request: protos.google.cloud.dialogflow.v2beta1.IDeleteAgentRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2beta1.IDeleteAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.IDeleteAgentRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2beta1.IDeleteAgentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteAgent(request, callback)

deleteAgent(request: protos.google.cloud.dialogflow.v2beta1.IDeleteAgentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2beta1.IDeleteAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.IDeleteAgentRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.dialogflow.v2beta1.IDeleteAgentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

exportAgent(request, options)

exportAgent(request: protos.google.cloud.dialogflow.v2beta1.IExportAgentRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.dialogflow.v2beta1.IExportAgentResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.IExportAgentRequest
options CallOptions
Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.dialogflow.v2beta1.IExportAgentResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

exportAgent(request, options, callback)

exportAgent(request: protos.google.cloud.dialogflow.v2beta1.IExportAgentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2beta1.IExportAgentResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.IExportAgentRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.dialogflow.v2beta1.IExportAgentResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

exportAgent(request, callback)

exportAgent(request: protos.google.cloud.dialogflow.v2beta1.IExportAgentRequest, callback: Callback<LROperation<protos.google.cloud.dialogflow.v2beta1.IExportAgentResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.IExportAgentRequest
callback Callback<LROperation<protos.google.cloud.dialogflow.v2beta1.IExportAgentResponse, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getAgent(request, options)

getAgent(request: protos.google.cloud.dialogflow.v2beta1.IGetAgentRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.v2beta1.IAgent, protos.google.cloud.dialogflow.v2beta1.IGetAgentRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.IGetAgentRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.dialogflow.v2beta1.IAgent, protos.google.cloud.dialogflow.v2beta1.IGetAgentRequest | undefined, {} | undefined]>

getAgent(request, options, callback)

getAgent(request: protos.google.cloud.dialogflow.v2beta1.IGetAgentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IAgent, protos.google.cloud.dialogflow.v2beta1.IGetAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.IGetAgentRequest
options CallOptions
callback Callback<protos.google.cloud.dialogflow.v2beta1.IAgent, protos.google.cloud.dialogflow.v2beta1.IGetAgentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getAgent(request, callback)

getAgent(request: protos.google.cloud.dialogflow.v2beta1.IGetAgentRequest, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IAgent, protos.google.cloud.dialogflow.v2beta1.IGetAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.IGetAgentRequest
callback Callback<protos.google.cloud.dialogflow.v2beta1.IAgent, protos.google.cloud.dialogflow.v2beta1.IGetAgentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
void

getValidationResult(request, options)

getValidationResult(request: protos.google.cloud.dialogflow.v2beta1.IGetValidationResultRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.v2beta1.IValidationResult, (protos.google.cloud.dialogflow.v2beta1.IGetValidationResultRequest | undefined), {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.IGetValidationResultRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.dialogflow.v2beta1.IValidationResult, (protos.google.cloud.dialogflow.v2beta1.IGetValidationResultRequest | undefined), {} | undefined]>

getValidationResult(request, options, callback)

getValidationResult(request: protos.google.cloud.dialogflow.v2beta1.IGetValidationResultRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IValidationResult, protos.google.cloud.dialogflow.v2beta1.IGetValidationResultRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.IGetValidationResultRequest
options CallOptions
callback Callback<protos.google.cloud.dialogflow.v2beta1.IValidationResult, protos.google.cloud.dialogflow.v2beta1.IGetValidationResultRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getValidationResult(request, callback)

getValidationResult(request: protos.google.cloud.dialogflow.v2beta1.IGetValidationResultRequest, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IValidationResult, protos.google.cloud.dialogflow.v2beta1.IGetValidationResultRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.IGetValidationResultRequest
callback Callback<protos.google.cloud.dialogflow.v2beta1.IValidationResult, protos.google.cloud.dialogflow.v2beta1.IGetValidationResultRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

importAgent(request, options)

importAgent(request: protos.google.cloud.dialogflow.v2beta1.IImportAgentRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.IImportAgentRequest
options CallOptions
Returns
TypeDescription
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

importAgent(request, options, callback)

importAgent(request: protos.google.cloud.dialogflow.v2beta1.IImportAgentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.IImportAgentRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

importAgent(request, callback)

importAgent(request: protos.google.cloud.dialogflow.v2beta1.IImportAgentRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.IImportAgentRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
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
TypeDescription
Promise<{ [name: string]: Function; }>

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

matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

matchContextFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;

Parse the context from ProjectAgentEnvironmentUserSessionContext resource.

Parameter
NameDescription
projectAgentEnvironmentUserSessionContextName string

A fully-qualified path representing project_agent_environment_user_session_context resource.

Returns
TypeDescription
string | number

{string} A string representing the context.

matchContextFromProjectAgentSessionContextName(projectAgentSessionContextName)

matchContextFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number;

Parse the context from ProjectAgentSessionContext resource.

Parameter
NameDescription
projectAgentSessionContextName string

A fully-qualified path representing project_agent_session_context resource.

Returns
TypeDescription
string | number

{string} A string representing the context.

matchContextFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName)

matchContextFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName: string): string | number;

Parse the context from ProjectLocationAgentSessionContext resource.

Parameter
NameDescription
projectLocationAgentSessionContextName string

A fully-qualified path representing project_location_agent_session_context resource.

Returns
TypeDescription
string | number

{string} A string representing the context.

matchDocumentFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName)

matchDocumentFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName: string): string | number;

Parse the document from ProjectKnowledgeBaseDocument resource.

Parameter
NameDescription
projectKnowledgeBaseDocumentName string

A fully-qualified path representing project_knowledge_base_document resource.

Returns
TypeDescription
string | number

{string} A string representing the document.

matchDocumentFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName)

matchDocumentFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName: string): string | number;

Parse the document from ProjectLocationKnowledgeBaseDocument resource.

Parameter
NameDescription
projectLocationKnowledgeBaseDocumentName string

A fully-qualified path representing project_location_knowledge_base_document resource.

Returns
TypeDescription
string | number

{string} A string representing the document.

matchEntityTypeFromProjectAgentEntityTypeName(projectAgentEntityTypeName)

matchEntityTypeFromProjectAgentEntityTypeName(projectAgentEntityTypeName: string): string | number;

Parse the entity_type from ProjectAgentEntityType resource.

Parameter
NameDescription
projectAgentEntityTypeName string

A fully-qualified path representing project_agent_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the entity_type.

matchEntityTypeFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

matchEntityTypeFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the entity_type from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameter
NameDescription
projectAgentEnvironmentUserSessionEntityTypeName string

A fully-qualified path representing project_agent_environment_user_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the entity_type.

matchEntityTypeFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)

matchEntityTypeFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number;

Parse the entity_type from ProjectAgentSessionEntityType resource.

Parameter
NameDescription
projectAgentSessionEntityTypeName string

A fully-qualified path representing project_agent_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName)

matchEntityTypeFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName: string): string | number;

Parse the entity_type from ProjectLocationAgentEntityType resource.

Parameter
NameDescription
projectLocationAgentEntityTypeName string

A fully-qualified path representing project_location_agent_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the entity_type.

matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchEntityTypeFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the entity_type from ProjectLocationAgentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the entity_type.

matchEnvironmentFromProjectAgentEnvironmentName(projectAgentEnvironmentName)

matchEnvironmentFromProjectAgentEnvironmentName(projectAgentEnvironmentName: string): string | number;

Parse the environment from ProjectAgentEnvironment resource.

Parameter
NameDescription
projectAgentEnvironmentName string

A fully-qualified path representing project_agent_environment resource.

Returns
TypeDescription
string | number

{string} A string representing the environment.

matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

matchEnvironmentFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;

Parse the environment from ProjectAgentEnvironmentUserSessionContext resource.

Parameter
NameDescription
projectAgentEnvironmentUserSessionContextName string

A fully-qualified path representing project_agent_environment_user_session_context resource.

Returns
TypeDescription
string | number

{string} A string representing the environment.

matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

matchEnvironmentFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the environment from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameter
NameDescription
projectAgentEnvironmentUserSessionEntityTypeName string

A fully-qualified path representing project_agent_environment_user_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the environment.

matchEnvironmentFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName)

matchEnvironmentFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName: string): string | number;

Parse the environment from ProjectLocationAgentEnvironment resource.

Parameter
NameDescription
projectLocationAgentEnvironmentName string

A fully-qualified path representing project_location_agent_environment resource.

Returns
TypeDescription
string | number

{string} A string representing the environment.

matchIntentFromProjectAgentIntentName(projectAgentIntentName)

matchIntentFromProjectAgentIntentName(projectAgentIntentName: string): string | number;

Parse the intent from ProjectAgentIntent resource.

Parameter
NameDescription
projectAgentIntentName string

A fully-qualified path representing project_agent_intent resource.

Returns
TypeDescription
string | number

{string} A string representing the intent.

matchIntentFromProjectLocationAgentIntentName(projectLocationAgentIntentName)

matchIntentFromProjectLocationAgentIntentName(projectLocationAgentIntentName: string): string | number;

Parse the intent from ProjectLocationAgentIntent resource.

Parameter
NameDescription
projectLocationAgentIntentName string

A fully-qualified path representing project_location_agent_intent resource.

Returns
TypeDescription
string | number

{string} A string representing the intent.

matchKnowledgeBaseFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName)

matchKnowledgeBaseFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName: string): string | number;

Parse the knowledge_base from ProjectKnowledgeBaseDocument resource.

Parameter
NameDescription
projectKnowledgeBaseDocumentName string

A fully-qualified path representing project_knowledge_base_document resource.

Returns
TypeDescription
string | number

{string} A string representing the knowledge_base.

matchKnowledgeBaseFromProjectKnowledgeBaseName(projectKnowledgeBaseName)

matchKnowledgeBaseFromProjectKnowledgeBaseName(projectKnowledgeBaseName: string): string | number;

Parse the knowledge_base from ProjectKnowledgeBase resource.

Parameter
NameDescription
projectKnowledgeBaseName string

A fully-qualified path representing project_knowledge_base resource.

Returns
TypeDescription
string | number

{string} A string representing the knowledge_base.

matchKnowledgeBaseFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName)

matchKnowledgeBaseFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName: string): string | number;

Parse the knowledge_base from ProjectLocationKnowledgeBaseDocument resource.

Parameter
NameDescription
projectLocationKnowledgeBaseDocumentName string

A fully-qualified path representing project_location_knowledge_base_document resource.

Returns
TypeDescription
string | number

{string} A string representing the knowledge_base.

matchKnowledgeBaseFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName)

matchKnowledgeBaseFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName: string): string | number;

Parse the knowledge_base from ProjectLocationKnowledgeBase resource.

Parameter
NameDescription
projectLocationKnowledgeBaseName string

A fully-qualified path representing project_location_knowledge_base resource.

Returns
TypeDescription
string | number

{string} A string representing the knowledge_base.

matchLocationFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName)

matchLocationFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName: string): string | number;

Parse the location from ProjectLocationAgentEntityType resource.

Parameter
NameDescription
projectLocationAgentEntityTypeName string

A fully-qualified path representing project_location_agent_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName)

matchLocationFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName: string): string | number;

Parse the location from ProjectLocationAgentEnvironment resource.

Parameter
NameDescription
projectLocationAgentEnvironmentName string

A fully-qualified path representing project_location_agent_environment resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAgentIntentName(projectLocationAgentIntentName)

matchLocationFromProjectLocationAgentIntentName(projectLocationAgentIntentName: string): string | number;

Parse the location from ProjectLocationAgentIntent resource.

Parameter
NameDescription
projectLocationAgentIntentName string

A fully-qualified path representing project_location_agent_intent resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAgentName(projectLocationAgentName)

matchLocationFromProjectLocationAgentName(projectLocationAgentName: string): string | number;

Parse the location from ProjectLocationAgent resource.

Parameter
NameDescription
projectLocationAgentName string

A fully-qualified path representing project_location_agent resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName)

matchLocationFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName: string): string | number;

Parse the location from ProjectLocationAgentSessionContext resource.

Parameter
NameDescription
projectLocationAgentSessionContextName string

A fully-qualified path representing project_location_agent_session_context resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchLocationFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the location from ProjectLocationAgentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName)

matchLocationFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName: string): string | number;

Parse the location from ProjectLocationKnowledgeBaseDocument resource.

Parameter
NameDescription
projectLocationKnowledgeBaseDocumentName string

A fully-qualified path representing project_location_knowledge_base_document resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName)

matchLocationFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName: string): string | number;

Parse the location from ProjectLocationKnowledgeBase resource.

Parameter
NameDescription
projectLocationKnowledgeBaseName string

A fully-qualified path representing project_location_knowledge_base resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchProjectFromProjectAgentEntityTypeName(projectAgentEntityTypeName)

matchProjectFromProjectAgentEntityTypeName(projectAgentEntityTypeName: string): string | number;

Parse the project from ProjectAgentEntityType resource.

Parameter
NameDescription
projectAgentEntityTypeName string

A fully-qualified path representing project_agent_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectAgentEnvironmentName(projectAgentEnvironmentName)

matchProjectFromProjectAgentEnvironmentName(projectAgentEnvironmentName: string): string | number;

Parse the project from ProjectAgentEnvironment resource.

Parameter
NameDescription
projectAgentEnvironmentName string

A fully-qualified path representing project_agent_environment resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

matchProjectFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;

Parse the project from ProjectAgentEnvironmentUserSessionContext resource.

Parameter
NameDescription
projectAgentEnvironmentUserSessionContextName string

A fully-qualified path representing project_agent_environment_user_session_context resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

matchProjectFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the project from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameter
NameDescription
projectAgentEnvironmentUserSessionEntityTypeName string

A fully-qualified path representing project_agent_environment_user_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectAgentIntentName(projectAgentIntentName)

matchProjectFromProjectAgentIntentName(projectAgentIntentName: string): string | number;

Parse the project from ProjectAgentIntent resource.

Parameter
NameDescription
projectAgentIntentName string

A fully-qualified path representing project_agent_intent resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectAgentName(projectAgentName)

matchProjectFromProjectAgentName(projectAgentName: string): string | number;

Parse the project from ProjectAgent resource.

Parameter
NameDescription
projectAgentName string

A fully-qualified path representing project_agent resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectAgentSessionContextName(projectAgentSessionContextName)

matchProjectFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number;

Parse the project from ProjectAgentSessionContext resource.

Parameter
NameDescription
projectAgentSessionContextName string

A fully-qualified path representing project_agent_session_context resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)

matchProjectFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number;

Parse the project from ProjectAgentSessionEntityType resource.

Parameter
NameDescription
projectAgentSessionEntityTypeName string

A fully-qualified path representing project_agent_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName)

matchProjectFromProjectKnowledgeBaseDocumentName(projectKnowledgeBaseDocumentName: string): string | number;

Parse the project from ProjectKnowledgeBaseDocument resource.

Parameter
NameDescription
projectKnowledgeBaseDocumentName string

A fully-qualified path representing project_knowledge_base_document resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectKnowledgeBaseName(projectKnowledgeBaseName)

matchProjectFromProjectKnowledgeBaseName(projectKnowledgeBaseName: string): string | number;

Parse the project from ProjectKnowledgeBase resource.

Parameter
NameDescription
projectKnowledgeBaseName string

A fully-qualified path representing project_knowledge_base resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName)

matchProjectFromProjectLocationAgentEntityTypeName(projectLocationAgentEntityTypeName: string): string | number;

Parse the project from ProjectLocationAgentEntityType resource.

Parameter
NameDescription
projectLocationAgentEntityTypeName string

A fully-qualified path representing project_location_agent_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName)

matchProjectFromProjectLocationAgentEnvironmentName(projectLocationAgentEnvironmentName: string): string | number;

Parse the project from ProjectLocationAgentEnvironment resource.

Parameter
NameDescription
projectLocationAgentEnvironmentName string

A fully-qualified path representing project_location_agent_environment resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAgentIntentName(projectLocationAgentIntentName)

matchProjectFromProjectLocationAgentIntentName(projectLocationAgentIntentName: string): string | number;

Parse the project from ProjectLocationAgentIntent resource.

Parameter
NameDescription
projectLocationAgentIntentName string

A fully-qualified path representing project_location_agent_intent resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAgentName(projectLocationAgentName)

matchProjectFromProjectLocationAgentName(projectLocationAgentName: string): string | number;

Parse the project from ProjectLocationAgent resource.

Parameter
NameDescription
projectLocationAgentName string

A fully-qualified path representing project_location_agent resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName)

matchProjectFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName: string): string | number;

Parse the project from ProjectLocationAgentSessionContext resource.

Parameter
NameDescription
projectLocationAgentSessionContextName string

A fully-qualified path representing project_location_agent_session_context resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchProjectFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the project from ProjectLocationAgentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName)

matchProjectFromProjectLocationKnowledgeBaseDocumentName(projectLocationKnowledgeBaseDocumentName: string): string | number;

Parse the project from ProjectLocationKnowledgeBaseDocument resource.

Parameter
NameDescription
projectLocationKnowledgeBaseDocumentName string

A fully-qualified path representing project_location_knowledge_base_document resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName)

matchProjectFromProjectLocationKnowledgeBaseName(projectLocationKnowledgeBaseName: string): string | number;

Parse the project from ProjectLocationKnowledgeBase resource.

Parameter
NameDescription
projectLocationKnowledgeBaseName string

A fully-qualified path representing project_location_knowledge_base resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
NameDescription
projectName string

A fully-qualified path representing Project resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchSessionFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

matchSessionFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;

Parse the session from ProjectAgentEnvironmentUserSessionContext resource.

Parameter
NameDescription
projectAgentEnvironmentUserSessionContextName string

A fully-qualified path representing project_agent_environment_user_session_context resource.

Returns
TypeDescription
string | number

{string} A string representing the session.

matchSessionFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

matchSessionFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the session from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameter
NameDescription
projectAgentEnvironmentUserSessionEntityTypeName string

A fully-qualified path representing project_agent_environment_user_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the session.

matchSessionFromProjectAgentSessionContextName(projectAgentSessionContextName)

matchSessionFromProjectAgentSessionContextName(projectAgentSessionContextName: string): string | number;

Parse the session from ProjectAgentSessionContext resource.

Parameter
NameDescription
projectAgentSessionContextName string

A fully-qualified path representing project_agent_session_context resource.

Returns
TypeDescription
string | number

{string} A string representing the session.

matchSessionFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName)

matchSessionFromProjectAgentSessionEntityTypeName(projectAgentSessionEntityTypeName: string): string | number;

Parse the session from ProjectAgentSessionEntityType resource.

Parameter
NameDescription
projectAgentSessionEntityTypeName string

A fully-qualified path representing project_agent_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the session.

matchSessionFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName)

matchSessionFromProjectLocationAgentSessionContextName(projectLocationAgentSessionContextName: string): string | number;

Parse the session from ProjectLocationAgentSessionContext resource.

Parameter
NameDescription
projectLocationAgentSessionContextName string

A fully-qualified path representing project_location_agent_session_context resource.

Returns
TypeDescription
string | number

{string} A string representing the session.

matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName)

matchSessionFromProjectLocationAgentSessionEntityTypeName(projectLocationAgentSessionEntityTypeName: string): string | number;

Parse the session from ProjectLocationAgentSessionEntityType resource.

Parameter
NameDescription
projectLocationAgentSessionEntityTypeName string

A fully-qualified path representing project_location_agent_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the session.

matchUserFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName)

matchUserFromProjectAgentEnvironmentUserSessionContextName(projectAgentEnvironmentUserSessionContextName: string): string | number;

Parse the user from ProjectAgentEnvironmentUserSessionContext resource.

Parameter
NameDescription
projectAgentEnvironmentUserSessionContextName string

A fully-qualified path representing project_agent_environment_user_session_context resource.

Returns
TypeDescription
string | number

{string} A string representing the user.

matchUserFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName)

matchUserFromProjectAgentEnvironmentUserSessionEntityTypeName(projectAgentEnvironmentUserSessionEntityTypeName: string): string | number;

Parse the user from ProjectAgentEnvironmentUserSessionEntityType resource.

Parameter
NameDescription
projectAgentEnvironmentUserSessionEntityTypeName string

A fully-qualified path representing project_agent_environment_user_session_entity_type resource.

Returns
TypeDescription
string | number

{string} A string representing the user.

projectAgentEntityTypePath(project, entityType)

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

Return a fully-qualified projectAgentEntityType resource name string.

Parameters
NameDescription
project string
entityType string
Returns
TypeDescription
string

{string} Resource name string.

projectAgentEnvironmentPath(project, environment)

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

Return a fully-qualified projectAgentEnvironment resource name string.

Parameters
NameDescription
project string
environment string
Returns
TypeDescription
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
NameDescription
project string
environment string
user string
session string
context string
Returns
TypeDescription
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
NameDescription
project string
environment string
user string
session string
entityType string
Returns
TypeDescription
string

{string} Resource name string.

projectAgentIntentPath(project, intent)

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

Return a fully-qualified projectAgentIntent resource name string.

Parameters
NameDescription
project string
intent string
Returns
TypeDescription
string

{string} Resource name string.

projectAgentPath(project)

projectAgentPath(project: string): string;

Return a fully-qualified projectAgent resource name string.

Parameter
NameDescription
project string
Returns
TypeDescription
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
NameDescription
project string
session string
context string
Returns
TypeDescription
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
NameDescription
project string
session string
entityType string
Returns
TypeDescription
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
NameDescription
project string
knowledgeBase string
document string
Returns
TypeDescription
string

{string} Resource name string.

projectKnowledgeBasePath(project, knowledgeBase)

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

Return a fully-qualified projectKnowledgeBase resource name string.

Parameters
NameDescription
project string
knowledgeBase string
Returns
TypeDescription
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
NameDescription
project string
location string
entityType string
Returns
TypeDescription
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
NameDescription
project string
location string
environment string
Returns
TypeDescription
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
NameDescription
project string
location string
intent string
Returns
TypeDescription
string

{string} Resource name string.

projectLocationAgentPath(project, location)

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

Return a fully-qualified projectLocationAgent resource name string.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
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
NameDescription
project string
location string
session string
context string
Returns
TypeDescription
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
NameDescription
project string
location string
session string
entityType string
Returns
TypeDescription
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
NameDescription
project string
location string
knowledgeBase string
document string
Returns
TypeDescription
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
NameDescription
project string
location string
knowledgeBase string
Returns
TypeDescription
string

{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
NameDescription
project string
Returns
TypeDescription
string

{string} Resource name string.

restoreAgent(request, options)

restoreAgent(request: protos.google.cloud.dialogflow.v2beta1.IRestoreAgentRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.IRestoreAgentRequest
options CallOptions
Returns
TypeDescription
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

restoreAgent(request, options, callback)

restoreAgent(request: protos.google.cloud.dialogflow.v2beta1.IRestoreAgentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.IRestoreAgentRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

restoreAgent(request, callback)

restoreAgent(request: protos.google.cloud.dialogflow.v2beta1.IRestoreAgentRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.IRestoreAgentRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

searchAgents(request, options)

searchAgents(request: protos.google.cloud.dialogflow.v2beta1.ISearchAgentsRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.v2beta1.IAgent[], protos.google.cloud.dialogflow.v2beta1.ISearchAgentsRequest | null, protos.google.cloud.dialogflow.v2beta1.ISearchAgentsResponse]>;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.ISearchAgentsRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.dialogflow.v2beta1.IAgent[], protos.google.cloud.dialogflow.v2beta1.ISearchAgentsRequest | null, protos.google.cloud.dialogflow.v2beta1.ISearchAgentsResponse]>

searchAgents(request, options, callback)

searchAgents(request: protos.google.cloud.dialogflow.v2beta1.ISearchAgentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.dialogflow.v2beta1.ISearchAgentsRequest, protos.google.cloud.dialogflow.v2beta1.ISearchAgentsResponse | null | undefined, protos.google.cloud.dialogflow.v2beta1.IAgent>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.ISearchAgentsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.dialogflow.v2beta1.ISearchAgentsRequest, protos.google.cloud.dialogflow.v2beta1.ISearchAgentsResponse | null | undefined, protos.google.cloud.dialogflow.v2beta1.IAgent>
Returns
TypeDescription
void

searchAgents(request, callback)

searchAgents(request: protos.google.cloud.dialogflow.v2beta1.ISearchAgentsRequest, callback: PaginationCallback<protos.google.cloud.dialogflow.v2beta1.ISearchAgentsRequest, protos.google.cloud.dialogflow.v2beta1.ISearchAgentsResponse | null | undefined, protos.google.cloud.dialogflow.v2beta1.IAgent>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.ISearchAgentsRequest
callback PaginationCallback<protos.google.cloud.dialogflow.v2beta1.ISearchAgentsRequest, protos.google.cloud.dialogflow.v2beta1.ISearchAgentsResponse | null | undefined, protos.google.cloud.dialogflow.v2beta1.IAgent>
Returns
TypeDescription
void

searchAgentsAsync(request, options)

searchAgentsAsync(request?: protos.google.cloud.dialogflow.v2beta1.ISearchAgentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.dialogflow.v2beta1.IAgent>;

Equivalent to searchAgents, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.ISearchAgentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.dialogflow.v2beta1.IAgent>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Agent]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

searchAgentsStream(request, options)

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

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

Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.ISearchAgentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [Agent] 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 searchAgentsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

setAgent(request, options)

setAgent(request: protos.google.cloud.dialogflow.v2beta1.ISetAgentRequest, options?: CallOptions): Promise<[protos.google.cloud.dialogflow.v2beta1.IAgent, protos.google.cloud.dialogflow.v2beta1.ISetAgentRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.ISetAgentRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.dialogflow.v2beta1.IAgent, protos.google.cloud.dialogflow.v2beta1.ISetAgentRequest | undefined, {} | undefined]>

setAgent(request, options, callback)

setAgent(request: protos.google.cloud.dialogflow.v2beta1.ISetAgentRequest, options: CallOptions, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IAgent, protos.google.cloud.dialogflow.v2beta1.ISetAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.ISetAgentRequest
options CallOptions
callback Callback<protos.google.cloud.dialogflow.v2beta1.IAgent, protos.google.cloud.dialogflow.v2beta1.ISetAgentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

setAgent(request, callback)

setAgent(request: protos.google.cloud.dialogflow.v2beta1.ISetAgentRequest, callback: Callback<protos.google.cloud.dialogflow.v2beta1.IAgent, protos.google.cloud.dialogflow.v2beta1.ISetAgentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.ISetAgentRequest
callback Callback<protos.google.cloud.dialogflow.v2beta1.IAgent, protos.google.cloud.dialogflow.v2beta1.ISetAgentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

trainAgent(request, options)

trainAgent(request: protos.google.cloud.dialogflow.v2beta1.ITrainAgentRequest, options?: CallOptions): Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.ITrainAgentRequest
options CallOptions
Returns
TypeDescription
Promise<[LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

trainAgent(request, options, callback)

trainAgent(request: protos.google.cloud.dialogflow.v2beta1.ITrainAgentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.ITrainAgentRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

trainAgent(request, callback)

trainAgent(request: protos.google.cloud.dialogflow.v2beta1.ITrainAgentRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.dialogflow.v2beta1.ITrainAgentRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.protobuf.IStruct>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void