Dialogflow API: projects. Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices). See: https://cloud.google.com/dialogflow/docs/reference/rest/v3/projects
Dialogflow API: projects. Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices). See: https://cloud.google.com/dialogflow/docs/reference/rest/v3/projects
(locations-agents-changelogs-get$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/changelogs/get
Required parameters: name
Optional parameters: none
Retrieves the specified Changelog.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/changelogs/get Required parameters: name Optional parameters: none Retrieves the specified Changelog.
(locations-agents-changelogs-list$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/changelogs/list
Required parameters: parent
Optional parameters: filter, pageSize, pageToken
Returns the list of Changelogs.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/changelogs/list Required parameters: parent Optional parameters: filter, pageSize, pageToken Returns the list of Changelogs.
(locations-agents-create$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/create
Required parameters: parent
Optional parameters: none
Body:
{:advancedSettings {:audioExportGcsDestination GoogleCloudDialogflowCxV3GcsDestination, :speechSettings GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings, :dtmfSettings GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings, :loggingSettings GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings}, :answerFeedbackSettings {:enableAnswerFeedback boolean}, :description string, :securitySettings string, :timeZone string, :startFlow string, :defaultLanguageCode string, :genAppBuilderSettings {:engine string}, :displayName string, :speechToTextSettings {:enableSpeechAdaptation boolean}, :name string, :textToSpeechSettings {:synthesizeSpeechConfigs {}}, :supportedLanguageCodes [string], :enableSpellCorrection boolean, :gitIntegrationSettings {:githubSettings GoogleCloudDialogflowCxV3AgentGitIntegrationSettingsGithubSettings}, :locked boolean, :personalizationSettings {:defaultEndUserMetadata {}}, :enableStackdriverLogging boolean, :avatarUri string, :enableMultiLanguageTraining boolean}
Creates an agent in the specified location. Note: You should always train flows prior to sending them queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/create
Required parameters: parent
Optional parameters: none
Body:
{:advancedSettings {:audioExportGcsDestination GoogleCloudDialogflowCxV3GcsDestination,
:speechSettings GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings,
:dtmfSettings GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings,
:loggingSettings GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings},
:answerFeedbackSettings {:enableAnswerFeedback boolean},
:description string,
:securitySettings string,
:timeZone string,
:startFlow string,
:defaultLanguageCode string,
:genAppBuilderSettings {:engine string},
:displayName string,
:speechToTextSettings {:enableSpeechAdaptation boolean},
:name string,
:textToSpeechSettings {:synthesizeSpeechConfigs {}},
:supportedLanguageCodes [string],
:enableSpellCorrection boolean,
:gitIntegrationSettings {:githubSettings GoogleCloudDialogflowCxV3AgentGitIntegrationSettingsGithubSettings},
:locked boolean,
:personalizationSettings {:defaultEndUserMetadata {}},
:enableStackdriverLogging boolean,
:avatarUri string,
:enableMultiLanguageTraining boolean}
Creates an agent in the specified location. Note: You should always train flows prior to sending them queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).(locations-agents-delete$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/delete
Required parameters: name
Optional parameters: none
Deletes the specified agent.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/delete Required parameters: name Optional parameters: none Deletes the specified agent.
(locations-agents-entityTypes-create$ auth parameters body)Required parameters: parent
Optional parameters: languageCode
Body:
{:name string, :displayName string, :kind string, :autoExpansionMode string, :entities [{:value string, :synonyms [string]}], :excludedPhrases [{:value string}], :enableFuzzyExtraction boolean, :redact boolean}
Creates an entity type in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/entityTypes/create
Required parameters: parent
Optional parameters: languageCode
Body:
{:name string,
:displayName string,
:kind string,
:autoExpansionMode string,
:entities [{:value string, :synonyms [string]}],
:excludedPhrases [{:value string}],
:enableFuzzyExtraction boolean,
:redact boolean}
Creates an entity type in the specified agent. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).(locations-agents-entityTypes-delete$ auth parameters)Required parameters: name
Optional parameters: force
Deletes the specified entity type. Note: You should always train a flow prior to sending it queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/entityTypes/delete Required parameters: name Optional parameters: force Deletes the specified entity type. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
(locations-agents-entityTypes-export$ auth parameters body)Required parameters: parent
Optional parameters: none
Body:
{:entityTypes [string], :entityTypesUri string, :entityTypesContentInline boolean, :dataFormat string, :languageCode string}
Exports the selected entity types.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/entityTypes/export
Required parameters: parent
Optional parameters: none
Body:
{:entityTypes [string],
:entityTypesUri string,
:entityTypesContentInline boolean,
:dataFormat string,
:languageCode string}
Exports the selected entity types.(locations-agents-entityTypes-get$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/entityTypes/get
Required parameters: name
Optional parameters: languageCode
Retrieves the specified entity type.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/entityTypes/get Required parameters: name Optional parameters: languageCode Retrieves the specified entity type.
(locations-agents-entityTypes-import$ auth parameters body)Required parameters: parent
Optional parameters: none
Body:
{:entityTypesUri string, :entityTypesContent {:content string}, :mergeOption string, :targetEntityType string}
Imports the specified entitytypes into the agent.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/entityTypes/import
Required parameters: parent
Optional parameters: none
Body:
{:entityTypesUri string,
:entityTypesContent {:content string},
:mergeOption string,
:targetEntityType string}
Imports the specified entitytypes into the agent.(locations-agents-entityTypes-list$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/entityTypes/list
Required parameters: parent
Optional parameters: languageCode, pageSize, pageToken
Returns the list of all entity types in the specified agent.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/entityTypes/list Required parameters: parent Optional parameters: languageCode, pageSize, pageToken Returns the list of all entity types in the specified agent.
(locations-agents-entityTypes-patch$ auth parameters body)Required parameters: name
Optional parameters: languageCode, updateMask
Body:
{:name string, :displayName string, :kind string, :autoExpansionMode string, :entities [{:value string, :synonyms [string]}], :excludedPhrases [{:value string}], :enableFuzzyExtraction boolean, :redact boolean}
Updates the specified entity type. Note: You should always train a flow prior to sending it queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/entityTypes/patch
Required parameters: name
Optional parameters: languageCode, updateMask
Body:
{:name string,
:displayName string,
:kind string,
:autoExpansionMode string,
:entities [{:value string, :synonyms [string]}],
:excludedPhrases [{:value string}],
:enableFuzzyExtraction boolean,
:redact boolean}
Updates the specified entity type. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).(locations-agents-environments-continuousTestResults-list$ auth parameters)Required parameters: parent
Optional parameters: pageSize, pageToken
Fetches a list of continuous test results for a given environment.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/continuousTestResults/list Required parameters: parent Optional parameters: pageSize, pageToken Fetches a list of continuous test results for a given environment.
(locations-agents-environments-create$ auth parameters body)Required parameters: parent
Optional parameters: none
Body:
{:name string, :displayName string, :description string, :versionConfigs [{:version string}], :updateTime string, :testCasesConfig {:testCases [string], :enableContinuousRun boolean, :enablePredeploymentRun boolean}, :webhookConfig {:webhookOverrides [GoogleCloudDialogflowCxV3Webhook]}}
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
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/create
Required parameters: parent
Optional parameters: none
Body:
{:name string,
:displayName string,
:description string,
:versionConfigs [{:version string}],
:updateTime string,
:testCasesConfig {:testCases [string],
:enableContinuousRun boolean,
:enablePredeploymentRun boolean},
:webhookConfig {:webhookOverrides [GoogleCloudDialogflowCxV3Webhook]}}
Creates an Environment in the specified Agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: Environment(locations-agents-environments-delete$ auth parameters)Required parameters: name
Optional parameters: none
Deletes the specified Environment.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/delete Required parameters: name Optional parameters: none Deletes the specified Environment.
(locations-agents-environments-deployFlow$ auth parameters body)Required parameters: environment
Optional parameters: none
Body:
{:flowVersion string}
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
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/deployFlow
Required parameters: environment
Optional parameters: none
Body:
{:flowVersion string}
Deploys a flow to the specified Environment. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: DeployFlowMetadata - `response`: DeployFlowResponse(locations-agents-environments-deployments-get$ auth parameters)Required parameters: name
Optional parameters: none
Retrieves the specified Deployment.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/deployments/get Required parameters: name Optional parameters: none Retrieves the specified Deployment.
(locations-agents-environments-deployments-list$ auth parameters)Required parameters: parent
Optional parameters: pageSize, pageToken
Returns the list of all deployments in the specified Environment.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/deployments/list Required parameters: parent Optional parameters: pageSize, pageToken Returns the list of all deployments in the specified Environment.
(locations-agents-environments-experiments-create$ auth parameters body)Required parameters: parent
Optional parameters: none
Body:
{:description string, :variantsHistory [{:versionVariants GoogleCloudDialogflowCxV3VersionVariants, :updateTime string}], :definition {:condition string, :versionVariants GoogleCloudDialogflowCxV3VersionVariants}, :rolloutState {:step string, :stepIndex integer, :startTime string}, :startTime string, :displayName string, :name string, :endTime string, :createTime string, :rolloutFailureReason string, :state string, :rolloutConfig {:rolloutSteps [GoogleCloudDialogflowCxV3RolloutConfigRolloutStep], :rolloutCondition string, :failureCondition string}, :result {:versionMetrics [GoogleCloudDialogflowCxV3ExperimentResultVersionMetrics], :lastUpdateTime string}, :lastUpdateTime string, :experimentLength string}
Creates an Experiment in the specified Environment.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/experiments/create
Required parameters: parent
Optional parameters: none
Body:
{:description string,
:variantsHistory [{:versionVariants GoogleCloudDialogflowCxV3VersionVariants,
:updateTime string}],
:definition {:condition string,
:versionVariants GoogleCloudDialogflowCxV3VersionVariants},
:rolloutState {:step string, :stepIndex integer, :startTime string},
:startTime string,
:displayName string,
:name string,
:endTime string,
:createTime string,
:rolloutFailureReason string,
:state string,
:rolloutConfig {:rolloutSteps [GoogleCloudDialogflowCxV3RolloutConfigRolloutStep],
:rolloutCondition string,
:failureCondition string},
:result {:versionMetrics [GoogleCloudDialogflowCxV3ExperimentResultVersionMetrics],
:lastUpdateTime string},
:lastUpdateTime string,
:experimentLength string}
Creates an Experiment in the specified Environment.(locations-agents-environments-experiments-delete$ auth parameters)Required parameters: name
Optional parameters: none
Deletes the specified Experiment.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/experiments/delete Required parameters: name Optional parameters: none Deletes the specified Experiment.
(locations-agents-environments-experiments-get$ auth parameters)Required parameters: name
Optional parameters: none
Retrieves the specified Experiment.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/experiments/get Required parameters: name Optional parameters: none Retrieves the specified Experiment.
(locations-agents-environments-experiments-list$ auth parameters)Required parameters: parent
Optional parameters: pageSize, pageToken
Returns the list of all experiments in the specified Environment.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/experiments/list Required parameters: parent Optional parameters: pageSize, pageToken Returns the list of all experiments in the specified Environment.
(locations-agents-environments-experiments-patch$ auth parameters body)Required parameters: name
Optional parameters: updateMask
Body:
{:description string, :variantsHistory [{:versionVariants GoogleCloudDialogflowCxV3VersionVariants, :updateTime string}], :definition {:condition string, :versionVariants GoogleCloudDialogflowCxV3VersionVariants}, :rolloutState {:step string, :stepIndex integer, :startTime string}, :startTime string, :displayName string, :name string, :endTime string, :createTime string, :rolloutFailureReason string, :state string, :rolloutConfig {:rolloutSteps [GoogleCloudDialogflowCxV3RolloutConfigRolloutStep], :rolloutCondition string, :failureCondition string}, :result {:versionMetrics [GoogleCloudDialogflowCxV3ExperimentResultVersionMetrics], :lastUpdateTime string}, :lastUpdateTime string, :experimentLength string}
Updates the specified Experiment.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/experiments/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:description string,
:variantsHistory [{:versionVariants GoogleCloudDialogflowCxV3VersionVariants,
:updateTime string}],
:definition {:condition string,
:versionVariants GoogleCloudDialogflowCxV3VersionVariants},
:rolloutState {:step string, :stepIndex integer, :startTime string},
:startTime string,
:displayName string,
:name string,
:endTime string,
:createTime string,
:rolloutFailureReason string,
:state string,
:rolloutConfig {:rolloutSteps [GoogleCloudDialogflowCxV3RolloutConfigRolloutStep],
:rolloutCondition string,
:failureCondition string},
:result {:versionMetrics [GoogleCloudDialogflowCxV3ExperimentResultVersionMetrics],
:lastUpdateTime string},
:lastUpdateTime string,
:experimentLength string}
Updates the specified Experiment.(locations-agents-environments-experiments-start$ auth parameters body)Required parameters: name
Optional parameters: none
Body:
{}
Starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/experiments/start
Required parameters: name
Optional parameters: none
Body:
{}
Starts the specified Experiment. This rpc only changes the state of experiment from PENDING to RUNNING.(locations-agents-environments-experiments-stop$ auth parameters body)Required parameters: name
Optional parameters: none
Body:
{}
Stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/experiments/stop
Required parameters: name
Optional parameters: none
Body:
{}
Stops the specified Experiment. This rpc only changes the state of experiment from RUNNING to DONE.(locations-agents-environments-get$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/get
Required parameters: name
Optional parameters: none
Retrieves the specified Environment.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/get Required parameters: name Optional parameters: none Retrieves the specified Environment.
(locations-agents-environments-list$ auth parameters)Required parameters: parent
Optional parameters: pageSize, pageToken
Returns the list of all environments in the specified Agent.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/list Required parameters: parent Optional parameters: pageSize, pageToken Returns the list of all environments in the specified Agent.
(locations-agents-environments-lookupEnvironmentHistory$ auth parameters)Required parameters: name
Optional parameters: pageSize, pageToken
Looks up the history of the specified Environment.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/lookupEnvironmentHistory Required parameters: name Optional parameters: pageSize, pageToken Looks up the history of the specified Environment.
(locations-agents-environments-patch$ auth parameters body)Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :displayName string, :description string, :versionConfigs [{:version string}], :updateTime string, :testCasesConfig {:testCases [string], :enableContinuousRun boolean, :enablePredeploymentRun boolean}, :webhookConfig {:webhookOverrides [GoogleCloudDialogflowCxV3Webhook]}}
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
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:name string,
:displayName string,
:description string,
:versionConfigs [{:version string}],
:updateTime string,
:testCasesConfig {:testCases [string],
:enableContinuousRun boolean,
:enablePredeploymentRun boolean},
:webhookConfig {:webhookOverrides [GoogleCloudDialogflowCxV3Webhook]}}
Updates the specified Environment. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: Environment(locations-agents-environments-runContinuousTest$ auth parameters body)Required parameters: environment
Optional parameters: none
Body:
{}
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
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/runContinuousTest
Required parameters: environment
Optional parameters: none
Body:
{}
Kicks off a continuous test under the specified Environment. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: RunContinuousTestMetadata - `response`: RunContinuousTestResponse(locations-agents-environments-sessions-detectIntent$ auth parameters body)Required parameters: session
Optional parameters: none
Body:
{:queryParams {:currentPage string, :timeZone string, :sessionEntityTypes [GoogleCloudDialogflowCxV3SessionEntityType], :payload {}, :searchConfig GoogleCloudDialogflowCxV3SearchConfig, :channel string, :webhookHeaders {}, :endUserMetadata {}, :sessionTtl string, :disableWebhook boolean, :analyzeQueryTextSentiment boolean, :flowVersions [string], :geoLocation GoogleTypeLatLng, :parameters {}, :populateDataStoreConnectionSignals boolean}, :queryInput {:text GoogleCloudDialogflowCxV3TextInput, :intent GoogleCloudDialogflowCxV3IntentInput, :audio GoogleCloudDialogflowCxV3AudioInput, :event GoogleCloudDialogflowCxV3EventInput, :dtmf GoogleCloudDialogflowCxV3DtmfInput, :languageCode string}, :outputAudioConfig {:audioEncoding string, :sampleRateHertz integer, :synthesizeSpeechConfig GoogleCloudDialogflowCxV3SynthesizeSpeechConfig}}
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.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/sessions/detectIntent
Required parameters: session
Optional parameters: none
Body:
{:queryParams {:currentPage string,
:timeZone string,
:sessionEntityTypes [GoogleCloudDialogflowCxV3SessionEntityType],
:payload {},
:searchConfig GoogleCloudDialogflowCxV3SearchConfig,
:channel string,
:webhookHeaders {},
:endUserMetadata {},
:sessionTtl string,
:disableWebhook boolean,
:analyzeQueryTextSentiment boolean,
:flowVersions [string],
:geoLocation GoogleTypeLatLng,
:parameters {},
:populateDataStoreConnectionSignals boolean},
:queryInput {:text GoogleCloudDialogflowCxV3TextInput,
:intent GoogleCloudDialogflowCxV3IntentInput,
:audio GoogleCloudDialogflowCxV3AudioInput,
:event GoogleCloudDialogflowCxV3EventInput,
:dtmf GoogleCloudDialogflowCxV3DtmfInput,
:languageCode string},
:outputAudioConfig {:audioEncoding string,
:sampleRateHertz integer,
:synthesizeSpeechConfig GoogleCloudDialogflowCxV3SynthesizeSpeechConfig}}
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](https://cloud.google.com/dialogflow/cx/docs/concept/version).(locations-agents-environments-sessions-entityTypes-create$ auth
parameters
body)Required parameters: parent
Optional parameters: none
Body:
{:name string, :entityOverrideMode string, :entities [{:value string, :synonyms [string]}]}
Creates a session entity type.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/sessions/entityTypes/create
Required parameters: parent
Optional parameters: none
Body:
{:name string,
:entityOverrideMode string,
:entities [{:value string, :synonyms [string]}]}
Creates a session entity type.(locations-agents-environments-sessions-entityTypes-delete$ auth parameters)Required parameters: name
Optional parameters: none
Deletes the specified session entity type.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/sessions/entityTypes/delete Required parameters: name Optional parameters: none Deletes the specified session entity type.
(locations-agents-environments-sessions-entityTypes-get$ auth parameters)Required parameters: name
Optional parameters: none
Retrieves the specified session entity type.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/sessions/entityTypes/get Required parameters: name Optional parameters: none Retrieves the specified session entity type.
(locations-agents-environments-sessions-entityTypes-list$ auth parameters)Required parameters: parent
Optional parameters: pageSize, pageToken
Returns the list of all session entity types in the specified session.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/sessions/entityTypes/list Required parameters: parent Optional parameters: pageSize, pageToken Returns the list of all session entity types in the specified session.
(locations-agents-environments-sessions-entityTypes-patch$ auth parameters body)Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :entityOverrideMode string, :entities [{:value string, :synonyms [string]}]}
Updates the specified session entity type.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/sessions/entityTypes/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:name string,
:entityOverrideMode string,
:entities [{:value string, :synonyms [string]}]}
Updates the specified session entity type.(locations-agents-environments-sessions-fulfillIntent$ auth parameters body)Required parameters: session
Optional parameters: none
Body:
{:matchIntentRequest {:queryParams GoogleCloudDialogflowCxV3QueryParameters, :queryInput GoogleCloudDialogflowCxV3QueryInput, :persistParameterChanges boolean}, :match {:intent GoogleCloudDialogflowCxV3Intent, :event string, :parameters {}, :resolvedInput string, :matchType string, :confidence number}, :outputAudioConfig {:audioEncoding string, :sampleRateHertz integer, :synthesizeSpeechConfig GoogleCloudDialogflowCxV3SynthesizeSpeechConfig}}
Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/sessions/fulfillIntent
Required parameters: session
Optional parameters: none
Body:
{:matchIntentRequest {:queryParams GoogleCloudDialogflowCxV3QueryParameters,
:queryInput GoogleCloudDialogflowCxV3QueryInput,
:persistParameterChanges boolean},
:match {:intent GoogleCloudDialogflowCxV3Intent,
:event string,
:parameters {},
:resolvedInput string,
:matchType string,
:confidence number},
:outputAudioConfig {:audioEncoding string,
:sampleRateHertz integer,
:synthesizeSpeechConfig GoogleCloudDialogflowCxV3SynthesizeSpeechConfig}}
Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.(locations-agents-environments-sessions-matchIntent$ auth parameters body)Required parameters: session
Optional parameters: none
Body:
{:queryParams {:currentPage string, :timeZone string, :sessionEntityTypes [GoogleCloudDialogflowCxV3SessionEntityType], :payload {}, :searchConfig GoogleCloudDialogflowCxV3SearchConfig, :channel string, :webhookHeaders {}, :endUserMetadata {}, :sessionTtl string, :disableWebhook boolean, :analyzeQueryTextSentiment boolean, :flowVersions [string], :geoLocation GoogleTypeLatLng, :parameters {}, :populateDataStoreConnectionSignals boolean}, :queryInput {:text GoogleCloudDialogflowCxV3TextInput, :intent GoogleCloudDialogflowCxV3IntentInput, :audio GoogleCloudDialogflowCxV3AudioInput, :event GoogleCloudDialogflowCxV3EventInput, :dtmf GoogleCloudDialogflowCxV3DtmfInput, :languageCode string}, :persistParameterChanges boolean}
Returns preliminary intent match results, doesn't change the session status.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/sessions/matchIntent
Required parameters: session
Optional parameters: none
Body:
{:queryParams {:currentPage string,
:timeZone string,
:sessionEntityTypes [GoogleCloudDialogflowCxV3SessionEntityType],
:payload {},
:searchConfig GoogleCloudDialogflowCxV3SearchConfig,
:channel string,
:webhookHeaders {},
:endUserMetadata {},
:sessionTtl string,
:disableWebhook boolean,
:analyzeQueryTextSentiment boolean,
:flowVersions [string],
:geoLocation GoogleTypeLatLng,
:parameters {},
:populateDataStoreConnectionSignals boolean},
:queryInput {:text GoogleCloudDialogflowCxV3TextInput,
:intent GoogleCloudDialogflowCxV3IntentInput,
:audio GoogleCloudDialogflowCxV3AudioInput,
:event GoogleCloudDialogflowCxV3EventInput,
:dtmf GoogleCloudDialogflowCxV3DtmfInput,
:languageCode string},
:persistParameterChanges boolean}
Returns preliminary intent match results, doesn't change the session status.(locations-agents-environments-sessions-serverStreamingDetectIntent$ auth
parameters
body)Required parameters: session
Optional parameters: none
Body:
{:queryParams {:currentPage string, :timeZone string, :sessionEntityTypes [GoogleCloudDialogflowCxV3SessionEntityType], :payload {}, :searchConfig GoogleCloudDialogflowCxV3SearchConfig, :channel string, :webhookHeaders {}, :endUserMetadata {}, :sessionTtl string, :disableWebhook boolean, :analyzeQueryTextSentiment boolean, :flowVersions [string], :geoLocation GoogleTypeLatLng, :parameters {}, :populateDataStoreConnectionSignals boolean}, :queryInput {:text GoogleCloudDialogflowCxV3TextInput, :intent GoogleCloudDialogflowCxV3IntentInput, :audio GoogleCloudDialogflowCxV3AudioInput, :event GoogleCloudDialogflowCxV3EventInput, :dtmf GoogleCloudDialogflowCxV3DtmfInput, :languageCode string}, :outputAudioConfig {:audioEncoding string, :sampleRateHertz integer, :synthesizeSpeechConfig GoogleCloudDialogflowCxV3SynthesizeSpeechConfig}}
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.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/environments/sessions/serverStreamingDetectIntent
Required parameters: session
Optional parameters: none
Body:
{:queryParams {:currentPage string,
:timeZone string,
:sessionEntityTypes [GoogleCloudDialogflowCxV3SessionEntityType],
:payload {},
:searchConfig GoogleCloudDialogflowCxV3SearchConfig,
:channel string,
:webhookHeaders {},
:endUserMetadata {},
:sessionTtl string,
:disableWebhook boolean,
:analyzeQueryTextSentiment boolean,
:flowVersions [string],
:geoLocation GoogleTypeLatLng,
:parameters {},
:populateDataStoreConnectionSignals boolean},
:queryInput {:text GoogleCloudDialogflowCxV3TextInput,
:intent GoogleCloudDialogflowCxV3IntentInput,
:audio GoogleCloudDialogflowCxV3AudioInput,
:event GoogleCloudDialogflowCxV3EventInput,
:dtmf GoogleCloudDialogflowCxV3DtmfInput,
:languageCode string},
:outputAudioConfig {:audioEncoding string,
:sampleRateHertz integer,
:synthesizeSpeechConfig GoogleCloudDialogflowCxV3SynthesizeSpeechConfig}}
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](https://cloud.google.com/dialogflow/cx/docs/concept/fulfillment#partial-response) earlier in a single request.(locations-agents-export$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/export
Required parameters: name
Optional parameters: none
Body:
{:agentUri string, :dataFormat string, :environment string, :gitDestination {:trackingBranch string, :commitMessage string}, :includeBigqueryExportSettings boolean}
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
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/export
Required parameters: name
Optional parameters: none
Body:
{:agentUri string,
:dataFormat string,
:environment string,
:gitDestination {:trackingBranch string, :commitMessage string},
:includeBigqueryExportSettings boolean}
Exports the specified agent to a binary file. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: ExportAgentResponse(locations-agents-flows-create$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/create
Required parameters: parent
Optional parameters: languageCode
Body:
{:advancedSettings {:audioExportGcsDestination GoogleCloudDialogflowCxV3GcsDestination, :speechSettings GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings, :dtmfSettings GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings, :loggingSettings GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings}, :description string, :multiLanguageSettings {:enableMultiLanguageDetection boolean, :supportedResponseLanguageCodes [string]}, :transitionRouteGroups [string], :transitionRoutes [{:name string, :description string, :intent string, :condition string, :triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment, :targetPage string, :targetFlow string}], :displayName string, :name string, :knowledgeConnectorSettings {:enabled boolean, :triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment, :targetPage string, :targetFlow string, :dataStoreConnections [GoogleCloudDialogflowCxV3DataStoreConnection]}, :eventHandlers [{:name string, :event string, :triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment, :targetPage string, :targetFlow string}], :nluSettings {:modelType string, :classificationThreshold number, :modelTrainingMode string}}
Creates a flow in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/create
Required parameters: parent
Optional parameters: languageCode
Body:
{:advancedSettings {:audioExportGcsDestination GoogleCloudDialogflowCxV3GcsDestination,
:speechSettings GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings,
:dtmfSettings GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings,
:loggingSettings GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings},
:description string,
:multiLanguageSettings {:enableMultiLanguageDetection boolean,
:supportedResponseLanguageCodes [string]},
:transitionRouteGroups [string],
:transitionRoutes [{:name string,
:description string,
:intent string,
:condition string,
:triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment,
:targetPage string,
:targetFlow string}],
:displayName string,
:name string,
:knowledgeConnectorSettings {:enabled boolean,
:triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment,
:targetPage string,
:targetFlow string,
:dataStoreConnections [GoogleCloudDialogflowCxV3DataStoreConnection]},
:eventHandlers [{:name string,
:event string,
:triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment,
:targetPage string,
:targetFlow string}],
:nluSettings {:modelType string,
:classificationThreshold number,
:modelTrainingMode string}}
Creates a flow in the specified agent. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).(locations-agents-flows-delete$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/delete
Required parameters: name
Optional parameters: force
Deletes a specified flow.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/delete Required parameters: name Optional parameters: force Deletes a specified flow.
(locations-agents-flows-export$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/export
Required parameters: name
Optional parameters: none
Body:
{:flowUri string, :includeReferencedFlows boolean}
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.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/export
Required parameters: name
Optional parameters: none
Body:
{:flowUri string, :includeReferencedFlows boolean}
Exports the specified flow to a binary file. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: ExportFlowResponse Note that resources (e.g. intents, entities, webhooks) that the flow references will also be exported.(locations-agents-flows-get$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/get
Required parameters: name
Optional parameters: languageCode
Retrieves the specified flow.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/get Required parameters: name Optional parameters: languageCode Retrieves the specified flow.
(locations-agents-flows-getValidationResult$ auth parameters)Required parameters: name
Optional parameters: languageCode
Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/getValidationResult Required parameters: name Optional parameters: languageCode Gets the latest flow validation result. Flow validation is performed when ValidateFlow is called.
(locations-agents-flows-import$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/import
Required parameters: parent
Optional parameters: none
Body:
{:flowUri string, :flowContent string, :importOption string, :flowImportStrategy {:globalImportStrategy string}}
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.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/import
Required parameters: parent
Optional parameters: none
Body:
{:flowUri string,
:flowContent string,
:importOption string,
:flowImportStrategy {:globalImportStrategy string}}
Imports the specified flow to the specified agent from a binary file. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: ImportFlowResponse Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).(locations-agents-flows-list$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/list
Required parameters: parent
Optional parameters: pageSize, pageToken, languageCode
Returns the list of all flows in the specified agent.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/list Required parameters: parent Optional parameters: pageSize, pageToken, languageCode Returns the list of all flows in the specified agent.
(locations-agents-flows-pages-create$ auth parameters body)Required parameters: parent
Optional parameters: languageCode
Body:
{:advancedSettings {:audioExportGcsDestination GoogleCloudDialogflowCxV3GcsDestination, :speechSettings GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings, :dtmfSettings GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings, :loggingSettings GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings}, :description string, :transitionRouteGroups [string], :transitionRoutes [{:name string, :description string, :intent string, :condition string, :triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment, :targetPage string, :targetFlow string}], :displayName string, :name string, :knowledgeConnectorSettings {:enabled boolean, :triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment, :targetPage string, :targetFlow string, :dataStoreConnections [GoogleCloudDialogflowCxV3DataStoreConnection]}, :eventHandlers [{:name string, :event string, :triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment, :targetPage string, :targetFlow string}], :entryFulfillment {:messages [GoogleCloudDialogflowCxV3ResponseMessage], :webhook string, :returnPartialResponses boolean, :tag string, :setParameterActions [GoogleCloudDialogflowCxV3FulfillmentSetParameterAction], :conditionalCases [GoogleCloudDialogflowCxV3FulfillmentConditionalCases], :advancedSettings GoogleCloudDialogflowCxV3AdvancedSettings, :enableGenerativeFallback boolean}, :form {:parameters [GoogleCloudDialogflowCxV3FormParameter]}}
Creates a page in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/pages/create
Required parameters: parent
Optional parameters: languageCode
Body:
{:advancedSettings {:audioExportGcsDestination GoogleCloudDialogflowCxV3GcsDestination,
:speechSettings GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings,
:dtmfSettings GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings,
:loggingSettings GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings},
:description string,
:transitionRouteGroups [string],
:transitionRoutes [{:name string,
:description string,
:intent string,
:condition string,
:triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment,
:targetPage string,
:targetFlow string}],
:displayName string,
:name string,
:knowledgeConnectorSettings {:enabled boolean,
:triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment,
:targetPage string,
:targetFlow string,
:dataStoreConnections [GoogleCloudDialogflowCxV3DataStoreConnection]},
:eventHandlers [{:name string,
:event string,
:triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment,
:targetPage string,
:targetFlow string}],
:entryFulfillment {:messages [GoogleCloudDialogflowCxV3ResponseMessage],
:webhook string,
:returnPartialResponses boolean,
:tag string,
:setParameterActions [GoogleCloudDialogflowCxV3FulfillmentSetParameterAction],
:conditionalCases [GoogleCloudDialogflowCxV3FulfillmentConditionalCases],
:advancedSettings GoogleCloudDialogflowCxV3AdvancedSettings,
:enableGenerativeFallback boolean},
:form {:parameters [GoogleCloudDialogflowCxV3FormParameter]}}
Creates a page in the specified flow. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).(locations-agents-flows-pages-delete$ auth parameters)Required parameters: name
Optional parameters: force
Deletes the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/pages/delete Required parameters: name Optional parameters: force Deletes the specified page. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
(locations-agents-flows-pages-get$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/pages/get
Required parameters: name
Optional parameters: languageCode
Retrieves the specified page.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/pages/get Required parameters: name Optional parameters: languageCode Retrieves the specified page.
(locations-agents-flows-pages-list$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/pages/list
Required parameters: parent
Optional parameters: languageCode, pageSize, pageToken
Returns the list of all pages in the specified flow.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/pages/list Required parameters: parent Optional parameters: languageCode, pageSize, pageToken Returns the list of all pages in the specified flow.
(locations-agents-flows-pages-patch$ auth parameters body)Required parameters: name
Optional parameters: languageCode, updateMask
Body:
{:advancedSettings {:audioExportGcsDestination GoogleCloudDialogflowCxV3GcsDestination, :speechSettings GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings, :dtmfSettings GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings, :loggingSettings GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings}, :description string, :transitionRouteGroups [string], :transitionRoutes [{:name string, :description string, :intent string, :condition string, :triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment, :targetPage string, :targetFlow string}], :displayName string, :name string, :knowledgeConnectorSettings {:enabled boolean, :triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment, :targetPage string, :targetFlow string, :dataStoreConnections [GoogleCloudDialogflowCxV3DataStoreConnection]}, :eventHandlers [{:name string, :event string, :triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment, :targetPage string, :targetFlow string}], :entryFulfillment {:messages [GoogleCloudDialogflowCxV3ResponseMessage], :webhook string, :returnPartialResponses boolean, :tag string, :setParameterActions [GoogleCloudDialogflowCxV3FulfillmentSetParameterAction], :conditionalCases [GoogleCloudDialogflowCxV3FulfillmentConditionalCases], :advancedSettings GoogleCloudDialogflowCxV3AdvancedSettings, :enableGenerativeFallback boolean}, :form {:parameters [GoogleCloudDialogflowCxV3FormParameter]}}
Updates the specified page. Note: You should always train a flow prior to sending it queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/pages/patch
Required parameters: name
Optional parameters: languageCode, updateMask
Body:
{:advancedSettings {:audioExportGcsDestination GoogleCloudDialogflowCxV3GcsDestination,
:speechSettings GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings,
:dtmfSettings GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings,
:loggingSettings GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings},
:description string,
:transitionRouteGroups [string],
:transitionRoutes [{:name string,
:description string,
:intent string,
:condition string,
:triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment,
:targetPage string,
:targetFlow string}],
:displayName string,
:name string,
:knowledgeConnectorSettings {:enabled boolean,
:triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment,
:targetPage string,
:targetFlow string,
:dataStoreConnections [GoogleCloudDialogflowCxV3DataStoreConnection]},
:eventHandlers [{:name string,
:event string,
:triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment,
:targetPage string,
:targetFlow string}],
:entryFulfillment {:messages [GoogleCloudDialogflowCxV3ResponseMessage],
:webhook string,
:returnPartialResponses boolean,
:tag string,
:setParameterActions [GoogleCloudDialogflowCxV3FulfillmentSetParameterAction],
:conditionalCases [GoogleCloudDialogflowCxV3FulfillmentConditionalCases],
:advancedSettings GoogleCloudDialogflowCxV3AdvancedSettings,
:enableGenerativeFallback boolean},
:form {:parameters [GoogleCloudDialogflowCxV3FormParameter]}}
Updates the specified page. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).(locations-agents-flows-patch$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/patch
Required parameters: name
Optional parameters: updateMask, languageCode
Body:
{:advancedSettings {:audioExportGcsDestination GoogleCloudDialogflowCxV3GcsDestination, :speechSettings GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings, :dtmfSettings GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings, :loggingSettings GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings}, :description string, :multiLanguageSettings {:enableMultiLanguageDetection boolean, :supportedResponseLanguageCodes [string]}, :transitionRouteGroups [string], :transitionRoutes [{:name string, :description string, :intent string, :condition string, :triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment, :targetPage string, :targetFlow string}], :displayName string, :name string, :knowledgeConnectorSettings {:enabled boolean, :triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment, :targetPage string, :targetFlow string, :dataStoreConnections [GoogleCloudDialogflowCxV3DataStoreConnection]}, :eventHandlers [{:name string, :event string, :triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment, :targetPage string, :targetFlow string}], :nluSettings {:modelType string, :classificationThreshold number, :modelTrainingMode string}}
Updates the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/patch
Required parameters: name
Optional parameters: updateMask, languageCode
Body:
{:advancedSettings {:audioExportGcsDestination GoogleCloudDialogflowCxV3GcsDestination,
:speechSettings GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings,
:dtmfSettings GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings,
:loggingSettings GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings},
:description string,
:multiLanguageSettings {:enableMultiLanguageDetection boolean,
:supportedResponseLanguageCodes [string]},
:transitionRouteGroups [string],
:transitionRoutes [{:name string,
:description string,
:intent string,
:condition string,
:triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment,
:targetPage string,
:targetFlow string}],
:displayName string,
:name string,
:knowledgeConnectorSettings {:enabled boolean,
:triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment,
:targetPage string,
:targetFlow string,
:dataStoreConnections [GoogleCloudDialogflowCxV3DataStoreConnection]},
:eventHandlers [{:name string,
:event string,
:triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment,
:targetPage string,
:targetFlow string}],
:nluSettings {:modelType string,
:classificationThreshold number,
:modelTrainingMode string}}
Updates the specified flow. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).(locations-agents-flows-train$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/train
Required parameters: name
Optional parameters: none
Body:
{}
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 - response: An Empty message Note: You should always train a flow prior to sending it queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/train
Required parameters: name
Optional parameters: none
Body:
{}
Trains the specified flow. Note that only the flow in 'draft' environment is trained. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).(locations-agents-flows-transitionRouteGroups-create$ auth parameters body)Required parameters: parent
Optional parameters: languageCode
Body:
{:name string, :displayName string, :transitionRoutes [{:name string, :description string, :intent string, :condition string, :triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment, :targetPage string, :targetFlow string}]}
Creates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/transitionRouteGroups/create
Required parameters: parent
Optional parameters: languageCode
Body:
{:name string,
:displayName string,
:transitionRoutes [{:name string,
:description string,
:intent string,
:condition string,
:triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment,
:targetPage string,
:targetFlow string}]}
Creates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).(locations-agents-flows-transitionRouteGroups-delete$ auth parameters)Required parameters: name
Optional parameters: force
Deletes the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/transitionRouteGroups/delete Required parameters: name Optional parameters: force Deletes the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
(locations-agents-flows-transitionRouteGroups-get$ auth parameters)Required parameters: name
Optional parameters: languageCode
Retrieves the specified TransitionRouteGroup.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/transitionRouteGroups/get Required parameters: name Optional parameters: languageCode Retrieves the specified TransitionRouteGroup.
(locations-agents-flows-transitionRouteGroups-list$ auth parameters)Required parameters: parent
Optional parameters: pageSize, pageToken, languageCode
Returns the list of all transition route groups in the specified flow.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/transitionRouteGroups/list Required parameters: parent Optional parameters: pageSize, pageToken, languageCode Returns the list of all transition route groups in the specified flow.
(locations-agents-flows-transitionRouteGroups-patch$ auth parameters body)Required parameters: name
Optional parameters: updateMask, languageCode
Body:
{:name string, :displayName string, :transitionRoutes [{:name string, :description string, :intent string, :condition string, :triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment, :targetPage string, :targetFlow string}]}
Updates the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/transitionRouteGroups/patch
Required parameters: name
Optional parameters: updateMask, languageCode
Body:
{:name string,
:displayName string,
:transitionRoutes [{:name string,
:description string,
:intent string,
:condition string,
:triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment,
:targetPage string,
:targetFlow string}]}
Updates the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).(locations-agents-flows-validate$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/validate
Required parameters: name
Optional parameters: none
Body:
{:languageCode string}
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.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/validate
Required parameters: name
Optional parameters: none
Body:
{:languageCode string}
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.(locations-agents-flows-versions-compareVersions$ auth parameters body)Required parameters: baseVersion
Optional parameters: none
Body:
{:targetVersion string, :languageCode string}
Compares the specified base version with target version.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/versions/compareVersions
Required parameters: baseVersion
Optional parameters: none
Body:
{:targetVersion string, :languageCode string}
Compares the specified base version with target version.(locations-agents-flows-versions-create$ auth parameters body)Required parameters: parent
Optional parameters: none
Body:
{:name string, :displayName string, :description string, :nluSettings {:modelType string, :classificationThreshold number, :modelTrainingMode string}, :createTime string, :state string}
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
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/versions/create
Required parameters: parent
Optional parameters: none
Body:
{:name string,
:displayName string,
:description string,
:nluSettings {:modelType string,
:classificationThreshold number,
:modelTrainingMode string},
:createTime string,
:state string}
Creates a Version in the specified Flow. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: CreateVersionOperationMetadata - `response`: Version(locations-agents-flows-versions-delete$ auth parameters)Required parameters: name
Optional parameters: none
Deletes the specified Version.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/versions/delete Required parameters: name Optional parameters: none Deletes the specified Version.
(locations-agents-flows-versions-get$ auth parameters)Required parameters: name
Optional parameters: none
Retrieves the specified Version.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/versions/get Required parameters: name Optional parameters: none Retrieves the specified Version.
(locations-agents-flows-versions-list$ auth parameters)Required parameters: parent
Optional parameters: pageSize, pageToken
Returns the list of all versions in the specified Flow.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/versions/list Required parameters: parent Optional parameters: pageSize, pageToken Returns the list of all versions in the specified Flow.
(locations-agents-flows-versions-load$ auth parameters body)Required parameters: name
Optional parameters: none
Body:
{:allowOverrideAgentResources boolean}
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 - response: An Empty message
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/versions/load
Required parameters: name
Optional parameters: none
Body:
{:allowOverrideAgentResources boolean}
Loads resources in the specified version to the draft flow. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)(locations-agents-flows-versions-patch$ auth parameters body)Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :displayName string, :description string, :nluSettings {:modelType string, :classificationThreshold number, :modelTrainingMode string}, :createTime string, :state string}
Updates the specified Version.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/flows/versions/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:name string,
:displayName string,
:description string,
:nluSettings {:modelType string,
:classificationThreshold number,
:modelTrainingMode string},
:createTime string,
:state string}
Updates the specified Version.(locations-agents-generators-create$ auth parameters body)Required parameters: parent
Optional parameters: languageCode
Body:
{:name string, :displayName string, :promptText {:text string}, :placeholders [{:id string, :name string}]}
Creates a generator in the specified agent.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/generators/create
Required parameters: parent
Optional parameters: languageCode
Body:
{:name string,
:displayName string,
:promptText {:text string},
:placeholders [{:id string, :name string}]}
Creates a generator in the specified agent.(locations-agents-generators-delete$ auth parameters)Required parameters: name
Optional parameters: force
Deletes the specified generators.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/generators/delete Required parameters: name Optional parameters: force Deletes the specified generators.
(locations-agents-generators-get$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/generators/get
Required parameters: name
Optional parameters: languageCode
Retrieves the specified generator.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/generators/get Required parameters: name Optional parameters: languageCode Retrieves the specified generator.
(locations-agents-generators-list$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/generators/list
Required parameters: parent
Optional parameters: languageCode, pageSize, pageToken
Returns the list of all generators in the specified agent.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/generators/list Required parameters: parent Optional parameters: languageCode, pageSize, pageToken Returns the list of all generators in the specified agent.
(locations-agents-generators-patch$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/generators/patch
Required parameters: name
Optional parameters: languageCode, updateMask
Body:
{:name string, :displayName string, :promptText {:text string}, :placeholders [{:id string, :name string}]}
Update the specified generator.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/generators/patch
Required parameters: name
Optional parameters: languageCode, updateMask
Body:
{:name string,
:displayName string,
:promptText {:text string},
:placeholders [{:id string, :name string}]}
Update the specified generator.(locations-agents-get$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/get
Required parameters: name
Optional parameters: none
Retrieves the specified agent.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/get Required parameters: name Optional parameters: none Retrieves the specified agent.
(locations-agents-getGenerativeSettings$ auth parameters)Required parameters: name
Optional parameters: languageCode
Gets the generative settings for the agent.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/getGenerativeSettings Required parameters: name Optional parameters: languageCode Gets the generative settings for the agent.
(locations-agents-getValidationResult$ auth parameters)Required parameters: name
Optional parameters: languageCode
Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/getValidationResult Required parameters: name Optional parameters: languageCode Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.
(locations-agents-intents-create$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/intents/create
Required parameters: parent
Optional parameters: languageCode
Body:
{:name string, :displayName string, :trainingPhrases [{:id string, :parts [GoogleCloudDialogflowCxV3IntentTrainingPhrasePart], :repeatCount integer}], :parameters [{:id string, :entityType string, :isList boolean, :redact boolean}], :priority integer, :isFallback boolean, :labels {}, :description string}
Creates an intent in the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/intents/create
Required parameters: parent
Optional parameters: languageCode
Body:
{:name string,
:displayName string,
:trainingPhrases [{:id string,
:parts [GoogleCloudDialogflowCxV3IntentTrainingPhrasePart],
:repeatCount integer}],
:parameters [{:id string,
:entityType string,
:isList boolean,
:redact boolean}],
:priority integer,
:isFallback boolean,
:labels {},
:description string}
Creates an intent in the specified agent. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).(locations-agents-intents-delete$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/intents/delete
Required parameters: name
Optional parameters: none
Deletes the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/intents/delete Required parameters: name Optional parameters: none Deletes the specified intent. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
(locations-agents-intents-export$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/intents/export
Required parameters: parent
Optional parameters: none
Body:
{:intents [string], :intentsUri string, :intentsContentInline boolean, :dataFormat string}
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
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/intents/export
Required parameters: parent
Optional parameters: none
Body:
{:intents [string],
:intentsUri string,
:intentsContentInline boolean,
:dataFormat string}
Exports the selected intents. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ExportIntentsMetadata - `response`: ExportIntentsResponse(locations-agents-intents-get$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/intents/get
Required parameters: name
Optional parameters: languageCode
Retrieves the specified intent.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/intents/get Required parameters: name Optional parameters: languageCode Retrieves the specified intent.
(locations-agents-intents-import$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/intents/import
Required parameters: parent
Optional parameters: none
Body:
{:intentsUri string, :intentsContent {:content string}, :mergeOption string}
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
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/intents/import
Required parameters: parent
Optional parameters: none
Body:
{:intentsUri string,
:intentsContent {:content string},
:mergeOption string}
Imports the specified intents into the agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ImportIntentsMetadata - `response`: ImportIntentsResponse(locations-agents-intents-list$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/intents/list
Required parameters: parent
Optional parameters: languageCode, intentView, pageSize, pageToken
Returns the list of all intents in the specified agent.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/intents/list Required parameters: parent Optional parameters: languageCode, intentView, pageSize, pageToken Returns the list of all intents in the specified agent.
(locations-agents-intents-patch$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/intents/patch
Required parameters: name
Optional parameters: languageCode, updateMask
Body:
{:name string, :displayName string, :trainingPhrases [{:id string, :parts [GoogleCloudDialogflowCxV3IntentTrainingPhrasePart], :repeatCount integer}], :parameters [{:id string, :entityType string, :isList boolean, :redact boolean}], :priority integer, :isFallback boolean, :labels {}, :description string}
Updates the specified intent. Note: You should always train a flow prior to sending it queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/intents/patch
Required parameters: name
Optional parameters: languageCode, updateMask
Body:
{:name string,
:displayName string,
:trainingPhrases [{:id string,
:parts [GoogleCloudDialogflowCxV3IntentTrainingPhrasePart],
:repeatCount integer}],
:parameters [{:id string,
:entityType string,
:isList boolean,
:redact boolean}],
:priority integer,
:isFallback boolean,
:labels {},
:description string}
Updates the specified intent. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).(locations-agents-list$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/list
Required parameters: parent
Optional parameters: pageSize, pageToken
Returns the list of all agents in the specified location.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/list Required parameters: parent Optional parameters: pageSize, pageToken Returns the list of all agents in the specified location.
(locations-agents-patch$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:advancedSettings {:audioExportGcsDestination GoogleCloudDialogflowCxV3GcsDestination, :speechSettings GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings, :dtmfSettings GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings, :loggingSettings GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings}, :answerFeedbackSettings {:enableAnswerFeedback boolean}, :description string, :securitySettings string, :timeZone string, :startFlow string, :defaultLanguageCode string, :genAppBuilderSettings {:engine string}, :displayName string, :speechToTextSettings {:enableSpeechAdaptation boolean}, :name string, :textToSpeechSettings {:synthesizeSpeechConfigs {}}, :supportedLanguageCodes [string], :enableSpellCorrection boolean, :gitIntegrationSettings {:githubSettings GoogleCloudDialogflowCxV3AgentGitIntegrationSettingsGithubSettings}, :locked boolean, :personalizationSettings {:defaultEndUserMetadata {}}, :enableStackdriverLogging boolean, :avatarUri string, :enableMultiLanguageTraining boolean}
Updates the specified agent. Note: You should always train flows prior to sending them queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:advancedSettings {:audioExportGcsDestination GoogleCloudDialogflowCxV3GcsDestination,
:speechSettings GoogleCloudDialogflowCxV3AdvancedSettingsSpeechSettings,
:dtmfSettings GoogleCloudDialogflowCxV3AdvancedSettingsDtmfSettings,
:loggingSettings GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings},
:answerFeedbackSettings {:enableAnswerFeedback boolean},
:description string,
:securitySettings string,
:timeZone string,
:startFlow string,
:defaultLanguageCode string,
:genAppBuilderSettings {:engine string},
:displayName string,
:speechToTextSettings {:enableSpeechAdaptation boolean},
:name string,
:textToSpeechSettings {:synthesizeSpeechConfigs {}},
:supportedLanguageCodes [string],
:enableSpellCorrection boolean,
:gitIntegrationSettings {:githubSettings GoogleCloudDialogflowCxV3AgentGitIntegrationSettingsGithubSettings},
:locked boolean,
:personalizationSettings {:defaultEndUserMetadata {}},
:enableStackdriverLogging boolean,
:avatarUri string,
:enableMultiLanguageTraining boolean}
Updates the specified agent. Note: You should always train flows prior to sending them queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).(locations-agents-restore$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/restore
Required parameters: name
Optional parameters: none
Body:
{:agentUri string, :agentContent string, :gitSource {:trackingBranch string}, :restoreOption string}
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 - response: An Empty message Note: You should always train flows prior to sending them queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/restore
Required parameters: name
Optional parameters: none
Body:
{:agentUri string,
:agentContent string,
:gitSource {:trackingBranch string},
:restoreOption string}
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](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: An empty [Struct message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct) - `response`: An [Empty message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty) Note: You should always train flows prior to sending them queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).(locations-agents-sessions-detectIntent$ auth parameters body)Required parameters: session
Optional parameters: none
Body:
{:queryParams {:currentPage string, :timeZone string, :sessionEntityTypes [GoogleCloudDialogflowCxV3SessionEntityType], :payload {}, :searchConfig GoogleCloudDialogflowCxV3SearchConfig, :channel string, :webhookHeaders {}, :endUserMetadata {}, :sessionTtl string, :disableWebhook boolean, :analyzeQueryTextSentiment boolean, :flowVersions [string], :geoLocation GoogleTypeLatLng, :parameters {}, :populateDataStoreConnectionSignals boolean}, :queryInput {:text GoogleCloudDialogflowCxV3TextInput, :intent GoogleCloudDialogflowCxV3IntentInput, :audio GoogleCloudDialogflowCxV3AudioInput, :event GoogleCloudDialogflowCxV3EventInput, :dtmf GoogleCloudDialogflowCxV3DtmfInput, :languageCode string}, :outputAudioConfig {:audioEncoding string, :sampleRateHertz integer, :synthesizeSpeechConfig GoogleCloudDialogflowCxV3SynthesizeSpeechConfig}}
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.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/sessions/detectIntent
Required parameters: session
Optional parameters: none
Body:
{:queryParams {:currentPage string,
:timeZone string,
:sessionEntityTypes [GoogleCloudDialogflowCxV3SessionEntityType],
:payload {},
:searchConfig GoogleCloudDialogflowCxV3SearchConfig,
:channel string,
:webhookHeaders {},
:endUserMetadata {},
:sessionTtl string,
:disableWebhook boolean,
:analyzeQueryTextSentiment boolean,
:flowVersions [string],
:geoLocation GoogleTypeLatLng,
:parameters {},
:populateDataStoreConnectionSignals boolean},
:queryInput {:text GoogleCloudDialogflowCxV3TextInput,
:intent GoogleCloudDialogflowCxV3IntentInput,
:audio GoogleCloudDialogflowCxV3AudioInput,
:event GoogleCloudDialogflowCxV3EventInput,
:dtmf GoogleCloudDialogflowCxV3DtmfInput,
:languageCode string},
:outputAudioConfig {:audioEncoding string,
:sampleRateHertz integer,
:synthesizeSpeechConfig GoogleCloudDialogflowCxV3SynthesizeSpeechConfig}}
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](https://cloud.google.com/dialogflow/cx/docs/concept/version).(locations-agents-sessions-entityTypes-create$ auth parameters body)Required parameters: parent
Optional parameters: none
Body:
{:name string, :entityOverrideMode string, :entities [{:value string, :synonyms [string]}]}
Creates a session entity type.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/sessions/entityTypes/create
Required parameters: parent
Optional parameters: none
Body:
{:name string,
:entityOverrideMode string,
:entities [{:value string, :synonyms [string]}]}
Creates a session entity type.(locations-agents-sessions-entityTypes-delete$ auth parameters)Required parameters: name
Optional parameters: none
Deletes the specified session entity type.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/sessions/entityTypes/delete Required parameters: name Optional parameters: none Deletes the specified session entity type.
(locations-agents-sessions-entityTypes-get$ auth parameters)Required parameters: name
Optional parameters: none
Retrieves the specified session entity type.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/sessions/entityTypes/get Required parameters: name Optional parameters: none Retrieves the specified session entity type.
(locations-agents-sessions-entityTypes-list$ auth parameters)Required parameters: parent
Optional parameters: pageSize, pageToken
Returns the list of all session entity types in the specified session.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/sessions/entityTypes/list Required parameters: parent Optional parameters: pageSize, pageToken Returns the list of all session entity types in the specified session.
(locations-agents-sessions-entityTypes-patch$ auth parameters body)Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :entityOverrideMode string, :entities [{:value string, :synonyms [string]}]}
Updates the specified session entity type.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/sessions/entityTypes/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:name string,
:entityOverrideMode string,
:entities [{:value string, :synonyms [string]}]}
Updates the specified session entity type.(locations-agents-sessions-fulfillIntent$ auth parameters body)Required parameters: session
Optional parameters: none
Body:
{:matchIntentRequest {:queryParams GoogleCloudDialogflowCxV3QueryParameters, :queryInput GoogleCloudDialogflowCxV3QueryInput, :persistParameterChanges boolean}, :match {:intent GoogleCloudDialogflowCxV3Intent, :event string, :parameters {}, :resolvedInput string, :matchType string, :confidence number}, :outputAudioConfig {:audioEncoding string, :sampleRateHertz integer, :synthesizeSpeechConfig GoogleCloudDialogflowCxV3SynthesizeSpeechConfig}}
Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/sessions/fulfillIntent
Required parameters: session
Optional parameters: none
Body:
{:matchIntentRequest {:queryParams GoogleCloudDialogflowCxV3QueryParameters,
:queryInput GoogleCloudDialogflowCxV3QueryInput,
:persistParameterChanges boolean},
:match {:intent GoogleCloudDialogflowCxV3Intent,
:event string,
:parameters {},
:resolvedInput string,
:matchType string,
:confidence number},
:outputAudioConfig {:audioEncoding string,
:sampleRateHertz integer,
:synthesizeSpeechConfig GoogleCloudDialogflowCxV3SynthesizeSpeechConfig}}
Fulfills a matched intent returned by MatchIntent. Must be called after MatchIntent, with input from MatchIntentResponse. Otherwise, the behavior is undefined.(locations-agents-sessions-matchIntent$ auth parameters body)Required parameters: session
Optional parameters: none
Body:
{:queryParams {:currentPage string, :timeZone string, :sessionEntityTypes [GoogleCloudDialogflowCxV3SessionEntityType], :payload {}, :searchConfig GoogleCloudDialogflowCxV3SearchConfig, :channel string, :webhookHeaders {}, :endUserMetadata {}, :sessionTtl string, :disableWebhook boolean, :analyzeQueryTextSentiment boolean, :flowVersions [string], :geoLocation GoogleTypeLatLng, :parameters {}, :populateDataStoreConnectionSignals boolean}, :queryInput {:text GoogleCloudDialogflowCxV3TextInput, :intent GoogleCloudDialogflowCxV3IntentInput, :audio GoogleCloudDialogflowCxV3AudioInput, :event GoogleCloudDialogflowCxV3EventInput, :dtmf GoogleCloudDialogflowCxV3DtmfInput, :languageCode string}, :persistParameterChanges boolean}
Returns preliminary intent match results, doesn't change the session status.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/sessions/matchIntent
Required parameters: session
Optional parameters: none
Body:
{:queryParams {:currentPage string,
:timeZone string,
:sessionEntityTypes [GoogleCloudDialogflowCxV3SessionEntityType],
:payload {},
:searchConfig GoogleCloudDialogflowCxV3SearchConfig,
:channel string,
:webhookHeaders {},
:endUserMetadata {},
:sessionTtl string,
:disableWebhook boolean,
:analyzeQueryTextSentiment boolean,
:flowVersions [string],
:geoLocation GoogleTypeLatLng,
:parameters {},
:populateDataStoreConnectionSignals boolean},
:queryInput {:text GoogleCloudDialogflowCxV3TextInput,
:intent GoogleCloudDialogflowCxV3IntentInput,
:audio GoogleCloudDialogflowCxV3AudioInput,
:event GoogleCloudDialogflowCxV3EventInput,
:dtmf GoogleCloudDialogflowCxV3DtmfInput,
:languageCode string},
:persistParameterChanges boolean}
Returns preliminary intent match results, doesn't change the session status.(locations-agents-sessions-serverStreamingDetectIntent$ auth parameters body)Required parameters: session
Optional parameters: none
Body:
{:queryParams {:currentPage string, :timeZone string, :sessionEntityTypes [GoogleCloudDialogflowCxV3SessionEntityType], :payload {}, :searchConfig GoogleCloudDialogflowCxV3SearchConfig, :channel string, :webhookHeaders {}, :endUserMetadata {}, :sessionTtl string, :disableWebhook boolean, :analyzeQueryTextSentiment boolean, :flowVersions [string], :geoLocation GoogleTypeLatLng, :parameters {}, :populateDataStoreConnectionSignals boolean}, :queryInput {:text GoogleCloudDialogflowCxV3TextInput, :intent GoogleCloudDialogflowCxV3IntentInput, :audio GoogleCloudDialogflowCxV3AudioInput, :event GoogleCloudDialogflowCxV3EventInput, :dtmf GoogleCloudDialogflowCxV3DtmfInput, :languageCode string}, :outputAudioConfig {:audioEncoding string, :sampleRateHertz integer, :synthesizeSpeechConfig GoogleCloudDialogflowCxV3SynthesizeSpeechConfig}}
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.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/sessions/serverStreamingDetectIntent
Required parameters: session
Optional parameters: none
Body:
{:queryParams {:currentPage string,
:timeZone string,
:sessionEntityTypes [GoogleCloudDialogflowCxV3SessionEntityType],
:payload {},
:searchConfig GoogleCloudDialogflowCxV3SearchConfig,
:channel string,
:webhookHeaders {},
:endUserMetadata {},
:sessionTtl string,
:disableWebhook boolean,
:analyzeQueryTextSentiment boolean,
:flowVersions [string],
:geoLocation GoogleTypeLatLng,
:parameters {},
:populateDataStoreConnectionSignals boolean},
:queryInput {:text GoogleCloudDialogflowCxV3TextInput,
:intent GoogleCloudDialogflowCxV3IntentInput,
:audio GoogleCloudDialogflowCxV3AudioInput,
:event GoogleCloudDialogflowCxV3EventInput,
:dtmf GoogleCloudDialogflowCxV3DtmfInput,
:languageCode string},
:outputAudioConfig {:audioEncoding string,
:sampleRateHertz integer,
:synthesizeSpeechConfig GoogleCloudDialogflowCxV3SynthesizeSpeechConfig}}
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](https://cloud.google.com/dialogflow/cx/docs/concept/fulfillment#partial-response) earlier in a single request.(locations-agents-sessions-submitAnswerFeedback$ auth parameters body)Required parameters: session
Optional parameters: none
Body:
{:responseId string, :answerFeedback {:rating string, :ratingReason GoogleCloudDialogflowCxV3AnswerFeedbackRatingReason, :customRating string}, :updateMask string}
Updates the feedback received from the user for a single turn of the bot response.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/sessions/submitAnswerFeedback
Required parameters: session
Optional parameters: none
Body:
{:responseId string,
:answerFeedback {:rating string,
:ratingReason GoogleCloudDialogflowCxV3AnswerFeedbackRatingReason,
:customRating string},
:updateMask string}
Updates the feedback received from the user for a single turn of the bot response.(locations-agents-testCases-batchDelete$ auth parameters body)Required parameters: parent
Optional parameters: none
Body:
{:names [string]}
Batch deletes test cases.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/testCases/batchDelete
Required parameters: parent
Optional parameters: none
Body:
{:names [string]}
Batch deletes test cases.(locations-agents-testCases-batchRun$ auth parameters body)Required parameters: parent
Optional parameters: none
Body:
{:environment string, :testCases [string]}
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
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/testCases/batchRun
Required parameters: parent
Optional parameters: none
Body:
{:environment string, :testCases [string]}
Kicks off a batch run of test cases. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: BatchRunTestCasesMetadata - `response`: BatchRunTestCasesResponse(locations-agents-testCases-calculateCoverage$ auth parameters)Required parameters: agent
Optional parameters: type
Calculates the test coverage for an agent.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/testCases/calculateCoverage Required parameters: agent Optional parameters: type Calculates the test coverage for an agent.
(locations-agents-testCases-create$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/testCases/create
Required parameters: parent
Optional parameters: none
Body:
{:name string, :tags [string], :displayName string, :notes string, :testConfig {:trackingParameters [string], :flow string, :page string}, :testCaseConversationTurns [{:userInput GoogleCloudDialogflowCxV3ConversationTurnUserInput, :virtualAgentOutput GoogleCloudDialogflowCxV3ConversationTurnVirtualAgentOutput}], :creationTime string, :lastTestResult {:name string, :environment string, :conversationTurns [GoogleCloudDialogflowCxV3ConversationTurn], :testResult string, :testTime string}}
Creates a test case for the given agent.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/testCases/create
Required parameters: parent
Optional parameters: none
Body:
{:name string,
:tags [string],
:displayName string,
:notes string,
:testConfig {:trackingParameters [string],
:flow string,
:page string},
:testCaseConversationTurns [{:userInput GoogleCloudDialogflowCxV3ConversationTurnUserInput,
:virtualAgentOutput GoogleCloudDialogflowCxV3ConversationTurnVirtualAgentOutput}],
:creationTime string,
:lastTestResult {:name string,
:environment string,
:conversationTurns [GoogleCloudDialogflowCxV3ConversationTurn],
:testResult string,
:testTime string}}
Creates a test case for the given agent.(locations-agents-testCases-export$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/testCases/export
Required parameters: parent
Optional parameters: none
Body:
{:gcsUri string, :dataFormat string, :filter string}
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
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/testCases/export
Required parameters: parent
Optional parameters: none
Body:
{:gcsUri string, :dataFormat string, :filter string}
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](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ExportTestCasesMetadata - `response`: ExportTestCasesResponse(locations-agents-testCases-get$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/testCases/get
Required parameters: name
Optional parameters: none
Gets a test case.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/testCases/get Required parameters: name Optional parameters: none Gets a test case.
(locations-agents-testCases-import$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/testCases/import
Required parameters: parent
Optional parameters: none
Body:
{:gcsUri string, :content string}
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
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/testCases/import
Required parameters: parent
Optional parameters: none
Body:
{:gcsUri string, :content string}
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](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ImportTestCasesMetadata - `response`: ImportTestCasesResponse(locations-agents-testCases-list$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/testCases/list
Required parameters: parent
Optional parameters: pageSize, pageToken, view
Fetches a list of test cases for a given agent.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/testCases/list Required parameters: parent Optional parameters: pageSize, pageToken, view Fetches a list of test cases for a given agent.
(locations-agents-testCases-patch$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/testCases/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :tags [string], :displayName string, :notes string, :testConfig {:trackingParameters [string], :flow string, :page string}, :testCaseConversationTurns [{:userInput GoogleCloudDialogflowCxV3ConversationTurnUserInput, :virtualAgentOutput GoogleCloudDialogflowCxV3ConversationTurnVirtualAgentOutput}], :creationTime string, :lastTestResult {:name string, :environment string, :conversationTurns [GoogleCloudDialogflowCxV3ConversationTurn], :testResult string, :testTime string}}
Updates the specified test case.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/testCases/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:name string,
:tags [string],
:displayName string,
:notes string,
:testConfig {:trackingParameters [string],
:flow string,
:page string},
:testCaseConversationTurns [{:userInput GoogleCloudDialogflowCxV3ConversationTurnUserInput,
:virtualAgentOutput GoogleCloudDialogflowCxV3ConversationTurnVirtualAgentOutput}],
:creationTime string,
:lastTestResult {:name string,
:environment string,
:conversationTurns [GoogleCloudDialogflowCxV3ConversationTurn],
:testResult string,
:testTime string}}
Updates the specified test case.(locations-agents-testCases-results-get$ auth parameters)Required parameters: name
Optional parameters: none
Gets a test case result.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/testCases/results/get Required parameters: name Optional parameters: none Gets a test case result.
(locations-agents-testCases-results-list$ auth parameters)Required parameters: parent
Optional parameters: pageSize, pageToken, filter
Fetches the list of run results for the given test case. A maximum of 100 results are kept for each test case.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/testCases/results/list Required parameters: parent Optional parameters: pageSize, pageToken, filter Fetches the list of run results for the given test case. A maximum of 100 results are kept for each test case.
(locations-agents-testCases-run$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/testCases/run
Required parameters: name
Optional parameters: none
Body:
{:environment string}
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
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/testCases/run
Required parameters: name
Optional parameters: none
Body:
{:environment string}
Kicks off a test case run. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: RunTestCaseMetadata - `response`: RunTestCaseResponse(locations-agents-transitionRouteGroups-create$ auth parameters body)Required parameters: parent
Optional parameters: languageCode
Body:
{:name string, :displayName string, :transitionRoutes [{:name string, :description string, :intent string, :condition string, :triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment, :targetPage string, :targetFlow string}]}
Creates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/transitionRouteGroups/create
Required parameters: parent
Optional parameters: languageCode
Body:
{:name string,
:displayName string,
:transitionRoutes [{:name string,
:description string,
:intent string,
:condition string,
:triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment,
:targetPage string,
:targetFlow string}]}
Creates an TransitionRouteGroup in the specified flow. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).(locations-agents-transitionRouteGroups-delete$ auth parameters)Required parameters: name
Optional parameters: force
Deletes the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/transitionRouteGroups/delete Required parameters: name Optional parameters: force Deletes the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).
(locations-agents-transitionRouteGroups-get$ auth parameters)Required parameters: name
Optional parameters: languageCode
Retrieves the specified TransitionRouteGroup.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/transitionRouteGroups/get Required parameters: name Optional parameters: languageCode Retrieves the specified TransitionRouteGroup.
(locations-agents-transitionRouteGroups-list$ auth parameters)Required parameters: parent
Optional parameters: pageSize, pageToken, languageCode
Returns the list of all transition route groups in the specified flow.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/transitionRouteGroups/list Required parameters: parent Optional parameters: pageSize, pageToken, languageCode Returns the list of all transition route groups in the specified flow.
(locations-agents-transitionRouteGroups-patch$ auth parameters body)Required parameters: name
Optional parameters: updateMask, languageCode
Body:
{:name string, :displayName string, :transitionRoutes [{:name string, :description string, :intent string, :condition string, :triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment, :targetPage string, :targetFlow string}]}
Updates the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the training documentation.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/transitionRouteGroups/patch
Required parameters: name
Optional parameters: updateMask, languageCode
Body:
{:name string,
:displayName string,
:transitionRoutes [{:name string,
:description string,
:intent string,
:condition string,
:triggerFulfillment GoogleCloudDialogflowCxV3Fulfillment,
:targetPage string,
:targetFlow string}]}
Updates the specified TransitionRouteGroup. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training).(locations-agents-updateGenerativeSettings$ auth parameters body)Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :fallbackSettings {:selectedPrompt string, :promptTemplates [GoogleCloudDialogflowCxV3GenerativeSettingsFallbackSettingsPromptTemplate]}, :generativeSafetySettings {:bannedPhrases [GoogleCloudDialogflowCxV3SafetySettingsPhrase]}, :knowledgeConnectorSettings {:business string, :agent string, :agentIdentity string, :businessDescription string, :agentScope string, :disableDataStoreFallback boolean}, :languageCode string}
Updates the generative settings for the agent.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/updateGenerativeSettings
Required parameters: name
Optional parameters: updateMask
Body:
{:name string,
:fallbackSettings {:selectedPrompt string,
:promptTemplates [GoogleCloudDialogflowCxV3GenerativeSettingsFallbackSettingsPromptTemplate]},
:generativeSafetySettings {:bannedPhrases [GoogleCloudDialogflowCxV3SafetySettingsPhrase]},
:knowledgeConnectorSettings {:business string,
:agent string,
:agentIdentity string,
:businessDescription string,
:agentScope string,
:disableDataStoreFallback boolean},
:languageCode string}
Updates the generative settings for the agent.(locations-agents-validate$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/validate
Required parameters: name
Optional parameters: none
Body:
{:languageCode string}
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.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/validate
Required parameters: name
Optional parameters: none
Body:
{:languageCode string}
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.(locations-agents-webhooks-create$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/webhooks/create
Required parameters: parent
Optional parameters: none
Body:
{:name string, :displayName string, :genericWebService {:password string, :requestHeaders {}, :webhookType string, :allowedCaCerts [string], :requestBody string, :username string, :oauthConfig GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig, :serviceAgentAuth string, :uri string, :httpMethod string, :parameterMapping {}}, :serviceDirectory {:service string, :genericWebService GoogleCloudDialogflowCxV3WebhookGenericWebService}, :timeout string, :disabled boolean}
Creates a webhook in the specified agent.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/webhooks/create
Required parameters: parent
Optional parameters: none
Body:
{:name string,
:displayName string,
:genericWebService {:password string,
:requestHeaders {},
:webhookType string,
:allowedCaCerts [string],
:requestBody string,
:username string,
:oauthConfig GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig,
:serviceAgentAuth string,
:uri string,
:httpMethod string,
:parameterMapping {}},
:serviceDirectory {:service string,
:genericWebService GoogleCloudDialogflowCxV3WebhookGenericWebService},
:timeout string,
:disabled boolean}
Creates a webhook in the specified agent.(locations-agents-webhooks-delete$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/webhooks/delete
Required parameters: name
Optional parameters: force
Deletes the specified webhook.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/webhooks/delete Required parameters: name Optional parameters: force Deletes the specified webhook.
(locations-agents-webhooks-get$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/webhooks/get
Required parameters: name
Optional parameters: none
Retrieves the specified webhook.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/webhooks/get Required parameters: name Optional parameters: none Retrieves the specified webhook.
(locations-agents-webhooks-list$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/webhooks/list
Required parameters: parent
Optional parameters: pageSize, pageToken
Returns the list of all webhooks in the specified agent.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/webhooks/list Required parameters: parent Optional parameters: pageSize, pageToken Returns the list of all webhooks in the specified agent.
(locations-agents-webhooks-patch$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/webhooks/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:name string, :displayName string, :genericWebService {:password string, :requestHeaders {}, :webhookType string, :allowedCaCerts [string], :requestBody string, :username string, :oauthConfig GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig, :serviceAgentAuth string, :uri string, :httpMethod string, :parameterMapping {}}, :serviceDirectory {:service string, :genericWebService GoogleCloudDialogflowCxV3WebhookGenericWebService}, :timeout string, :disabled boolean}
Updates the specified webhook.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/agents/webhooks/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:name string,
:displayName string,
:genericWebService {:password string,
:requestHeaders {},
:webhookType string,
:allowedCaCerts [string],
:requestBody string,
:username string,
:oauthConfig GoogleCloudDialogflowCxV3WebhookGenericWebServiceOAuthConfig,
:serviceAgentAuth string,
:uri string,
:httpMethod string,
:parameterMapping {}},
:serviceDirectory {:service string,
:genericWebService GoogleCloudDialogflowCxV3WebhookGenericWebService},
:timeout string,
:disabled boolean}
Updates the specified webhook.(locations-get$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/get
Required parameters: name
Optional parameters: none
Gets information about a location.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/get Required parameters: name Optional parameters: none Gets information about a location.
(locations-list$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/list
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists information about the supported locations for this service.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists information about the supported locations for this service.
(locations-operations-cancel$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/operations/cancel
Required parameters: name
Optional parameters: none
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.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/operations/cancel Required parameters: name Optional parameters: none 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`.
(locations-operations-get$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/operations/get
Required parameters: name
Optional parameters: none
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.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/operations/get Required parameters: name Optional parameters: none 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.
(locations-operations-list$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/operations/list
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
(locations-securitySettings-create$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/securitySettings/create
Required parameters: parent
Optional parameters: none
Body:
{:audioExportSettings {:gcsBucket string, :audioExportPattern string, :enableAudioRedaction boolean, :audioFormat string, :storeTtsAudio boolean}, :displayName string, :redactionStrategy string, :name string, :purgeDataTypes [string], :retentionStrategy string, :retentionWindowDays integer, :insightsExportSettings {:enableInsightsExport boolean}, :inspectTemplate string, :redactionScope string, :deidentifyTemplate string}
Create security settings in the specified location.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/securitySettings/create
Required parameters: parent
Optional parameters: none
Body:
{:audioExportSettings {:gcsBucket string,
:audioExportPattern string,
:enableAudioRedaction boolean,
:audioFormat string,
:storeTtsAudio boolean},
:displayName string,
:redactionStrategy string,
:name string,
:purgeDataTypes [string],
:retentionStrategy string,
:retentionWindowDays integer,
:insightsExportSettings {:enableInsightsExport boolean},
:inspectTemplate string,
:redactionScope string,
:deidentifyTemplate string}
Create security settings in the specified location.(locations-securitySettings-delete$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/securitySettings/delete
Required parameters: name
Optional parameters: none
Deletes the specified SecuritySettings.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/securitySettings/delete Required parameters: name Optional parameters: none Deletes the specified SecuritySettings.
(locations-securitySettings-get$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/securitySettings/get
Required parameters: name
Optional parameters: none
Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/securitySettings/get Required parameters: name Optional parameters: none Retrieves the specified SecuritySettings. The returned settings may be stale by up to 1 minute.
(locations-securitySettings-list$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/securitySettings/list
Required parameters: parent
Optional parameters: pageSize, pageToken
Returns the list of all security settings in the specified location.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/securitySettings/list Required parameters: parent Optional parameters: pageSize, pageToken Returns the list of all security settings in the specified location.
(locations-securitySettings-patch$ auth parameters body)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/securitySettings/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:audioExportSettings {:gcsBucket string, :audioExportPattern string, :enableAudioRedaction boolean, :audioFormat string, :storeTtsAudio boolean}, :displayName string, :redactionStrategy string, :name string, :purgeDataTypes [string], :retentionStrategy string, :retentionWindowDays integer, :insightsExportSettings {:enableInsightsExport boolean}, :inspectTemplate string, :redactionScope string, :deidentifyTemplate string}
Updates the specified SecuritySettings.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/locations/securitySettings/patch
Required parameters: name
Optional parameters: updateMask
Body:
{:audioExportSettings {:gcsBucket string,
:audioExportPattern string,
:enableAudioRedaction boolean,
:audioFormat string,
:storeTtsAudio boolean},
:displayName string,
:redactionStrategy string,
:name string,
:purgeDataTypes [string],
:retentionStrategy string,
:retentionWindowDays integer,
:insightsExportSettings {:enableInsightsExport boolean},
:inspectTemplate string,
:redactionScope string,
:deidentifyTemplate string}
Updates the specified SecuritySettings.(operations-cancel$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/operations/cancel
Required parameters: name
Optional parameters: none
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.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/operations/cancel Required parameters: name Optional parameters: none 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`.
(operations-get$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/operations/get
Required parameters: name
Optional parameters: none
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.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/operations/get Required parameters: name Optional parameters: none 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.
(operations-list$ auth parameters)https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/operations/list
Required parameters: name
Optional parameters: filter, pageSize, pageToken
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
https://cloud.google.com/dialogflow/api/reference/rest/v3/projects/operations/list Required parameters: name Optional parameters: filter, pageSize, pageToken Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |