com.google.cloud.dialogflow.cx.v3.package-info Maven / Gradle / Ivy
Show all versions of google-cloud-dialogflow-cx Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* A client to Dialogflow API
*
* The interfaces provided are listed below, along with usage samples.
*
*
======================= AgentsClient =======================
*
*
Service Description: Service for managing [Agents][google.cloud.dialogflow.cx.v3.Agent].
*
*
Sample for AgentsClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (AgentsClient agentsClient = AgentsClient.create()) {
* AgentName name = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
* Agent response = agentsClient.getAgent(name);
* }
* }
*
* ======================= ChangelogsClient =======================
*
*
Service Description: Service for managing
* [Changelogs][google.cloud.dialogflow.cx.v3.Changelog].
*
*
Sample for ChangelogsClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ChangelogsClient changelogsClient = ChangelogsClient.create()) {
* ChangelogName name = ChangelogName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[CHANGELOG]");
* Changelog response = changelogsClient.getChangelog(name);
* }
* }
*
* ======================= DeploymentsClient =======================
*
*
Service Description: Service for managing
* [Deployments][google.cloud.dialogflow.cx.v3.Deployment].
*
*
Sample for DeploymentsClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (DeploymentsClient deploymentsClient = DeploymentsClient.create()) {
* DeploymentName name =
* DeploymentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[DEPLOYMENT]");
* Deployment response = deploymentsClient.getDeployment(name);
* }
* }
*
* ======================= EntityTypesClient =======================
*
*
Service Description: Service for managing
* [EntityTypes][google.cloud.dialogflow.cx.v3.EntityType].
*
*
Sample for EntityTypesClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (EntityTypesClient entityTypesClient = EntityTypesClient.create()) {
* EntityTypeName name =
* EntityTypeName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENTITY_TYPE]");
* EntityType response = entityTypesClient.getEntityType(name);
* }
* }
*
* ======================= EnvironmentsClient =======================
*
*
Service Description: Service for managing
* [Environments][google.cloud.dialogflow.cx.v3.Environment].
*
*
Sample for EnvironmentsClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (EnvironmentsClient environmentsClient = EnvironmentsClient.create()) {
* EnvironmentName name =
* EnvironmentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]");
* Environment response = environmentsClient.getEnvironment(name);
* }
* }
*
* ======================= ExperimentsClient =======================
*
*
Service Description: Service for managing
* [Experiments][google.cloud.dialogflow.cx.v3.Experiment].
*
*
Sample for ExperimentsClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (ExperimentsClient experimentsClient = ExperimentsClient.create()) {
* ExperimentName name =
* ExperimentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[ENVIRONMENT]", "[EXPERIMENT]");
* Experiment response = experimentsClient.getExperiment(name);
* }
* }
*
* ======================= FlowsClient =======================
*
*
Service Description: Service for managing [Flows][google.cloud.dialogflow.cx.v3.Flow].
*
*
Sample for FlowsClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (FlowsClient flowsClient = FlowsClient.create()) {
* AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
* Flow flow = Flow.newBuilder().build();
* Flow response = flowsClient.createFlow(parent, flow);
* }
* }
*
* ======================= GeneratorsClient =======================
*
*
Service Description: Service for managing
* [Generators][google.cloud.dialogflow.cx.v3.Generator]
*
*
Sample for GeneratorsClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (GeneratorsClient generatorsClient = GeneratorsClient.create()) {
* GeneratorName name = GeneratorName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[GENERATOR]");
* Generator response = generatorsClient.getGenerator(name);
* }
* }
*
* ======================= IntentsClient =======================
*
*
Service Description: Service for managing [Intents][google.cloud.dialogflow.cx.v3.Intent].
*
*
Sample for IntentsClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (IntentsClient intentsClient = IntentsClient.create()) {
* IntentName name = IntentName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[INTENT]");
* Intent response = intentsClient.getIntent(name);
* }
* }
*
* ======================= PagesClient =======================
*
*
Service Description: Service for managing [Pages][google.cloud.dialogflow.cx.v3.Page].
*
*
Sample for PagesClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (PagesClient pagesClient = PagesClient.create()) {
* PageName name = PageName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[PAGE]");
* Page response = pagesClient.getPage(name);
* }
* }
*
* ======================= SecuritySettingsServiceClient =======================
*
*
Service Description: Service for managing security settings for Dialogflow.
*
*
Sample for SecuritySettingsServiceClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SecuritySettingsServiceClient securitySettingsServiceClient =
* SecuritySettingsServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* SecuritySettings securitySettings = SecuritySettings.newBuilder().build();
* SecuritySettings response =
* securitySettingsServiceClient.createSecuritySettings(parent, securitySettings);
* }
* }
*
* ======================= SessionsClient =======================
*
*
Service Description: A session represents an interaction with a user. You retrieve user input
* and pass it to the [DetectIntent][google.cloud.dialogflow.cx.v3.Sessions.DetectIntent] method to
* determine user intent and respond.
*
*
Sample for SessionsClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SessionsClient sessionsClient = SessionsClient.create()) {
* DetectIntentRequest request =
* DetectIntentRequest.newBuilder()
* .setSession(
* SessionName.ofProjectLocationAgentSessionName(
* "[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]")
* .toString())
* .setQueryParams(QueryParameters.newBuilder().build())
* .setQueryInput(QueryInput.newBuilder().build())
* .setOutputAudioConfig(OutputAudioConfig.newBuilder().build())
* .build();
* DetectIntentResponse response = sessionsClient.detectIntent(request);
* }
* }
*
* ======================= SessionEntityTypesClient =======================
*
*
Service Description: Service for managing
* [SessionEntityTypes][google.cloud.dialogflow.cx.v3.SessionEntityType].
*
*
Sample for SessionEntityTypesClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (SessionEntityTypesClient sessionEntityTypesClient = SessionEntityTypesClient.create()) {
* SessionEntityTypeName name =
* SessionEntityTypeName.ofProjectLocationAgentSessionEntityTypeName(
* "[PROJECT]", "[LOCATION]", "[AGENT]", "[SESSION]", "[ENTITY_TYPE]");
* SessionEntityType response = sessionEntityTypesClient.getSessionEntityType(name);
* }
* }
*
* ======================= TestCasesClient =======================
*
*
Service Description: Service for managing [Test Cases][google.cloud.dialogflow.cx.v3.TestCase]
* and [Test Case Results][google.cloud.dialogflow.cx.v3.TestCaseResult].
*
*
Sample for TestCasesClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (TestCasesClient testCasesClient = TestCasesClient.create()) {
* AgentName parent = AgentName.of("[PROJECT]", "[LOCATION]", "[AGENT]");
* testCasesClient.batchDeleteTestCases(parent);
* }
* }
*
* ======================= TransitionRouteGroupsClient =======================
*
*
Service Description: Service for managing
* [TransitionRouteGroups][google.cloud.dialogflow.cx.v3.TransitionRouteGroup].
*
*
Sample for TransitionRouteGroupsClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (TransitionRouteGroupsClient transitionRouteGroupsClient =
* TransitionRouteGroupsClient.create()) {
* TransitionRouteGroupName name =
* TransitionRouteGroupName.ofProjectLocationAgentFlowTransitionRouteGroupName(
* "[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[TRANSITION_ROUTE_GROUP]");
* TransitionRouteGroup response = transitionRouteGroupsClient.getTransitionRouteGroup(name);
* }
* }
*
* ======================= VersionsClient =======================
*
*
Service Description: Service for managing [Versions][google.cloud.dialogflow.cx.v3.Version].
*
*
Sample for VersionsClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (VersionsClient versionsClient = VersionsClient.create()) {
* VersionName name =
* VersionName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[FLOW]", "[VERSION]");
* Version response = versionsClient.getVersion(name);
* }
* }
*
* ======================= WebhooksClient =======================
*
*
Service Description: Service for managing [Webhooks][google.cloud.dialogflow.cx.v3.Webhook].
*
*
Sample for WebhooksClient:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (WebhooksClient webhooksClient = WebhooksClient.create()) {
* WebhookName name = WebhookName.of("[PROJECT]", "[LOCATION]", "[AGENT]", "[WEBHOOK]");
* Webhook response = webhooksClient.getWebhook(name);
* }
* }
*/
@Generated("by gapic-generator-java")
package com.google.cloud.dialogflow.cx.v3;
import javax.annotation.Generated;