Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Dialogflow

import { Dialogflow } from "https://googleapis.deno.dev/v1/dialogflow:v3.ts";

Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).

class Dialogflow {
constructor(client?: CredentialsClient, baseUrl?: string);
async projectsLocationsAgentsChangelogsGet(name: string): Promise<GoogleCloudDialogflowCxV3Changelog>;
async projectsLocationsAgentsChangelogsList(parent: string, opts?: ProjectsLocationsAgentsChangelogsListOptions): Promise<GoogleCloudDialogflowCxV3ListChangelogsResponse>;
async projectsLocationsAgentsCreate(parent: string, req: GoogleCloudDialogflowCxV3Agent): Promise<GoogleCloudDialogflowCxV3Agent>;
async projectsLocationsAgentsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsAgentsEntityTypesCreate(
parent: string,
): Promise<GoogleCloudDialogflowCxV3EntityType>;
async projectsLocationsAgentsEntityTypesDelete(name: string, opts?: ProjectsLocationsAgentsEntityTypesDeleteOptions): Promise<GoogleProtobufEmpty>;
async projectsLocationsAgentsEntityTypesExport(parent: string, req: GoogleCloudDialogflowCxV3ExportEntityTypesRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsAgentsEntityTypesGet(name: string, opts?: ProjectsLocationsAgentsEntityTypesGetOptions): Promise<GoogleCloudDialogflowCxV3EntityType>;
async projectsLocationsAgentsEntityTypesImport(parent: string, req: GoogleCloudDialogflowCxV3ImportEntityTypesRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsAgentsEntityTypesList(parent: string, opts?: ProjectsLocationsAgentsEntityTypesListOptions): Promise<GoogleCloudDialogflowCxV3ListEntityTypesResponse>;
async projectsLocationsAgentsEntityTypesPatch(
name: string,
): Promise<GoogleCloudDialogflowCxV3EntityType>;
async projectsLocationsAgentsEnvironmentsContinuousTestResultsList(parent: string, opts?: ProjectsLocationsAgentsEnvironmentsContinuousTestResultsListOptions): Promise<GoogleCloudDialogflowCxV3ListContinuousTestResultsResponse>;
async projectsLocationsAgentsEnvironmentsCreate(parent: string, req: GoogleCloudDialogflowCxV3Environment): Promise<GoogleLongrunningOperation>;
async projectsLocationsAgentsEnvironmentsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsAgentsEnvironmentsDeployFlow(environment: string, req: GoogleCloudDialogflowCxV3DeployFlowRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsAgentsEnvironmentsDeploymentsGet(name: string): Promise<GoogleCloudDialogflowCxV3Deployment>;
async projectsLocationsAgentsEnvironmentsDeploymentsList(parent: string, opts?: ProjectsLocationsAgentsEnvironmentsDeploymentsListOptions): Promise<GoogleCloudDialogflowCxV3ListDeploymentsResponse>;
async projectsLocationsAgentsEnvironmentsExperimentsCreate(parent: string, req: GoogleCloudDialogflowCxV3Experiment): Promise<GoogleCloudDialogflowCxV3Experiment>;
async projectsLocationsAgentsEnvironmentsExperimentsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsAgentsEnvironmentsExperimentsGet(name: string): Promise<GoogleCloudDialogflowCxV3Experiment>;
async projectsLocationsAgentsEnvironmentsExperimentsList(parent: string, opts?: ProjectsLocationsAgentsEnvironmentsExperimentsListOptions): Promise<GoogleCloudDialogflowCxV3ListExperimentsResponse>;
async projectsLocationsAgentsEnvironmentsExperimentsPatch(
name: string,
): Promise<GoogleCloudDialogflowCxV3Experiment>;
async projectsLocationsAgentsEnvironmentsExperimentsStart(name: string, req: GoogleCloudDialogflowCxV3StartExperimentRequest): Promise<GoogleCloudDialogflowCxV3Experiment>;
async projectsLocationsAgentsEnvironmentsExperimentsStop(name: string, req: GoogleCloudDialogflowCxV3StopExperimentRequest): Promise<GoogleCloudDialogflowCxV3Experiment>;
async projectsLocationsAgentsEnvironmentsGet(name: string): Promise<GoogleCloudDialogflowCxV3Environment>;
async projectsLocationsAgentsEnvironmentsList(parent: string, opts?: ProjectsLocationsAgentsEnvironmentsListOptions): Promise<GoogleCloudDialogflowCxV3ListEnvironmentsResponse>;
async projectsLocationsAgentsEnvironmentsLookupEnvironmentHistory(name: string, opts?: ProjectsLocationsAgentsEnvironmentsLookupEnvironmentHistoryOptions): Promise<GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse>;
async projectsLocationsAgentsEnvironmentsPatch(
name: string,
): Promise<GoogleLongrunningOperation>;
async projectsLocationsAgentsEnvironmentsRunContinuousTest(environment: string, req: GoogleCloudDialogflowCxV3RunContinuousTestRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsAgentsEnvironmentsSessionsDetectIntent(session: string, req: GoogleCloudDialogflowCxV3DetectIntentRequest): Promise<GoogleCloudDialogflowCxV3DetectIntentResponse>;
async projectsLocationsAgentsEnvironmentsSessionsEntityTypesCreate(parent: string, req: GoogleCloudDialogflowCxV3SessionEntityType): Promise<GoogleCloudDialogflowCxV3SessionEntityType>;
async projectsLocationsAgentsEnvironmentsSessionsEntityTypesDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsAgentsEnvironmentsSessionsEntityTypesGet(name: string): Promise<GoogleCloudDialogflowCxV3SessionEntityType>;
async projectsLocationsAgentsEnvironmentsSessionsEntityTypesList(parent: string, opts?: ProjectsLocationsAgentsEnvironmentsSessionsEntityTypesListOptions): Promise<GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse>;
async projectsLocationsAgentsEnvironmentsSessionsEntityTypesPatch(
name: string,
): Promise<GoogleCloudDialogflowCxV3SessionEntityType>;
async projectsLocationsAgentsEnvironmentsSessionsFulfillIntent(session: string, req: GoogleCloudDialogflowCxV3FulfillIntentRequest): Promise<GoogleCloudDialogflowCxV3FulfillIntentResponse>;
async projectsLocationsAgentsEnvironmentsSessionsMatchIntent(session: string, req: GoogleCloudDialogflowCxV3MatchIntentRequest): Promise<GoogleCloudDialogflowCxV3MatchIntentResponse>;
async projectsLocationsAgentsEnvironmentsSessionsServerStreamingDetectIntent(session: string, req: GoogleCloudDialogflowCxV3DetectIntentRequest): Promise<GoogleCloudDialogflowCxV3DetectIntentResponse>;
async projectsLocationsAgentsExport(name: string, req: GoogleCloudDialogflowCxV3ExportAgentRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsAgentsFlowsCreate(
parent: string,
): Promise<GoogleCloudDialogflowCxV3Flow>;
async projectsLocationsAgentsFlowsDelete(name: string, opts?: ProjectsLocationsAgentsFlowsDeleteOptions): Promise<GoogleProtobufEmpty>;
async projectsLocationsAgentsFlowsExport(name: string, req: GoogleCloudDialogflowCxV3ExportFlowRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsAgentsFlowsGet(name: string, opts?: ProjectsLocationsAgentsFlowsGetOptions): Promise<GoogleCloudDialogflowCxV3Flow>;
async projectsLocationsAgentsFlowsGetValidationResult(name: string, opts?: ProjectsLocationsAgentsFlowsGetValidationResultOptions): Promise<GoogleCloudDialogflowCxV3FlowValidationResult>;
async projectsLocationsAgentsFlowsImport(parent: string, req: GoogleCloudDialogflowCxV3ImportFlowRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsAgentsFlowsList(parent: string, opts?: ProjectsLocationsAgentsFlowsListOptions): Promise<GoogleCloudDialogflowCxV3ListFlowsResponse>;
async projectsLocationsAgentsFlowsPagesCreate(
parent: string,
): Promise<GoogleCloudDialogflowCxV3Page>;
async projectsLocationsAgentsFlowsPagesDelete(name: string, opts?: ProjectsLocationsAgentsFlowsPagesDeleteOptions): Promise<GoogleProtobufEmpty>;
async projectsLocationsAgentsFlowsPagesGet(name: string, opts?: ProjectsLocationsAgentsFlowsPagesGetOptions): Promise<GoogleCloudDialogflowCxV3Page>;
async projectsLocationsAgentsFlowsPagesList(parent: string, opts?: ProjectsLocationsAgentsFlowsPagesListOptions): Promise<GoogleCloudDialogflowCxV3ListPagesResponse>;
async projectsLocationsAgentsFlowsPagesPatch(
name: string,
): Promise<GoogleCloudDialogflowCxV3Page>;
async projectsLocationsAgentsFlowsPatch(
name: string,
): Promise<GoogleCloudDialogflowCxV3Flow>;
async projectsLocationsAgentsFlowsTrain(name: string, req: GoogleCloudDialogflowCxV3TrainFlowRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsAgentsFlowsTransitionRouteGroupsCreate(
parent: string,
): Promise<GoogleCloudDialogflowCxV3TransitionRouteGroup>;
async projectsLocationsAgentsFlowsTransitionRouteGroupsDelete(name: string, opts?: ProjectsLocationsAgentsFlowsTransitionRouteGroupsDeleteOptions): Promise<GoogleProtobufEmpty>;
async projectsLocationsAgentsFlowsTransitionRouteGroupsGet(name: string, opts?: ProjectsLocationsAgentsFlowsTransitionRouteGroupsGetOptions): Promise<GoogleCloudDialogflowCxV3TransitionRouteGroup>;
async projectsLocationsAgentsFlowsTransitionRouteGroupsList(parent: string, opts?: ProjectsLocationsAgentsFlowsTransitionRouteGroupsListOptions): Promise<GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse>;
async projectsLocationsAgentsFlowsTransitionRouteGroupsPatch(
name: string,
): Promise<GoogleCloudDialogflowCxV3TransitionRouteGroup>;
async projectsLocationsAgentsFlowsValidate(name: string, req: GoogleCloudDialogflowCxV3ValidateFlowRequest): Promise<GoogleCloudDialogflowCxV3FlowValidationResult>;
async projectsLocationsAgentsFlowsVersionsCompareVersions(baseVersion: string, req: GoogleCloudDialogflowCxV3CompareVersionsRequest): Promise<GoogleCloudDialogflowCxV3CompareVersionsResponse>;
async projectsLocationsAgentsFlowsVersionsCreate(parent: string, req: GoogleCloudDialogflowCxV3Version): Promise<GoogleLongrunningOperation>;
async projectsLocationsAgentsFlowsVersionsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsAgentsFlowsVersionsGet(name: string): Promise<GoogleCloudDialogflowCxV3Version>;
async projectsLocationsAgentsFlowsVersionsList(parent: string, opts?: ProjectsLocationsAgentsFlowsVersionsListOptions): Promise<GoogleCloudDialogflowCxV3ListVersionsResponse>;
async projectsLocationsAgentsFlowsVersionsLoad(name: string, req: GoogleCloudDialogflowCxV3LoadVersionRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsAgentsFlowsVersionsPatch(
name: string,
): Promise<GoogleCloudDialogflowCxV3Version>;
async projectsLocationsAgentsGeneratorsCreate(
parent: string,
): Promise<GoogleCloudDialogflowCxV3Generator>;
async projectsLocationsAgentsGeneratorsDelete(name: string, opts?: ProjectsLocationsAgentsGeneratorsDeleteOptions): Promise<GoogleProtobufEmpty>;
async projectsLocationsAgentsGeneratorsGet(name: string, opts?: ProjectsLocationsAgentsGeneratorsGetOptions): Promise<GoogleCloudDialogflowCxV3Generator>;
async projectsLocationsAgentsGeneratorsList(parent: string, opts?: ProjectsLocationsAgentsGeneratorsListOptions): Promise<GoogleCloudDialogflowCxV3ListGeneratorsResponse>;
async projectsLocationsAgentsGeneratorsPatch(
name: string,
): Promise<GoogleCloudDialogflowCxV3Generator>;
async projectsLocationsAgentsGet(name: string): Promise<GoogleCloudDialogflowCxV3Agent>;
async projectsLocationsAgentsGetGenerativeSettings(name: string, opts?: ProjectsLocationsAgentsGetGenerativeSettingsOptions): Promise<GoogleCloudDialogflowCxV3GenerativeSettings>;
async projectsLocationsAgentsGetValidationResult(name: string, opts?: ProjectsLocationsAgentsGetValidationResultOptions): Promise<GoogleCloudDialogflowCxV3AgentValidationResult>;
async projectsLocationsAgentsIntentsCreate(
parent: string,
): Promise<GoogleCloudDialogflowCxV3Intent>;
async projectsLocationsAgentsIntentsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsAgentsIntentsExport(parent: string, req: GoogleCloudDialogflowCxV3ExportIntentsRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsAgentsIntentsGet(name: string, opts?: ProjectsLocationsAgentsIntentsGetOptions): Promise<GoogleCloudDialogflowCxV3Intent>;
async projectsLocationsAgentsIntentsImport(parent: string, req: GoogleCloudDialogflowCxV3ImportIntentsRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsAgentsIntentsList(parent: string, opts?: ProjectsLocationsAgentsIntentsListOptions): Promise<GoogleCloudDialogflowCxV3ListIntentsResponse>;
async projectsLocationsAgentsIntentsPatch(
name: string,
): Promise<GoogleCloudDialogflowCxV3Intent>;
async projectsLocationsAgentsList(parent: string, opts?: ProjectsLocationsAgentsListOptions): Promise<GoogleCloudDialogflowCxV3ListAgentsResponse>;
async projectsLocationsAgentsPatch(
name: string,
): Promise<GoogleCloudDialogflowCxV3Agent>;
async projectsLocationsAgentsRestore(name: string, req: GoogleCloudDialogflowCxV3RestoreAgentRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsAgentsSessionsDetectIntent(session: string, req: GoogleCloudDialogflowCxV3DetectIntentRequest): Promise<GoogleCloudDialogflowCxV3DetectIntentResponse>;
async projectsLocationsAgentsSessionsEntityTypesCreate(parent: string, req: GoogleCloudDialogflowCxV3SessionEntityType): Promise<GoogleCloudDialogflowCxV3SessionEntityType>;
async projectsLocationsAgentsSessionsEntityTypesDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsAgentsSessionsEntityTypesGet(name: string): Promise<GoogleCloudDialogflowCxV3SessionEntityType>;
async projectsLocationsAgentsSessionsEntityTypesList(parent: string, opts?: ProjectsLocationsAgentsSessionsEntityTypesListOptions): Promise<GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse>;
async projectsLocationsAgentsSessionsEntityTypesPatch(
name: string,
): Promise<GoogleCloudDialogflowCxV3SessionEntityType>;
async projectsLocationsAgentsSessionsFulfillIntent(session: string, req: GoogleCloudDialogflowCxV3FulfillIntentRequest): Promise<GoogleCloudDialogflowCxV3FulfillIntentResponse>;
async projectsLocationsAgentsSessionsMatchIntent(session: string, req: GoogleCloudDialogflowCxV3MatchIntentRequest): Promise<GoogleCloudDialogflowCxV3MatchIntentResponse>;
async projectsLocationsAgentsSessionsServerStreamingDetectIntent(session: string, req: GoogleCloudDialogflowCxV3DetectIntentRequest): Promise<GoogleCloudDialogflowCxV3DetectIntentResponse>;
async projectsLocationsAgentsSessionsSubmitAnswerFeedback(session: string, req: GoogleCloudDialogflowCxV3SubmitAnswerFeedbackRequest): Promise<GoogleCloudDialogflowCxV3AnswerFeedback>;
async projectsLocationsAgentsTestCasesBatchDelete(parent: string, req: GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest): Promise<GoogleProtobufEmpty>;
async projectsLocationsAgentsTestCasesBatchRun(parent: string, req: GoogleCloudDialogflowCxV3BatchRunTestCasesRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsAgentsTestCasesCalculateCoverage(agent: string, opts?: ProjectsLocationsAgentsTestCasesCalculateCoverageOptions): Promise<GoogleCloudDialogflowCxV3CalculateCoverageResponse>;
async projectsLocationsAgentsTestCasesCreate(parent: string, req: GoogleCloudDialogflowCxV3TestCase): Promise<GoogleCloudDialogflowCxV3TestCase>;
async projectsLocationsAgentsTestCasesExport(parent: string, req: GoogleCloudDialogflowCxV3ExportTestCasesRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsAgentsTestCasesGet(name: string): Promise<GoogleCloudDialogflowCxV3TestCase>;
async projectsLocationsAgentsTestCasesImport(parent: string, req: GoogleCloudDialogflowCxV3ImportTestCasesRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsAgentsTestCasesList(parent: string, opts?: ProjectsLocationsAgentsTestCasesListOptions): Promise<GoogleCloudDialogflowCxV3ListTestCasesResponse>;
async projectsLocationsAgentsTestCasesPatch(
name: string,
): Promise<GoogleCloudDialogflowCxV3TestCase>;
async projectsLocationsAgentsTestCasesResultsGet(name: string): Promise<GoogleCloudDialogflowCxV3TestCaseResult>;
async projectsLocationsAgentsTestCasesResultsList(parent: string, opts?: ProjectsLocationsAgentsTestCasesResultsListOptions): Promise<GoogleCloudDialogflowCxV3ListTestCaseResultsResponse>;
async projectsLocationsAgentsTestCasesRun(name: string, req: GoogleCloudDialogflowCxV3RunTestCaseRequest): Promise<GoogleLongrunningOperation>;
async projectsLocationsAgentsTransitionRouteGroupsCreate(
parent: string,
): Promise<GoogleCloudDialogflowCxV3TransitionRouteGroup>;
async projectsLocationsAgentsTransitionRouteGroupsDelete(name: string, opts?: ProjectsLocationsAgentsTransitionRouteGroupsDeleteOptions): Promise<GoogleProtobufEmpty>;
async projectsLocationsAgentsTransitionRouteGroupsGet(name: string, opts?: ProjectsLocationsAgentsTransitionRouteGroupsGetOptions): Promise<GoogleCloudDialogflowCxV3TransitionRouteGroup>;
async projectsLocationsAgentsTransitionRouteGroupsList(parent: string, opts?: ProjectsLocationsAgentsTransitionRouteGroupsListOptions): Promise<GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse>;
async projectsLocationsAgentsUpdateGenerativeSettings(
name: string,
): Promise<GoogleCloudDialogflowCxV3GenerativeSettings>;
async projectsLocationsAgentsValidate(name: string, req: GoogleCloudDialogflowCxV3ValidateAgentRequest): Promise<GoogleCloudDialogflowCxV3AgentValidationResult>;
async projectsLocationsAgentsWebhooksCreate(parent: string, req: GoogleCloudDialogflowCxV3Webhook): Promise<GoogleCloudDialogflowCxV3Webhook>;
async projectsLocationsAgentsWebhooksDelete(name: string, opts?: ProjectsLocationsAgentsWebhooksDeleteOptions): Promise<GoogleProtobufEmpty>;
async projectsLocationsAgentsWebhooksGet(name: string): Promise<GoogleCloudDialogflowCxV3Webhook>;
async projectsLocationsAgentsWebhooksList(parent: string, opts?: ProjectsLocationsAgentsWebhooksListOptions): Promise<GoogleCloudDialogflowCxV3ListWebhooksResponse>;
async projectsLocationsAgentsWebhooksPatch(
name: string,
): Promise<GoogleCloudDialogflowCxV3Webhook>;
async projectsLocationsGet(name: string): Promise<GoogleCloudLocationLocation>;
async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<GoogleCloudLocationListLocationsResponse>;
async projectsLocationsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
async projectsLocationsSecuritySettingsCreate(parent: string, req: GoogleCloudDialogflowCxV3SecuritySettings): Promise<GoogleCloudDialogflowCxV3SecuritySettings>;
async projectsLocationsSecuritySettingsDelete(name: string): Promise<GoogleProtobufEmpty>;
async projectsLocationsSecuritySettingsGet(name: string): Promise<GoogleCloudDialogflowCxV3SecuritySettings>;
async projectsLocationsSecuritySettingsList(parent: string, opts?: ProjectsLocationsSecuritySettingsListOptions): Promise<GoogleCloudDialogflowCxV3ListSecuritySettingsResponse>;
async projectsLocationsSecuritySettingsPatch(
name: string,
): Promise<GoogleCloudDialogflowCxV3SecuritySettings>;
async projectsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>;
async projectsOperationsGet(name: string): Promise<GoogleLongrunningOperation>;
async projectsOperationsList(name: string, opts?: ProjectsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;
}

§Constructors

§
new Dialogflow(client?: CredentialsClient, baseUrl?: string)
[src]

§Methods

§
projectsLocationsAgentsChangelogsGet(name: string): Promise<GoogleCloudDialogflowCxV3Changelog>
[src]

Retrieves the specified Changelog.

@param name

Required. The name of the changelog to get. Format: projects//locations//agents//changelogs/.

§
projectsLocationsAgentsChangelogsList(parent: string, opts?: ProjectsLocationsAgentsChangelogsListOptions): Promise<GoogleCloudDialogflowCxV3ListChangelogsResponse>
[src]

Returns the list of Changelogs.

@param parent

Required. The agent containing the changelogs. Format: projects//locations//agents/.

§
projectsLocationsAgentsCreate(parent: string, req: GoogleCloudDialogflowCxV3Agent): Promise<GoogleCloudDialogflowCxV3Agent>
[src]

Creates an agent in the specified location. Note: You should always train flows prior to sending them queries. See the training documentation.

@param parent

Required. The location to create a agent for. Format: projects//locations/.

§
projectsLocationsAgentsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes the specified agent.

@param name

Required. The name of the agent to delete. Format: projects//locations//agents/.

§
projectsLocationsAgentsEntityTypesCreate(parent: string, req: GoogleCloudDialogflowCxV3EntityType, opts?: ProjectsLocationsAgentsEntityTypesCreateOptions): Promise<GoogleCloudDialogflowCxV3EntityType>
[src]

Creates an entity type in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.

@param parent

Required. The agent to create a entity type for. Format: projects//locations//agents/.

§
projectsLocationsAgentsEntityTypesDelete(name: string, opts?: ProjectsLocationsAgentsEntityTypesDeleteOptions): Promise<GoogleProtobufEmpty>
[src]

Deletes the specified entity type. Note: You should always train a flow prior to sending it queries. See the training documentation.

@param name

Required. The name of the entity type to delete. Format: projects//locations//agents//entityTypes/.

§
projectsLocationsAgentsEntityTypesExport(parent: string, req: GoogleCloudDialogflowCxV3ExportEntityTypesRequest): Promise<GoogleLongrunningOperation>
[src]

Exports the selected entity types.

@param parent

Required. The name of the parent agent to export entity types. Format: projects//locations//agents/.

§
projectsLocationsAgentsEntityTypesGet(name: string, opts?: ProjectsLocationsAgentsEntityTypesGetOptions): Promise<GoogleCloudDialogflowCxV3EntityType>
[src]

Retrieves the specified entity type.

@param name

Required. The name of the entity type. Format: projects//locations//agents//entityTypes/.

§
projectsLocationsAgentsEntityTypesImport(parent: string, req: GoogleCloudDialogflowCxV3ImportEntityTypesRequest): Promise<GoogleLongrunningOperation>
[src]

Imports the specified entitytypes into the agent.

@param parent

Required. The agent to import the entity types into. Format: projects//locations//agents/.

§
projectsLocationsAgentsEntityTypesList(parent: string, opts?: ProjectsLocationsAgentsEntityTypesListOptions): Promise<GoogleCloudDialogflowCxV3ListEntityTypesResponse>
[src]

Returns the list of all entity types in the specified agent.

@param parent

Required. The agent to list all entity types for. Format: projects//locations//agents/.

§

Updates the specified entity type. Note: You should always train a flow prior to sending it queries. See the training documentation.

@param name

The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: projects//locations//agents//entityTypes/.

§
projectsLocationsAgentsEnvironmentsContinuousTestResultsList(parent: string, opts?: ProjectsLocationsAgentsEnvironmentsContinuousTestResultsListOptions): Promise<GoogleCloudDialogflowCxV3ListContinuousTestResultsResponse>
[src]

Fetches a list of continuous test results for a given environment.

@param parent

Required. The environment to list results for. Format: projects//locations//agents// environments/.

§
projectsLocationsAgentsEnvironmentsCreate(parent: string, req: GoogleCloudDialogflowCxV3Environment): Promise<GoogleLongrunningOperation>
[src]

Creates an Environment in the specified Agent. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message

  • response: Environment
@param parent

Required. The Agent to create an Environment for. Format: projects//locations//agents/.

§
projectsLocationsAgentsEnvironmentsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes the specified Environment.

@param name

Required. The name of the Environment to delete. Format: projects//locations//agents//environments/.

§
projectsLocationsAgentsEnvironmentsDeployFlow(environment: string, req: GoogleCloudDialogflowCxV3DeployFlowRequest): Promise<GoogleLongrunningOperation>
[src]

Deploys a flow to the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: DeployFlowMetadata - response: DeployFlowResponse

@param environment

Required. The environment to deploy the flow to. Format: projects//locations//agents// environments/.

§
projectsLocationsAgentsEnvironmentsDeploymentsGet(name: string): Promise<GoogleCloudDialogflowCxV3Deployment>
[src]

Retrieves the specified Deployment.

@param name

Required. The name of the Deployment. Format: projects//locations//agents//environments//deployments/.

§
projectsLocationsAgentsEnvironmentsDeploymentsList(parent: string, opts?: ProjectsLocationsAgentsEnvironmentsDeploymentsListOptions): Promise<GoogleCloudDialogflowCxV3ListDeploymentsResponse>
[src]

Returns the list of all deployments in the specified Environment.

@param parent

Required. The Environment to list all environments for. Format: projects//locations//agents//environments/.

§
projectsLocationsAgentsEnvironmentsExperimentsCreate(parent: string, req: GoogleCloudDialogflowCxV3Experiment): Promise<GoogleCloudDialogflowCxV3Experiment>
[src]

Creates an Experiment in the specified Environment.

@param parent

Required. The Agent to create an Environment for. Format: projects//locations//agents//environments/.

§
projectsLocationsAgentsEnvironmentsExperimentsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes the specified Experiment.

@param name

Required. The name of the Environment to delete. Format: projects//locations//agents//environments//experiments/.

§
projectsLocationsAgentsEnvironmentsExperimentsGet(name: string): Promise<GoogleCloudDialogflowCxV3Experiment>
[src]

Retrieves the specified Experiment.

@param name

Required. The name of the Environment. Format: projects//locations//agents//environments//experiments/.

§
projectsLocationsAgentsEnvironmentsExperimentsList(parent: string, opts?: ProjectsLocationsAgentsEnvironmentsExperimentsListOptions): Promise<GoogleCloudDialogflowCxV3ListExperimentsResponse>
[src]

Returns the list of all experiments in the specified Environment.

@param parent

Required. The Environment to list all environments for. Format: projects//locations//agents//environments/.

§
projectsLocationsAgentsEnvironmentsExperimentsPatch(name: string, req: GoogleCloudDialogflowCxV3Experiment, opts?: ProjectsLocationsAgentsEnvironmentsExperimentsPatchOptions): Promise<GoogleCloudDialogflowCxV3Experiment>
[src]

Updates the specified Experiment.

@param name

The name of the experiment. Format: projects//locations//agents//environments//experiments/..

§
projectsLocationsAgentsEnvironmentsExperimentsStart(name: string, req: GoogleCloudDialogflowCxV3StartExperimentRequest): Promise<GoogleCloudDialogflowCxV3Experiment>
[src]

Starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING.

@param name

Required. Resource name of the experiment to start. Format: projects//locations//agents//environments//experiments/.

§
projectsLocationsAgentsEnvironmentsExperimentsStop(name: string, req: GoogleCloudDialogflowCxV3StopExperimentRequest): Promise<GoogleCloudDialogflowCxV3Experiment>
[src]

Stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE.

@param name

Required. Resource name of the experiment to stop. Format: projects//locations//agents//environments//experiments/.

§
projectsLocationsAgentsEnvironmentsGet(name: string): Promise<GoogleCloudDialogflowCxV3Environment>
[src]

Retrieves the specified Environment.

@param name

Required. The name of the Environment. Format: projects//locations//agents//environments/.

§
projectsLocationsAgentsEnvironmentsList(parent: string, opts?: ProjectsLocationsAgentsEnvironmentsListOptions): Promise<GoogleCloudDialogflowCxV3ListEnvironmentsResponse>
[src]

Returns the list of all environments in the specified Agent.

@param parent

Required. The Agent to list all environments for. Format: projects//locations//agents/.

§
projectsLocationsAgentsEnvironmentsLookupEnvironmentHistory(name: string, opts?: ProjectsLocationsAgentsEnvironmentsLookupEnvironmentHistoryOptions): Promise<GoogleCloudDialogflowCxV3LookupEnvironmentHistoryResponse>
[src]

Looks up the history of the specified Environment.

@param name

Required. Resource name of the environment to look up the history for. Format: projects//locations//agents//environments/.

§
projectsLocationsAgentsEnvironmentsPatch(name: string, req: GoogleCloudDialogflowCxV3Environment, opts?: ProjectsLocationsAgentsEnvironmentsPatchOptions): Promise<GoogleLongrunningOperation>
[src]

Updates the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message

  • response: Environment
@param name

The name of the environment. Format: projects//locations//agents//environments/.

§
projectsLocationsAgentsEnvironmentsRunContinuousTest(environment: string, req: GoogleCloudDialogflowCxV3RunContinuousTestRequest): Promise<GoogleLongrunningOperation>
[src]

Kicks off a continuous test under the specified Environment. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: RunContinuousTestMetadata - response: RunContinuousTestResponse

@param environment

Required. Format: projects//locations//agents//environments/.

§
projectsLocationsAgentsEnvironmentsSessionsDetectIntent(session: string, req: GoogleCloudDialogflowCxV3DetectIntentRequest): Promise<GoogleCloudDialogflowCxV3DetectIntentResponse>
[src]

Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See Versions and environments.

@param session

Required. The name of the session this query is sent to. Format: projects//locations//agents//sessions/ or projects//locations//agents//environments//sessions/. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. For more information, see the sessions guide. Note: Always use agent versions for production traffic. See Versions and environments.

§
projectsLocationsAgentsEnvironmentsSessionsEntityTypesCreate(parent: string, req: GoogleCloudDialogflowCxV3SessionEntityType): Promise<GoogleCloudDialogflowCxV3SessionEntityType>
[src]

Creates a session entity type.

@param parent

Required. The session to create a session entity type for. Format: projects//locations//agents//sessions/ or projects//locations//agents//environments//sessions/. If Environment ID is not specified, we assume default 'draft' environment.

§
projectsLocationsAgentsEnvironmentsSessionsEntityTypesDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes the specified session entity type.

@param name

Required. The name of the session entity type to delete. Format: projects//locations//agents//sessions//entityTypes/ or projects//locations//agents//environments//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment.

§
projectsLocationsAgentsEnvironmentsSessionsEntityTypesGet(name: string): Promise<GoogleCloudDialogflowCxV3SessionEntityType>
[src]

Retrieves the specified session entity type.

@param name

Required. The name of the session entity type. Format: projects//locations//agents//sessions//entityTypes/ or projects//locations//agents//environments//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment.

§
projectsLocationsAgentsEnvironmentsSessionsEntityTypesList(parent: string, opts?: ProjectsLocationsAgentsEnvironmentsSessionsEntityTypesListOptions): Promise<GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse>
[src]

Returns the list of all session entity types in the specified session.

@param parent

Required. The session to list all session entity types from. Format: projects//locations//agents//sessions/ or projects//locations//agents//environments//sessions/. If Environment ID is not specified, we assume default 'draft' environment.

§

Updates the specified session entity type.

@param name

Required. The unique identifier of the session entity type. Format: projects//locations//agents//sessions//entityTypes/ or projects//locations//agents//environments//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment.

§
projectsLocationsAgentsEnvironmentsSessionsFulfillIntent(session: string, req: GoogleCloudDialogflowCxV3FulfillIntentRequest): Promise<GoogleCloudDialogflowCxV3FulfillIntentResponse>
[src]

Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.

@param session

Required. The name of the session this query is sent to. Format: projects//locations//agents//sessions/ or projects//locations//agents//environments//sessions/. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. For more information, see the sessions guide.

§
projectsLocationsAgentsEnvironmentsSessionsMatchIntent(session: string, req: GoogleCloudDialogflowCxV3MatchIntentRequest): Promise<GoogleCloudDialogflowCxV3MatchIntentResponse>
[src]

Returns preliminary intent match results, doesn't change the session status.

@param session

Required. The name of the session this query is sent to. Format: projects//locations//agents//sessions/ or projects//locations//agents//environments//sessions/. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. For more information, see the sessions guide.

§
projectsLocationsAgentsEnvironmentsSessionsServerStreamingDetectIntent(session: string, req: GoogleCloudDialogflowCxV3DetectIntentRequest): Promise<GoogleCloudDialogflowCxV3DetectIntentResponse>
[src]

Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send partial responses earlier in a single request.

@param session

Required. The name of the session this query is sent to. Format: projects//locations//agents//sessions/ or projects//locations//agents//environments//sessions/. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. For more information, see the sessions guide. Note: Always use agent versions for production traffic. See Versions and environments.

§
projectsLocationsAgentsExport(name: string, req: GoogleCloudDialogflowCxV3ExportAgentRequest): Promise<GoogleLongrunningOperation>
[src]

Exports the specified agent to a binary file. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message

  • response: ExportAgentResponse
@param name

Required. The name of the agent to export. Format: projects//locations//agents/.

§
projectsLocationsAgentsFlowsCreate(parent: string, req: GoogleCloudDialogflowCxV3Flow, opts?: ProjectsLocationsAgentsFlowsCreateOptions): Promise<GoogleCloudDialogflowCxV3Flow>
[src]

Creates a flow in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.

@param parent

Required. The agent to create a flow for. Format: projects//locations//agents/.

§
projectsLocationsAgentsFlowsDelete(name: string, opts?: ProjectsLocationsAgentsFlowsDeleteOptions): Promise<GoogleProtobufEmpty>
[src]

Deletes a specified flow.

@param name

Required. The name of the flow to delete. Format: projects//locations//agents//flows/.

§
projectsLocationsAgentsFlowsExport(name: string, req: GoogleCloudDialogflowCxV3ExportFlowRequest): Promise<GoogleLongrunningOperation>
[src]

Exports the specified flow to a binary file. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message

  • response: ExportFlowResponse Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.
@param name

Required. The name of the flow to export. Format: projects//locations//agents//flows/.

§
projectsLocationsAgentsFlowsGet(name: string, opts?: ProjectsLocationsAgentsFlowsGetOptions): Promise<GoogleCloudDialogflowCxV3Flow>
[src]

Retrieves the specified flow.

@param name

Required. The name of the flow to get. Format: projects//locations//agents//flows/.

§
projectsLocationsAgentsFlowsGetValidationResult(name: string, opts?: ProjectsLocationsAgentsFlowsGetValidationResultOptions): Promise<GoogleCloudDialogflowCxV3FlowValidationResult>
[src]

Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called.

@param name

Required. The flow name. Format: projects//locations//agents//flows//validationResult.

§
projectsLocationsAgentsFlowsImport(parent: string, req: GoogleCloudDialogflowCxV3ImportFlowRequest): Promise<GoogleLongrunningOperation>
[src]

Imports the specified flow to the specified agent from a binary file. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message

  • response: ImportFlowResponse Note: You should always train a flow prior to sending it queries. See the training documentation.
@param parent

Required. The agent to import the flow into. Format: projects//locations//agents/.

§
projectsLocationsAgentsFlowsList(parent: string, opts?: ProjectsLocationsAgentsFlowsListOptions): Promise<GoogleCloudDialogflowCxV3ListFlowsResponse>
[src]

Returns the list of all flows in the specified agent.

@param parent

Required. The agent containing the flows. Format: projects//locations//agents/.

§
projectsLocationsAgentsFlowsPagesCreate(parent: string, req: GoogleCloudDialogflowCxV3Page, opts?: ProjectsLocationsAgentsFlowsPagesCreateOptions): Promise<GoogleCloudDialogflowCxV3Page>
[src]

Creates a page in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.

@param parent

Required. The flow to create a page for. Format: projects//locations//agents//flows/.

§
projectsLocationsAgentsFlowsPagesDelete(name: string, opts?: ProjectsLocationsAgentsFlowsPagesDeleteOptions): Promise<GoogleProtobufEmpty>
[src]

Deletes the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation.

@param name

Required. The name of the page to delete. Format: projects//locations//agents//Flows//pages/.

§
projectsLocationsAgentsFlowsPagesGet(name: string, opts?: ProjectsLocationsAgentsFlowsPagesGetOptions): Promise<GoogleCloudDialogflowCxV3Page>
[src]

Retrieves the specified page.

@param name

Required. The name of the page. Format: projects//locations//agents//flows//pages/.

§
projectsLocationsAgentsFlowsPagesList(parent: string, opts?: ProjectsLocationsAgentsFlowsPagesListOptions): Promise<GoogleCloudDialogflowCxV3ListPagesResponse>
[src]

Returns the list of all pages in the specified flow.

@param parent

Required. The flow to list all pages for. Format: projects//locations//agents//flows/.

§
projectsLocationsAgentsFlowsPagesPatch(name: string, req: GoogleCloudDialogflowCxV3Page, opts?: ProjectsLocationsAgentsFlowsPagesPatchOptions): Promise<GoogleCloudDialogflowCxV3Page>
[src]

Updates the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation.

@param name

The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: projects//locations//agents//flows//pages/.

§
projectsLocationsAgentsFlowsPatch(name: string, req: GoogleCloudDialogflowCxV3Flow, opts?: ProjectsLocationsAgentsFlowsPatchOptions): Promise<GoogleCloudDialogflowCxV3Flow>
[src]

Updates the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.

@param name

The unique identifier of the flow. Format: projects//locations//agents//flows/.

§
projectsLocationsAgentsFlowsTrain(name: string, req: GoogleCloudDialogflowCxV3TrainFlowRequest): Promise<GoogleLongrunningOperation>
[src]

Trains the specified flow. Note that only the flow in 'draft' environment is trained. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message

@param name

Required. The flow to train. Format: projects//locations//agents//flows/.

§

Creates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.

@param parent

Required. The flow to create an TransitionRouteGroup for. Format: projects//locations//agents//flows/ or projects//locations//agents/ for agent-level groups.

§
projectsLocationsAgentsFlowsTransitionRouteGroupsDelete(name: string, opts?: ProjectsLocationsAgentsFlowsTransitionRouteGroupsDeleteOptions): Promise<GoogleProtobufEmpty>
[src]

Deletes the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.

@param name

Required. The name of the TransitionRouteGroup to delete. Format: projects//locations//agents//flows//transitionRouteGroups/ or projects//locations//agents//transitionRouteGroups/.

§
projectsLocationsAgentsFlowsTransitionRouteGroupsGet(name: string, opts?: ProjectsLocationsAgentsFlowsTransitionRouteGroupsGetOptions): Promise<GoogleCloudDialogflowCxV3TransitionRouteGroup>
[src]

Retrieves the specified TransitionRouteGroup.

@param name

Required. The name of the TransitionRouteGroup. Format: projects//locations//agents//flows//transitionRouteGroups/ or projects//locations//agents//transitionRouteGroups/.

§
projectsLocationsAgentsFlowsTransitionRouteGroupsList(parent: string, opts?: ProjectsLocationsAgentsFlowsTransitionRouteGroupsListOptions): Promise<GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse>
[src]

Returns the list of all transition route groups in the specified flow.

@param parent

Required. The flow to list all transition route groups for. Format: projects//locations//agents//flows/ or `projects//locations//agents/.

§

Updates the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.

@param name

The unique identifier of the transition route group. TransitionRouteGroups.CreateTransitionRouteGroup populates the name automatically. Format: projects//locations//agents//flows//transitionRouteGroups/ .

§
projectsLocationsAgentsFlowsValidate(name: string, req: GoogleCloudDialogflowCxV3ValidateFlowRequest): Promise<GoogleCloudDialogflowCxV3FlowValidationResult>
[src]

Validates the specified flow and creates or updates validation results. Please call this API after the training is completed to get the complete validation results.

@param name

Required. The flow to validate. Format: projects//locations//agents//flows/.

§
projectsLocationsAgentsFlowsVersionsCompareVersions(baseVersion: string, req: GoogleCloudDialogflowCxV3CompareVersionsRequest): Promise<GoogleCloudDialogflowCxV3CompareVersionsResponse>
[src]

Compares the specified base version with target version.

@param baseVersion

Required. Name of the base flow version to compare with the target version. Use version ID 0 to indicate the draft version of the specified flow. Format: projects//locations//agents/ /flows//versions/.

§
projectsLocationsAgentsFlowsVersionsCreate(parent: string, req: GoogleCloudDialogflowCxV3Version): Promise<GoogleLongrunningOperation>
[src]

Creates a Version in the specified Flow. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: CreateVersionOperationMetadata - response: Version

@param parent

Required. The Flow to create an Version for. Format: projects//locations//agents//flows/.

§
projectsLocationsAgentsFlowsVersionsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes the specified Version.

@param name

Required. The name of the Version to delete. Format: projects//locations//agents//flows//versions/.

§
projectsLocationsAgentsFlowsVersionsGet(name: string): Promise<GoogleCloudDialogflowCxV3Version>
[src]

Retrieves the specified Version.

@param name

Required. The name of the Version. Format: projects//locations//agents//flows//versions/.

§
projectsLocationsAgentsFlowsVersionsList(parent: string, opts?: ProjectsLocationsAgentsFlowsVersionsListOptions): Promise<GoogleCloudDialogflowCxV3ListVersionsResponse>
[src]

Returns the list of all versions in the specified Flow.

@param parent

Required. The Flow to list all versions for. Format: projects//locations//agents//flows/.

§
projectsLocationsAgentsFlowsVersionsLoad(name: string, req: GoogleCloudDialogflowCxV3LoadVersionRequest): Promise<GoogleLongrunningOperation>
[src]

Loads resources in the specified version to the draft flow. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message

@param name

Required. The Version to be loaded to draft flow. Format: projects//locations//agents//flows//versions/.

§
projectsLocationsAgentsFlowsVersionsPatch(name: string, req: GoogleCloudDialogflowCxV3Version, opts?: ProjectsLocationsAgentsFlowsVersionsPatchOptions): Promise<GoogleCloudDialogflowCxV3Version>
[src]

Updates the specified Version.

@param name

Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation.

§
projectsLocationsAgentsGeneratorsCreate(parent: string, req: GoogleCloudDialogflowCxV3Generator, opts?: ProjectsLocationsAgentsGeneratorsCreateOptions): Promise<GoogleCloudDialogflowCxV3Generator>
[src]

Creates a generator in the specified agent.

@param parent

Required. The agent to create a generator for. Format: projects//locations//agents/.

§
projectsLocationsAgentsGeneratorsDelete(name: string, opts?: ProjectsLocationsAgentsGeneratorsDeleteOptions): Promise<GoogleProtobufEmpty>
[src]

Deletes the specified generators.

@param name

Required. The name of the generator to delete. Format: projects//locations//agents//generators/.

§
projectsLocationsAgentsGeneratorsGet(name: string, opts?: ProjectsLocationsAgentsGeneratorsGetOptions): Promise<GoogleCloudDialogflowCxV3Generator>
[src]

Retrieves the specified generator.

@param name

Required. The name of the generator. Format: projects//locations//agents//generators/.

§
projectsLocationsAgentsGeneratorsList(parent: string, opts?: ProjectsLocationsAgentsGeneratorsListOptions): Promise<GoogleCloudDialogflowCxV3ListGeneratorsResponse>
[src]

Returns the list of all generators in the specified agent.

@param parent

Required. The agent to list all generators for. Format: projects//locations//agents/.

§
projectsLocationsAgentsGeneratorsPatch(name: string, req: GoogleCloudDialogflowCxV3Generator, opts?: ProjectsLocationsAgentsGeneratorsPatchOptions): Promise<GoogleCloudDialogflowCxV3Generator>
[src]

Update the specified generator.

@param name

The unique identifier of the generator. Must be set for the Generators.UpdateGenerator method. Generators.CreateGenerate populates the name automatically. Format: projects//locations//agents//generators/.

§
projectsLocationsAgentsGet(name: string): Promise<GoogleCloudDialogflowCxV3Agent>
[src]

Retrieves the specified agent.

@param name

Required. The name of the agent. Format: projects//locations//agents/.

§
projectsLocationsAgentsGetGenerativeSettings(name: string, opts?: ProjectsLocationsAgentsGetGenerativeSettingsOptions): Promise<GoogleCloudDialogflowCxV3GenerativeSettings>
[src]

Gets the generative settings for the agent.

@param name

Required. Format: projects//locations//agents//generativeSettings.

§
projectsLocationsAgentsGetValidationResult(name: string, opts?: ProjectsLocationsAgentsGetValidationResultOptions): Promise<GoogleCloudDialogflowCxV3AgentValidationResult>
[src]

Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.

@param name

Required. The agent name. Format: projects//locations//agents//validationResult.

§
projectsLocationsAgentsIntentsCreate(parent: string, req: GoogleCloudDialogflowCxV3Intent, opts?: ProjectsLocationsAgentsIntentsCreateOptions): Promise<GoogleCloudDialogflowCxV3Intent>
[src]

Creates an intent in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.

@param parent

Required. The agent to create an intent for. Format: projects//locations//agents/.

§
projectsLocationsAgentsIntentsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation.

@param name

Required. The name of the intent to delete. Format: projects//locations//agents//intents/.

§
projectsLocationsAgentsIntentsExport(parent: string, req: GoogleCloudDialogflowCxV3ExportIntentsRequest): Promise<GoogleLongrunningOperation>
[src]

Exports the selected intents. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: ExportIntentsMetadata - response: ExportIntentsResponse

@param parent

Required. The name of the parent agent to export intents. Format: projects//locations//agents/.

§
projectsLocationsAgentsIntentsGet(name: string, opts?: ProjectsLocationsAgentsIntentsGetOptions): Promise<GoogleCloudDialogflowCxV3Intent>
[src]

Retrieves the specified intent.

@param name

Required. The name of the intent. Format: projects//locations//agents//intents/.

§
projectsLocationsAgentsIntentsImport(parent: string, req: GoogleCloudDialogflowCxV3ImportIntentsRequest): Promise<GoogleLongrunningOperation>
[src]

Imports the specified intents into the agent. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: ImportIntentsMetadata - response: ImportIntentsResponse

@param parent

Required. The agent to import the intents into. Format: projects//locations//agents/.

§
projectsLocationsAgentsIntentsList(parent: string, opts?: ProjectsLocationsAgentsIntentsListOptions): Promise<GoogleCloudDialogflowCxV3ListIntentsResponse>
[src]

Returns the list of all intents in the specified agent.

@param parent

Required. The agent to list all intents for. Format: projects//locations//agents/.

§
projectsLocationsAgentsIntentsPatch(name: string, req: GoogleCloudDialogflowCxV3Intent, opts?: ProjectsLocationsAgentsIntentsPatchOptions): Promise<GoogleCloudDialogflowCxV3Intent>
[src]

Updates the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation.

@param name

The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: projects//locations//agents//intents/.

§
projectsLocationsAgentsList(parent: string, opts?: ProjectsLocationsAgentsListOptions): Promise<GoogleCloudDialogflowCxV3ListAgentsResponse>
[src]

Returns the list of all agents in the specified location.

@param parent

Required. The location to list all agents for. Format: projects//locations/.

§
projectsLocationsAgentsPatch(name: string, req: GoogleCloudDialogflowCxV3Agent, opts?: ProjectsLocationsAgentsPatchOptions): Promise<GoogleCloudDialogflowCxV3Agent>
[src]

Updates the specified agent. Note: You should always train flows prior to sending them queries. See the training documentation.

@param name

The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: projects//locations//agents/.

§
projectsLocationsAgentsRestore(name: string, req: GoogleCloudDialogflowCxV3RestoreAgentRequest): Promise<GoogleLongrunningOperation>
[src]

Restores the specified agent from a binary file. Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: An empty Struct message

@param name

Required. The name of the agent to restore into. Format: projects//locations//agents/.

§
projectsLocationsAgentsSessionsDetectIntent(session: string, req: GoogleCloudDialogflowCxV3DetectIntentRequest): Promise<GoogleCloudDialogflowCxV3DetectIntentResponse>
[src]

Processes a natural language query and returns structured, actionable data as a result. This method is not idempotent, because it may cause session entity types to be updated, which in turn might affect results of future queries. Note: Always use agent versions for production traffic. See Versions and environments.

@param session

Required. The name of the session this query is sent to. Format: projects//locations//agents//sessions/ or projects//locations//agents//environments//sessions/. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. For more information, see the sessions guide. Note: Always use agent versions for production traffic. See Versions and environments.

§
projectsLocationsAgentsSessionsEntityTypesCreate(parent: string, req: GoogleCloudDialogflowCxV3SessionEntityType): Promise<GoogleCloudDialogflowCxV3SessionEntityType>
[src]

Creates a session entity type.

@param parent

Required. The session to create a session entity type for. Format: projects//locations//agents//sessions/ or projects//locations//agents//environments//sessions/. If Environment ID is not specified, we assume default 'draft' environment.

§
projectsLocationsAgentsSessionsEntityTypesDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes the specified session entity type.

@param name

Required. The name of the session entity type to delete. Format: projects//locations//agents//sessions//entityTypes/ or projects//locations//agents//environments//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment.

§
projectsLocationsAgentsSessionsEntityTypesGet(name: string): Promise<GoogleCloudDialogflowCxV3SessionEntityType>
[src]

Retrieves the specified session entity type.

@param name

Required. The name of the session entity type. Format: projects//locations//agents//sessions//entityTypes/ or projects//locations//agents//environments//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment.

§
projectsLocationsAgentsSessionsEntityTypesList(parent: string, opts?: ProjectsLocationsAgentsSessionsEntityTypesListOptions): Promise<GoogleCloudDialogflowCxV3ListSessionEntityTypesResponse>
[src]

Returns the list of all session entity types in the specified session.

@param parent

Required. The session to list all session entity types from. Format: projects//locations//agents//sessions/ or projects//locations//agents//environments//sessions/. If Environment ID is not specified, we assume default 'draft' environment.

§

Updates the specified session entity type.

@param name

Required. The unique identifier of the session entity type. Format: projects//locations//agents//sessions//entityTypes/ or projects//locations//agents//environments//sessions//entityTypes/. If Environment ID is not specified, we assume default 'draft' environment.

§
projectsLocationsAgentsSessionsFulfillIntent(session: string, req: GoogleCloudDialogflowCxV3FulfillIntentRequest): Promise<GoogleCloudDialogflowCxV3FulfillIntentResponse>
[src]

Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.

@param session

Required. The name of the session this query is sent to. Format: projects//locations//agents//sessions/ or projects//locations//agents//environments//sessions/. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. For more information, see the sessions guide.

§
projectsLocationsAgentsSessionsMatchIntent(session: string, req: GoogleCloudDialogflowCxV3MatchIntentRequest): Promise<GoogleCloudDialogflowCxV3MatchIntentResponse>
[src]

Returns preliminary intent match results, doesn't change the session status.

@param session

Required. The name of the session this query is sent to. Format: projects//locations//agents//sessions/ or projects//locations//agents//environments//sessions/. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. For more information, see the sessions guide.

§
projectsLocationsAgentsSessionsServerStreamingDetectIntent(session: string, req: GoogleCloudDialogflowCxV3DetectIntentRequest): Promise<GoogleCloudDialogflowCxV3DetectIntentResponse>
[src]

Processes a natural language query and returns structured, actionable data as a result through server-side streaming. Server-side streaming allows Dialogflow to send partial responses earlier in a single request.

@param session

Required. The name of the session this query is sent to. Format: projects//locations//agents//sessions/ or projects//locations//agents//environments//sessions/. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. For more information, see the sessions guide. Note: Always use agent versions for production traffic. See Versions and environments.

§
projectsLocationsAgentsSessionsSubmitAnswerFeedback(session: string, req: GoogleCloudDialogflowCxV3SubmitAnswerFeedbackRequest): Promise<GoogleCloudDialogflowCxV3AnswerFeedback>
[src]

Updates the feedback received from the user for a single turn of the bot response.

@param session

Required. The name of the session the feedback was sent to.

§
projectsLocationsAgentsTestCasesBatchDelete(parent: string, req: GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest): Promise<GoogleProtobufEmpty>
[src]

Batch deletes test cases.

@param parent

Required. The agent to delete test cases from. Format: projects//locations//agents/.

§
projectsLocationsAgentsTestCasesBatchRun(parent: string, req: GoogleCloudDialogflowCxV3BatchRunTestCasesRequest): Promise<GoogleLongrunningOperation>
[src]

Kicks off a batch run of test cases. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: BatchRunTestCasesMetadata - response: BatchRunTestCasesResponse

@param parent

Required. Agent name. Format: projects//locations//agents/ .

§
projectsLocationsAgentsTestCasesCalculateCoverage(agent: string, opts?: ProjectsLocationsAgentsTestCasesCalculateCoverageOptions): Promise<GoogleCloudDialogflowCxV3CalculateCoverageResponse>
[src]

Calculates the test coverage for an agent.

@param agent

Required. The agent to calculate coverage for. Format: projects//locations//agents/.

§
projectsLocationsAgentsTestCasesCreate(parent: string, req: GoogleCloudDialogflowCxV3TestCase): Promise<GoogleCloudDialogflowCxV3TestCase>
[src]

Creates a test case for the given agent.

@param parent

Required. The agent to create the test case for. Format: projects//locations//agents/.

§
projectsLocationsAgentsTestCasesExport(parent: string, req: GoogleCloudDialogflowCxV3ExportTestCasesRequest): Promise<GoogleLongrunningOperation>
[src]

Exports the test cases under the agent to a Cloud Storage bucket or a local file. Filter can be applied to export a subset of test cases. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: ExportTestCasesMetadata - response: ExportTestCasesResponse

@param parent

Required. The agent where to export test cases from. Format: projects//locations//agents/.

§
projectsLocationsAgentsTestCasesGet(name: string): Promise<GoogleCloudDialogflowCxV3TestCase>
[src]

Gets a test case.

@param name

Required. The name of the testcase. Format: projects//locations//agents//testCases/.

§
projectsLocationsAgentsTestCasesImport(parent: string, req: GoogleCloudDialogflowCxV3ImportTestCasesRequest): Promise<GoogleLongrunningOperation>
[src]

Imports the test cases from a Cloud Storage bucket or a local file. It always creates new test cases and won't overwrite any existing ones. The provided ID in the imported test case is neglected. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: ImportTestCasesMetadata - response: ImportTestCasesResponse

@param parent

Required. The agent to import test cases to. Format: projects//locations//agents/.

§
projectsLocationsAgentsTestCasesList(parent: string, opts?: ProjectsLocationsAgentsTestCasesListOptions): Promise<GoogleCloudDialogflowCxV3ListTestCasesResponse>
[src]

Fetches a list of test cases for a given agent.

@param parent

Required. The agent to list all pages for. Format: projects//locations//agents/.

§
projectsLocationsAgentsTestCasesPatch(name: string, req: GoogleCloudDialogflowCxV3TestCase, opts?: ProjectsLocationsAgentsTestCasesPatchOptions): Promise<GoogleCloudDialogflowCxV3TestCase>
[src]

Updates the specified test case.

@param name

The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: projects//locations//agents/ /testCases/.

§
projectsLocationsAgentsTestCasesResultsGet(name: string): Promise<GoogleCloudDialogflowCxV3TestCaseResult>
[src]

Gets a test case result.

@param name

Required. The name of the testcase. Format: projects//locations//agents//testCases//results/.

§
projectsLocationsAgentsTestCasesResultsList(parent: string, opts?: ProjectsLocationsAgentsTestCasesResultsListOptions): Promise<GoogleCloudDialogflowCxV3ListTestCaseResultsResponse>
[src]

Fetches the list of run results for the given test case. A maximum of 100 results are kept for each test case.

@param parent

Required. The test case to list results for. Format: projects//locations//agents// testCases/. Specify a - as a wildcard for TestCase ID to list results across multiple test cases.

§
projectsLocationsAgentsTestCasesRun(name: string, req: GoogleCloudDialogflowCxV3RunTestCaseRequest): Promise<GoogleLongrunningOperation>
[src]

Kicks off a test case run. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: RunTestCaseMetadata - response: RunTestCaseResponse

@param name

Required. Format of test case name to run: projects//locations/ /agents//testCases/.

§

Creates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.

@param parent

Required. The flow to create an TransitionRouteGroup for. Format: projects//locations//agents//flows/ or projects//locations//agents/ for agent-level groups.

§
projectsLocationsAgentsTransitionRouteGroupsDelete(name: string, opts?: ProjectsLocationsAgentsTransitionRouteGroupsDeleteOptions): Promise<GoogleProtobufEmpty>
[src]

Deletes the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.

@param name

Required. The name of the TransitionRouteGroup to delete. Format: projects//locations//agents//flows//transitionRouteGroups/ or projects//locations//agents//transitionRouteGroups/.

§
projectsLocationsAgentsTransitionRouteGroupsGet(name: string, opts?: ProjectsLocationsAgentsTransitionRouteGroupsGetOptions): Promise<GoogleCloudDialogflowCxV3TransitionRouteGroup>
[src]

Retrieves the specified TransitionRouteGroup.

@param name

Required. The name of the TransitionRouteGroup. Format: projects//locations//agents//flows//transitionRouteGroups/ or projects//locations//agents//transitionRouteGroups/.

§
projectsLocationsAgentsTransitionRouteGroupsList(parent: string, opts?: ProjectsLocationsAgentsTransitionRouteGroupsListOptions): Promise<GoogleCloudDialogflowCxV3ListTransitionRouteGroupsResponse>
[src]

Returns the list of all transition route groups in the specified flow.

@param parent

Required. The flow to list all transition route groups for. Format: projects//locations//agents//flows/ or `projects//locations//agents/.

§

Updates the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.

@param name

The unique identifier of the transition route group. TransitionRouteGroups.CreateTransitionRouteGroup populates the name automatically. Format: projects//locations//agents//flows//transitionRouteGroups/ .

§

Updates the generative settings for the agent.

@param name

Format: projects//locations//agents//generativeSettings.

§

Validates the specified agent and creates or updates validation results. The agent in draft version is validated. Please call this API after the training is completed to get the complete validation results.

@param name

Required. The agent to validate. Format: projects//locations//agents/.

§
projectsLocationsAgentsWebhooksCreate(parent: string, req: GoogleCloudDialogflowCxV3Webhook): Promise<GoogleCloudDialogflowCxV3Webhook>
[src]

Creates a webhook in the specified agent.

@param parent

Required. The agent to create a webhook for. Format: projects//locations//agents/.

§
projectsLocationsAgentsWebhooksDelete(name: string, opts?: ProjectsLocationsAgentsWebhooksDeleteOptions): Promise<GoogleProtobufEmpty>
[src]

Deletes the specified webhook.

@param name

Required. The name of the webhook to delete. Format: projects//locations//agents//webhooks/.

§
projectsLocationsAgentsWebhooksGet(name: string): Promise<GoogleCloudDialogflowCxV3Webhook>
[src]

Retrieves the specified webhook.

@param name

Required. The name of the webhook. Format: projects//locations//agents//webhooks/.

§
projectsLocationsAgentsWebhooksList(parent: string, opts?: ProjectsLocationsAgentsWebhooksListOptions): Promise<GoogleCloudDialogflowCxV3ListWebhooksResponse>
[src]

Returns the list of all webhooks in the specified agent.

@param parent

Required. The agent to list all webhooks for. Format: projects//locations//agents/.

§
projectsLocationsAgentsWebhooksPatch(name: string, req: GoogleCloudDialogflowCxV3Webhook, opts?: ProjectsLocationsAgentsWebhooksPatchOptions): Promise<GoogleCloudDialogflowCxV3Webhook>
[src]

Updates the specified webhook.

@param name

The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: projects//locations//agents//webhooks/.

§
projectsLocationsGet(name: string): Promise<GoogleCloudLocationLocation>
[src]

Gets information about a location.

@param name

Resource name for the location.

§
projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<GoogleCloudLocationListLocationsResponse>
[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

§
projectsLocationsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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

@param name

The name of the operation resource to be cancelled.

§
projectsLocationsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

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

@param name

The name of the operation resource.

§
projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

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

@param name

The name of the operation's parent resource.

§
projectsLocationsSecuritySettingsCreate(parent: string, req: GoogleCloudDialogflowCxV3SecuritySettings): Promise<GoogleCloudDialogflowCxV3SecuritySettings>
[src]

Create security settings in the specified location.

@param parent

Required. The location to create an SecuritySettings for. Format: projects//locations/.

§
projectsLocationsSecuritySettingsDelete(name: string): Promise<GoogleProtobufEmpty>
[src]

Deletes the specified SecuritySettings.

@param name

Required. The name of the SecuritySettings to delete. Format: projects//locations//securitySettings/.

§
projectsLocationsSecuritySettingsGet(name: string): Promise<GoogleCloudDialogflowCxV3SecuritySettings>
[src]

Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.

@param name

Required. Resource name of the settings. Format: projects//locations//securitySettings/.

§
projectsLocationsSecuritySettingsList(parent: string, opts?: ProjectsLocationsSecuritySettingsListOptions): Promise<GoogleCloudDialogflowCxV3ListSecuritySettingsResponse>
[src]

Returns the list of all security settings in the specified location.

@param parent

Required. The location to list all security settings for. Format: projects//locations/.

§

Updates the specified SecuritySettings.

@param name

Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: projects//locations//securitySettings/.

§
projectsOperationsCancel(name: string): Promise<GoogleProtobufEmpty>
[src]

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

@param name

The name of the operation resource to be cancelled.

§
projectsOperationsGet(name: string): Promise<GoogleLongrunningOperation>
[src]

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

@param name

The name of the operation resource.

§
projectsOperationsList(name: string, opts?: ProjectsOperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>
[src]

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

@param name

The name of the operation's parent resource.