com.google.cloud.dialogflow.v2.package-info Maven / Gradle / Ivy
Show all versions of google-cloud-dialogflow 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.v2.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()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* Agent response = agentsClient.getAgent(parent);
* }
* }
*
* ======================= AnswerRecordsClient =======================
*
*
Service Description: Service for managing
* [AnswerRecords][google.cloud.dialogflow.v2.AnswerRecord].
*
*
Sample for AnswerRecordsClient:
*
*
{@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 (AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create()) {
* AnswerRecord answerRecord = AnswerRecord.newBuilder().build();
* FieldMask updateMask = FieldMask.newBuilder().build();
* AnswerRecord response = answerRecordsClient.updateAnswerRecord(answerRecord, updateMask);
* }
* }
*
* ======================= ContextsClient =======================
*
*
Service Description: Service for managing [Contexts][google.cloud.dialogflow.v2.Context].
*
*
Sample for ContextsClient:
*
*
{@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 (ContextsClient contextsClient = ContextsClient.create()) {
* ContextName name =
* ContextName.ofProjectSessionContextName("[PROJECT]", "[SESSION]", "[CONTEXT]");
* Context response = contextsClient.getContext(name);
* }
* }
*
* ======================= ConversationsClient =======================
*
*
Service Description: Service for managing
* [Conversations][google.cloud.dialogflow.v2.Conversation].
*
*
Sample for ConversationsClient:
*
*
{@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 (ConversationsClient conversationsClient = ConversationsClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* Conversation conversation = Conversation.newBuilder().build();
* Conversation response = conversationsClient.createConversation(parent, conversation);
* }
* }
*
* ======================= ConversationDatasetsClient =======================
*
*
Service Description: Conversation datasets.
*
*
Conversation datasets contain raw conversation files and their customizable metadata that can
* be used for model training.
*
*
Sample for ConversationDatasetsClient:
*
*
{@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 (ConversationDatasetsClient conversationDatasetsClient =
* ConversationDatasetsClient.create()) {
* ConversationDatasetName name =
* ConversationDatasetName.of("[PROJECT]", "[LOCATION]", "[CONVERSATION_DATASET]");
* ConversationDataset response = conversationDatasetsClient.getConversationDataset(name);
* }
* }
*
* ======================= ConversationModelsClient =======================
*
*
Service Description: Manages a collection of models for human agent assistant.
*
*
Sample for ConversationModelsClient:
*
*
{@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 (ConversationModelsClient conversationModelsClient = ConversationModelsClient.create()) {
* String name = "name3373707";
* ConversationModel response = conversationModelsClient.getConversationModel(name);
* }
* }
*
* ======================= ConversationProfilesClient =======================
*
*
Service Description: Service for managing
* [ConversationProfiles][google.cloud.dialogflow.v2.ConversationProfile].
*
*
Sample for ConversationProfilesClient:
*
*
{@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 (ConversationProfilesClient conversationProfilesClient =
* ConversationProfilesClient.create()) {
* ConversationProfileName name =
* ConversationProfileName.ofProjectConversationProfileName(
* "[PROJECT]", "[CONVERSATION_PROFILE]");
* ConversationProfile response = conversationProfilesClient.getConversationProfile(name);
* }
* }
*
* ======================= DocumentsClient =======================
*
*
Service Description: Service for managing knowledge
* [Documents][google.cloud.dialogflow.v2.Document].
*
*
Sample for DocumentsClient:
*
*
{@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 (DocumentsClient documentsClient = DocumentsClient.create()) {
* DocumentName name =
* DocumentName.ofProjectKnowledgeBaseDocumentName(
* "[PROJECT]", "[KNOWLEDGE_BASE]", "[DOCUMENT]");
* Document response = documentsClient.getDocument(name);
* }
* }
*
* ======================= EncryptionSpecServiceClient =======================
*
*
Service Description: Manages encryption spec settings for Dialogflow and Agent Assist.
*
*
Sample for EncryptionSpecServiceClient:
*
*
{@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 (EncryptionSpecServiceClient encryptionSpecServiceClient =
* EncryptionSpecServiceClient.create()) {
* EncryptionSpecName name = EncryptionSpecName.of("[PROJECT]", "[LOCATION]");
* EncryptionSpec response = encryptionSpecServiceClient.getEncryptionSpec(name);
* }
* }
*
* ======================= EntityTypesClient =======================
*
*
Service Description: Service for managing
* [EntityTypes][google.cloud.dialogflow.v2.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.ofProjectEntityTypeName("[PROJECT]", "[ENTITY_TYPE]");
* EntityType response = entityTypesClient.getEntityType(name);
* }
* }
*
* ======================= EnvironmentsClient =======================
*
*
Service Description: Service for managing
* [Environments][google.cloud.dialogflow.v2.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()) {
* GetEnvironmentRequest request =
* GetEnvironmentRequest.newBuilder()
* .setName(
* EnvironmentName.ofProjectEnvironmentName("[PROJECT]", "[ENVIRONMENT]").toString())
* .build();
* Environment response = environmentsClient.getEnvironment(request);
* }
* }
*
* ======================= FulfillmentsClient =======================
*
*
Service Description: Service for managing
* [Fulfillments][google.cloud.dialogflow.v2.Fulfillment].
*
*
Sample for FulfillmentsClient:
*
*
{@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 (FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create()) {
* FulfillmentName name = FulfillmentName.ofProjectName("[PROJECT]");
* Fulfillment response = fulfillmentsClient.getFulfillment(name);
* }
* }
*
* ======================= GeneratorsClient =======================
*
*
Service Description: Generator Service for LLM powered Agent Assist. This service manages the
* configurations of user owned Generators, such as description, context and instruction,
* input/output format, etc. The generator resources will be used inside a conversation and will be
* triggered by TriggerEvent to query LLM for answers.
*
*
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()) {
* ProjectName parent = ProjectName.of("[PROJECT]");
* Generator generator = Generator.newBuilder().build();
* String generatorId = "generatorId887044942";
* Generator response = generatorsClient.createGenerator(parent, generator, generatorId);
* }
* }
*
* ======================= IntentsClient =======================
*
*
Service Description: Service for managing [Intents][google.cloud.dialogflow.v2.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.ofProjectIntentName("[PROJECT]", "[INTENT]");
* Intent response = intentsClient.getIntent(name);
* }
* }
*
* ======================= KnowledgeBasesClient =======================
*
*
Service Description: Service for managing
* [KnowledgeBases][google.cloud.dialogflow.v2.KnowledgeBase].
*
*
Sample for KnowledgeBasesClient:
*
*
{@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 (KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create()) {
* KnowledgeBaseName name =
* KnowledgeBaseName.ofProjectKnowledgeBaseName("[PROJECT]", "[KNOWLEDGE_BASE]");
* KnowledgeBase response = knowledgeBasesClient.getKnowledgeBase(name);
* }
* }
*
* ======================= ParticipantsClient =======================
*
*
Service Description: Service for managing
* [Participants][google.cloud.dialogflow.v2.Participant].
*
*
Sample for ParticipantsClient:
*
*
{@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 (ParticipantsClient participantsClient = ParticipantsClient.create()) {
* ConversationName parent =
* ConversationName.ofProjectConversationName("[PROJECT]", "[CONVERSATION]");
* Participant participant = Participant.newBuilder().build();
* Participant response = participantsClient.createParticipant(parent, participant);
* }
* }
*
* ======================= SessionsClient =======================
*
*
Service Description: A service used for session interactions.
*
*
For more information, see the [API interactions
* guide](https://cloud.google.com/dialogflow/docs/api-overview).
*
*
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()) {
* SessionName session = SessionName.ofProjectSessionName("[PROJECT]", "[SESSION]");
* QueryInput queryInput = QueryInput.newBuilder().build();
* DetectIntentResponse response = sessionsClient.detectIntent(session, queryInput);
* }
* }
*
* ======================= SessionEntityTypesClient =======================
*
*
Service Description: Service for managing
* [SessionEntityTypes][google.cloud.dialogflow.v2.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.ofProjectSessionEntityTypeName(
* "[PROJECT]", "[SESSION]", "[ENTITY_TYPE]");
* SessionEntityType response = sessionEntityTypesClient.getSessionEntityType(name);
* }
* }
*
* ======================= VersionsClient =======================
*
*
Service Description: Service for managing [Versions][google.cloud.dialogflow.v2.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.ofProjectVersionName("[PROJECT]", "[VERSION]");
* Version response = versionsClient.getVersion(name);
* }
* }
*/
@Generated("by gapic-generator-java")
package com.google.cloud.dialogflow.v2;
import javax.annotation.Generated;