- 4.53.0 (latest)
- 4.52.0
- 4.51.0
- 4.50.0
- 4.49.0
- 4.48.0
- 4.47.0
- 4.46.0
- 4.45.0
- 4.43.0
- 4.42.0
- 4.41.0
- 4.40.0
- 4.39.0
- 4.38.0
- 4.37.0
- 4.36.0
- 4.35.0
- 4.34.0
- 4.33.0
- 4.30.0
- 4.29.0
- 4.28.0
- 4.27.0
- 4.26.0
- 4.25.0
- 4.24.0
- 4.23.0
- 4.22.0
- 4.21.0
- 4.20.0
- 4.19.0
- 4.18.0
- 4.17.0
- 4.15.0
- 4.14.0
- 4.13.0
- 4.12.0
- 4.11.0
- 4.10.0
- 4.9.1
- 4.8.6
- 4.7.5
- 4.6.0
- 4.5.11
- 4.4.0
- 4.3.1
A client to Dialogflow API
The interfaces provided are listed below, along with usage samples.
AgentsClient
Service Description: Service for managing Agents.
Sample for AgentsClient:
// 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.
Sample for AnswerRecordsClient:
// 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.
Sample for ContextsClient:
// 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.
Sample for ConversationsClient:
// 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:
// 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:
// 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.
Sample for ConversationProfilesClient:
// 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.
Sample for DocumentsClient:
// 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);
}
EntityTypesClient
Service Description: Service for managing EntityTypes.
Sample for EntityTypesClient:
// 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.
Sample for EnvironmentsClient:
// 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.
Sample for FulfillmentsClient:
// 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);
}
IntentsClient
Service Description: Service for managing Intents.
Sample for IntentsClient:
// 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.
Sample for KnowledgeBasesClient:
// 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.
Sample for ParticipantsClient:
// 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.
Sample for SessionsClient:
// 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.
Sample for SessionEntityTypesClient:
// 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.
Sample for VersionsClient:
// 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);
}
Classes
Agent
A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. For more information about agents, see the Agent guide.
Protobuf type google.cloud.dialogflow.v2.Agent
Agent.Builder
A Dialogflow agent is a virtual agent that handles conversations with your end-users. It is a natural language understanding module that understands the nuances of human language. Dialogflow translates end-user text or audio during a conversation to structured data that your apps and services can understand. You design and build a Dialogflow agent to handle the types of conversations required for your system. For more information about agents, see the Agent guide.
Protobuf type google.cloud.dialogflow.v2.Agent
AgentAssistantFeedback
Detail feedback of Agent Assist result.
Protobuf type google.cloud.dialogflow.v2.AgentAssistantFeedback
AgentAssistantFeedback.Builder
Detail feedback of Agent Assist result.
Protobuf type google.cloud.dialogflow.v2.AgentAssistantFeedback
AgentAssistantRecord
Represents a record of a human agent assist answer.
Protobuf type google.cloud.dialogflow.v2.AgentAssistantRecord
AgentAssistantRecord.Builder
Represents a record of a human agent assist answer.
Protobuf type google.cloud.dialogflow.v2.AgentAssistantRecord
AgentName
AgentName.Builder
Builder for projects/{project}/agent.
AgentName.ProjectLocationBuilder
Builder for projects/{project}/locations/{location}/agent.
AgentProto
AgentsClient
Service Description: Service for managing Agents.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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);
}
Note: close() needs to be called on the AgentsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of AgentsSettings to create(). For example:
To customize credentials:
// 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
AgentsSettings agentsSettings =
AgentsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AgentsClient agentsClient = AgentsClient.create(agentsSettings);
To customize the endpoint:
// 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
AgentsSettings agentsSettings = AgentsSettings.newBuilder().setEndpoint(myEndpoint).build();
AgentsClient agentsClient = AgentsClient.create(agentsSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
AgentsSettings agentsSettings =
AgentsSettings.newBuilder()
.setTransportChannelProvider(
AgentsSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
AgentsClient agentsClient = AgentsClient.create(agentsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
AgentsClient.ListLocationsFixedSizeCollection
AgentsClient.ListLocationsPage
AgentsClient.ListLocationsPagedResponse
AgentsClient.SearchAgentsFixedSizeCollection
AgentsClient.SearchAgentsPage
AgentsClient.SearchAgentsPagedResponse
AgentsGrpc
Service for managing Agents.
AgentsGrpc.AgentsBlockingStub
Service for managing Agents.
AgentsGrpc.AgentsFutureStub
Service for managing Agents.
AgentsGrpc.AgentsImplBase
Service for managing Agents.
AgentsGrpc.AgentsStub
Service for managing Agents.
AgentsSettings
Settings class to configure an instance of AgentsClient.
The default instance has everything set to sensible defaults:
- The default service address (dialogflow.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getAgent to 30 seconds:
// 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
AgentsSettings.Builder agentsSettingsBuilder = AgentsSettings.newBuilder();
agentsSettingsBuilder
.getAgentSettings()
.setRetrySettings(
agentsSettingsBuilder.getAgentSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
AgentsSettings agentsSettings = agentsSettingsBuilder.build();
AgentsSettings.Builder
Builder for AgentsSettings.
AnalyzeContentRequest
The request message for Participants.AnalyzeContent.
Protobuf type google.cloud.dialogflow.v2.AnalyzeContentRequest
AnalyzeContentRequest.Builder
The request message for Participants.AnalyzeContent.
Protobuf type google.cloud.dialogflow.v2.AnalyzeContentRequest
AnalyzeContentResponse
The response message for Participants.AnalyzeContent.
Protobuf type google.cloud.dialogflow.v2.AnalyzeContentResponse
AnalyzeContentResponse.Builder
The response message for Participants.AnalyzeContent.
Protobuf type google.cloud.dialogflow.v2.AnalyzeContentResponse
AnnotatedMessagePart
Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end.
Protobuf type google.cloud.dialogflow.v2.AnnotatedMessagePart
AnnotatedMessagePart.Builder
Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end.
Protobuf type google.cloud.dialogflow.v2.AnnotatedMessagePart
AnswerFeedback
Represents feedback the customer has about the quality & correctness of a certain answer in a conversation.
Protobuf type google.cloud.dialogflow.v2.AnswerFeedback
AnswerFeedback.Builder
Represents feedback the customer has about the quality & correctness of a certain answer in a conversation.
Protobuf type google.cloud.dialogflow.v2.AnswerFeedback
AnswerRecord
Answer records are records to manage answer history and feedbacks for Dialogflow. Currently, answer record includes:
- human agent assistant article suggestion
- human agent assistant faq article It doesn't include:
DetectIntent
intent matchingDetectIntent
knowledge Answer records are not related to the conversation history in the Dialogflow Console. A Record is generated even when the end-user disables conversation history in the console. Records are created when there's a human agent assistant suggestion generated. A typical workflow for customers provide feedback to an answer is:- For human agent assistant, customers get suggestion via ListSuggestions API. Together with the answers, AnswerRecord.name are returned to the customers.
- The customer uses the AnswerRecord.name to call the [UpdateAnswerRecord][] method to send feedback about a specific answer that they believe is wrong.
Protobuf type google.cloud.dialogflow.v2.AnswerRecord
AnswerRecord.Builder
Answer records are records to manage answer history and feedbacks for Dialogflow. Currently, answer record includes:
- human agent assistant article suggestion
- human agent assistant faq article It doesn't include:
DetectIntent
intent matchingDetectIntent
knowledge Answer records are not related to the conversation history in the Dialogflow Console. A Record is generated even when the end-user disables conversation history in the console. Records are created when there's a human agent assistant suggestion generated. A typical workflow for customers provide feedback to an answer is:- For human agent assistant, customers get suggestion via ListSuggestions API. Together with the answers, AnswerRecord.name are returned to the customers.
- The customer uses the AnswerRecord.name to call the [UpdateAnswerRecord][] method to send feedback about a specific answer that they believe is wrong.
Protobuf type google.cloud.dialogflow.v2.AnswerRecord
AnswerRecordName
AnswerRecordName.Builder
Builder for projects/{project}/answerRecords/{answer_record}.
AnswerRecordName.ProjectLocationAnswerRecordBuilder
Builder for projects/{project}/locations/{location}/answerRecords/{answer_record}.
AnswerRecordsClient
Service Description: Service for managing AnswerRecords.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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);
}
Note: close() needs to be called on the AnswerRecordsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of AnswerRecordsSettings to create(). For example:
To customize credentials:
// 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
AnswerRecordsSettings answerRecordsSettings =
AnswerRecordsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create(answerRecordsSettings);
To customize the endpoint:
// 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
AnswerRecordsSettings answerRecordsSettings =
AnswerRecordsSettings.newBuilder().setEndpoint(myEndpoint).build();
AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create(answerRecordsSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
AnswerRecordsSettings answerRecordsSettings =
AnswerRecordsSettings.newBuilder()
.setTransportChannelProvider(
AnswerRecordsSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
AnswerRecordsClient answerRecordsClient = AnswerRecordsClient.create(answerRecordsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
AnswerRecordsClient.ListAnswerRecordsFixedSizeCollection
AnswerRecordsClient.ListAnswerRecordsPage
AnswerRecordsClient.ListAnswerRecordsPagedResponse
AnswerRecordsClient.ListLocationsFixedSizeCollection
AnswerRecordsClient.ListLocationsPage
AnswerRecordsClient.ListLocationsPagedResponse
AnswerRecordsGrpc
Service for managing AnswerRecords.
AnswerRecordsGrpc.AnswerRecordsBlockingStub
Service for managing AnswerRecords.
AnswerRecordsGrpc.AnswerRecordsFutureStub
Service for managing AnswerRecords.
AnswerRecordsGrpc.AnswerRecordsImplBase
Service for managing AnswerRecords.
AnswerRecordsGrpc.AnswerRecordsStub
Service for managing AnswerRecords.
AnswerRecordsProto
AnswerRecordsSettings
Settings class to configure an instance of AnswerRecordsClient.
The default instance has everything set to sensible defaults:
- The default service address (dialogflow.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of updateAnswerRecord to 30 seconds:
// 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
AnswerRecordsSettings.Builder answerRecordsSettingsBuilder = AnswerRecordsSettings.newBuilder();
answerRecordsSettingsBuilder
.updateAnswerRecordSettings()
.setRetrySettings(
answerRecordsSettingsBuilder.updateAnswerRecordSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
AnswerRecordsSettings answerRecordsSettings = answerRecordsSettingsBuilder.build();
AnswerRecordsSettings.Builder
Builder for AnswerRecordsSettings.
ArticleAnswer
Represents article answer.
Protobuf type google.cloud.dialogflow.v2.ArticleAnswer
ArticleAnswer.Builder
Represents article answer.
Protobuf type google.cloud.dialogflow.v2.ArticleAnswer
ArticleSuggestionModelMetadata
Metadata for article suggestion models.
Protobuf type google.cloud.dialogflow.v2.ArticleSuggestionModelMetadata
ArticleSuggestionModelMetadata.Builder
Metadata for article suggestion models.
Protobuf type google.cloud.dialogflow.v2.ArticleSuggestionModelMetadata
AssistQueryParameters
Represents the parameters of human assist query.
Protobuf type google.cloud.dialogflow.v2.AssistQueryParameters
AssistQueryParameters.Builder
Represents the parameters of human assist query.
Protobuf type google.cloud.dialogflow.v2.AssistQueryParameters
AudioConfigProto
AutomatedAgentConfig
Defines the Automated Agent to connect to a conversation.
Protobuf type google.cloud.dialogflow.v2.AutomatedAgentConfig
AutomatedAgentConfig.Builder
Defines the Automated Agent to connect to a conversation.
Protobuf type google.cloud.dialogflow.v2.AutomatedAgentConfig
AutomatedAgentReply
Represents a response from an automated agent.
Protobuf type google.cloud.dialogflow.v2.AutomatedAgentReply
AutomatedAgentReply.Builder
Represents a response from an automated agent.
Protobuf type google.cloud.dialogflow.v2.AutomatedAgentReply
BatchCreateEntitiesRequest
The request message for EntityTypes.BatchCreateEntities.
Protobuf type google.cloud.dialogflow.v2.BatchCreateEntitiesRequest
BatchCreateEntitiesRequest.Builder
The request message for EntityTypes.BatchCreateEntities.
Protobuf type google.cloud.dialogflow.v2.BatchCreateEntitiesRequest
BatchDeleteEntitiesRequest
The request message for EntityTypes.BatchDeleteEntities.
Protobuf type google.cloud.dialogflow.v2.BatchDeleteEntitiesRequest
BatchDeleteEntitiesRequest.Builder
The request message for EntityTypes.BatchDeleteEntities.
Protobuf type google.cloud.dialogflow.v2.BatchDeleteEntitiesRequest
BatchDeleteEntityTypesRequest
The request message for EntityTypes.BatchDeleteEntityTypes.
Protobuf type google.cloud.dialogflow.v2.BatchDeleteEntityTypesRequest
BatchDeleteEntityTypesRequest.Builder
The request message for EntityTypes.BatchDeleteEntityTypes.
Protobuf type google.cloud.dialogflow.v2.BatchDeleteEntityTypesRequest
BatchDeleteIntentsRequest
The request message for Intents.BatchDeleteIntents.
Protobuf type google.cloud.dialogflow.v2.BatchDeleteIntentsRequest
BatchDeleteIntentsRequest.Builder
The request message for Intents.BatchDeleteIntents.
Protobuf type google.cloud.dialogflow.v2.BatchDeleteIntentsRequest
BatchUpdateEntitiesRequest
The request message for EntityTypes.BatchUpdateEntities.
Protobuf type google.cloud.dialogflow.v2.BatchUpdateEntitiesRequest
BatchUpdateEntitiesRequest.Builder
The request message for EntityTypes.BatchUpdateEntities.
Protobuf type google.cloud.dialogflow.v2.BatchUpdateEntitiesRequest
BatchUpdateEntityTypesRequest
The request message for EntityTypes.BatchUpdateEntityTypes.
Protobuf type google.cloud.dialogflow.v2.BatchUpdateEntityTypesRequest
BatchUpdateEntityTypesRequest.Builder
The request message for EntityTypes.BatchUpdateEntityTypes.
Protobuf type google.cloud.dialogflow.v2.BatchUpdateEntityTypesRequest
BatchUpdateEntityTypesResponse
The response message for EntityTypes.BatchUpdateEntityTypes.
Protobuf type google.cloud.dialogflow.v2.BatchUpdateEntityTypesResponse
BatchUpdateEntityTypesResponse.Builder
The response message for EntityTypes.BatchUpdateEntityTypes.
Protobuf type google.cloud.dialogflow.v2.BatchUpdateEntityTypesResponse
BatchUpdateIntentsRequest
Protobuf type google.cloud.dialogflow.v2.BatchUpdateIntentsRequest
BatchUpdateIntentsRequest.Builder
Protobuf type google.cloud.dialogflow.v2.BatchUpdateIntentsRequest
BatchUpdateIntentsResponse
The response message for Intents.BatchUpdateIntents.
Protobuf type google.cloud.dialogflow.v2.BatchUpdateIntentsResponse
BatchUpdateIntentsResponse.Builder
The response message for Intents.BatchUpdateIntents.
Protobuf type google.cloud.dialogflow.v2.BatchUpdateIntentsResponse
ClearSuggestionFeatureConfigOperationMetadata
Metadata for a [ConversationProfile.ClearSuggestionFeatureConfig][] operation.
Protobuf type google.cloud.dialogflow.v2.ClearSuggestionFeatureConfigOperationMetadata
ClearSuggestionFeatureConfigOperationMetadata.Builder
Metadata for a [ConversationProfile.ClearSuggestionFeatureConfig][] operation.
Protobuf type google.cloud.dialogflow.v2.ClearSuggestionFeatureConfigOperationMetadata
ClearSuggestionFeatureConfigRequest
The request message for [ConversationProfiles.ClearFeature][].
Protobuf type google.cloud.dialogflow.v2.ClearSuggestionFeatureConfigRequest
ClearSuggestionFeatureConfigRequest.Builder
The request message for [ConversationProfiles.ClearFeature][].
Protobuf type google.cloud.dialogflow.v2.ClearSuggestionFeatureConfigRequest
CompleteConversationRequest
The request message for Conversations.CompleteConversation.
Protobuf type google.cloud.dialogflow.v2.CompleteConversationRequest
CompleteConversationRequest.Builder
The request message for Conversations.CompleteConversation.
Protobuf type google.cloud.dialogflow.v2.CompleteConversationRequest
Context
Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the Contexts guide.
Protobuf type google.cloud.dialogflow.v2.Context
Context.Builder
Dialogflow contexts are similar to natural language context. If a person says to you "they are orange", you need context in order to understand what "they" is referring to. Similarly, for Dialogflow to handle an end-user expression like that, it needs to be provided with context in order to correctly match an intent. Using contexts, you can control the flow of a conversation. You can configure contexts for an intent by setting input and output contexts, which are identified by string names. When an intent is matched, any configured output contexts for that intent become active. While any contexts are active, Dialogflow is more likely to match intents that are configured with input contexts that correspond to the currently active contexts. For more information about context, see the Contexts guide.
Protobuf type google.cloud.dialogflow.v2.Context
ContextName
ContextName.Builder
Builder for projects/{project}/agent/sessions/{session}/contexts/{context}.
ContextName.ProjectEnvironmentUserSessionContextBuilder
Builder for projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}.
ContextName.ProjectLocationEnvironmentUserSessionContextBuilder
Builder for projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/contexts/{context}.
ContextName.ProjectLocationSessionContextBuilder
Builder for projects/{project}/locations/{location}/agent/sessions/{session}/contexts/{context}.
ContextProto
ContextsClient
Service Description: Service for managing Contexts.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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);
}
Note: close() needs to be called on the ContextsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ContextsSettings to create(). For example:
To customize credentials:
// 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
ContextsSettings contextsSettings =
ContextsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ContextsClient contextsClient = ContextsClient.create(contextsSettings);
To customize the endpoint:
// 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
ContextsSettings contextsSettings =
ContextsSettings.newBuilder().setEndpoint(myEndpoint).build();
ContextsClient contextsClient = ContextsClient.create(contextsSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
ContextsSettings contextsSettings =
ContextsSettings.newBuilder()
.setTransportChannelProvider(
ContextsSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
ContextsClient contextsClient = ContextsClient.create(contextsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
ContextsClient.ListContextsFixedSizeCollection
ContextsClient.ListContextsPage
ContextsClient.ListContextsPagedResponse
ContextsClient.ListLocationsFixedSizeCollection
ContextsClient.ListLocationsPage
ContextsClient.ListLocationsPagedResponse
ContextsGrpc
Service for managing Contexts.
ContextsGrpc.ContextsBlockingStub
Service for managing Contexts.
ContextsGrpc.ContextsFutureStub
Service for managing Contexts.
ContextsGrpc.ContextsImplBase
Service for managing Contexts.
ContextsGrpc.ContextsStub
Service for managing Contexts.
ContextsSettings
Settings class to configure an instance of ContextsClient.
The default instance has everything set to sensible defaults:
- The default service address (dialogflow.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getContext to 30 seconds:
// 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
ContextsSettings.Builder contextsSettingsBuilder = ContextsSettings.newBuilder();
contextsSettingsBuilder
.getContextSettings()
.setRetrySettings(
contextsSettingsBuilder.getContextSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ContextsSettings contextsSettings = contextsSettingsBuilder.build();
ContextsSettings.Builder
Builder for ContextsSettings.
Conversation
Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions.
Protobuf type google.cloud.dialogflow.v2.Conversation
Conversation.Builder
Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions.
Protobuf type google.cloud.dialogflow.v2.Conversation
ConversationDataset
Represents a conversation dataset that a user imports raw data into. The data inside ConversationDataset can not be changed after ImportConversationData finishes (and calling ImportConversationData on a dataset that already has data is not allowed).
Protobuf type google.cloud.dialogflow.v2.ConversationDataset
ConversationDataset.Builder
Represents a conversation dataset that a user imports raw data into. The data inside ConversationDataset can not be changed after ImportConversationData finishes (and calling ImportConversationData on a dataset that already has data is not allowed).
Protobuf type google.cloud.dialogflow.v2.ConversationDataset
ConversationDatasetName
ConversationDatasetName.Builder
Builder for projects/{project}/locations/{location}/conversationDatasets/{conversation_dataset}.
ConversationDatasetProto
ConversationDatasetsClient
Service Description: Conversation datasets.
Conversation datasets contain raw conversation files and their customizable metadata that can be used for model training.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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);
}
Note: close() needs to be called on the ConversationDatasetsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ConversationDatasetsSettings to create(). For example:
To customize credentials:
// 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
ConversationDatasetsSettings conversationDatasetsSettings =
ConversationDatasetsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create(conversationDatasetsSettings);
To customize the endpoint:
// 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
ConversationDatasetsSettings conversationDatasetsSettings =
ConversationDatasetsSettings.newBuilder().setEndpoint(myEndpoint).build();
ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create(conversationDatasetsSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
ConversationDatasetsSettings conversationDatasetsSettings =
ConversationDatasetsSettings.newBuilder()
.setTransportChannelProvider(
ConversationDatasetsSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
ConversationDatasetsClient conversationDatasetsClient =
ConversationDatasetsClient.create(conversationDatasetsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
ConversationDatasetsClient.ListConversationDatasetsFixedSizeCollection
ConversationDatasetsClient.ListConversationDatasetsPage
ConversationDatasetsClient.ListConversationDatasetsPagedResponse
ConversationDatasetsClient.ListLocationsFixedSizeCollection
ConversationDatasetsClient.ListLocationsPage
ConversationDatasetsClient.ListLocationsPagedResponse
ConversationDatasetsGrpc
Conversation datasets. Conversation datasets contain raw conversation files and their customizable metadata that can be used for model training.
ConversationDatasetsGrpc.ConversationDatasetsBlockingStub
Conversation datasets. Conversation datasets contain raw conversation files and their customizable metadata that can be used for model training.
ConversationDatasetsGrpc.ConversationDatasetsFutureStub
Conversation datasets. Conversation datasets contain raw conversation files and their customizable metadata that can be used for model training.
ConversationDatasetsGrpc.ConversationDatasetsImplBase
Conversation datasets. Conversation datasets contain raw conversation files and their customizable metadata that can be used for model training.
ConversationDatasetsGrpc.ConversationDatasetsStub
Conversation datasets. Conversation datasets contain raw conversation files and their customizable metadata that can be used for model training.
ConversationDatasetsSettings
Settings class to configure an instance of ConversationDatasetsClient.
The default instance has everything set to sensible defaults:
- The default service address (dialogflow.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getConversationDataset to 30 seconds:
// 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
ConversationDatasetsSettings.Builder conversationDatasetsSettingsBuilder =
ConversationDatasetsSettings.newBuilder();
conversationDatasetsSettingsBuilder
.getConversationDatasetSettings()
.setRetrySettings(
conversationDatasetsSettingsBuilder
.getConversationDatasetSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ConversationDatasetsSettings conversationDatasetsSettings =
conversationDatasetsSettingsBuilder.build();
ConversationDatasetsSettings.Builder
Builder for ConversationDatasetsSettings.
ConversationEvent
Represents a notification sent to Pub/Sub subscribers for conversation lifecycle events.
Protobuf type google.cloud.dialogflow.v2.ConversationEvent
ConversationEvent.Builder
Represents a notification sent to Pub/Sub subscribers for conversation lifecycle events.
Protobuf type google.cloud.dialogflow.v2.ConversationEvent
ConversationEventProto
ConversationInfo
Represents metadata of a conversation.
Protobuf type google.cloud.dialogflow.v2.ConversationInfo
ConversationInfo.Builder
Represents metadata of a conversation.
Protobuf type google.cloud.dialogflow.v2.ConversationInfo
ConversationModel
Represents a conversation model.
Protobuf type google.cloud.dialogflow.v2.ConversationModel
ConversationModel.Builder
Represents a conversation model.
Protobuf type google.cloud.dialogflow.v2.ConversationModel
ConversationModelEvaluation
Represents evaluation result of a conversation model.
Protobuf type google.cloud.dialogflow.v2.ConversationModelEvaluation
ConversationModelEvaluation.Builder
Represents evaluation result of a conversation model.
Protobuf type google.cloud.dialogflow.v2.ConversationModelEvaluation
ConversationModelEvaluationName
ConversationModelEvaluationName.Builder
Builder for projects/{project}/conversationModels/{conversation_model}/evaluations/{evaluation}.
ConversationModelEvaluationName.ProjectLocationConversationModelEvaluationBuilder
Builder for projects/{project}/locations/{location}/conversationModels/{conversation_model}/evaluations/{evaluation}.
ConversationModelName
ConversationModelName.Builder
Builder for projects/{project}/locations/{location}/conversationModels/{conversation_model}.
ConversationModelName.ProjectConversationModelBuilder
Builder for projects/{project}/conversationModels/{conversation_model}.
ConversationModelProto
ConversationModelsClient
Service Description: Manages a collection of models for human agent assistant.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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);
}
Note: close() needs to be called on the ConversationModelsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ConversationModelsSettings to create(). For example:
To customize credentials:
// 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
ConversationModelsSettings conversationModelsSettings =
ConversationModelsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ConversationModelsClient conversationModelsClient =
ConversationModelsClient.create(conversationModelsSettings);
To customize the endpoint:
// 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
ConversationModelsSettings conversationModelsSettings =
ConversationModelsSettings.newBuilder().setEndpoint(myEndpoint).build();
ConversationModelsClient conversationModelsClient =
ConversationModelsClient.create(conversationModelsSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
ConversationModelsSettings conversationModelsSettings =
ConversationModelsSettings.newBuilder()
.setTransportChannelProvider(
ConversationModelsSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
ConversationModelsClient conversationModelsClient =
ConversationModelsClient.create(conversationModelsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
ConversationModelsClient.ListConversationModelEvaluationsFixedSizeCollection
ConversationModelsClient.ListConversationModelEvaluationsPage
ConversationModelsClient.ListConversationModelEvaluationsPagedResponse
ConversationModelsClient.ListConversationModelsFixedSizeCollection
ConversationModelsClient.ListConversationModelsPage
ConversationModelsClient.ListConversationModelsPagedResponse
ConversationModelsClient.ListLocationsFixedSizeCollection
ConversationModelsClient.ListLocationsPage
ConversationModelsClient.ListLocationsPagedResponse
ConversationModelsGrpc
Manages a collection of models for human agent assistant.
ConversationModelsGrpc.ConversationModelsBlockingStub
Manages a collection of models for human agent assistant.
ConversationModelsGrpc.ConversationModelsFutureStub
Manages a collection of models for human agent assistant.
ConversationModelsGrpc.ConversationModelsImplBase
Manages a collection of models for human agent assistant.
ConversationModelsGrpc.ConversationModelsStub
Manages a collection of models for human agent assistant.
ConversationModelsSettings
Settings class to configure an instance of ConversationModelsClient.
The default instance has everything set to sensible defaults:
- The default service address (dialogflow.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getConversationModel to 30 seconds:
// 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
ConversationModelsSettings.Builder conversationModelsSettingsBuilder =
ConversationModelsSettings.newBuilder();
conversationModelsSettingsBuilder
.getConversationModelSettings()
.setRetrySettings(
conversationModelsSettingsBuilder
.getConversationModelSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ConversationModelsSettings conversationModelsSettings =
conversationModelsSettingsBuilder.build();
ConversationModelsSettings.Builder
Builder for ConversationModelsSettings.
ConversationName
ConversationName.Builder
Builder for projects/{project}/conversations/{conversation}.
ConversationName.ProjectLocationConversationBuilder
Builder for projects/{project}/locations/{location}/conversations/{conversation}.
ConversationPhoneNumber
Represents a phone number for telephony integration. It allows for connecting a particular conversation over telephony.
Protobuf type google.cloud.dialogflow.v2.ConversationPhoneNumber
ConversationPhoneNumber.Builder
Represents a phone number for telephony integration. It allows for connecting a particular conversation over telephony.
Protobuf type google.cloud.dialogflow.v2.ConversationPhoneNumber
ConversationProfile
Defines the services to connect to incoming Dialogflow conversations.
Protobuf type google.cloud.dialogflow.v2.ConversationProfile
ConversationProfile.Builder
Defines the services to connect to incoming Dialogflow conversations.
Protobuf type google.cloud.dialogflow.v2.ConversationProfile
ConversationProfileName
ConversationProfileName.Builder
Builder for projects/{project}/conversationProfiles/{conversation_profile}.
ConversationProfileName.ProjectLocationConversationProfileBuilder
Builder for projects/{project}/locations/{location}/conversationProfiles/{conversation_profile}.
ConversationProfileProto
ConversationProfilesClient
Service Description: Service for managing ConversationProfiles.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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);
}
Note: close() needs to be called on the ConversationProfilesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ConversationProfilesSettings to create(). For example:
To customize credentials:
// 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
ConversationProfilesSettings conversationProfilesSettings =
ConversationProfilesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ConversationProfilesClient conversationProfilesClient =
ConversationProfilesClient.create(conversationProfilesSettings);
To customize the endpoint:
// 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
ConversationProfilesSettings conversationProfilesSettings =
ConversationProfilesSettings.newBuilder().setEndpoint(myEndpoint).build();
ConversationProfilesClient conversationProfilesClient =
ConversationProfilesClient.create(conversationProfilesSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
ConversationProfilesSettings conversationProfilesSettings =
ConversationProfilesSettings.newBuilder()
.setTransportChannelProvider(
ConversationProfilesSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
ConversationProfilesClient conversationProfilesClient =
ConversationProfilesClient.create(conversationProfilesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
ConversationProfilesClient.ListConversationProfilesFixedSizeCollection
ConversationProfilesClient.ListConversationProfilesPage
ConversationProfilesClient.ListConversationProfilesPagedResponse
ConversationProfilesClient.ListLocationsFixedSizeCollection
ConversationProfilesClient.ListLocationsPage
ConversationProfilesClient.ListLocationsPagedResponse
ConversationProfilesGrpc
Service for managing ConversationProfiles.
ConversationProfilesGrpc.ConversationProfilesBlockingStub
Service for managing ConversationProfiles.
ConversationProfilesGrpc.ConversationProfilesFutureStub
Service for managing ConversationProfiles.
ConversationProfilesGrpc.ConversationProfilesImplBase
Service for managing ConversationProfiles.
ConversationProfilesGrpc.ConversationProfilesStub
Service for managing ConversationProfiles.
ConversationProfilesSettings
Settings class to configure an instance of ConversationProfilesClient.
The default instance has everything set to sensible defaults:
- The default service address (dialogflow.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getConversationProfile to 30 seconds:
// 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
ConversationProfilesSettings.Builder conversationProfilesSettingsBuilder =
ConversationProfilesSettings.newBuilder();
conversationProfilesSettingsBuilder
.getConversationProfileSettings()
.setRetrySettings(
conversationProfilesSettingsBuilder
.getConversationProfileSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ConversationProfilesSettings conversationProfilesSettings =
conversationProfilesSettingsBuilder.build();
ConversationProfilesSettings.Builder
Builder for ConversationProfilesSettings.
ConversationProto
ConversationsClient
Service Description: Service for managing Conversations.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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);
}
Note: close() needs to be called on the ConversationsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ConversationsSettings to create(). For example:
To customize credentials:
// 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
ConversationsSettings conversationsSettings =
ConversationsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ConversationsClient conversationsClient = ConversationsClient.create(conversationsSettings);
To customize the endpoint:
// 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
ConversationsSettings conversationsSettings =
ConversationsSettings.newBuilder().setEndpoint(myEndpoint).build();
ConversationsClient conversationsClient = ConversationsClient.create(conversationsSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
ConversationsSettings conversationsSettings =
ConversationsSettings.newBuilder()
.setTransportChannelProvider(
ConversationsSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
ConversationsClient conversationsClient = ConversationsClient.create(conversationsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
ConversationsClient.ListConversationsFixedSizeCollection
ConversationsClient.ListConversationsPage
ConversationsClient.ListConversationsPagedResponse
ConversationsClient.ListLocationsFixedSizeCollection
ConversationsClient.ListLocationsPage
ConversationsClient.ListLocationsPagedResponse
ConversationsClient.ListMessagesFixedSizeCollection
ConversationsClient.ListMessagesPage
ConversationsClient.ListMessagesPagedResponse
ConversationsGrpc
Service for managing Conversations.
ConversationsGrpc.ConversationsBlockingStub
Service for managing Conversations.
ConversationsGrpc.ConversationsFutureStub
Service for managing Conversations.
ConversationsGrpc.ConversationsImplBase
Service for managing Conversations.
ConversationsGrpc.ConversationsStub
Service for managing Conversations.
ConversationsSettings
Settings class to configure an instance of ConversationsClient.
The default instance has everything set to sensible defaults:
- The default service address (dialogflow.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of createConversation to 30 seconds:
// 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
ConversationsSettings.Builder conversationsSettingsBuilder = ConversationsSettings.newBuilder();
conversationsSettingsBuilder
.createConversationSettings()
.setRetrySettings(
conversationsSettingsBuilder.createConversationSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ConversationsSettings conversationsSettings = conversationsSettingsBuilder.build();
ConversationsSettings.Builder
Builder for ConversationsSettings.
CreateContextRequest
The request message for Contexts.CreateContext.
Protobuf type google.cloud.dialogflow.v2.CreateContextRequest
CreateContextRequest.Builder
The request message for Contexts.CreateContext.
Protobuf type google.cloud.dialogflow.v2.CreateContextRequest
CreateConversationDatasetOperationMetadata
Metadata for ConversationDatasets.
Protobuf type google.cloud.dialogflow.v2.CreateConversationDatasetOperationMetadata
CreateConversationDatasetOperationMetadata.Builder
Metadata for ConversationDatasets.
Protobuf type google.cloud.dialogflow.v2.CreateConversationDatasetOperationMetadata
CreateConversationDatasetRequest
The request message for ConversationDatasets.CreateConversationDataset.
Protobuf type google.cloud.dialogflow.v2.CreateConversationDatasetRequest
CreateConversationDatasetRequest.Builder
The request message for ConversationDatasets.CreateConversationDataset.
Protobuf type google.cloud.dialogflow.v2.CreateConversationDatasetRequest
CreateConversationModelEvaluationOperationMetadata
Metadata for a ConversationModels.CreateConversationModelEvaluation operation.
Protobuf type
google.cloud.dialogflow.v2.CreateConversationModelEvaluationOperationMetadata
CreateConversationModelEvaluationOperationMetadata.Builder
Metadata for a ConversationModels.CreateConversationModelEvaluation operation.
Protobuf type
google.cloud.dialogflow.v2.CreateConversationModelEvaluationOperationMetadata
CreateConversationModelEvaluationRequest
The request message for ConversationModels.CreateConversationModelEvaluation
Protobuf type google.cloud.dialogflow.v2.CreateConversationModelEvaluationRequest
CreateConversationModelEvaluationRequest.Builder
The request message for ConversationModels.CreateConversationModelEvaluation
Protobuf type google.cloud.dialogflow.v2.CreateConversationModelEvaluationRequest
CreateConversationModelOperationMetadata
Metadata for a ConversationModels.CreateConversationModel operation.
Protobuf type google.cloud.dialogflow.v2.CreateConversationModelOperationMetadata
CreateConversationModelOperationMetadata.Builder
Metadata for a ConversationModels.CreateConversationModel operation.
Protobuf type google.cloud.dialogflow.v2.CreateConversationModelOperationMetadata
CreateConversationModelRequest
The request message for ConversationModels.CreateConversationModel
Protobuf type google.cloud.dialogflow.v2.CreateConversationModelRequest
CreateConversationModelRequest.Builder
The request message for ConversationModels.CreateConversationModel
Protobuf type google.cloud.dialogflow.v2.CreateConversationModelRequest
CreateConversationProfileRequest
The request message for ConversationProfiles.CreateConversationProfile.
Protobuf type google.cloud.dialogflow.v2.CreateConversationProfileRequest
CreateConversationProfileRequest.Builder
The request message for ConversationProfiles.CreateConversationProfile.
Protobuf type google.cloud.dialogflow.v2.CreateConversationProfileRequest
CreateConversationRequest
The request message for Conversations.CreateConversation.
Protobuf type google.cloud.dialogflow.v2.CreateConversationRequest
CreateConversationRequest.Builder
The request message for Conversations.CreateConversation.
Protobuf type google.cloud.dialogflow.v2.CreateConversationRequest
CreateDocumentRequest
Request message for Documents.CreateDocument.
Protobuf type google.cloud.dialogflow.v2.CreateDocumentRequest
CreateDocumentRequest.Builder
Request message for Documents.CreateDocument.
Protobuf type google.cloud.dialogflow.v2.CreateDocumentRequest
CreateEntityTypeRequest
The request message for EntityTypes.CreateEntityType.
Protobuf type google.cloud.dialogflow.v2.CreateEntityTypeRequest
CreateEntityTypeRequest.Builder
The request message for EntityTypes.CreateEntityType.
Protobuf type google.cloud.dialogflow.v2.CreateEntityTypeRequest
CreateEnvironmentRequest
The request message for Environments.CreateEnvironment.
Protobuf type google.cloud.dialogflow.v2.CreateEnvironmentRequest
CreateEnvironmentRequest.Builder
The request message for Environments.CreateEnvironment.
Protobuf type google.cloud.dialogflow.v2.CreateEnvironmentRequest
CreateIntentRequest
The request message for Intents.CreateIntent.
Protobuf type google.cloud.dialogflow.v2.CreateIntentRequest
CreateIntentRequest.Builder
The request message for Intents.CreateIntent.
Protobuf type google.cloud.dialogflow.v2.CreateIntentRequest
CreateKnowledgeBaseRequest
Request message for KnowledgeBases.CreateKnowledgeBase.
Protobuf type google.cloud.dialogflow.v2.CreateKnowledgeBaseRequest
CreateKnowledgeBaseRequest.Builder
Request message for KnowledgeBases.CreateKnowledgeBase.
Protobuf type google.cloud.dialogflow.v2.CreateKnowledgeBaseRequest
CreateParticipantRequest
The request message for Participants.CreateParticipant.
Protobuf type google.cloud.dialogflow.v2.CreateParticipantRequest
CreateParticipantRequest.Builder
The request message for Participants.CreateParticipant.
Protobuf type google.cloud.dialogflow.v2.CreateParticipantRequest
CreateSessionEntityTypeRequest
The request message for SessionEntityTypes.CreateSessionEntityType.
Protobuf type google.cloud.dialogflow.v2.CreateSessionEntityTypeRequest
CreateSessionEntityTypeRequest.Builder
The request message for SessionEntityTypes.CreateSessionEntityType.
Protobuf type google.cloud.dialogflow.v2.CreateSessionEntityTypeRequest
CreateVersionRequest
The request message for Versions.CreateVersion.
Protobuf type google.cloud.dialogflow.v2.CreateVersionRequest
CreateVersionRequest.Builder
The request message for Versions.CreateVersion.
Protobuf type google.cloud.dialogflow.v2.CreateVersionRequest
DeleteAgentRequest
The request message for Agents.DeleteAgent.
Protobuf type google.cloud.dialogflow.v2.DeleteAgentRequest
DeleteAgentRequest.Builder
The request message for Agents.DeleteAgent.
Protobuf type google.cloud.dialogflow.v2.DeleteAgentRequest
DeleteAllContextsRequest
The request message for Contexts.DeleteAllContexts.
Protobuf type google.cloud.dialogflow.v2.DeleteAllContextsRequest
DeleteAllContextsRequest.Builder
The request message for Contexts.DeleteAllContexts.
Protobuf type google.cloud.dialogflow.v2.DeleteAllContextsRequest
DeleteContextRequest
The request message for Contexts.DeleteContext.
Protobuf type google.cloud.dialogflow.v2.DeleteContextRequest
DeleteContextRequest.Builder
The request message for Contexts.DeleteContext.
Protobuf type google.cloud.dialogflow.v2.DeleteContextRequest
DeleteConversationDatasetOperationMetadata
Metadata for ConversationDatasets.
Protobuf type google.cloud.dialogflow.v2.DeleteConversationDatasetOperationMetadata
DeleteConversationDatasetOperationMetadata.Builder
Metadata for ConversationDatasets.
Protobuf type google.cloud.dialogflow.v2.DeleteConversationDatasetOperationMetadata
DeleteConversationDatasetRequest
The request message for ConversationDatasets.DeleteConversationDataset.
Protobuf type google.cloud.dialogflow.v2.DeleteConversationDatasetRequest
DeleteConversationDatasetRequest.Builder
The request message for ConversationDatasets.DeleteConversationDataset.
Protobuf type google.cloud.dialogflow.v2.DeleteConversationDatasetRequest
DeleteConversationModelOperationMetadata
Metadata for a ConversationModels.DeleteConversationModel operation.
Protobuf type google.cloud.dialogflow.v2.DeleteConversationModelOperationMetadata
DeleteConversationModelOperationMetadata.Builder
Metadata for a ConversationModels.DeleteConversationModel operation.
Protobuf type google.cloud.dialogflow.v2.DeleteConversationModelOperationMetadata
DeleteConversationModelRequest
The request message for ConversationModels.DeleteConversationModel
Protobuf type google.cloud.dialogflow.v2.DeleteConversationModelRequest
DeleteConversationModelRequest.Builder
The request message for ConversationModels.DeleteConversationModel
Protobuf type google.cloud.dialogflow.v2.DeleteConversationModelRequest
DeleteConversationProfileRequest
The request message for ConversationProfiles.DeleteConversationProfile. This operation fails if the conversation profile is still referenced from a phone number.
Protobuf type google.cloud.dialogflow.v2.DeleteConversationProfileRequest
DeleteConversationProfileRequest.Builder
The request message for ConversationProfiles.DeleteConversationProfile. This operation fails if the conversation profile is still referenced from a phone number.
Protobuf type google.cloud.dialogflow.v2.DeleteConversationProfileRequest
DeleteDocumentRequest
Request message for Documents.DeleteDocument.
Protobuf type google.cloud.dialogflow.v2.DeleteDocumentRequest
DeleteDocumentRequest.Builder
Request message for Documents.DeleteDocument.
Protobuf type google.cloud.dialogflow.v2.DeleteDocumentRequest
DeleteEntityTypeRequest
The request message for EntityTypes.DeleteEntityType.
Protobuf type google.cloud.dialogflow.v2.DeleteEntityTypeRequest
DeleteEntityTypeRequest.Builder
The request message for EntityTypes.DeleteEntityType.
Protobuf type google.cloud.dialogflow.v2.DeleteEntityTypeRequest
DeleteEnvironmentRequest
The request message for Environments.DeleteEnvironment.
Protobuf type google.cloud.dialogflow.v2.DeleteEnvironmentRequest
DeleteEnvironmentRequest.Builder
The request message for Environments.DeleteEnvironment.
Protobuf type google.cloud.dialogflow.v2.DeleteEnvironmentRequest
DeleteIntentRequest
The request message for Intents.DeleteIntent.
Protobuf type google.cloud.dialogflow.v2.DeleteIntentRequest
DeleteIntentRequest.Builder
The request message for Intents.DeleteIntent.
Protobuf type google.cloud.dialogflow.v2.DeleteIntentRequest
DeleteKnowledgeBaseRequest
Request message for KnowledgeBases.DeleteKnowledgeBase.
Protobuf type google.cloud.dialogflow.v2.DeleteKnowledgeBaseRequest
DeleteKnowledgeBaseRequest.Builder
Request message for KnowledgeBases.DeleteKnowledgeBase.
Protobuf type google.cloud.dialogflow.v2.DeleteKnowledgeBaseRequest
DeleteSessionEntityTypeRequest
The request message for SessionEntityTypes.DeleteSessionEntityType.
Protobuf type google.cloud.dialogflow.v2.DeleteSessionEntityTypeRequest
DeleteSessionEntityTypeRequest.Builder
The request message for SessionEntityTypes.DeleteSessionEntityType.
Protobuf type google.cloud.dialogflow.v2.DeleteSessionEntityTypeRequest
DeleteVersionRequest
The request message for Versions.DeleteVersion.
Protobuf type google.cloud.dialogflow.v2.DeleteVersionRequest
DeleteVersionRequest.Builder
The request message for Versions.DeleteVersion.
Protobuf type google.cloud.dialogflow.v2.DeleteVersionRequest
DeployConversationModelOperationMetadata
Metadata for a ConversationModels.DeployConversationModel operation.
Protobuf type google.cloud.dialogflow.v2.DeployConversationModelOperationMetadata
DeployConversationModelOperationMetadata.Builder
Metadata for a ConversationModels.DeployConversationModel operation.
Protobuf type google.cloud.dialogflow.v2.DeployConversationModelOperationMetadata
DeployConversationModelRequest
The request message for ConversationModels.DeployConversationModel
Protobuf type google.cloud.dialogflow.v2.DeployConversationModelRequest
DeployConversationModelRequest.Builder
The request message for ConversationModels.DeployConversationModel
Protobuf type google.cloud.dialogflow.v2.DeployConversationModelRequest
DetectIntentRequest
The request to detect user's intent.
Protobuf type google.cloud.dialogflow.v2.DetectIntentRequest
DetectIntentRequest.Builder
The request to detect user's intent.
Protobuf type google.cloud.dialogflow.v2.DetectIntentRequest
DetectIntentResponse
The message returned from the DetectIntent method.
Protobuf type google.cloud.dialogflow.v2.DetectIntentResponse
DetectIntentResponse.Builder
The message returned from the DetectIntent method.
Protobuf type google.cloud.dialogflow.v2.DetectIntentResponse
Document
A knowledge document to be used by a KnowledgeBase.
For more information, see the knowledge base
guide.
Note: The projects.agent.knowledgeBases.documents
resource is deprecated;
only use projects.knowledgeBases.documents
.
Protobuf type google.cloud.dialogflow.v2.Document
Document.Builder
A knowledge document to be used by a KnowledgeBase.
For more information, see the knowledge base
guide.
Note: The projects.agent.knowledgeBases.documents
resource is deprecated;
only use projects.knowledgeBases.documents
.
Protobuf type google.cloud.dialogflow.v2.Document
Document.ReloadStatus
The status of a reload attempt.
Protobuf type google.cloud.dialogflow.v2.Document.ReloadStatus
Document.ReloadStatus.Builder
The status of a reload attempt.
Protobuf type google.cloud.dialogflow.v2.Document.ReloadStatus
DocumentName
DocumentName.Builder
Builder for projects/{project}/knowledgeBases/{knowledge_base}/documents/{document}.
DocumentName.ProjectLocationKnowledgeBaseDocumentBuilder
Builder for projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}/documents/{document}.
DocumentProto
DocumentsClient
Service Description: Service for managing knowledge Documents.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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);
}
Note: close() needs to be called on the DocumentsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of DocumentsSettings to create(). For example:
To customize credentials:
// 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
DocumentsSettings documentsSettings =
DocumentsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
DocumentsClient documentsClient = DocumentsClient.create(documentsSettings);
To customize the endpoint:
// 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
DocumentsSettings documentsSettings =
DocumentsSettings.newBuilder().setEndpoint(myEndpoint).build();
DocumentsClient documentsClient = DocumentsClient.create(documentsSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
DocumentsSettings documentsSettings =
DocumentsSettings.newBuilder()
.setTransportChannelProvider(
DocumentsSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
DocumentsClient documentsClient = DocumentsClient.create(documentsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
DocumentsClient.ListDocumentsFixedSizeCollection
DocumentsClient.ListDocumentsPage
DocumentsClient.ListDocumentsPagedResponse
DocumentsClient.ListLocationsFixedSizeCollection
DocumentsClient.ListLocationsPage
DocumentsClient.ListLocationsPagedResponse
DocumentsGrpc
Service for managing knowledge Documents.
DocumentsGrpc.DocumentsBlockingStub
Service for managing knowledge Documents.
DocumentsGrpc.DocumentsFutureStub
Service for managing knowledge Documents.
DocumentsGrpc.DocumentsImplBase
Service for managing knowledge Documents.
DocumentsGrpc.DocumentsStub
Service for managing knowledge Documents.
DocumentsSettings
Settings class to configure an instance of DocumentsClient.
The default instance has everything set to sensible defaults:
- The default service address (dialogflow.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getDocument to 30 seconds:
// 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
DocumentsSettings.Builder documentsSettingsBuilder = DocumentsSettings.newBuilder();
documentsSettingsBuilder
.getDocumentSettings()
.setRetrySettings(
documentsSettingsBuilder.getDocumentSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
DocumentsSettings documentsSettings = documentsSettingsBuilder.build();
DocumentsSettings.Builder
Builder for DocumentsSettings.
DtmfParameters
The message in the response that indicates the parameters of DTMF.
Protobuf type google.cloud.dialogflow.v2.DtmfParameters
DtmfParameters.Builder
The message in the response that indicates the parameters of DTMF.
Protobuf type google.cloud.dialogflow.v2.DtmfParameters
EntityType
Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the Entity guide.
Protobuf type google.cloud.dialogflow.v2.EntityType
EntityType.Builder
Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the Entity guide.
Protobuf type google.cloud.dialogflow.v2.EntityType
EntityType.Entity
An entity entry for an associated entity type.
Protobuf type google.cloud.dialogflow.v2.EntityType.Entity
EntityType.Entity.Builder
An entity entry for an associated entity type.
Protobuf type google.cloud.dialogflow.v2.EntityType.Entity
EntityTypeBatch
This message is a wrapper around a collection of entity types.
Protobuf type google.cloud.dialogflow.v2.EntityTypeBatch
EntityTypeBatch.Builder
This message is a wrapper around a collection of entity types.
Protobuf type google.cloud.dialogflow.v2.EntityTypeBatch
EntityTypeName
EntityTypeName.Builder
Builder for projects/{project}/agent/entityTypes/{entity_type}.
EntityTypeName.ProjectLocationEntityTypeBuilder
Builder for projects/{project}/locations/{location}/agent/entityTypes/{entity_type}.
EntityTypeProto
EntityTypesClient
Service Description: Service for managing EntityTypes.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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);
}
Note: close() needs to be called on the EntityTypesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of EntityTypesSettings to create(). For example:
To customize credentials:
// 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
EntityTypesSettings entityTypesSettings =
EntityTypesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
EntityTypesClient entityTypesClient = EntityTypesClient.create(entityTypesSettings);
To customize the endpoint:
// 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
EntityTypesSettings entityTypesSettings =
EntityTypesSettings.newBuilder().setEndpoint(myEndpoint).build();
EntityTypesClient entityTypesClient = EntityTypesClient.create(entityTypesSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
EntityTypesSettings entityTypesSettings =
EntityTypesSettings.newBuilder()
.setTransportChannelProvider(
EntityTypesSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
EntityTypesClient entityTypesClient = EntityTypesClient.create(entityTypesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
EntityTypesClient.ListEntityTypesFixedSizeCollection
EntityTypesClient.ListEntityTypesPage
EntityTypesClient.ListEntityTypesPagedResponse
EntityTypesClient.ListLocationsFixedSizeCollection
EntityTypesClient.ListLocationsPage
EntityTypesClient.ListLocationsPagedResponse
EntityTypesGrpc
Service for managing EntityTypes.
EntityTypesGrpc.EntityTypesBlockingStub
Service for managing EntityTypes.
EntityTypesGrpc.EntityTypesFutureStub
Service for managing EntityTypes.
EntityTypesGrpc.EntityTypesImplBase
Service for managing EntityTypes.
EntityTypesGrpc.EntityTypesStub
Service for managing EntityTypes.
EntityTypesSettings
Settings class to configure an instance of EntityTypesClient.
The default instance has everything set to sensible defaults:
- The default service address (dialogflow.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getEntityType to 30 seconds:
// 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
EntityTypesSettings.Builder entityTypesSettingsBuilder = EntityTypesSettings.newBuilder();
entityTypesSettingsBuilder
.getEntityTypeSettings()
.setRetrySettings(
entityTypesSettingsBuilder.getEntityTypeSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
EntityTypesSettings entityTypesSettings = entityTypesSettingsBuilder.build();
EntityTypesSettings.Builder
Builder for EntityTypesSettings.
Environment
You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for:
- testing
- development
- production
- etc. For more information, see the versions and environments guide.
Protobuf type google.cloud.dialogflow.v2.Environment
Environment.Builder
You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for:
- testing
- development
- production
- etc. For more information, see the versions and environments guide.
Protobuf type google.cloud.dialogflow.v2.Environment
EnvironmentHistory
The response message for Environments.GetEnvironmentHistory.
Protobuf type google.cloud.dialogflow.v2.EnvironmentHistory
EnvironmentHistory.Builder
The response message for Environments.GetEnvironmentHistory.
Protobuf type google.cloud.dialogflow.v2.EnvironmentHistory
EnvironmentHistory.Entry
Represents an environment history entry.
Protobuf type google.cloud.dialogflow.v2.EnvironmentHistory.Entry
EnvironmentHistory.Entry.Builder
Represents an environment history entry.
Protobuf type google.cloud.dialogflow.v2.EnvironmentHistory.Entry
EnvironmentName
EnvironmentName.Builder
Builder for projects/{project}/agent/environments/{environment}.
EnvironmentName.ProjectLocationEnvironmentBuilder
Builder for projects/{project}/locations/{location}/agent/environments/{environment}.
EnvironmentProto
EnvironmentsClient
Service Description: Service for managing Environments.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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);
}
Note: close() needs to be called on the EnvironmentsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of EnvironmentsSettings to create(). For example:
To customize credentials:
// 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
EnvironmentsSettings environmentsSettings =
EnvironmentsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
EnvironmentsClient environmentsClient = EnvironmentsClient.create(environmentsSettings);
To customize the endpoint:
// 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
EnvironmentsSettings environmentsSettings =
EnvironmentsSettings.newBuilder().setEndpoint(myEndpoint).build();
EnvironmentsClient environmentsClient = EnvironmentsClient.create(environmentsSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
EnvironmentsSettings environmentsSettings =
EnvironmentsSettings.newBuilder()
.setTransportChannelProvider(
EnvironmentsSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
EnvironmentsClient environmentsClient = EnvironmentsClient.create(environmentsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
EnvironmentsClient.GetEnvironmentHistoryFixedSizeCollection
EnvironmentsClient.GetEnvironmentHistoryPage
EnvironmentsClient.GetEnvironmentHistoryPagedResponse
EnvironmentsClient.ListEnvironmentsFixedSizeCollection
EnvironmentsClient.ListEnvironmentsPage
EnvironmentsClient.ListEnvironmentsPagedResponse
EnvironmentsClient.ListLocationsFixedSizeCollection
EnvironmentsClient.ListLocationsPage
EnvironmentsClient.ListLocationsPagedResponse
EnvironmentsGrpc
Service for managing Environments.
EnvironmentsGrpc.EnvironmentsBlockingStub
Service for managing Environments.
EnvironmentsGrpc.EnvironmentsFutureStub
Service for managing Environments.
EnvironmentsGrpc.EnvironmentsImplBase
Service for managing Environments.
EnvironmentsGrpc.EnvironmentsStub
Service for managing Environments.
EnvironmentsSettings
Settings class to configure an instance of EnvironmentsClient.
The default instance has everything set to sensible defaults:
- The default service address (dialogflow.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getEnvironment to 30 seconds:
// 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
EnvironmentsSettings.Builder environmentsSettingsBuilder = EnvironmentsSettings.newBuilder();
environmentsSettingsBuilder
.getEnvironmentSettings()
.setRetrySettings(
environmentsSettingsBuilder.getEnvironmentSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
EnvironmentsSettings environmentsSettings = environmentsSettingsBuilder.build();
EnvironmentsSettings.Builder
Builder for EnvironmentsSettings.
EvaluationConfig
The configuration for model evaluation.
Protobuf type google.cloud.dialogflow.v2.EvaluationConfig
EvaluationConfig.Builder
The configuration for model evaluation.
Protobuf type google.cloud.dialogflow.v2.EvaluationConfig
EvaluationConfig.SmartComposeConfig
Smart compose specific configuration for evaluation job.
Protobuf type google.cloud.dialogflow.v2.EvaluationConfig.SmartComposeConfig
EvaluationConfig.SmartComposeConfig.Builder
Smart compose specific configuration for evaluation job.
Protobuf type google.cloud.dialogflow.v2.EvaluationConfig.SmartComposeConfig
EvaluationConfig.SmartReplyConfig
Smart reply specific configuration for evaluation job.
Protobuf type google.cloud.dialogflow.v2.EvaluationConfig.SmartReplyConfig
EvaluationConfig.SmartReplyConfig.Builder
Smart reply specific configuration for evaluation job.
Protobuf type google.cloud.dialogflow.v2.EvaluationConfig.SmartReplyConfig
EventInput
Events allow for matching intents by event name instead of the natural
language input. For instance, input <event: { name: "welcome_event",
parameters: { name: "Sam" } }>
can trigger a personalized welcome response.
The parameter name
may be used by the agent in the response:
"Hello #welcome_event.name! What can I do for you today?"
.
Protobuf type google.cloud.dialogflow.v2.EventInput
EventInput.Builder
Events allow for matching intents by event name instead of the natural
language input. For instance, input <event: { name: "welcome_event",
parameters: { name: "Sam" } }>
can trigger a personalized welcome response.
The parameter name
may be used by the agent in the response:
"Hello #welcome_event.name! What can I do for you today?"
.
Protobuf type google.cloud.dialogflow.v2.EventInput
ExportAgentRequest
The request message for Agents.ExportAgent.
Protobuf type google.cloud.dialogflow.v2.ExportAgentRequest
ExportAgentRequest.Builder
The request message for Agents.ExportAgent.
Protobuf type google.cloud.dialogflow.v2.ExportAgentRequest
ExportAgentResponse
The response message for Agents.ExportAgent.
Protobuf type google.cloud.dialogflow.v2.ExportAgentResponse
ExportAgentResponse.Builder
The response message for Agents.ExportAgent.
Protobuf type google.cloud.dialogflow.v2.ExportAgentResponse
ExportDocumentRequest
Request message for Documents.ExportDocument.
Protobuf type google.cloud.dialogflow.v2.ExportDocumentRequest
ExportDocumentRequest.Builder
Request message for Documents.ExportDocument.
Protobuf type google.cloud.dialogflow.v2.ExportDocumentRequest
ExportOperationMetadata
Metadata related to the Export Data Operations (e.g. ExportDocument).
Protobuf type google.cloud.dialogflow.v2.ExportOperationMetadata
ExportOperationMetadata.Builder
Metadata related to the Export Data Operations (e.g. ExportDocument).
Protobuf type google.cloud.dialogflow.v2.ExportOperationMetadata
FaqAnswer
Represents answer from "frequently asked questions".
Protobuf type google.cloud.dialogflow.v2.FaqAnswer
FaqAnswer.Builder
Represents answer from "frequently asked questions".
Protobuf type google.cloud.dialogflow.v2.FaqAnswer
Fulfillment
By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the fulfillment guide.
Protobuf type google.cloud.dialogflow.v2.Fulfillment
Fulfillment.Builder
By default, your agent responds to a matched intent with a static response. As an alternative, you can provide a more dynamic response by using fulfillment. When you enable fulfillment for an intent, Dialogflow responds to that intent by calling a service that you define. For example, if an end-user wants to schedule a haircut on Friday, your service can check your database and respond to the end-user with availability information for Friday. For more information, see the fulfillment guide.
Protobuf type google.cloud.dialogflow.v2.Fulfillment
Fulfillment.Feature
Whether fulfillment is enabled for the specific feature.
Protobuf type google.cloud.dialogflow.v2.Fulfillment.Feature
Fulfillment.Feature.Builder
Whether fulfillment is enabled for the specific feature.
Protobuf type google.cloud.dialogflow.v2.Fulfillment.Feature
Fulfillment.GenericWebService
Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications:
- Basic authentication with username and password.
- Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure.
Protobuf type google.cloud.dialogflow.v2.Fulfillment.GenericWebService
Fulfillment.GenericWebService.Builder
Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications:
- Basic authentication with username and password.
- Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure.
Protobuf type google.cloud.dialogflow.v2.Fulfillment.GenericWebService
FulfillmentName
FulfillmentName.Builder
Builder for projects/{project}/agent/fulfillment.
FulfillmentName.ProjectLocationBuilder
Builder for projects/{project}/locations/{location}/agent/fulfillment.
FulfillmentProto
FulfillmentsClient
Service Description: Service for managing Fulfillments.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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);
}
Note: close() needs to be called on the FulfillmentsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of FulfillmentsSettings to create(). For example:
To customize credentials:
// 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
FulfillmentsSettings fulfillmentsSettings =
FulfillmentsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create(fulfillmentsSettings);
To customize the endpoint:
// 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
FulfillmentsSettings fulfillmentsSettings =
FulfillmentsSettings.newBuilder().setEndpoint(myEndpoint).build();
FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create(fulfillmentsSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
FulfillmentsSettings fulfillmentsSettings =
FulfillmentsSettings.newBuilder()
.setTransportChannelProvider(
FulfillmentsSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
FulfillmentsClient fulfillmentsClient = FulfillmentsClient.create(fulfillmentsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
FulfillmentsClient.ListLocationsFixedSizeCollection
FulfillmentsClient.ListLocationsPage
FulfillmentsClient.ListLocationsPagedResponse
FulfillmentsGrpc
Service for managing Fulfillments.
FulfillmentsGrpc.FulfillmentsBlockingStub
Service for managing Fulfillments.
FulfillmentsGrpc.FulfillmentsFutureStub
Service for managing Fulfillments.
FulfillmentsGrpc.FulfillmentsImplBase
Service for managing Fulfillments.
FulfillmentsGrpc.FulfillmentsStub
Service for managing Fulfillments.
FulfillmentsSettings
Settings class to configure an instance of FulfillmentsClient.
The default instance has everything set to sensible defaults:
- The default service address (dialogflow.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getFulfillment to 30 seconds:
// 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
FulfillmentsSettings.Builder fulfillmentsSettingsBuilder = FulfillmentsSettings.newBuilder();
fulfillmentsSettingsBuilder
.getFulfillmentSettings()
.setRetrySettings(
fulfillmentsSettingsBuilder.getFulfillmentSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
FulfillmentsSettings fulfillmentsSettings = fulfillmentsSettingsBuilder.build();
FulfillmentsSettings.Builder
Builder for FulfillmentsSettings.
GcsDestination
Google Cloud Storage location for the output.
Protobuf type google.cloud.dialogflow.v2.GcsDestination
GcsDestination.Builder
Google Cloud Storage location for the output.
Protobuf type google.cloud.dialogflow.v2.GcsDestination
GcsProto
GcsSources
Google Cloud Storage location for the inputs.
Protobuf type google.cloud.dialogflow.v2.GcsSources
GcsSources.Builder
Google Cloud Storage location for the inputs.
Protobuf type google.cloud.dialogflow.v2.GcsSources
GetAgentRequest
The request message for Agents.GetAgent.
Protobuf type google.cloud.dialogflow.v2.GetAgentRequest
GetAgentRequest.Builder
The request message for Agents.GetAgent.
Protobuf type google.cloud.dialogflow.v2.GetAgentRequest
GetContextRequest
The request message for Contexts.GetContext.
Protobuf type google.cloud.dialogflow.v2.GetContextRequest
GetContextRequest.Builder
The request message for Contexts.GetContext.
Protobuf type google.cloud.dialogflow.v2.GetContextRequest
GetConversationDatasetRequest
The request message for ConversationDatasets.GetConversationDataset.
Protobuf type google.cloud.dialogflow.v2.GetConversationDatasetRequest
GetConversationDatasetRequest.Builder
The request message for ConversationDatasets.GetConversationDataset.
Protobuf type google.cloud.dialogflow.v2.GetConversationDatasetRequest
GetConversationModelEvaluationRequest
The request message for ConversationModels.GetConversationModelEvaluation
Protobuf type google.cloud.dialogflow.v2.GetConversationModelEvaluationRequest
GetConversationModelEvaluationRequest.Builder
The request message for ConversationModels.GetConversationModelEvaluation
Protobuf type google.cloud.dialogflow.v2.GetConversationModelEvaluationRequest
GetConversationModelRequest
The request message for ConversationModels.GetConversationModel
Protobuf type google.cloud.dialogflow.v2.GetConversationModelRequest
GetConversationModelRequest.Builder
The request message for ConversationModels.GetConversationModel
Protobuf type google.cloud.dialogflow.v2.GetConversationModelRequest
GetConversationProfileRequest
The request message for ConversationProfiles.GetConversationProfile.
Protobuf type google.cloud.dialogflow.v2.GetConversationProfileRequest
GetConversationProfileRequest.Builder
The request message for ConversationProfiles.GetConversationProfile.
Protobuf type google.cloud.dialogflow.v2.GetConversationProfileRequest
GetConversationRequest
The request message for Conversations.GetConversation.
Protobuf type google.cloud.dialogflow.v2.GetConversationRequest
GetConversationRequest.Builder
The request message for Conversations.GetConversation.
Protobuf type google.cloud.dialogflow.v2.GetConversationRequest
GetDocumentRequest
Request message for Documents.GetDocument.
Protobuf type google.cloud.dialogflow.v2.GetDocumentRequest
GetDocumentRequest.Builder
Request message for Documents.GetDocument.
Protobuf type google.cloud.dialogflow.v2.GetDocumentRequest
GetEntityTypeRequest
The request message for EntityTypes.GetEntityType.
Protobuf type google.cloud.dialogflow.v2.GetEntityTypeRequest
GetEntityTypeRequest.Builder
The request message for EntityTypes.GetEntityType.
Protobuf type google.cloud.dialogflow.v2.GetEntityTypeRequest
GetEnvironmentHistoryRequest
The request message for Environments.GetEnvironmentHistory.
Protobuf type google.cloud.dialogflow.v2.GetEnvironmentHistoryRequest
GetEnvironmentHistoryRequest.Builder
The request message for Environments.GetEnvironmentHistory.
Protobuf type google.cloud.dialogflow.v2.GetEnvironmentHistoryRequest
GetEnvironmentRequest
The request message for Environments.GetEnvironment.
Protobuf type google.cloud.dialogflow.v2.GetEnvironmentRequest
GetEnvironmentRequest.Builder
The request message for Environments.GetEnvironment.
Protobuf type google.cloud.dialogflow.v2.GetEnvironmentRequest
GetFulfillmentRequest
The request message for Fulfillments.GetFulfillment.
Protobuf type google.cloud.dialogflow.v2.GetFulfillmentRequest
GetFulfillmentRequest.Builder
The request message for Fulfillments.GetFulfillment.
Protobuf type google.cloud.dialogflow.v2.GetFulfillmentRequest
GetIntentRequest
The request message for Intents.GetIntent.
Protobuf type google.cloud.dialogflow.v2.GetIntentRequest
GetIntentRequest.Builder
The request message for Intents.GetIntent.
Protobuf type google.cloud.dialogflow.v2.GetIntentRequest
GetKnowledgeBaseRequest
Request message for KnowledgeBases.GetKnowledgeBase.
Protobuf type google.cloud.dialogflow.v2.GetKnowledgeBaseRequest
GetKnowledgeBaseRequest.Builder
Request message for KnowledgeBases.GetKnowledgeBase.
Protobuf type google.cloud.dialogflow.v2.GetKnowledgeBaseRequest
GetParticipantRequest
The request message for Participants.GetParticipant.
Protobuf type google.cloud.dialogflow.v2.GetParticipantRequest
GetParticipantRequest.Builder
The request message for Participants.GetParticipant.
Protobuf type google.cloud.dialogflow.v2.GetParticipantRequest
GetSessionEntityTypeRequest
The request message for SessionEntityTypes.GetSessionEntityType.
Protobuf type google.cloud.dialogflow.v2.GetSessionEntityTypeRequest
GetSessionEntityTypeRequest.Builder
The request message for SessionEntityTypes.GetSessionEntityType.
Protobuf type google.cloud.dialogflow.v2.GetSessionEntityTypeRequest
GetValidationResultRequest
The request message for Agents.GetValidationResult.
Protobuf type google.cloud.dialogflow.v2.GetValidationResultRequest
GetValidationResultRequest.Builder
The request message for Agents.GetValidationResult.
Protobuf type google.cloud.dialogflow.v2.GetValidationResultRequest
GetVersionRequest
The request message for Versions.GetVersion.
Protobuf type google.cloud.dialogflow.v2.GetVersionRequest
GetVersionRequest.Builder
The request message for Versions.GetVersion.
Protobuf type google.cloud.dialogflow.v2.GetVersionRequest
HumanAgentAssistantConfig
Defines the Human Agent Assist to connect to a conversation.
Protobuf type google.cloud.dialogflow.v2.HumanAgentAssistantConfig
HumanAgentAssistantConfig.Builder
Defines the Human Agent Assist to connect to a conversation.
Protobuf type google.cloud.dialogflow.v2.HumanAgentAssistantConfig
HumanAgentAssistantConfig.ConversationModelConfig
Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.ConversationModelConfig
HumanAgentAssistantConfig.ConversationModelConfig.Builder
Custom conversation models used in agent assist feature. Supported feature: ARTICLE_SUGGESTION, SMART_COMPOSE, SMART_REPLY, CONVERSATION_SUMMARIZATION.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.ConversationModelConfig
HumanAgentAssistantConfig.ConversationProcessConfig
Config to process conversation.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.ConversationProcessConfig
HumanAgentAssistantConfig.ConversationProcessConfig.Builder
Config to process conversation.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.ConversationProcessConfig
HumanAgentAssistantConfig.MessageAnalysisConfig
Configuration for analyses to run on each conversation message.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.MessageAnalysisConfig
HumanAgentAssistantConfig.MessageAnalysisConfig.Builder
Configuration for analyses to run on each conversation message.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.MessageAnalysisConfig
HumanAgentAssistantConfig.SuggestionConfig
Detail human agent assistant config.
Protobuf type google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionConfig
HumanAgentAssistantConfig.SuggestionConfig.Builder
Detail human agent assistant config.
Protobuf type google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionConfig
HumanAgentAssistantConfig.SuggestionFeatureConfig
Config for suggestion features.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionFeatureConfig
HumanAgentAssistantConfig.SuggestionFeatureConfig.Builder
Config for suggestion features.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionFeatureConfig
HumanAgentAssistantConfig.SuggestionQueryConfig
Config for suggestion query.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig
HumanAgentAssistantConfig.SuggestionQueryConfig.Builder
Config for suggestion query.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig
HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings
Settings that determine how to filter recent conversation context when generating suggestions.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings
HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings.Builder
Settings that determine how to filter recent conversation context when generating suggestions.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettings
HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource
Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource
HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource.Builder
Dialogflow source setting. Supported feature: DIALOGFLOW_ASSIST.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySource
HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource
Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource
HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource.Builder
Document source settings. Supported features: SMART_REPLY, SMART_COMPOSE.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySource
HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource
Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource
HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource.Builder
Knowledge base source settings. Supported features: ARTICLE_SUGGESTION, FAQ.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySource
HumanAgentAssistantConfig.SuggestionTriggerSettings
Settings of suggestion trigger.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionTriggerSettings
HumanAgentAssistantConfig.SuggestionTriggerSettings.Builder
Settings of suggestion trigger.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionTriggerSettings
HumanAgentAssistantEvent
Represents a notification sent to Cloud Pub/Sub subscribers for human agent assistant events in a specific conversation.
Protobuf type google.cloud.dialogflow.v2.HumanAgentAssistantEvent
HumanAgentAssistantEvent.Builder
Represents a notification sent to Cloud Pub/Sub subscribers for human agent assistant events in a specific conversation.
Protobuf type google.cloud.dialogflow.v2.HumanAgentAssistantEvent
HumanAgentAssistantEventProto
HumanAgentHandoffConfig
Defines the hand off to a live agent, typically on which external agent service provider to connect to a conversation. Currently, this feature is not general available, please contact Google to get access.
Protobuf type google.cloud.dialogflow.v2.HumanAgentHandoffConfig
HumanAgentHandoffConfig.Builder
Defines the hand off to a live agent, typically on which external agent service provider to connect to a conversation. Currently, this feature is not general available, please contact Google to get access.
Protobuf type google.cloud.dialogflow.v2.HumanAgentHandoffConfig
HumanAgentHandoffConfig.LivePersonConfig
Configuration specific to LivePerson (https://www.liveperson.com).
Protobuf type google.cloud.dialogflow.v2.HumanAgentHandoffConfig.LivePersonConfig
HumanAgentHandoffConfig.LivePersonConfig.Builder
Configuration specific to LivePerson (https://www.liveperson.com).
Protobuf type google.cloud.dialogflow.v2.HumanAgentHandoffConfig.LivePersonConfig
HumanAgentHandoffConfig.SalesforceLiveAgentConfig
Configuration specific to Salesforce Live Agent.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentHandoffConfig.SalesforceLiveAgentConfig
HumanAgentHandoffConfig.SalesforceLiveAgentConfig.Builder
Configuration specific to Salesforce Live Agent.
Protobuf type
google.cloud.dialogflow.v2.HumanAgentHandoffConfig.SalesforceLiveAgentConfig
ImportAgentRequest
The request message for Agents.ImportAgent.
Protobuf type google.cloud.dialogflow.v2.ImportAgentRequest
ImportAgentRequest.Builder
The request message for Agents.ImportAgent.
Protobuf type google.cloud.dialogflow.v2.ImportAgentRequest
ImportConversationDataOperationMetadata
Metadata for a ConversationDatasets.ImportConversationData operation.
Protobuf type google.cloud.dialogflow.v2.ImportConversationDataOperationMetadata
ImportConversationDataOperationMetadata.Builder
Metadata for a ConversationDatasets.ImportConversationData operation.
Protobuf type google.cloud.dialogflow.v2.ImportConversationDataOperationMetadata
ImportConversationDataOperationResponse
Response used for ConversationDatasets.ImportConversationData long running operation.
Protobuf type google.cloud.dialogflow.v2.ImportConversationDataOperationResponse
ImportConversationDataOperationResponse.Builder
Response used for ConversationDatasets.ImportConversationData long running operation.
Protobuf type google.cloud.dialogflow.v2.ImportConversationDataOperationResponse
ImportConversationDataRequest
The request message for ConversationDatasets.ImportConversationData.
Protobuf type google.cloud.dialogflow.v2.ImportConversationDataRequest
ImportConversationDataRequest.Builder
The request message for ConversationDatasets.ImportConversationData.
Protobuf type google.cloud.dialogflow.v2.ImportConversationDataRequest
ImportDocumentTemplate
The template used for importing documents.
Protobuf type google.cloud.dialogflow.v2.ImportDocumentTemplate
ImportDocumentTemplate.Builder
The template used for importing documents.
Protobuf type google.cloud.dialogflow.v2.ImportDocumentTemplate
ImportDocumentsRequest
Request message for Documents.ImportDocuments.
Protobuf type google.cloud.dialogflow.v2.ImportDocumentsRequest
ImportDocumentsRequest.Builder
Request message for Documents.ImportDocuments.
Protobuf type google.cloud.dialogflow.v2.ImportDocumentsRequest
ImportDocumentsResponse
Response message for Documents.ImportDocuments.
Protobuf type google.cloud.dialogflow.v2.ImportDocumentsResponse
ImportDocumentsResponse.Builder
Response message for Documents.ImportDocuments.
Protobuf type google.cloud.dialogflow.v2.ImportDocumentsResponse
InputAudioConfig
Instructs the speech recognizer how to process the audio content.
Protobuf type google.cloud.dialogflow.v2.InputAudioConfig
InputAudioConfig.Builder
Instructs the speech recognizer how to process the audio content.
Protobuf type google.cloud.dialogflow.v2.InputAudioConfig
InputConfig
Represents the configuration of importing a set of conversation files in Google Cloud Storage.
Protobuf type google.cloud.dialogflow.v2.InputConfig
InputConfig.Builder
Represents the configuration of importing a set of conversation files in Google Cloud Storage.
Protobuf type google.cloud.dialogflow.v2.InputConfig
InputDataset
InputDataset used to create model or do evaluation. NextID:5
Protobuf type google.cloud.dialogflow.v2.InputDataset
InputDataset.Builder
InputDataset used to create model or do evaluation. NextID:5
Protobuf type google.cloud.dialogflow.v2.InputDataset
Intent
An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the intent guide.
Protobuf type google.cloud.dialogflow.v2.Intent
Intent.Builder
An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the intent guide.
Protobuf type google.cloud.dialogflow.v2.Intent
Intent.FollowupIntentInfo
Represents a single followup intent in the chain.
Protobuf type google.cloud.dialogflow.v2.Intent.FollowupIntentInfo
Intent.FollowupIntentInfo.Builder
Represents a single followup intent in the chain.
Protobuf type google.cloud.dialogflow.v2.Intent.FollowupIntentInfo
Intent.Message
A rich response message.
Corresponds to the intent Response
field in the Dialogflow console.
For more information, see
Rich response
messages.
Protobuf type google.cloud.dialogflow.v2.Intent.Message
Intent.Message.BasicCard
The basic card message. Useful for displaying information.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.BasicCard
Intent.Message.BasicCard.Builder
The basic card message. Useful for displaying information.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.BasicCard
Intent.Message.BasicCard.Button
The button object that appears at the bottom of a card.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.BasicCard.Button
Intent.Message.BasicCard.Button.Builder
The button object that appears at the bottom of a card.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.BasicCard.Button
Intent.Message.BasicCard.Button.OpenUriAction
Opens the given URI.
Protobuf type
google.cloud.dialogflow.v2.Intent.Message.BasicCard.Button.OpenUriAction
Intent.Message.BasicCard.Button.OpenUriAction.Builder
Opens the given URI.
Protobuf type
google.cloud.dialogflow.v2.Intent.Message.BasicCard.Button.OpenUriAction
Intent.Message.BrowseCarouselCard
Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel
Protobuf type google.cloud.dialogflow.v2.Intent.Message.BrowseCarouselCard
Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem
Browsing carousel tile
Protobuf type
google.cloud.dialogflow.v2.Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem
Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem.Builder
Browsing carousel tile
Protobuf type
google.cloud.dialogflow.v2.Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem
Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem.OpenUrlAction
Actions on Google action to open a given url.
Protobuf type
google.cloud.dialogflow.v2.Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem.OpenUrlAction
Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem.OpenUrlAction.Builder
Actions on Google action to open a given url.
Protobuf type
google.cloud.dialogflow.v2.Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem.OpenUrlAction
Intent.Message.BrowseCarouselCard.Builder
Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel
Protobuf type google.cloud.dialogflow.v2.Intent.Message.BrowseCarouselCard
Intent.Message.Builder
A rich response message.
Corresponds to the intent Response
field in the Dialogflow console.
For more information, see
Rich response
messages.
Protobuf type google.cloud.dialogflow.v2.Intent.Message
Intent.Message.Card
The card response message.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.Card
Intent.Message.Card.Builder
The card response message.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.Card
Intent.Message.Card.Button
Contains information about a button.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.Card.Button
Intent.Message.Card.Button.Builder
Contains information about a button.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.Card.Button
Intent.Message.CarouselSelect
The card for presenting a carousel of options to select from.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.CarouselSelect
Intent.Message.CarouselSelect.Builder
The card for presenting a carousel of options to select from.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.CarouselSelect
Intent.Message.CarouselSelect.Item
An item in the carousel.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.CarouselSelect.Item
Intent.Message.CarouselSelect.Item.Builder
An item in the carousel.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.CarouselSelect.Item
Intent.Message.ColumnProperties
Column properties for TableCard.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.ColumnProperties
Intent.Message.ColumnProperties.Builder
Column properties for TableCard.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.ColumnProperties
Intent.Message.Image
The image response message.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.Image
Intent.Message.Image.Builder
The image response message.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.Image
Intent.Message.LinkOutSuggestion
The suggestion chip message that allows the user to jump out to the app or website associated with this agent.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.LinkOutSuggestion
Intent.Message.LinkOutSuggestion.Builder
The suggestion chip message that allows the user to jump out to the app or website associated with this agent.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.LinkOutSuggestion
Intent.Message.ListSelect
The card for presenting a list of options to select from.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.ListSelect
Intent.Message.ListSelect.Builder
The card for presenting a list of options to select from.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.ListSelect
Intent.Message.ListSelect.Item
An item in the list.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.ListSelect.Item
Intent.Message.ListSelect.Item.Builder
An item in the list.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.ListSelect.Item
Intent.Message.MediaContent
The media content card for Actions on Google.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.MediaContent
Intent.Message.MediaContent.Builder
The media content card for Actions on Google.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.MediaContent
Intent.Message.MediaContent.ResponseMediaObject
Response media object for media content card.
Protobuf type
google.cloud.dialogflow.v2.Intent.Message.MediaContent.ResponseMediaObject
Intent.Message.MediaContent.ResponseMediaObject.Builder
Response media object for media content card.
Protobuf type
google.cloud.dialogflow.v2.Intent.Message.MediaContent.ResponseMediaObject
Intent.Message.QuickReplies
The quick replies response message.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.QuickReplies
Intent.Message.QuickReplies.Builder
The quick replies response message.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.QuickReplies
Intent.Message.SelectItemInfo
Additional info about the select item for when it is triggered in a dialog.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.SelectItemInfo
Intent.Message.SelectItemInfo.Builder
Additional info about the select item for when it is triggered in a dialog.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.SelectItemInfo
Intent.Message.SimpleResponse
The simple response message containing speech or text.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.SimpleResponse
Intent.Message.SimpleResponse.Builder
The simple response message containing speech or text.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.SimpleResponse
Intent.Message.SimpleResponses
The collection of simple response candidates.
This message in QueryResult.fulfillment_messages
and
WebhookResponse.fulfillment_messages
should contain only one
SimpleResponse
.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.SimpleResponses
Intent.Message.SimpleResponses.Builder
The collection of simple response candidates.
This message in QueryResult.fulfillment_messages
and
WebhookResponse.fulfillment_messages
should contain only one
SimpleResponse
.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.SimpleResponses
Intent.Message.Suggestion
The suggestion chip message that the user can tap to quickly post a reply to the conversation.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.Suggestion
Intent.Message.Suggestion.Builder
The suggestion chip message that the user can tap to quickly post a reply to the conversation.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.Suggestion
Intent.Message.Suggestions
The collection of suggestions.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.Suggestions
Intent.Message.Suggestions.Builder
The collection of suggestions.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.Suggestions
Intent.Message.TableCard
Table card for Actions on Google.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.TableCard
Intent.Message.TableCard.Builder
Table card for Actions on Google.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.TableCard
Intent.Message.TableCardCell
Cell of TableCardRow.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.TableCardCell
Intent.Message.TableCardCell.Builder
Cell of TableCardRow.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.TableCardCell
Intent.Message.TableCardRow
Row of TableCard.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.TableCardRow
Intent.Message.TableCardRow.Builder
Row of TableCard.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.TableCardRow
Intent.Message.Text
The text response message.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.Text
Intent.Message.Text.Builder
The text response message.
Protobuf type google.cloud.dialogflow.v2.Intent.Message.Text
Intent.Parameter
Represents intent parameters.
Protobuf type google.cloud.dialogflow.v2.Intent.Parameter
Intent.Parameter.Builder
Represents intent parameters.
Protobuf type google.cloud.dialogflow.v2.Intent.Parameter
Intent.TrainingPhrase
Represents an example that the agent is trained on.
Protobuf type google.cloud.dialogflow.v2.Intent.TrainingPhrase
Intent.TrainingPhrase.Builder
Represents an example that the agent is trained on.
Protobuf type google.cloud.dialogflow.v2.Intent.TrainingPhrase
Intent.TrainingPhrase.Part
Represents a part of a training phrase.
Protobuf type google.cloud.dialogflow.v2.Intent.TrainingPhrase.Part
Intent.TrainingPhrase.Part.Builder
Represents a part of a training phrase.
Protobuf type google.cloud.dialogflow.v2.Intent.TrainingPhrase.Part
IntentBatch
This message is a wrapper around a collection of intents.
Protobuf type google.cloud.dialogflow.v2.IntentBatch
IntentBatch.Builder
This message is a wrapper around a collection of intents.
Protobuf type google.cloud.dialogflow.v2.IntentBatch
IntentName
IntentName.Builder
Builder for projects/{project}/agent/intents/{intent}.
IntentName.ProjectLocationIntentBuilder
Builder for projects/{project}/locations/{location}/agent/intents/{intent}.
IntentProto
IntentsClient
Service Description: Service for managing Intents.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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);
}
Note: close() needs to be called on the IntentsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of IntentsSettings to create(). For example:
To customize credentials:
// 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
IntentsSettings intentsSettings =
IntentsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
IntentsClient intentsClient = IntentsClient.create(intentsSettings);
To customize the endpoint:
// 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
IntentsSettings intentsSettings = IntentsSettings.newBuilder().setEndpoint(myEndpoint).build();
IntentsClient intentsClient = IntentsClient.create(intentsSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
IntentsSettings intentsSettings =
IntentsSettings.newBuilder()
.setTransportChannelProvider(
IntentsSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
IntentsClient intentsClient = IntentsClient.create(intentsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
IntentsClient.ListIntentsFixedSizeCollection
IntentsClient.ListIntentsPage
IntentsClient.ListIntentsPagedResponse
IntentsClient.ListLocationsFixedSizeCollection
IntentsClient.ListLocationsPage
IntentsClient.ListLocationsPagedResponse
IntentsGrpc
Service for managing Intents.
IntentsGrpc.IntentsBlockingStub
Service for managing Intents.
IntentsGrpc.IntentsFutureStub
Service for managing Intents.
IntentsGrpc.IntentsImplBase
Service for managing Intents.
IntentsGrpc.IntentsStub
Service for managing Intents.
IntentsSettings
Settings class to configure an instance of IntentsClient.
The default instance has everything set to sensible defaults:
- The default service address (dialogflow.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getIntent to 30 seconds:
// 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
IntentsSettings.Builder intentsSettingsBuilder = IntentsSettings.newBuilder();
intentsSettingsBuilder
.getIntentSettings()
.setRetrySettings(
intentsSettingsBuilder.getIntentSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
IntentsSettings intentsSettings = intentsSettingsBuilder.build();
IntentsSettings.Builder
Builder for IntentsSettings.
KnowledgeBase
A knowledge base represents a collection of knowledge documents that you
provide to Dialogflow. Your knowledge documents contain information that may
be useful during conversations with end-users. Some Dialogflow features use
knowledge bases when looking for a response to an end-user input.
For more information, see the knowledge base
guide.
Note: The projects.agent.knowledgeBases
resource is deprecated;
only use projects.knowledgeBases
.
Protobuf type google.cloud.dialogflow.v2.KnowledgeBase
KnowledgeBase.Builder
A knowledge base represents a collection of knowledge documents that you
provide to Dialogflow. Your knowledge documents contain information that may
be useful during conversations with end-users. Some Dialogflow features use
knowledge bases when looking for a response to an end-user input.
For more information, see the knowledge base
guide.
Note: The projects.agent.knowledgeBases
resource is deprecated;
only use projects.knowledgeBases
.
Protobuf type google.cloud.dialogflow.v2.KnowledgeBase
KnowledgeBaseName
KnowledgeBaseName.Builder
Builder for projects/{project}/knowledgeBases/{knowledge_base}.
KnowledgeBaseName.ProjectLocationKnowledgeBaseBuilder
Builder for projects/{project}/locations/{location}/knowledgeBases/{knowledge_base}.
KnowledgeBaseProto
KnowledgeBasesClient
Service Description: Service for managing KnowledgeBases.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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);
}
Note: close() needs to be called on the KnowledgeBasesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of KnowledgeBasesSettings to create(). For example:
To customize credentials:
// 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
KnowledgeBasesSettings knowledgeBasesSettings =
KnowledgeBasesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create(knowledgeBasesSettings);
To customize the endpoint:
// 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
KnowledgeBasesSettings knowledgeBasesSettings =
KnowledgeBasesSettings.newBuilder().setEndpoint(myEndpoint).build();
KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create(knowledgeBasesSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
KnowledgeBasesSettings knowledgeBasesSettings =
KnowledgeBasesSettings.newBuilder()
.setTransportChannelProvider(
KnowledgeBasesSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
KnowledgeBasesClient knowledgeBasesClient = KnowledgeBasesClient.create(knowledgeBasesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
KnowledgeBasesClient.ListKnowledgeBasesFixedSizeCollection
KnowledgeBasesClient.ListKnowledgeBasesPage
KnowledgeBasesClient.ListKnowledgeBasesPagedResponse
KnowledgeBasesClient.ListLocationsFixedSizeCollection
KnowledgeBasesClient.ListLocationsPage
KnowledgeBasesClient.ListLocationsPagedResponse
KnowledgeBasesGrpc
Service for managing KnowledgeBases.
KnowledgeBasesGrpc.KnowledgeBasesBlockingStub
Service for managing KnowledgeBases.
KnowledgeBasesGrpc.KnowledgeBasesFutureStub
Service for managing KnowledgeBases.
KnowledgeBasesGrpc.KnowledgeBasesImplBase
Service for managing KnowledgeBases.
KnowledgeBasesGrpc.KnowledgeBasesStub
Service for managing KnowledgeBases.
KnowledgeBasesSettings
Settings class to configure an instance of KnowledgeBasesClient.
The default instance has everything set to sensible defaults:
- The default service address (dialogflow.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getKnowledgeBase to 30 seconds:
// 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
KnowledgeBasesSettings.Builder knowledgeBasesSettingsBuilder =
KnowledgeBasesSettings.newBuilder();
knowledgeBasesSettingsBuilder
.getKnowledgeBaseSettings()
.setRetrySettings(
knowledgeBasesSettingsBuilder.getKnowledgeBaseSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
KnowledgeBasesSettings knowledgeBasesSettings = knowledgeBasesSettingsBuilder.build();
KnowledgeBasesSettings.Builder
Builder for KnowledgeBasesSettings.
KnowledgeOperationMetadata
Metadata in google::longrunning::Operation for Knowledge operations.
Protobuf type google.cloud.dialogflow.v2.KnowledgeOperationMetadata
KnowledgeOperationMetadata.Builder
Metadata in google::longrunning::Operation for Knowledge operations.
Protobuf type google.cloud.dialogflow.v2.KnowledgeOperationMetadata
ListAnswerRecordsRequest
Request message for AnswerRecords.ListAnswerRecords.
Protobuf type google.cloud.dialogflow.v2.ListAnswerRecordsRequest
ListAnswerRecordsRequest.Builder
Request message for AnswerRecords.ListAnswerRecords.
Protobuf type google.cloud.dialogflow.v2.ListAnswerRecordsRequest
ListAnswerRecordsResponse
Response message for AnswerRecords.ListAnswerRecords.
Protobuf type google.cloud.dialogflow.v2.ListAnswerRecordsResponse
ListAnswerRecordsResponse.Builder
Response message for AnswerRecords.ListAnswerRecords.
Protobuf type google.cloud.dialogflow.v2.ListAnswerRecordsResponse
ListContextsRequest
The request message for Contexts.ListContexts.
Protobuf type google.cloud.dialogflow.v2.ListContextsRequest
ListContextsRequest.Builder
The request message for Contexts.ListContexts.
Protobuf type google.cloud.dialogflow.v2.ListContextsRequest
ListContextsResponse
The response message for Contexts.ListContexts.
Protobuf type google.cloud.dialogflow.v2.ListContextsResponse
ListContextsResponse.Builder
The response message for Contexts.ListContexts.
Protobuf type google.cloud.dialogflow.v2.ListContextsResponse
ListConversationDatasetsRequest
The request message for ConversationDatasets.ListConversationDatasets.
Protobuf type google.cloud.dialogflow.v2.ListConversationDatasetsRequest
ListConversationDatasetsRequest.Builder
The request message for ConversationDatasets.ListConversationDatasets.
Protobuf type google.cloud.dialogflow.v2.ListConversationDatasetsRequest
ListConversationDatasetsResponse
The response message for ConversationDatasets.ListConversationDatasets.
Protobuf type google.cloud.dialogflow.v2.ListConversationDatasetsResponse
ListConversationDatasetsResponse.Builder
The response message for ConversationDatasets.ListConversationDatasets.
Protobuf type google.cloud.dialogflow.v2.ListConversationDatasetsResponse
ListConversationModelEvaluationsRequest
The request message for ConversationModels.ListConversationModelEvaluations
Protobuf type google.cloud.dialogflow.v2.ListConversationModelEvaluationsRequest
ListConversationModelEvaluationsRequest.Builder
The request message for ConversationModels.ListConversationModelEvaluations
Protobuf type google.cloud.dialogflow.v2.ListConversationModelEvaluationsRequest
ListConversationModelEvaluationsResponse
The response message for ConversationModels.ListConversationModelEvaluations
Protobuf type google.cloud.dialogflow.v2.ListConversationModelEvaluationsResponse
ListConversationModelEvaluationsResponse.Builder
The response message for ConversationModels.ListConversationModelEvaluations
Protobuf type google.cloud.dialogflow.v2.ListConversationModelEvaluationsResponse
ListConversationModelsRequest
The request message for ConversationModels.ListConversationModels
Protobuf type google.cloud.dialogflow.v2.ListConversationModelsRequest
ListConversationModelsRequest.Builder
The request message for ConversationModels.ListConversationModels
Protobuf type google.cloud.dialogflow.v2.ListConversationModelsRequest
ListConversationModelsResponse
The response message for ConversationModels.ListConversationModels
Protobuf type google.cloud.dialogflow.v2.ListConversationModelsResponse
ListConversationModelsResponse.Builder
The response message for ConversationModels.ListConversationModels
Protobuf type google.cloud.dialogflow.v2.ListConversationModelsResponse
ListConversationProfilesRequest
The request message for ConversationProfiles.ListConversationProfiles.
Protobuf type google.cloud.dialogflow.v2.ListConversationProfilesRequest
ListConversationProfilesRequest.Builder
The request message for ConversationProfiles.ListConversationProfiles.
Protobuf type google.cloud.dialogflow.v2.ListConversationProfilesRequest
ListConversationProfilesResponse
The response message for ConversationProfiles.ListConversationProfiles.
Protobuf type google.cloud.dialogflow.v2.ListConversationProfilesResponse
ListConversationProfilesResponse.Builder
The response message for ConversationProfiles.ListConversationProfiles.
Protobuf type google.cloud.dialogflow.v2.ListConversationProfilesResponse
ListConversationsRequest
The request message for Conversations.ListConversations.
Protobuf type google.cloud.dialogflow.v2.ListConversationsRequest
ListConversationsRequest.Builder
The request message for Conversations.ListConversations.
Protobuf type google.cloud.dialogflow.v2.ListConversationsRequest
ListConversationsResponse
The response message for Conversations.ListConversations.
Protobuf type google.cloud.dialogflow.v2.ListConversationsResponse
ListConversationsResponse.Builder
The response message for Conversations.ListConversations.
Protobuf type google.cloud.dialogflow.v2.ListConversationsResponse
ListDocumentsRequest
Request message for Documents.ListDocuments.
Protobuf type google.cloud.dialogflow.v2.ListDocumentsRequest
ListDocumentsRequest.Builder
Request message for Documents.ListDocuments.
Protobuf type google.cloud.dialogflow.v2.ListDocumentsRequest
ListDocumentsResponse
Response message for Documents.ListDocuments.
Protobuf type google.cloud.dialogflow.v2.ListDocumentsResponse
ListDocumentsResponse.Builder
Response message for Documents.ListDocuments.
Protobuf type google.cloud.dialogflow.v2.ListDocumentsResponse
ListEntityTypesRequest
The request message for EntityTypes.ListEntityTypes.
Protobuf type google.cloud.dialogflow.v2.ListEntityTypesRequest
ListEntityTypesRequest.Builder
The request message for EntityTypes.ListEntityTypes.
Protobuf type google.cloud.dialogflow.v2.ListEntityTypesRequest
ListEntityTypesResponse
The response message for EntityTypes.ListEntityTypes.
Protobuf type google.cloud.dialogflow.v2.ListEntityTypesResponse
ListEntityTypesResponse.Builder
The response message for EntityTypes.ListEntityTypes.
Protobuf type google.cloud.dialogflow.v2.ListEntityTypesResponse
ListEnvironmentsRequest
The request message for Environments.ListEnvironments.
Protobuf type google.cloud.dialogflow.v2.ListEnvironmentsRequest
ListEnvironmentsRequest.Builder
The request message for Environments.ListEnvironments.
Protobuf type google.cloud.dialogflow.v2.ListEnvironmentsRequest
ListEnvironmentsResponse
The response message for Environments.ListEnvironments.
Protobuf type google.cloud.dialogflow.v2.ListEnvironmentsResponse
ListEnvironmentsResponse.Builder
The response message for Environments.ListEnvironments.
Protobuf type google.cloud.dialogflow.v2.ListEnvironmentsResponse
ListIntentsRequest
The request message for Intents.ListIntents.
Protobuf type google.cloud.dialogflow.v2.ListIntentsRequest
ListIntentsRequest.Builder
The request message for Intents.ListIntents.
Protobuf type google.cloud.dialogflow.v2.ListIntentsRequest
ListIntentsResponse
The response message for Intents.ListIntents.
Protobuf type google.cloud.dialogflow.v2.ListIntentsResponse
ListIntentsResponse.Builder
The response message for Intents.ListIntents.
Protobuf type google.cloud.dialogflow.v2.ListIntentsResponse
ListKnowledgeBasesRequest
Request message for KnowledgeBases.ListKnowledgeBases.
Protobuf type google.cloud.dialogflow.v2.ListKnowledgeBasesRequest
ListKnowledgeBasesRequest.Builder
Request message for KnowledgeBases.ListKnowledgeBases.
Protobuf type google.cloud.dialogflow.v2.ListKnowledgeBasesRequest
ListKnowledgeBasesResponse
Response message for KnowledgeBases.ListKnowledgeBases.
Protobuf type google.cloud.dialogflow.v2.ListKnowledgeBasesResponse
ListKnowledgeBasesResponse.Builder
Response message for KnowledgeBases.ListKnowledgeBases.
Protobuf type google.cloud.dialogflow.v2.ListKnowledgeBasesResponse
ListMessagesRequest
The request message for Conversations.ListMessages.
Protobuf type google.cloud.dialogflow.v2.ListMessagesRequest
ListMessagesRequest.Builder
The request message for Conversations.ListMessages.
Protobuf type google.cloud.dialogflow.v2.ListMessagesRequest
ListMessagesResponse
The response message for Conversations.ListMessages.
Protobuf type google.cloud.dialogflow.v2.ListMessagesResponse
ListMessagesResponse.Builder
The response message for Conversations.ListMessages.
Protobuf type google.cloud.dialogflow.v2.ListMessagesResponse
ListParticipantsRequest
The request message for Participants.ListParticipants.
Protobuf type google.cloud.dialogflow.v2.ListParticipantsRequest
ListParticipantsRequest.Builder
The request message for Participants.ListParticipants.
Protobuf type google.cloud.dialogflow.v2.ListParticipantsRequest
ListParticipantsResponse
The response message for Participants.ListParticipants.
Protobuf type google.cloud.dialogflow.v2.ListParticipantsResponse
ListParticipantsResponse.Builder
The response message for Participants.ListParticipants.
Protobuf type google.cloud.dialogflow.v2.ListParticipantsResponse
ListSessionEntityTypesRequest
The request message for SessionEntityTypes.ListSessionEntityTypes.
Protobuf type google.cloud.dialogflow.v2.ListSessionEntityTypesRequest
ListSessionEntityTypesRequest.Builder
The request message for SessionEntityTypes.ListSessionEntityTypes.
Protobuf type google.cloud.dialogflow.v2.ListSessionEntityTypesRequest
ListSessionEntityTypesResponse
The response message for SessionEntityTypes.ListSessionEntityTypes.
Protobuf type google.cloud.dialogflow.v2.ListSessionEntityTypesResponse
ListSessionEntityTypesResponse.Builder
The response message for SessionEntityTypes.ListSessionEntityTypes.
Protobuf type google.cloud.dialogflow.v2.ListSessionEntityTypesResponse
ListVersionsRequest
The request message for Versions.ListVersions.
Protobuf type google.cloud.dialogflow.v2.ListVersionsRequest
ListVersionsRequest.Builder
The request message for Versions.ListVersions.
Protobuf type google.cloud.dialogflow.v2.ListVersionsRequest
ListVersionsResponse
The response message for Versions.ListVersions.
Protobuf type google.cloud.dialogflow.v2.ListVersionsResponse
ListVersionsResponse.Builder
The response message for Versions.ListVersions.
Protobuf type google.cloud.dialogflow.v2.ListVersionsResponse
LocationName
LocationName.Builder
Builder for projects/{project}/locations/{location}.
LoggingConfig
Defines logging behavior for conversation lifecycle events.
Protobuf type google.cloud.dialogflow.v2.LoggingConfig
LoggingConfig.Builder
Defines logging behavior for conversation lifecycle events.
Protobuf type google.cloud.dialogflow.v2.LoggingConfig
Message
Represents a message posted into a conversation.
Protobuf type google.cloud.dialogflow.v2.Message
Message.Builder
Represents a message posted into a conversation.
Protobuf type google.cloud.dialogflow.v2.Message
MessageAnnotation
Represents the result of annotation for the message.
Protobuf type google.cloud.dialogflow.v2.MessageAnnotation
MessageAnnotation.Builder
Represents the result of annotation for the message.
Protobuf type google.cloud.dialogflow.v2.MessageAnnotation
MessageName
MessageName.Builder
Builder for projects/{project}/conversations/{conversation}/messages/{message}.
MessageName.ProjectLocationConversationMessageBuilder
Builder for projects/{project}/locations/{location}/conversations/{conversation}/messages/{message}.
NotificationConfig
Defines notification behavior.
Protobuf type google.cloud.dialogflow.v2.NotificationConfig
NotificationConfig.Builder
Defines notification behavior.
Protobuf type google.cloud.dialogflow.v2.NotificationConfig
OriginalDetectIntentRequest
Represents the contents of the original request that was passed to
the [Streaming]DetectIntent
call.
Protobuf type google.cloud.dialogflow.v2.OriginalDetectIntentRequest
OriginalDetectIntentRequest.Builder
Represents the contents of the original request that was passed to
the [Streaming]DetectIntent
call.
Protobuf type google.cloud.dialogflow.v2.OriginalDetectIntentRequest
OutputAudio
Represents the natural language speech audio to be played to the end user.
Protobuf type google.cloud.dialogflow.v2.OutputAudio
OutputAudio.Builder
Represents the natural language speech audio to be played to the end user.
Protobuf type google.cloud.dialogflow.v2.OutputAudio
OutputAudioConfig
Instructs the speech synthesizer on how to generate the output audio content. If this audio config is supplied in a request, it overrides all existing text-to-speech settings applied to the agent.
Protobuf type google.cloud.dialogflow.v2.OutputAudioConfig
OutputAudioConfig.Builder
Instructs the speech synthesizer on how to generate the output audio content. If this audio config is supplied in a request, it overrides all existing text-to-speech settings applied to the agent.
Protobuf type google.cloud.dialogflow.v2.OutputAudioConfig
Participant
Represents a conversation participant (human agent, virtual agent, end-user).
Protobuf type google.cloud.dialogflow.v2.Participant
Participant.Builder
Represents a conversation participant (human agent, virtual agent, end-user).
Protobuf type google.cloud.dialogflow.v2.Participant
ParticipantName
ParticipantName.Builder
Builder for projects/{project}/conversations/{conversation}/participants/{participant}.
ParticipantName.ProjectLocationConversationParticipantBuilder
Builder for projects/{project}/locations/{location}/conversations/{conversation}/participants/{participant}.
ParticipantProto
ParticipantsClient
Service Description: Service for managing Participants.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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);
}
Note: close() needs to be called on the ParticipantsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ParticipantsSettings to create(). For example:
To customize credentials:
// 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
ParticipantsSettings participantsSettings =
ParticipantsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ParticipantsClient participantsClient = ParticipantsClient.create(participantsSettings);
To customize the endpoint:
// 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
ParticipantsSettings participantsSettings =
ParticipantsSettings.newBuilder().setEndpoint(myEndpoint).build();
ParticipantsClient participantsClient = ParticipantsClient.create(participantsSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
ParticipantsSettings participantsSettings =
ParticipantsSettings.newBuilder()
.setTransportChannelProvider(
ParticipantsSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
ParticipantsClient participantsClient = ParticipantsClient.create(participantsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
ParticipantsClient.ListLocationsFixedSizeCollection
ParticipantsClient.ListLocationsPage
ParticipantsClient.ListLocationsPagedResponse
ParticipantsClient.ListParticipantsFixedSizeCollection
ParticipantsClient.ListParticipantsPage
ParticipantsClient.ListParticipantsPagedResponse
ParticipantsGrpc
Service for managing Participants.
ParticipantsGrpc.ParticipantsBlockingStub
Service for managing Participants.
ParticipantsGrpc.ParticipantsFutureStub
Service for managing Participants.
ParticipantsGrpc.ParticipantsImplBase
Service for managing Participants.
ParticipantsGrpc.ParticipantsStub
Service for managing Participants.
ParticipantsSettings
Settings class to configure an instance of ParticipantsClient.
The default instance has everything set to sensible defaults:
- The default service address (dialogflow.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of createParticipant to 30 seconds:
// 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
ParticipantsSettings.Builder participantsSettingsBuilder = ParticipantsSettings.newBuilder();
participantsSettingsBuilder
.createParticipantSettings()
.setRetrySettings(
participantsSettingsBuilder.createParticipantSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ParticipantsSettings participantsSettings = participantsSettingsBuilder.build();
ParticipantsSettings.Builder
Builder for ParticipantsSettings.
ProjectAgentName
AUTO-GENERATED DOCUMENTATION AND CLASS
ProjectAgentName.Builder
Builder for ProjectAgentName.
ProjectName
ProjectName.Builder
Builder for projects/{project}.
QueryInput
Represents the query input. It can contain either:
- An audio config which instructs the speech recognizer how to process the speech audio.
- A conversational query in the form of text,.
- An event that specifies which intent to trigger.
Protobuf type google.cloud.dialogflow.v2.QueryInput
QueryInput.Builder
Represents the query input. It can contain either:
- An audio config which instructs the speech recognizer how to process the speech audio.
- A conversational query in the form of text,.
- An event that specifies which intent to trigger.
Protobuf type google.cloud.dialogflow.v2.QueryInput
QueryParameters
Represents the parameters of the conversational query.
Protobuf type google.cloud.dialogflow.v2.QueryParameters
QueryParameters.Builder
Represents the parameters of the conversational query.
Protobuf type google.cloud.dialogflow.v2.QueryParameters
QueryResult
Represents the result of conversational query or event processing.
Protobuf type google.cloud.dialogflow.v2.QueryResult
QueryResult.Builder
Represents the result of conversational query or event processing.
Protobuf type google.cloud.dialogflow.v2.QueryResult
ReloadDocumentRequest
Request message for Documents.ReloadDocument.
Protobuf type google.cloud.dialogflow.v2.ReloadDocumentRequest
ReloadDocumentRequest.Builder
Request message for Documents.ReloadDocument.
Protobuf type google.cloud.dialogflow.v2.ReloadDocumentRequest
RestoreAgentRequest
The request message for Agents.RestoreAgent.
Protobuf type google.cloud.dialogflow.v2.RestoreAgentRequest
RestoreAgentRequest.Builder
The request message for Agents.RestoreAgent.
Protobuf type google.cloud.dialogflow.v2.RestoreAgentRequest
SearchAgentsRequest
The request message for Agents.SearchAgents.
Protobuf type google.cloud.dialogflow.v2.SearchAgentsRequest
SearchAgentsRequest.Builder
The request message for Agents.SearchAgents.
Protobuf type google.cloud.dialogflow.v2.SearchAgentsRequest
SearchAgentsResponse
The response message for Agents.SearchAgents.
Protobuf type google.cloud.dialogflow.v2.SearchAgentsResponse
SearchAgentsResponse.Builder
The response message for Agents.SearchAgents.
Protobuf type google.cloud.dialogflow.v2.SearchAgentsResponse
Sentiment
The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text.
Protobuf type google.cloud.dialogflow.v2.Sentiment
Sentiment.Builder
The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text.
Protobuf type google.cloud.dialogflow.v2.Sentiment
SentimentAnalysisRequestConfig
Configures the types of sentiment analysis to perform.
Protobuf type google.cloud.dialogflow.v2.SentimentAnalysisRequestConfig
SentimentAnalysisRequestConfig.Builder
Configures the types of sentiment analysis to perform.
Protobuf type google.cloud.dialogflow.v2.SentimentAnalysisRequestConfig
SentimentAnalysisResult
The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For [Participants.DetectIntent][], it needs to be configured in DetectIntentRequest.query_params. For [Participants.StreamingDetectIntent][], it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config
Protobuf type google.cloud.dialogflow.v2.SentimentAnalysisResult
SentimentAnalysisResult.Builder
The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For [Participants.DetectIntent][], it needs to be configured in DetectIntentRequest.query_params. For [Participants.StreamingDetectIntent][], it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config
Protobuf type google.cloud.dialogflow.v2.SentimentAnalysisResult
SessionEntityType
A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes. For more information, see the session entity guide.
Protobuf type google.cloud.dialogflow.v2.SessionEntityType
SessionEntityType.Builder
A session represents a conversation between a Dialogflow agent and an end-user. You can create special entities, called session entities, during a session. Session entities can extend or replace custom entity types and only exist during the session that they were created for. All session data, including session entities, is stored by Dialogflow for 20 minutes. For more information, see the session entity guide.
Protobuf type google.cloud.dialogflow.v2.SessionEntityType
SessionEntityTypeName
SessionEntityTypeName.Builder
Builder for projects/{project}/agent/sessions/{session}/entityTypes/{entity_type}.
SessionEntityTypeName.ProjectEnvironmentUserSessionEntityTypeBuilder
Builder for projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}.
SessionEntityTypeName.ProjectLocationEnvironmentUserSessionEntityTypeBuilder
Builder for projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}/entityTypes/{entity_type}.
SessionEntityTypeName.ProjectLocationSessionEntityTypeBuilder
Builder for projects/{project}/locations/{location}/agent/sessions/{session}/entityTypes/{entity_type}.
SessionEntityTypeProto
SessionEntityTypesClient
Service Description: Service for managing SessionEntityTypes.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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);
}
Note: close() needs to be called on the SessionEntityTypesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of SessionEntityTypesSettings to create(). For example:
To customize credentials:
// 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
SessionEntityTypesSettings sessionEntityTypesSettings =
SessionEntityTypesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
SessionEntityTypesClient sessionEntityTypesClient =
SessionEntityTypesClient.create(sessionEntityTypesSettings);
To customize the endpoint:
// 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
SessionEntityTypesSettings sessionEntityTypesSettings =
SessionEntityTypesSettings.newBuilder().setEndpoint(myEndpoint).build();
SessionEntityTypesClient sessionEntityTypesClient =
SessionEntityTypesClient.create(sessionEntityTypesSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
SessionEntityTypesSettings sessionEntityTypesSettings =
SessionEntityTypesSettings.newBuilder()
.setTransportChannelProvider(
SessionEntityTypesSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
SessionEntityTypesClient sessionEntityTypesClient =
SessionEntityTypesClient.create(sessionEntityTypesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
SessionEntityTypesClient.ListLocationsFixedSizeCollection
SessionEntityTypesClient.ListLocationsPage
SessionEntityTypesClient.ListLocationsPagedResponse
SessionEntityTypesClient.ListSessionEntityTypesFixedSizeCollection
SessionEntityTypesClient.ListSessionEntityTypesPage
SessionEntityTypesClient.ListSessionEntityTypesPagedResponse
SessionEntityTypesGrpc
Service for managing SessionEntityTypes.
SessionEntityTypesGrpc.SessionEntityTypesBlockingStub
Service for managing SessionEntityTypes.
SessionEntityTypesGrpc.SessionEntityTypesFutureStub
Service for managing SessionEntityTypes.
SessionEntityTypesGrpc.SessionEntityTypesImplBase
Service for managing SessionEntityTypes.
SessionEntityTypesGrpc.SessionEntityTypesStub
Service for managing SessionEntityTypes.
SessionEntityTypesSettings
Settings class to configure an instance of SessionEntityTypesClient.
The default instance has everything set to sensible defaults:
- The default service address (dialogflow.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getSessionEntityType to 30 seconds:
// 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
SessionEntityTypesSettings.Builder sessionEntityTypesSettingsBuilder =
SessionEntityTypesSettings.newBuilder();
sessionEntityTypesSettingsBuilder
.getSessionEntityTypeSettings()
.setRetrySettings(
sessionEntityTypesSettingsBuilder
.getSessionEntityTypeSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
SessionEntityTypesSettings sessionEntityTypesSettings =
sessionEntityTypesSettingsBuilder.build();
SessionEntityTypesSettings.Builder
Builder for SessionEntityTypesSettings.
SessionName
SessionName.Builder
Builder for projects/{project}/agent/sessions/{session}.
SessionName.ProjectEnvironmentUserSessionBuilder
Builder for projects/{project}/agent/environments/{environment}/users/{user}/sessions/{session}.
SessionName.ProjectLocationEnvironmentUserSessionBuilder
Builder for projects/{project}/locations/{location}/agent/environments/{environment}/users/{user}/sessions/{session}.
SessionName.ProjectLocationSessionBuilder
Builder for projects/{project}/locations/{location}/agent/sessions/{session}.
SessionProto
SessionsClient
Service Description: A service used for session interactions.
For more information, see the API interactions guide.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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);
}
Note: close() needs to be called on the SessionsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of SessionsSettings to create(). For example:
To customize credentials:
// 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
SessionsSettings sessionsSettings =
SessionsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
SessionsClient sessionsClient = SessionsClient.create(sessionsSettings);
To customize the endpoint:
// 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
SessionsSettings sessionsSettings =
SessionsSettings.newBuilder().setEndpoint(myEndpoint).build();
SessionsClient sessionsClient = SessionsClient.create(sessionsSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
SessionsSettings sessionsSettings =
SessionsSettings.newBuilder()
.setTransportChannelProvider(
SessionsSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
SessionsClient sessionsClient = SessionsClient.create(sessionsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
SessionsClient.ListLocationsFixedSizeCollection
SessionsClient.ListLocationsPage
SessionsClient.ListLocationsPagedResponse
SessionsGrpc
A service used for session interactions. For more information, see the API interactions guide.
SessionsGrpc.SessionsBlockingStub
A service used for session interactions. For more information, see the API interactions guide.
SessionsGrpc.SessionsFutureStub
A service used for session interactions. For more information, see the API interactions guide.
SessionsGrpc.SessionsImplBase
A service used for session interactions. For more information, see the API interactions guide.
SessionsGrpc.SessionsStub
A service used for session interactions. For more information, see the API interactions guide.
SessionsSettings
Settings class to configure an instance of SessionsClient.
The default instance has everything set to sensible defaults:
- The default service address (dialogflow.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of detectIntent to 30 seconds:
// 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
SessionsSettings.Builder sessionsSettingsBuilder = SessionsSettings.newBuilder();
sessionsSettingsBuilder
.detectIntentSettings()
.setRetrySettings(
sessionsSettingsBuilder.detectIntentSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
SessionsSettings sessionsSettings = sessionsSettingsBuilder.build();
SessionsSettings.Builder
Builder for SessionsSettings.
SetAgentRequest
The request message for Agents.SetAgent.
Protobuf type google.cloud.dialogflow.v2.SetAgentRequest
SetAgentRequest.Builder
The request message for Agents.SetAgent.
Protobuf type google.cloud.dialogflow.v2.SetAgentRequest
SetSuggestionFeatureConfigOperationMetadata
Metadata for a [ConversationProfile.SetSuggestionFeatureConfig][] operation.
Protobuf type google.cloud.dialogflow.v2.SetSuggestionFeatureConfigOperationMetadata
SetSuggestionFeatureConfigOperationMetadata.Builder
Metadata for a [ConversationProfile.SetSuggestionFeatureConfig][] operation.
Protobuf type google.cloud.dialogflow.v2.SetSuggestionFeatureConfigOperationMetadata
SetSuggestionFeatureConfigRequest
The request message for [ConversationProfiles.SetSuggestionFeature][].
Protobuf type google.cloud.dialogflow.v2.SetSuggestionFeatureConfigRequest
SetSuggestionFeatureConfigRequest.Builder
The request message for [ConversationProfiles.SetSuggestionFeature][].
Protobuf type google.cloud.dialogflow.v2.SetSuggestionFeatureConfigRequest
SmartReplyAnswer
Represents a smart reply answer.
Protobuf type google.cloud.dialogflow.v2.SmartReplyAnswer
SmartReplyAnswer.Builder
Represents a smart reply answer.
Protobuf type google.cloud.dialogflow.v2.SmartReplyAnswer
SmartReplyMetrics
The evaluation metrics for smart reply model.
Protobuf type google.cloud.dialogflow.v2.SmartReplyMetrics
SmartReplyMetrics.Builder
The evaluation metrics for smart reply model.
Protobuf type google.cloud.dialogflow.v2.SmartReplyMetrics
SmartReplyMetrics.TopNMetrics
Evaluation metrics when retrieving n
smart replies with the model.
Protobuf type google.cloud.dialogflow.v2.SmartReplyMetrics.TopNMetrics
SmartReplyMetrics.TopNMetrics.Builder
Evaluation metrics when retrieving n
smart replies with the model.
Protobuf type google.cloud.dialogflow.v2.SmartReplyMetrics.TopNMetrics
SmartReplyModelMetadata
Metadata for smart reply models.
Protobuf type google.cloud.dialogflow.v2.SmartReplyModelMetadata
SmartReplyModelMetadata.Builder
Metadata for smart reply models.
Protobuf type google.cloud.dialogflow.v2.SmartReplyModelMetadata
SpeechContext
Hints for the speech recognizer to help with recognition in a specific conversation state.
Protobuf type google.cloud.dialogflow.v2.SpeechContext
SpeechContext.Builder
Hints for the speech recognizer to help with recognition in a specific conversation state.
Protobuf type google.cloud.dialogflow.v2.SpeechContext
SpeechToTextConfig
Configures speech transcription for ConversationProfile.
Protobuf type google.cloud.dialogflow.v2.SpeechToTextConfig
SpeechToTextConfig.Builder
Configures speech transcription for ConversationProfile.
Protobuf type google.cloud.dialogflow.v2.SpeechToTextConfig
SpeechWordInfo
Information for a word recognized by the speech recognizer.
Protobuf type google.cloud.dialogflow.v2.SpeechWordInfo
SpeechWordInfo.Builder
Information for a word recognized by the speech recognizer.
Protobuf type google.cloud.dialogflow.v2.SpeechWordInfo
StreamingDetectIntentRequest
The top-level message sent by the client to the Sessions.StreamingDetectIntent method. Multiple request messages should be sent in order:
- The first message must contain session, query_input plus optionally query_params. If the client wants to receive an audio response, it should also contain output_audio_config. The message must not contain input_audio.
- If query_input was set to
query_input.audio_config, all subsequent
messages must contain
input_audio to continue with
Speech recognition.
If you decide to rather detect an intent from text input after you
already started Speech recognition, please send a message with
query_input.text.
However, note that:
- Dialogflow will bill you for the audio duration so far.
- Dialogflow discards all Speech recognition results in favor of the input text.
- Dialogflow will use the language code from the first message. After you sent all input, you must half-close or abort the request stream.
Protobuf type google.cloud.dialogflow.v2.StreamingDetectIntentRequest
StreamingDetectIntentRequest.Builder
The top-level message sent by the client to the Sessions.StreamingDetectIntent method. Multiple request messages should be sent in order:
- The first message must contain session, query_input plus optionally query_params. If the client wants to receive an audio response, it should also contain output_audio_config. The message must not contain input_audio.
- If query_input was set to
query_input.audio_config, all subsequent
messages must contain
input_audio to continue with
Speech recognition.
If you decide to rather detect an intent from text input after you
already started Speech recognition, please send a message with
query_input.text.
However, note that:
- Dialogflow will bill you for the audio duration so far.
- Dialogflow discards all Speech recognition results in favor of the input text.
- Dialogflow will use the language code from the first message. After you sent all input, you must half-close or abort the request stream.
Protobuf type google.cloud.dialogflow.v2.StreamingDetectIntentRequest
StreamingDetectIntentResponse
The top-level message returned from the
StreamingDetectIntent
method.
Multiple response messages can be returned in order:
- If the
StreamingDetectIntentRequest.input_audio
field was set, therecognition_result
field is populated for one or more messages. See the StreamingRecognitionResult message for details about the result message sequence. - The next message contains
response_id
,query_result
and optionallywebhook_status
if a WebHook was called.
Protobuf type google.cloud.dialogflow.v2.StreamingDetectIntentResponse
StreamingDetectIntentResponse.Builder
The top-level message returned from the
StreamingDetectIntent
method.
Multiple response messages can be returned in order:
- If the
StreamingDetectIntentRequest.input_audio
field was set, therecognition_result
field is populated for one or more messages. See the StreamingRecognitionResult message for details about the result message sequence. - The next message contains
response_id
,query_result
and optionallywebhook_status
if a WebHook was called.
Protobuf type google.cloud.dialogflow.v2.StreamingDetectIntentResponse
StreamingRecognitionResult
Contains a speech recognition result corresponding to a portion of the audio
that is currently being processed or an indication that this is the end
of the single requested utterance.
While end-user audio is being processed, Dialogflow sends a series of
results. Each result may contain a transcript
value. A transcript
represents a portion of the utterance. While the recognizer is processing
audio, transcript values may be interim values or finalized values.
Once a transcript is finalized, the is_final
value is set to true and
processing continues for the next transcript.
If StreamingDetectIntentRequest.query_input.audio_config.single_utterance
was true, and the recognizer has completed processing audio,
the message_type
value is set to END_OF_SINGLE_UTTERANCE and the
following (last) result contains the last finalized transcript.
The complete end-user utterance is determined by concatenating the
finalized transcript values received for the series of results.
In the following example, single utterance is enabled. In the case where
single utterance is not enabled, result 7 would not occur.
Num | transcript | message_type | is_final |
---|---|---|---|
1 | "tube" | TRANSCRIPT | false |
2 | "to be a" | TRANSCRIPT | false |
3 | "to be" | TRANSCRIPT | false |
4 | "to be or not to be" | TRANSCRIPT | true |
5 | "that's" | TRANSCRIPT | false |
6 | "that is | TRANSCRIPT | false |
7 | unset | END_OF_SINGLE_UTTERANCE | unset |
8 | " that is the question" | TRANSCRIPT | true |
Concatenating the finalized transcripts with
is_final` set to true,
the complete utterance becomes "to be or not to be that is the question".
Protobuf type google.cloud.dialogflow.v2.StreamingRecognitionResult
StreamingRecognitionResult.Builder
Contains a speech recognition result corresponding to a portion of the audio
that is currently being processed or an indication that this is the end
of the single requested utterance.
While end-user audio is being processed, Dialogflow sends a series of
results. Each result may contain a transcript
value. A transcript
represents a portion of the utterance. While the recognizer is processing
audio, transcript values may be interim values or finalized values.
Once a transcript is finalized, the is_final
value is set to true and
processing continues for the next transcript.
If StreamingDetectIntentRequest.query_input.audio_config.single_utterance
was true, and the recognizer has completed processing audio,
the message_type
value is set to END_OF_SINGLE_UTTERANCE and the
following (last) result contains the last finalized transcript.
The complete end-user utterance is determined by concatenating the
finalized transcript values received for the series of results.
In the following example, single utterance is enabled. In the case where
single utterance is not enabled, result 7 would not occur.
Num | transcript | message_type | is_final |
---|---|---|---|
1 | "tube" | TRANSCRIPT | false |
2 | "to be a" | TRANSCRIPT | false |
3 | "to be" | TRANSCRIPT | false |
4 | "to be or not to be" | TRANSCRIPT | true |
5 | "that's" | TRANSCRIPT | false |
6 | "that is | TRANSCRIPT | false |
7 | unset | END_OF_SINGLE_UTTERANCE | unset |
8 | " that is the question" | TRANSCRIPT | true |
Concatenating the finalized transcripts with
is_final` set to true,
the complete utterance becomes "to be or not to be that is the question".
Protobuf type google.cloud.dialogflow.v2.StreamingRecognitionResult
SuggestArticlesRequest
The request message for Participants.SuggestArticles.
Protobuf type google.cloud.dialogflow.v2.SuggestArticlesRequest
SuggestArticlesRequest.Builder
The request message for Participants.SuggestArticles.
Protobuf type google.cloud.dialogflow.v2.SuggestArticlesRequest
SuggestArticlesResponse
The response message for Participants.SuggestArticles.
Protobuf type google.cloud.dialogflow.v2.SuggestArticlesResponse
SuggestArticlesResponse.Builder
The response message for Participants.SuggestArticles.
Protobuf type google.cloud.dialogflow.v2.SuggestArticlesResponse
SuggestFaqAnswersRequest
The request message for Participants.SuggestFaqAnswers.
Protobuf type google.cloud.dialogflow.v2.SuggestFaqAnswersRequest
SuggestFaqAnswersRequest.Builder
The request message for Participants.SuggestFaqAnswers.
Protobuf type google.cloud.dialogflow.v2.SuggestFaqAnswersRequest
SuggestFaqAnswersResponse
The request message for Participants.SuggestFaqAnswers.
Protobuf type google.cloud.dialogflow.v2.SuggestFaqAnswersResponse
SuggestFaqAnswersResponse.Builder
The request message for Participants.SuggestFaqAnswers.
Protobuf type google.cloud.dialogflow.v2.SuggestFaqAnswersResponse
SuggestSmartRepliesRequest
The request message for Participants.SuggestSmartReplies.
Protobuf type google.cloud.dialogflow.v2.SuggestSmartRepliesRequest
SuggestSmartRepliesRequest.Builder
The request message for Participants.SuggestSmartReplies.
Protobuf type google.cloud.dialogflow.v2.SuggestSmartRepliesRequest
SuggestSmartRepliesResponse
The response message for Participants.SuggestSmartReplies.
Protobuf type google.cloud.dialogflow.v2.SuggestSmartRepliesResponse
SuggestSmartRepliesResponse.Builder
The response message for Participants.SuggestSmartReplies.
Protobuf type google.cloud.dialogflow.v2.SuggestSmartRepliesResponse
SuggestionFeature
The type of Human Agent Assistant API suggestion to perform, and the maximum
number of results to return for that type. Multiple Feature
objects can
be specified in the features
list.
Protobuf type google.cloud.dialogflow.v2.SuggestionFeature
SuggestionFeature.Builder
The type of Human Agent Assistant API suggestion to perform, and the maximum
number of results to return for that type. Multiple Feature
objects can
be specified in the features
list.
Protobuf type google.cloud.dialogflow.v2.SuggestionFeature
SuggestionResult
One response of different type of suggestion response which is used in the response of Participants.AnalyzeContent and Participants.AnalyzeContent, as well as HumanAgentAssistantEvent.
Protobuf type google.cloud.dialogflow.v2.SuggestionResult
SuggestionResult.Builder
One response of different type of suggestion response which is used in the response of Participants.AnalyzeContent and Participants.AnalyzeContent, as well as HumanAgentAssistantEvent.
Protobuf type google.cloud.dialogflow.v2.SuggestionResult
SynthesizeSpeechConfig
Configuration of how speech should be synthesized.
Protobuf type google.cloud.dialogflow.v2.SynthesizeSpeechConfig
SynthesizeSpeechConfig.Builder
Configuration of how speech should be synthesized.
Protobuf type google.cloud.dialogflow.v2.SynthesizeSpeechConfig
TextInput
============================================================================ Auxiliary proto messages. Represents the natural language text to be processed.
Protobuf type google.cloud.dialogflow.v2.TextInput
TextInput.Builder
============================================================================ Auxiliary proto messages. Represents the natural language text to be processed.
Protobuf type google.cloud.dialogflow.v2.TextInput
TextToSpeechSettings
Instructs the speech synthesizer on how to generate the output audio content.
Protobuf type google.cloud.dialogflow.v2.TextToSpeechSettings
TextToSpeechSettings.Builder
Instructs the speech synthesizer on how to generate the output audio content.
Protobuf type google.cloud.dialogflow.v2.TextToSpeechSettings
TrainAgentRequest
The request message for Agents.TrainAgent.
Protobuf type google.cloud.dialogflow.v2.TrainAgentRequest
TrainAgentRequest.Builder
The request message for Agents.TrainAgent.
Protobuf type google.cloud.dialogflow.v2.TrainAgentRequest
UndeployConversationModelOperationMetadata
Metadata for a ConversationModels.UndeployConversationModel operation.
Protobuf type google.cloud.dialogflow.v2.UndeployConversationModelOperationMetadata
UndeployConversationModelOperationMetadata.Builder
Metadata for a ConversationModels.UndeployConversationModel operation.
Protobuf type google.cloud.dialogflow.v2.UndeployConversationModelOperationMetadata
UndeployConversationModelRequest
The request message for ConversationModels.UndeployConversationModel
Protobuf type google.cloud.dialogflow.v2.UndeployConversationModelRequest
UndeployConversationModelRequest.Builder
The request message for ConversationModels.UndeployConversationModel
Protobuf type google.cloud.dialogflow.v2.UndeployConversationModelRequest
UpdateAnswerRecordRequest
Request message for AnswerRecords.UpdateAnswerRecord.
Protobuf type google.cloud.dialogflow.v2.UpdateAnswerRecordRequest
UpdateAnswerRecordRequest.Builder
Request message for AnswerRecords.UpdateAnswerRecord.
Protobuf type google.cloud.dialogflow.v2.UpdateAnswerRecordRequest
UpdateContextRequest
The request message for Contexts.UpdateContext.
Protobuf type google.cloud.dialogflow.v2.UpdateContextRequest
UpdateContextRequest.Builder
The request message for Contexts.UpdateContext.
Protobuf type google.cloud.dialogflow.v2.UpdateContextRequest
UpdateConversationProfileRequest
The request message for ConversationProfiles.UpdateConversationProfile.
Protobuf type google.cloud.dialogflow.v2.UpdateConversationProfileRequest
UpdateConversationProfileRequest.Builder
The request message for ConversationProfiles.UpdateConversationProfile.
Protobuf type google.cloud.dialogflow.v2.UpdateConversationProfileRequest
UpdateDocumentRequest
Request message for Documents.UpdateDocument.
Protobuf type google.cloud.dialogflow.v2.UpdateDocumentRequest
UpdateDocumentRequest.Builder
Request message for Documents.UpdateDocument.
Protobuf type google.cloud.dialogflow.v2.UpdateDocumentRequest
UpdateEntityTypeRequest
The request message for EntityTypes.UpdateEntityType.
Protobuf type google.cloud.dialogflow.v2.UpdateEntityTypeRequest
UpdateEntityTypeRequest.Builder
The request message for EntityTypes.UpdateEntityType.
Protobuf type google.cloud.dialogflow.v2.UpdateEntityTypeRequest
UpdateEnvironmentRequest
The request message for Environments.UpdateEnvironment.
Protobuf type google.cloud.dialogflow.v2.UpdateEnvironmentRequest
UpdateEnvironmentRequest.Builder
The request message for Environments.UpdateEnvironment.
Protobuf type google.cloud.dialogflow.v2.UpdateEnvironmentRequest
UpdateFulfillmentRequest
The request message for Fulfillments.UpdateFulfillment.
Protobuf type google.cloud.dialogflow.v2.UpdateFulfillmentRequest
UpdateFulfillmentRequest.Builder
The request message for Fulfillments.UpdateFulfillment.
Protobuf type google.cloud.dialogflow.v2.UpdateFulfillmentRequest
UpdateIntentRequest
The request message for Intents.UpdateIntent.
Protobuf type google.cloud.dialogflow.v2.UpdateIntentRequest
UpdateIntentRequest.Builder
The request message for Intents.UpdateIntent.
Protobuf type google.cloud.dialogflow.v2.UpdateIntentRequest
UpdateKnowledgeBaseRequest
Request message for KnowledgeBases.UpdateKnowledgeBase.
Protobuf type google.cloud.dialogflow.v2.UpdateKnowledgeBaseRequest
UpdateKnowledgeBaseRequest.Builder
Request message for KnowledgeBases.UpdateKnowledgeBase.
Protobuf type google.cloud.dialogflow.v2.UpdateKnowledgeBaseRequest
UpdateParticipantRequest
The request message for Participants.UpdateParticipant.
Protobuf type google.cloud.dialogflow.v2.UpdateParticipantRequest
UpdateParticipantRequest.Builder
The request message for Participants.UpdateParticipant.
Protobuf type google.cloud.dialogflow.v2.UpdateParticipantRequest
UpdateSessionEntityTypeRequest
The request message for SessionEntityTypes.UpdateSessionEntityType.
Protobuf type google.cloud.dialogflow.v2.UpdateSessionEntityTypeRequest
UpdateSessionEntityTypeRequest.Builder
The request message for SessionEntityTypes.UpdateSessionEntityType.
Protobuf type google.cloud.dialogflow.v2.UpdateSessionEntityTypeRequest
UpdateVersionRequest
The request message for Versions.UpdateVersion.
Protobuf type google.cloud.dialogflow.v2.UpdateVersionRequest
UpdateVersionRequest.Builder
The request message for Versions.UpdateVersion.
Protobuf type google.cloud.dialogflow.v2.UpdateVersionRequest
ValidationError
Represents a single validation error.
Protobuf type google.cloud.dialogflow.v2.ValidationError
ValidationError.Builder
Represents a single validation error.
Protobuf type google.cloud.dialogflow.v2.ValidationError
ValidationResult
Represents the output of agent validation.
Protobuf type google.cloud.dialogflow.v2.ValidationResult
ValidationResult.Builder
Represents the output of agent validation.
Protobuf type google.cloud.dialogflow.v2.ValidationResult
ValidationResultProto
Version
You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for:
- testing
- development
- production
- etc. For more information, see the versions and environments guide.
Protobuf type google.cloud.dialogflow.v2.Version
Version.Builder
You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for:
- testing
- development
- production
- etc. For more information, see the versions and environments guide.
Protobuf type google.cloud.dialogflow.v2.Version
VersionName
VersionName.Builder
Builder for projects/{project}/agent/versions/{version}.
VersionName.ProjectLocationVersionBuilder
Builder for projects/{project}/locations/{location}/agent/versions/{version}.
VersionProto
VersionsClient
Service Description: Service for managing Versions.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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);
}
Note: close() needs to be called on the VersionsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of VersionsSettings to create(). For example:
To customize credentials:
// 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
VersionsSettings versionsSettings =
VersionsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
VersionsClient versionsClient = VersionsClient.create(versionsSettings);
To customize the endpoint:
// 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
VersionsSettings versionsSettings =
VersionsSettings.newBuilder().setEndpoint(myEndpoint).build();
VersionsClient versionsClient = VersionsClient.create(versionsSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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
VersionsSettings versionsSettings =
VersionsSettings.newBuilder()
.setTransportChannelProvider(
VersionsSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
VersionsClient versionsClient = VersionsClient.create(versionsSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
VersionsClient.ListLocationsFixedSizeCollection
VersionsClient.ListLocationsPage
VersionsClient.ListLocationsPagedResponse
VersionsClient.ListVersionsFixedSizeCollection
VersionsClient.ListVersionsPage
VersionsClient.ListVersionsPagedResponse
VersionsGrpc
Service for managing Versions.
VersionsGrpc.VersionsBlockingStub
Service for managing Versions.
VersionsGrpc.VersionsFutureStub
Service for managing Versions.
VersionsGrpc.VersionsImplBase
Service for managing Versions.
VersionsGrpc.VersionsStub
Service for managing Versions.
VersionsSettings
Settings class to configure an instance of VersionsClient.
The default instance has everything set to sensible defaults:
- The default service address (dialogflow.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of getVersion to 30 seconds:
// 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
VersionsSettings.Builder versionsSettingsBuilder = VersionsSettings.newBuilder();
versionsSettingsBuilder
.getVersionSettings()
.setRetrySettings(
versionsSettingsBuilder.getVersionSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
VersionsSettings versionsSettings = versionsSettingsBuilder.build();
VersionsSettings.Builder
Builder for VersionsSettings.
VoiceSelectionParams
Description of which voice to use for speech synthesis.
Protobuf type google.cloud.dialogflow.v2.VoiceSelectionParams
VoiceSelectionParams.Builder
Description of which voice to use for speech synthesis.
Protobuf type google.cloud.dialogflow.v2.VoiceSelectionParams
WebhookProto
WebhookRequest
The request message for a webhook call.
Protobuf type google.cloud.dialogflow.v2.WebhookRequest
WebhookRequest.Builder
The request message for a webhook call.
Protobuf type google.cloud.dialogflow.v2.WebhookRequest
WebhookResponse
The response message for a webhook call. This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error:
- Use
""
for empty strings - Use
{}
ornull
for empty objects - Use
[]
ornull
for empty arrays For more information, see the Protocol Buffers Language Guide.
Protobuf type google.cloud.dialogflow.v2.WebhookResponse
WebhookResponse.Builder
The response message for a webhook call. This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error:
- Use
""
for empty strings - Use
{}
ornull
for empty objects - Use
[]
ornull
for empty arrays For more information, see the Protocol Buffers Language Guide.
Protobuf type google.cloud.dialogflow.v2.WebhookResponse
Interfaces
AgentAssistantFeedbackOrBuilder
AgentAssistantRecordOrBuilder
AgentOrBuilder
AnalyzeContentRequestOrBuilder
AnalyzeContentResponseOrBuilder
AnnotatedMessagePartOrBuilder
AnswerFeedbackOrBuilder
AnswerRecordOrBuilder
ArticleAnswerOrBuilder
ArticleSuggestionModelMetadataOrBuilder
AssistQueryParametersOrBuilder
AutomatedAgentConfigOrBuilder
AutomatedAgentReplyOrBuilder
BatchCreateEntitiesRequestOrBuilder
BatchDeleteEntitiesRequestOrBuilder
BatchDeleteEntityTypesRequestOrBuilder
BatchDeleteIntentsRequestOrBuilder
BatchUpdateEntitiesRequestOrBuilder
BatchUpdateEntityTypesRequestOrBuilder
BatchUpdateEntityTypesResponseOrBuilder
BatchUpdateIntentsRequestOrBuilder
BatchUpdateIntentsResponseOrBuilder
ClearSuggestionFeatureConfigOperationMetadataOrBuilder
ClearSuggestionFeatureConfigRequestOrBuilder
CompleteConversationRequestOrBuilder
ContextOrBuilder
ConversationDatasetOrBuilder
ConversationEventOrBuilder
ConversationInfoOrBuilder
ConversationModelEvaluationOrBuilder
ConversationModelOrBuilder
ConversationOrBuilder
ConversationPhoneNumberOrBuilder
ConversationProfileOrBuilder
CreateContextRequestOrBuilder
CreateConversationDatasetOperationMetadataOrBuilder
CreateConversationDatasetRequestOrBuilder
CreateConversationModelEvaluationOperationMetadataOrBuilder
CreateConversationModelEvaluationRequestOrBuilder
CreateConversationModelOperationMetadataOrBuilder
CreateConversationModelRequestOrBuilder
CreateConversationProfileRequestOrBuilder
CreateConversationRequestOrBuilder
CreateDocumentRequestOrBuilder
CreateEntityTypeRequestOrBuilder
CreateEnvironmentRequestOrBuilder
CreateIntentRequestOrBuilder
CreateKnowledgeBaseRequestOrBuilder
CreateParticipantRequestOrBuilder
CreateSessionEntityTypeRequestOrBuilder
CreateVersionRequestOrBuilder
DeleteAgentRequestOrBuilder
DeleteAllContextsRequestOrBuilder
DeleteContextRequestOrBuilder
DeleteConversationDatasetOperationMetadataOrBuilder
DeleteConversationDatasetRequestOrBuilder
DeleteConversationModelOperationMetadataOrBuilder
DeleteConversationModelRequestOrBuilder
DeleteConversationProfileRequestOrBuilder
DeleteDocumentRequestOrBuilder
DeleteEntityTypeRequestOrBuilder
DeleteEnvironmentRequestOrBuilder
DeleteIntentRequestOrBuilder
DeleteKnowledgeBaseRequestOrBuilder
DeleteSessionEntityTypeRequestOrBuilder
DeleteVersionRequestOrBuilder
DeployConversationModelOperationMetadataOrBuilder
DeployConversationModelRequestOrBuilder
DetectIntentRequestOrBuilder
DetectIntentResponseOrBuilder
Document.ReloadStatusOrBuilder
DocumentOrBuilder
DtmfParametersOrBuilder
EntityType.EntityOrBuilder
EntityTypeBatchOrBuilder
EntityTypeOrBuilder
EnvironmentHistory.EntryOrBuilder
EnvironmentHistoryOrBuilder
EnvironmentOrBuilder
EvaluationConfig.SmartComposeConfigOrBuilder
EvaluationConfig.SmartReplyConfigOrBuilder
EvaluationConfigOrBuilder
EventInputOrBuilder
ExportAgentRequestOrBuilder
ExportAgentResponseOrBuilder
ExportDocumentRequestOrBuilder
ExportOperationMetadataOrBuilder
FaqAnswerOrBuilder
Fulfillment.FeatureOrBuilder
Fulfillment.GenericWebServiceOrBuilder
FulfillmentOrBuilder
GcsDestinationOrBuilder
GcsSourcesOrBuilder
GetAgentRequestOrBuilder
GetContextRequestOrBuilder
GetConversationDatasetRequestOrBuilder
GetConversationModelEvaluationRequestOrBuilder
GetConversationModelRequestOrBuilder
GetConversationProfileRequestOrBuilder
GetConversationRequestOrBuilder
GetDocumentRequestOrBuilder
GetEntityTypeRequestOrBuilder
GetEnvironmentHistoryRequestOrBuilder
GetEnvironmentRequestOrBuilder
GetFulfillmentRequestOrBuilder
GetIntentRequestOrBuilder
GetKnowledgeBaseRequestOrBuilder
GetParticipantRequestOrBuilder
GetSessionEntityTypeRequestOrBuilder
GetValidationResultRequestOrBuilder
GetVersionRequestOrBuilder
HumanAgentAssistantConfig.ConversationModelConfigOrBuilder
HumanAgentAssistantConfig.ConversationProcessConfigOrBuilder
HumanAgentAssistantConfig.MessageAnalysisConfigOrBuilder
HumanAgentAssistantConfig.SuggestionConfigOrBuilder
HumanAgentAssistantConfig.SuggestionFeatureConfigOrBuilder
HumanAgentAssistantConfig.SuggestionQueryConfig.ContextFilterSettingsOrBuilder
HumanAgentAssistantConfig.SuggestionQueryConfig.DialogflowQuerySourceOrBuilder
HumanAgentAssistantConfig.SuggestionQueryConfig.DocumentQuerySourceOrBuilder
HumanAgentAssistantConfig.SuggestionQueryConfig.KnowledgeBaseQuerySourceOrBuilder
HumanAgentAssistantConfig.SuggestionQueryConfigOrBuilder
HumanAgentAssistantConfig.SuggestionTriggerSettingsOrBuilder
HumanAgentAssistantConfigOrBuilder
HumanAgentAssistantEventOrBuilder
HumanAgentHandoffConfig.LivePersonConfigOrBuilder
HumanAgentHandoffConfig.SalesforceLiveAgentConfigOrBuilder
HumanAgentHandoffConfigOrBuilder
ImportAgentRequestOrBuilder
ImportConversationDataOperationMetadataOrBuilder
ImportConversationDataOperationResponseOrBuilder
ImportConversationDataRequestOrBuilder
ImportDocumentTemplateOrBuilder
ImportDocumentsRequestOrBuilder
ImportDocumentsResponseOrBuilder
InputAudioConfigOrBuilder
InputConfigOrBuilder
InputDatasetOrBuilder
Intent.FollowupIntentInfoOrBuilder
Intent.Message.BasicCard.Button.OpenUriActionOrBuilder
Intent.Message.BasicCard.ButtonOrBuilder
Intent.Message.BasicCardOrBuilder
Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem.OpenUrlActionOrBuilder
Intent.Message.BrowseCarouselCard.BrowseCarouselCardItemOrBuilder
Intent.Message.BrowseCarouselCardOrBuilder
Intent.Message.Card.ButtonOrBuilder
Intent.Message.CardOrBuilder
Intent.Message.CarouselSelect.ItemOrBuilder
Intent.Message.CarouselSelectOrBuilder
Intent.Message.ColumnPropertiesOrBuilder
Intent.Message.ImageOrBuilder
Intent.Message.LinkOutSuggestionOrBuilder
Intent.Message.ListSelect.ItemOrBuilder
Intent.Message.ListSelectOrBuilder
Intent.Message.MediaContent.ResponseMediaObjectOrBuilder
Intent.Message.MediaContentOrBuilder
Intent.Message.QuickRepliesOrBuilder
Intent.Message.SelectItemInfoOrBuilder
Intent.Message.SimpleResponseOrBuilder
Intent.Message.SimpleResponsesOrBuilder
Intent.Message.SuggestionOrBuilder
Intent.Message.SuggestionsOrBuilder
Intent.Message.TableCardCellOrBuilder
Intent.Message.TableCardOrBuilder
Intent.Message.TableCardRowOrBuilder
Intent.Message.TextOrBuilder
Intent.MessageOrBuilder
Intent.ParameterOrBuilder
Intent.TrainingPhrase.PartOrBuilder
Intent.TrainingPhraseOrBuilder
IntentBatchOrBuilder
IntentOrBuilder
KnowledgeBaseOrBuilder
KnowledgeOperationMetadataOrBuilder
ListAnswerRecordsRequestOrBuilder
ListAnswerRecordsResponseOrBuilder
ListContextsRequestOrBuilder
ListContextsResponseOrBuilder
ListConversationDatasetsRequestOrBuilder
ListConversationDatasetsResponseOrBuilder
ListConversationModelEvaluationsRequestOrBuilder
ListConversationModelEvaluationsResponseOrBuilder
ListConversationModelsRequestOrBuilder
ListConversationModelsResponseOrBuilder
ListConversationProfilesRequestOrBuilder
ListConversationProfilesResponseOrBuilder
ListConversationsRequestOrBuilder
ListConversationsResponseOrBuilder
ListDocumentsRequestOrBuilder
ListDocumentsResponseOrBuilder
ListEntityTypesRequestOrBuilder
ListEntityTypesResponseOrBuilder
ListEnvironmentsRequestOrBuilder
ListEnvironmentsResponseOrBuilder
ListIntentsRequestOrBuilder
ListIntentsResponseOrBuilder
ListKnowledgeBasesRequestOrBuilder
ListKnowledgeBasesResponseOrBuilder
ListMessagesRequestOrBuilder
ListMessagesResponseOrBuilder
ListParticipantsRequestOrBuilder
ListParticipantsResponseOrBuilder
ListSessionEntityTypesRequestOrBuilder
ListSessionEntityTypesResponseOrBuilder
ListVersionsRequestOrBuilder
ListVersionsResponseOrBuilder
LoggingConfigOrBuilder
MessageAnnotationOrBuilder
MessageOrBuilder
NotificationConfigOrBuilder
OriginalDetectIntentRequestOrBuilder
OutputAudioConfigOrBuilder
OutputAudioOrBuilder
ParticipantOrBuilder
QueryInputOrBuilder
QueryParametersOrBuilder
QueryResultOrBuilder
ReloadDocumentRequestOrBuilder
RestoreAgentRequestOrBuilder
SearchAgentsRequestOrBuilder
SearchAgentsResponseOrBuilder
SentimentAnalysisRequestConfigOrBuilder
SentimentAnalysisResultOrBuilder
SentimentOrBuilder
SessionEntityTypeOrBuilder
SetAgentRequestOrBuilder
SetSuggestionFeatureConfigOperationMetadataOrBuilder
SetSuggestionFeatureConfigRequestOrBuilder
SmartReplyAnswerOrBuilder
SmartReplyMetrics.TopNMetricsOrBuilder
SmartReplyMetricsOrBuilder
SmartReplyModelMetadataOrBuilder
SpeechContextOrBuilder
SpeechToTextConfigOrBuilder
SpeechWordInfoOrBuilder
StreamingDetectIntentRequestOrBuilder
StreamingDetectIntentResponseOrBuilder
StreamingRecognitionResultOrBuilder
SuggestArticlesRequestOrBuilder
SuggestArticlesResponseOrBuilder
SuggestFaqAnswersRequestOrBuilder
SuggestFaqAnswersResponseOrBuilder
SuggestSmartRepliesRequestOrBuilder
SuggestSmartRepliesResponseOrBuilder
SuggestionFeatureOrBuilder
SuggestionResultOrBuilder
SynthesizeSpeechConfigOrBuilder
TextInputOrBuilder
TextToSpeechSettingsOrBuilder
TrainAgentRequestOrBuilder
UndeployConversationModelOperationMetadataOrBuilder
UndeployConversationModelRequestOrBuilder
UpdateAnswerRecordRequestOrBuilder
UpdateContextRequestOrBuilder
UpdateConversationProfileRequestOrBuilder
UpdateDocumentRequestOrBuilder
UpdateEntityTypeRequestOrBuilder
UpdateEnvironmentRequestOrBuilder
UpdateFulfillmentRequestOrBuilder
UpdateIntentRequestOrBuilder
UpdateKnowledgeBaseRequestOrBuilder
UpdateParticipantRequestOrBuilder
UpdateSessionEntityTypeRequestOrBuilder
UpdateVersionRequestOrBuilder
ValidationErrorOrBuilder
ValidationResultOrBuilder
VersionOrBuilder
VoiceSelectionParamsOrBuilder
WebhookRequestOrBuilder
WebhookResponseOrBuilder
Enums
Agent.ApiVersion
API version for the agent.
Protobuf enum google.cloud.dialogflow.v2.Agent.ApiVersion
Agent.MatchMode
Match mode determines how intents are detected from user queries.
Protobuf enum google.cloud.dialogflow.v2.Agent.MatchMode
Agent.Tier
Represents the agent tier.
Protobuf enum google.cloud.dialogflow.v2.Agent.Tier
AgentAssistantFeedback.AnswerRelevance
Relevance of an answer.
Protobuf enum google.cloud.dialogflow.v2.AgentAssistantFeedback.AnswerRelevance
AgentAssistantFeedback.DocumentCorrectness
Correctness of document.
Protobuf enum google.cloud.dialogflow.v2.AgentAssistantFeedback.DocumentCorrectness
AgentAssistantFeedback.DocumentEfficiency
Efficiency of document.
Protobuf enum google.cloud.dialogflow.v2.AgentAssistantFeedback.DocumentEfficiency
AgentAssistantRecord.AnswerCase
AnalyzeContentRequest.InputCase
AnswerFeedback.CorrectnessLevel
The correctness level of an answer.
Protobuf enum google.cloud.dialogflow.v2.AnswerFeedback.CorrectnessLevel
AnswerFeedback.DetailFeedbackCase
AnswerRecord.RecordCase
AudioEncoding
Audio encoding of the audio content sent in the conversational query request. Refer to the Cloud Speech API documentation for more details.
Protobuf enum google.cloud.dialogflow.v2.AudioEncoding
AutomatedAgentReply.AutomatedAgentReplyType
Represents different automated agent reply types.
Protobuf enum google.cloud.dialogflow.v2.AutomatedAgentReply.AutomatedAgentReplyType
BatchUpdateEntityTypesRequest.EntityTypeBatchCase
BatchUpdateIntentsRequest.IntentBatchCase
Conversation.ConversationStage
Enumeration of the different conversation stages a conversation can be in. Reference: https://cloud.google.com/dialogflow/priv/docs/contact-center/basics#stages
Protobuf enum google.cloud.dialogflow.v2.Conversation.ConversationStage
Conversation.LifecycleState
Enumeration of the completion status of the conversation.
Protobuf enum google.cloud.dialogflow.v2.Conversation.LifecycleState
ConversationEvent.PayloadCase
ConversationEvent.Type
Enumeration of the types of events available.
Protobuf enum google.cloud.dialogflow.v2.ConversationEvent.Type
ConversationModel.ModelMetadataCase
ConversationModel.ModelType
Model type.
Protobuf enum google.cloud.dialogflow.v2.ConversationModel.ModelType
ConversationModel.State
State of the model.
Protobuf enum google.cloud.dialogflow.v2.ConversationModel.State
ConversationModelEvaluation.MetricsCase
CreateConversationModelEvaluationOperationMetadata.State
State of CreateConversationModel operation.
Protobuf enum
google.cloud.dialogflow.v2.CreateConversationModelEvaluationOperationMetadata.State
CreateConversationModelOperationMetadata.State
State of CreateConversationModel operation.
Protobuf enum google.cloud.dialogflow.v2.CreateConversationModelOperationMetadata.State
Document.KnowledgeType
The knowledge type of document content.
Protobuf enum google.cloud.dialogflow.v2.Document.KnowledgeType
Document.SourceCase
Document.State
Possible states of the document
Protobuf enum google.cloud.dialogflow.v2.Document.State
EntityType.AutoExpansionMode
Represents different entity type expansion modes. Automated expansion allows an agent to recognize values that have not been explicitly listed in the entity (for example, new kinds of shopping list items).
Protobuf enum google.cloud.dialogflow.v2.EntityType.AutoExpansionMode
EntityType.Kind
Represents kinds of entities.
Protobuf enum google.cloud.dialogflow.v2.EntityType.Kind
Environment.State
Represents an environment state. When an environment is pointed to a new
agent version, the environment is temporarily set to the LOADING
state.
During that time, the environment keeps on serving the previous version of
the agent. After the new agent version is done loading, the environment is
set back to the RUNNING
state.
Protobuf enum google.cloud.dialogflow.v2.Environment.State
EvaluationConfig.ModelSpecificConfigCase
ExportAgentResponse.AgentCase
ExportDocumentRequest.DestinationCase
Fulfillment.Feature.Type
The type of the feature.
Protobuf enum google.cloud.dialogflow.v2.Fulfillment.Feature.Type
Fulfillment.FulfillmentCase
HumanAgentAssistantConfig.SuggestionQueryConfig.QuerySourceCase
HumanAgentHandoffConfig.AgentServiceCase
ImportAgentRequest.AgentCase
ImportDocumentsRequest.SourceCase
InputConfig.SourceCase
Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem.OpenUrlAction.UrlTypeHint
Type of the URI.
Protobuf enum
google.cloud.dialogflow.v2.Intent.Message.BrowseCarouselCard.BrowseCarouselCardItem.OpenUrlAction.UrlTypeHint
Intent.Message.BrowseCarouselCard.ImageDisplayOptions
Image display options for Actions on Google. This should be used for when the image's aspect ratio does not match the image container's aspect ratio.
Protobuf enum
google.cloud.dialogflow.v2.Intent.Message.BrowseCarouselCard.ImageDisplayOptions
Intent.Message.ColumnProperties.HorizontalAlignment
Text alignments within a cell.
Protobuf enum
google.cloud.dialogflow.v2.Intent.Message.ColumnProperties.HorizontalAlignment
Intent.Message.MediaContent.ResponseMediaObject.ImageCase
Intent.Message.MediaContent.ResponseMediaType
Format of response media type.
Protobuf enum
google.cloud.dialogflow.v2.Intent.Message.MediaContent.ResponseMediaType
Intent.Message.MessageCase
Intent.Message.Platform
The rich response message integration platform. See Integrations.
Protobuf enum google.cloud.dialogflow.v2.Intent.Message.Platform
Intent.TrainingPhrase.Type
Represents different types of training phrases.
Protobuf enum google.cloud.dialogflow.v2.Intent.TrainingPhrase.Type
Intent.WebhookState
Represents the different states that webhooks can be in.
Protobuf enum google.cloud.dialogflow.v2.Intent.WebhookState
IntentView
Represents the options for views of an intent. An intent can be a sizable object. Therefore, we provide a resource view that does not return training phrases in the response by default.
Protobuf enum google.cloud.dialogflow.v2.IntentView
KnowledgeOperationMetadata.OperationMetadataCase
KnowledgeOperationMetadata.State
States of the operation.
Protobuf enum google.cloud.dialogflow.v2.KnowledgeOperationMetadata.State
NotificationConfig.MessageFormat
Format of cloud pub/sub message.
Protobuf enum google.cloud.dialogflow.v2.NotificationConfig.MessageFormat
OutputAudioEncoding
Audio encoding of the output audio format in Text-To-Speech.
Protobuf enum google.cloud.dialogflow.v2.OutputAudioEncoding
Participant.Role
Enumeration of the roles a participant can play in a conversation.
Protobuf enum google.cloud.dialogflow.v2.Participant.Role
QueryInput.InputCase
ReloadDocumentRequest.SourceCase
RestoreAgentRequest.AgentCase
SessionEntityType.EntityOverrideMode
The types of modifications for a session entity type.
Protobuf enum google.cloud.dialogflow.v2.SessionEntityType.EntityOverrideMode
SpeechModelVariant
Variant of the specified Speech model to use. See the Cloud Speech documentation for which models have different variants. For example, the "phone_call" model has both a standard and an enhanced variant. When you use an enhanced model, you will generally receive higher quality results than for a standard model.
Protobuf enum google.cloud.dialogflow.v2.SpeechModelVariant
SsmlVoiceGender
Gender of the voice as described in SSML voice element.
Protobuf enum google.cloud.dialogflow.v2.SsmlVoiceGender
StreamingRecognitionResult.MessageType
Type of the response message.
Protobuf enum google.cloud.dialogflow.v2.StreamingRecognitionResult.MessageType
SuggestionFeature.Type
Defines the type of Human Agent Assistant feature.
Protobuf enum google.cloud.dialogflow.v2.SuggestionFeature.Type
SuggestionResult.SuggestionResponseCase
ValidationError.Severity
Represents a level of severity.
Protobuf enum google.cloud.dialogflow.v2.ValidationError.Severity
Version.VersionStatus
The status of a version.
Protobuf enum google.cloud.dialogflow.v2.Version.VersionStatus