google-cloud-dialogflow-cx-v3 0.1.0

data/proto_docs/google/cloud/dialogflow/cx/v3/session_entity_type.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Dialogflow
+      module CX
+        module V3
+          # Session entity types are referred to as **User** entity types and are
+          # entities that are built for an individual user such as favorites,
+          # preferences, playlists, and so on.
+          #
+          # You can redefine a session entity type at the session level to extend or
+          # replace a {::Google::Cloud::Dialogflow::CX::V3::EntityType custom entity type} at the user session level (we
+          # refer to the entity types defined at the agent level as "custom entity
+          # types").
+          #
+          # Note: session entity types apply to all queries, regardless of the language.
+          #
+          # For more information about entity types, see the [Dialogflow
+          # documentation](https://cloud.google.com/dialogflow/docs/entities-overview).
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The unique identifier of the session entity type.
+          #     Format: `projects/<Project ID>/locations/<Location
+          #     ID>/agents/<Agent ID>/sessions/<Session ID>/entityTypes/<Entity Type
+          #     ID>` or `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity
+          #     Type ID>`. If `Environment ID` is not specified, we assume default 'draft'
+          #     environment.
+          # @!attribute [rw] entity_override_mode
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::SessionEntityType::EntityOverrideMode]
+          #     Required. Indicates whether the additional data should override or supplement the
+          #     custom entity type definition.
+          # @!attribute [rw] entities
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::EntityType::Entity>]
+          #     Required. The collection of entities to override or supplement the custom entity
+          #     type.
+          class SessionEntityType
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The types of modifications for the session entity type.
+            module EntityOverrideMode
+              # Not specified. This value should be never used.
+              ENTITY_OVERRIDE_MODE_UNSPECIFIED = 0
+
+              # The collection of session entities overrides the collection of entities
+              # in the corresponding custom entity type.
+              ENTITY_OVERRIDE_MODE_OVERRIDE = 1
+
+              # The collection of session entities extends the collection of entities in
+              # the corresponding custom entity type.
+              #
+              # Note: Even in this override mode calls to `ListSessionEntityTypes`,
+              # `GetSessionEntityType`, `CreateSessionEntityType` and
+              # `UpdateSessionEntityType` only return the additional entities added in
+              # this session entity type. If you want to get the supplemented list,
+              # please call {::Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client#get_entity_type EntityTypes.GetEntityType} on the custom entity type
+              # and merge.
+              ENTITY_OVERRIDE_MODE_SUPPLEMENT = 2
+            end
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client#list_session_entity_types SessionEntityTypes.ListSessionEntityTypes}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The session to list all session entity types from.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
+          #     ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`.
+          #     If `Environment ID` is not specified, we assume default 'draft'
+          #     environment.
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     The maximum number of items to return in a single page. By default 100 and
+          #     at most 1000.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     The next_page_token value returned from a previous list request.
+          class ListSessionEntityTypesRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response message for {::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client#list_session_entity_types SessionEntityTypes.ListSessionEntityTypes}.
+          # @!attribute [rw] session_entity_types
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::SessionEntityType>]
+          #     The list of session entity types. There will be a maximum number of items
+          #     returned based on the page_size field in the request.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     Token to retrieve the next page of results, or empty if there are no
+          #     more results in the list.
+          class ListSessionEntityTypesResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client#get_session_entity_type SessionEntityTypes.GetSessionEntityType}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the session entity type.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>` or
+          #     `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity
+          #     Type ID>`. If `Environment ID` is not specified, we assume default 'draft'
+          #     environment.
+          class GetSessionEntityTypeRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client#create_session_entity_type SessionEntityTypes.CreateSessionEntityType}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The session to create a session entity type for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/sessions/<Session ID>` or `projects/<Project ID>/locations/<Location
+          #     ID>/agents/<Agent ID>/environments/<Environment ID>/sessions/<Session ID>`.
+          #     If `Environment ID` is not specified, we assume default 'draft'
+          #     environment.
+          # @!attribute [rw] session_entity_type
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::SessionEntityType]
+          #     Required. The session entity type to create.
+          class CreateSessionEntityTypeRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client#update_session_entity_type SessionEntityTypes.UpdateSessionEntityType}.
+          # @!attribute [rw] session_entity_type
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::SessionEntityType]
+          #     Required. The session entity type to update.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>` or
+          #     `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity
+          #     Type ID>`. If `Environment ID` is not specified, we assume default 'draft'
+          #     environment.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     The mask to control which fields get updated.
+          class UpdateSessionEntityTypeRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client#delete_session_entity_type SessionEntityTypes.DeleteSessionEntityType}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the session entity type to delete.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/sessions/<Session ID>/entityTypes/<Entity Type ID>` or
+          #     `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/environments/<Environment ID>/sessions/<Session ID>/entityTypes/<Entity
+          #     Type ID>`. If `Environment ID` is not specified, we assume default 'draft'
+          #     environment.
+          class DeleteSessionEntityTypeRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/dialogflow/cx/v3/test_case.rb

@@ -0,0 +1,757 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Dialogflow
+      module CX
+        module V3
+          # Represents a test case.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The unique identifier of the test case.
+          #     {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#create_test_case TestCases.CreateTestCase} will populate the name automatically.
+          #     Otherwise use format: `projects/<Project ID>/locations/<LocationID>/agents/
+          #     <AgentID>/testCases/<TestCase ID>`.
+          # @!attribute [rw] tags
+          #   @return [::Array<::String>]
+          #     Tags are short descriptions that users may apply to test cases for
+          #     organizational and filtering purposes. Each tag should start with "#" and
+          #     has a limit of 30 characters.
+          # @!attribute [rw] display_name
+          #   @return [::String]
+          #     Required. The human-readable name of the test case, unique within the agent. Limit of
+          #     200 characters.
+          # @!attribute [rw] notes
+          #   @return [::String]
+          #     Additional freeform notes about the test case. Limit of 400 characters.
+          # @!attribute [rw] test_config
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::TestConfig]
+          #     Config for the test case.
+          # @!attribute [rw] test_case_conversation_turns
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ConversationTurn>]
+          #     The conversation turns uttered when the test case was created, in
+          #     chronological order. These include the canonical set of agent utterances
+          #     that should occur when the agent is working properly.
+          # @!attribute [r] creation_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. When the test was created.
+          # @!attribute [rw] last_test_result
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::TestCaseResult]
+          #     The latest test result.
+          class TestCase
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents a result from running a test case in an agent environment.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The resource name for the test case result. Format:
+          #     `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/testCases/
+          #     <TestCase ID>/results/<TestCaseResult ID>`.
+          # @!attribute [rw] environment
+          #   @return [::String]
+          #     Environment where the test was run. If not set, it indicates the draft
+          #     environment.
+          # @!attribute [rw] conversation_turns
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ConversationTurn>]
+          #     The conversation turns uttered during the test case replay in chronological
+          #     order.
+          # @!attribute [rw] test_result
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::TestResult]
+          #     Whether the test case passed in the agent environment.
+          # @!attribute [rw] test_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The time that the test was run.
+          class TestCaseResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents configurations for a test case.
+          # @!attribute [rw] tracking_parameters
+          #   @return [::Array<::String>]
+          #     Session parameters to be compared when calculating differences.
+          # @!attribute [rw] flow
+          #   @return [::String]
+          #     Flow name. If not set, default start flow is assumed.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/flows/<Flow ID>`.
+          class TestConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # One interaction between a human and virtual agent. The human provides some
+          # input and the virtual agent provides a response.
+          # @!attribute [rw] user_input
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::ConversationTurn::UserInput]
+          #     The user input.
+          # @!attribute [rw] virtual_agent_output
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::ConversationTurn::VirtualAgentOutput]
+          #     The virtual agent output.
+          class ConversationTurn
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The input from the human user.
+            # @!attribute [rw] input
+            #   @return [::Google::Cloud::Dialogflow::CX::V3::QueryInput]
+            #     Supports {::Google::Cloud::Dialogflow::CX::V3::QueryInput#text text input}, {::Google::Cloud::Dialogflow::CX::V3::QueryInput#event event input},
+            #     {::Google::Cloud::Dialogflow::CX::V3::QueryInput#dtmf dtmf input} in the test case.
+            # @!attribute [rw] injected_parameters
+            #   @return [::Google::Protobuf::Struct]
+            #     Parameters that need to be injected into the conversation during intent
+            #     detection.
+            # @!attribute [rw] is_webhook_enabled
+            #   @return [::Boolean]
+            #     If webhooks should be allowed to trigger in response to the user
+            #     utterance. Often if parameters are injected, webhooks should not be
+            #     enabled.
+            # @!attribute [rw] enable_sentiment_analysis
+            #   @return [::Boolean]
+            #     Whether sentiment analysis is enabled.
+            class UserInput
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # The output from the virtual agent.
+            # @!attribute [rw] session_parameters
+            #   @return [::Google::Protobuf::Struct]
+            #     The session parameters available to the bot at this point.
+            # @!attribute [r] differences
+            #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::TestRunDifference>]
+            #     Output only. If this is part of a [result conversation
+            #     turn][TestCaseResult.conversation_turns], the list of differences
+            #     between the original run and the replay for this output, if any.
+            # @!attribute [rw] diagnostic_info
+            #   @return [::Google::Protobuf::Struct]
+            #     Required. Input only. The diagnostic
+            #     [info][Session.DetectIntentResponse.QueryResult.diagnostic_info]
+            #     output for the turn.
+            # @!attribute [rw] triggered_intent
+            #   @return [::Google::Cloud::Dialogflow::CX::V3::Intent]
+            #     The {::Google::Cloud::Dialogflow::CX::V3::Intent Intent} that triggered the response. Only name and displayName
+            #     will be set.
+            # @!attribute [rw] current_page
+            #   @return [::Google::Cloud::Dialogflow::CX::V3::Page]
+            #     The {::Google::Cloud::Dialogflow::CX::V3::Page Page} on which the utterance was spoken. Only name and displayName
+            #     will be set.
+            # @!attribute [rw] text_responses
+            #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::Text>]
+            #     The {::Google::Cloud::Dialogflow::CX::V3::ResponseMessage::Text text} responses from the agent for the turn.
+            # @!attribute [rw] status
+            #   @return [::Google::Rpc::Status]
+            #     Response error from the agent in the test result. If set, other output
+            #     is empty.
+            class VirtualAgentOutput
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # The description of differences between original and replayed agent output.
+          # @!attribute [rw] type
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::TestRunDifference::DiffType]
+          #     The type of diff.
+          # @!attribute [rw] description
+          #   @return [::String]
+          #     A description of the diff, showing the actual output vs expected output.
+          class TestRunDifference
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # What part of the message replay differs from the test case.
+            module DiffType
+              # Should never be used.
+              DIFF_TYPE_UNSPECIFIED = 0
+
+              # The intent.
+              INTENT = 1
+
+              # The page.
+              PAGE = 2
+
+              # The parameters.
+              PARAMETERS = 3
+
+              # The message utterance.
+              UTTERANCE = 4
+            end
+          end
+
+          # Transition coverage represents the percentage of all possible page
+          # transitions (page-level transition routes and event handlers, excluding
+          # transition route groups) present within any of a parent's test cases.
+          # @!attribute [rw] transitions
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::TransitionCoverage::Transition>]
+          #     The list of Transitions present in the agent.
+          # @!attribute [rw] coverage_score
+          #   @return [::Float]
+          #     The percent of transitions in the agent that are covered.
+          class TransitionCoverage
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The source or target of a transition.
+            # @!attribute [rw] page
+            #   @return [::Google::Cloud::Dialogflow::CX::V3::Page]
+            #     Indicates a transition to a {::Google::Cloud::Dialogflow::CX::V3::Page Page}. Only some fields such as name and
+            #     displayname will be set.
+            # @!attribute [rw] flow
+            #   @return [::Google::Cloud::Dialogflow::CX::V3::Flow]
+            #     Indicates a transition to a {::Google::Cloud::Dialogflow::CX::V3::Flow Flow}. Only some fields such as name and
+            #     displayname will be set.
+            class TransitionNode
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # A transition in a page.
+            # @!attribute [rw] source
+            #   @return [::Google::Cloud::Dialogflow::CX::V3::TransitionCoverage::TransitionNode]
+            #     The start node of a transition.
+            # @!attribute [rw] index
+            #   @return [::Integer]
+            #     The index of a transition in the transition list. Starting from 0.
+            # @!attribute [rw] target
+            #   @return [::Google::Cloud::Dialogflow::CX::V3::TransitionCoverage::TransitionNode]
+            #     The end node of a transition.
+            # @!attribute [rw] covered
+            #   @return [::Boolean]
+            #     Whether or not the transition is covered by at least one of the
+            #     agent's test cases.
+            # @!attribute [rw] transition_route
+            #   @return [::Google::Cloud::Dialogflow::CX::V3::TransitionRoute]
+            #     Intent route or condition route.
+            # @!attribute [rw] event_handler
+            #   @return [::Google::Cloud::Dialogflow::CX::V3::EventHandler]
+            #     Event handler.
+            class Transition
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Transition route group coverage represents the percentage of all possible
+          # transition routes present within any of a parent's test cases. The results
+          # are grouped by the transition route group.
+          # @!attribute [rw] coverages
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroupCoverage::Coverage>]
+          #     Transition route group coverages.
+          # @!attribute [rw] coverage_score
+          #   @return [::Float]
+          #     The percent of transition routes in all the transition route groups that
+          #     are covered.
+          class TransitionRouteGroupCoverage
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Coverage result message for one transition route group.
+            # @!attribute [rw] route_group
+            #   @return [::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroup]
+            #     Transition route group metadata. Only name and displayName will be set.
+            # @!attribute [rw] transitions
+            #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroupCoverage::Coverage::Transition>]
+            #     The list of transition routes and coverage in the transition route group.
+            # @!attribute [rw] coverage_score
+            #   @return [::Float]
+            #     The percent of transition routes in the transition route group that are
+            #     covered.
+            class Coverage
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # A transition coverage in a transition route group.
+              # @!attribute [rw] transition_route
+              #   @return [::Google::Cloud::Dialogflow::CX::V3::TransitionRoute]
+              #     Intent route or condition route.
+              # @!attribute [rw] covered
+              #   @return [::Boolean]
+              #     Whether or not the transition route is covered by at least one of the
+              #     agent's test cases.
+              class Transition
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
+            end
+          end
+
+          # Intent coverage represents the percentage of all possible intents in the
+          # agent that are triggered in any of a parent's test cases.
+          # @!attribute [rw] intents
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::IntentCoverage::Intent>]
+          #     The list of Intents present in the agent
+          # @!attribute [rw] coverage_score
+          #   @return [::Float]
+          #     The percent of intents in the agent that are covered.
+          class IntentCoverage
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The agent's intent.
+            # @!attribute [rw] intent
+            #   @return [::String]
+            #     The intent full resource name
+            # @!attribute [rw] covered
+            #   @return [::Boolean]
+            #     Whether or not the intent is covered by at least one of the agent's
+            #     test cases.
+            class Intent
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#calculate_coverage TestCases.CalculateCoverage}.
+          # @!attribute [rw] agent
+          #   @return [::String]
+          #     Required. The agent to calculate coverage for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+          # @!attribute [rw] type
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::CalculateCoverageRequest::CoverageType]
+          #     Required. The type of coverage requested.
+          class CalculateCoverageRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The type of coverage score requested.
+            module CoverageType
+              # Should never be used.
+              COVERAGE_TYPE_UNSPECIFIED = 0
+
+              # Intent coverage.
+              INTENT = 1
+
+              # Page transition coverage.
+              PAGE_TRANSITION = 2
+
+              # Transition route group coverage.
+              TRANSITION_ROUTE_GROUP = 3
+            end
+          end
+
+          # The response message for {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#calculate_coverage TestCases.CalculateCoverage}.
+          # @!attribute [rw] agent
+          #   @return [::String]
+          #     The agent to calculate coverage for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+          # @!attribute [rw] intent_coverage
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::IntentCoverage]
+          #     Intent coverage.
+          # @!attribute [rw] transition_coverage
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::TransitionCoverage]
+          #     Transition (excluding transition route groups) coverage.
+          # @!attribute [rw] route_group_coverage
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroupCoverage]
+          #     Transition route group coverage.
+          class CalculateCoverageResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#list_test_cases TestCases.ListTestCases}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The agent to list all pages for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     The maximum number of items to return in a single page. By default 20.
+          #     Note that when TestCaseView = FULL, the maximum page size allowed is 20.
+          #     When TestCaseView = BASIC, the maximum page size allowed is 500.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     The next_page_token value returned from a previous list request.
+          # @!attribute [rw] view
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::ListTestCasesRequest::TestCaseView]
+          #     Specifies whether response should include all fields or just the metadata.
+          class ListTestCasesRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Specifies how much test case information to include in the response.
+            module TestCaseView
+              # The default / unset value.
+              # The API will default to the BASIC view.
+              TEST_CASE_VIEW_UNSPECIFIED = 0
+
+              # Include basic metadata about the test case, but not the conversation
+              # turns. This is the default value.
+              BASIC = 1
+
+              # Include everything.
+              FULL = 2
+            end
+          end
+
+          # The response message for {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#list_test_cases TestCases.ListTestCases}.
+          # @!attribute [rw] test_cases
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::TestCase>]
+          #     The list of test cases. There will be a maximum number of items returned
+          #     based on the page_size field in the request.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     Token to retrieve the next page of results, or empty if there are no more
+          #     results in the list.
+          class ListTestCasesResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#batch_delete_test_cases TestCases.BatchDeleteTestCases}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The agent to delete test cases from.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+          # @!attribute [rw] names
+          #   @return [::Array<::String>]
+          #     Required. Format of test case names: `projects/<Project ID>/locations/
+          #     <Location ID>/agents/<AgentID>/testCases/<TestCase ID>`.
+          class BatchDeleteTestCasesRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#create_test_case TestCases.CreateTestCase}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The agent to create the test case for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+          # @!attribute [rw] test_case
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::TestCase]
+          #     Required. The test case to create.
+          class CreateTestCaseRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#update_test_case TestCases.UpdateTestCase}.
+          # @!attribute [rw] test_case
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::TestCase]
+          #     Required. The test case to update.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     Required. The mask to specify which fields should be updated. The
+          #     {::Google::Cloud::Dialogflow::CX::V3::TestCase#creation_time `creationTime`} and
+          #     {::Google::Cloud::Dialogflow::CX::V3::TestCase#last_test_result `lastTestResult`} cannot be updated.
+          class UpdateTestCaseRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#get_test_case TestCases.GetTestCase}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the testcase.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/testCases/<TestCase ID>`.
+          class GetTestCaseRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#run_test_case TestCases.RunTestCase}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. Format of test case name to run: `projects/<Project ID>/locations/
+          #     <Location ID>/agents/<AgentID>/testCases/<TestCase ID>`.
+          # @!attribute [rw] environment
+          #   @return [::String]
+          #     Optional. Environment name. If not set, draft environment is assumed.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/environments/<Environment ID>`.
+          class RunTestCaseRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response message for {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#run_test_case TestCases.RunTestCase}.
+          # @!attribute [rw] result
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::TestCaseResult]
+          #     The result.
+          class RunTestCaseResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Metadata returned for the {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#run_test_case TestCases.RunTestCase} long running operation.
+          class RunTestCaseMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#batch_run_test_cases TestCases.BatchRunTestCases}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. Agent name. Format: `projects/<Project ID>/locations/<Location ID>/agents/
+          #     <AgentID>`.
+          # @!attribute [rw] environment
+          #   @return [::String]
+          #     Optional. If not set, draft environment is assumed. Format: `projects/<Project
+          #     ID>/locations/<Location ID>/agents/<Agent ID>/environments/<Environment
+          #     ID>`.
+          # @!attribute [rw] test_cases
+          #   @return [::Array<::String>]
+          #     Required. Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/testCases/<TestCase ID>`.
+          class BatchRunTestCasesRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response message for {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#batch_run_test_cases TestCases.BatchRunTestCases}.
+          # @!attribute [rw] results
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::TestCaseResult>]
+          #     The test case results. The detailed
+          #     {::Google::Cloud::Dialogflow::CX::V3::TestCaseResult#conversation_turns conversation turns} are empty in this
+          #     response.
+          class BatchRunTestCasesResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Metadata returned for the {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#batch_run_test_cases TestCases.BatchRunTestCases} long running
+          # operation.
+          # @!attribute [rw] errors
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::TestError>]
+          #     The test errors.
+          class BatchRunTestCasesMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Error info for running a test.
+          # @!attribute [rw] test_case
+          #   @return [::String]
+          #     The test case resource name.
+          # @!attribute [rw] status
+          #   @return [::Google::Rpc::Status]
+          #     The status associated with the test.
+          # @!attribute [rw] test_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The timestamp when the test was completed.
+          class TestError
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#import_test_cases TestCases.ImportTestCases}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The agent to import test cases to.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+          # @!attribute [rw] gcs_uri
+          #   @return [::String]
+          #     The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
+          #     to import test cases from. The format of this URI must be
+          #     `gs://<bucket-name>/<object-name>`.
+          # @!attribute [rw] content
+          #   @return [::String]
+          #     Uncompressed raw byte content for test cases.
+          class ImportTestCasesRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response message for {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#import_test_cases TestCases.ImportTestCases}.
+          # @!attribute [rw] names
+          #   @return [::Array<::String>]
+          #     The unique identifiers of the new test cases.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/testCases/<TestCase ID>`.
+          class ImportTestCasesResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Metadata returned for the {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#import_test_cases TestCases.ImportTestCases} long running
+          # operation.
+          # @!attribute [rw] errors
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::TestCaseError>]
+          #     Errors for failed test cases.
+          class ImportTestCasesMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Error info for importing a test.
+          # @!attribute [rw] test_case
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::TestCase]
+          #     The test case.
+          # @!attribute [rw] status
+          #   @return [::Google::Rpc::Status]
+          #     The status associated with the test case.
+          class TestCaseError
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#export_test_cases TestCases.ExportTestCases}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The agent where to export test cases from.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+          # @!attribute [rw] gcs_uri
+          #   @return [::String]
+          #     The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to
+          #     export the test cases to. The format of this URI must be
+          #     `gs://<bucket-name>/<object-name>`. If unspecified, the serialized test
+          #     cases is returned inline.
+          # @!attribute [rw] data_format
+          #   @return [::Google::Cloud::Dialogflow::CX::V3::ExportTestCasesRequest::DataFormat]
+          #     The data format of the exported test cases. If not specified, `BLOB` is
+          #     assumed.
+          # @!attribute [rw] filter
+          #   @return [::String]
+          #     The filter expression used to filter exported test cases, see
+          #     [API Filtering](https://aip.dev/160). The expression is case insensitive
+          #     and supports the following syntax:
+          #
+          #       name = <value> [OR name = <value>] ...
+          #
+          #     For example:
+          #
+          #     *   "name = t1 OR name = t2" matches the test case with the exact resource
+          #         name "t1" or "t2".
+          class ExportTestCasesRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Data format of the exported test cases.
+            module DataFormat
+              # Unspecified format.
+              DATA_FORMAT_UNSPECIFIED = 0
+
+              # Raw bytes.
+              BLOB = 1
+
+              # JSON format.
+              JSON = 2
+            end
+          end
+
+          # The response message for {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#export_test_cases TestCases.ExportTestCases}.
+          # @!attribute [rw] gcs_uri
+          #   @return [::String]
+          #     The URI to a file containing the exported test cases. This field is
+          #     populated only if `gcs_uri` is specified in
+          #     {::Google::Cloud::Dialogflow::CX::V3::ExportTestCasesRequest ExportTestCasesRequest}.
+          # @!attribute [rw] content
+          #   @return [::String]
+          #     Uncompressed raw byte content for test cases.
+          class ExportTestCasesResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Metadata returned for the {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#export_test_cases TestCases.ExportTestCases} long running
+          # operation.
+          class ExportTestCasesMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#list_test_case_results TestCases.ListTestCaseResults}.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The test case to list results for.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/
+          #     testCases/<TestCase ID>`. Specify a `-` as a wildcard for TestCase ID to
+          #     list results across multiple test cases.
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     The maximum number of items to return in a single page. By default 100 and
+          #     at most 1000.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     The next_page_token value returned from a previous list request.
+          # @!attribute [rw] filter
+          #   @return [::String]
+          #     The filter expression used to filter test case results. See
+          #     [API Filtering](https://aip.dev/160).
+          #
+          #     The expression is case insensitive. Only 'AND' is supported for logical
+          #     operators. The supported syntax is listed below in detail:
+          #
+          #       <field> <operator> <value> [AND <field> <operator> <value>] ...
+          #       [AND latest]
+          #
+          #     The supported fields and operators are:
+          #     field                 operator
+          #     `environment`         `=`, `IN`  (Use value `draft` for draft environment)
+          #     `test_time`           `>`, `<`
+          #
+          #     `latest` only returns the latest test result in all results for each test
+          #     case.
+          #
+          #     Examples:
+          #     *   "environment=draft AND latest" matches the latest test result for each
+          #         test case in the draft environment.
+          #     *   "environment IN (e1,e2)" matches any test case results with an
+          #         environment resource name of either "e1" or "e2".
+          #     *   "test_time > 1602540713" matches any test case results with test time
+          #         later than a unix timestamp in seconds 1602540713.
+          class ListTestCaseResultsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The response message for {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#list_test_case_results TestCases.ListTestCaseResults}.
+          # @!attribute [rw] test_case_results
+          #   @return [::Array<::Google::Cloud::Dialogflow::CX::V3::TestCaseResult>]
+          #     The list of test case results.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     Token to retrieve the next page of results, or empty if there are no more
+          #     results in the list.
+          class ListTestCaseResultsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request message for {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client#get_test_case_result TestCases.GetTestCaseResult}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the testcase.
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>/testCases/<TestCase ID>/results/<TestCaseResult ID>`.
+          class GetTestCaseResultRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The test result for a test case and an agent environment.
+          module TestResult
+            # Not specified. Should never be used.
+            TEST_RESULT_UNSPECIFIED = 0
+
+            # The test passed.
+            PASSED = 1
+
+            # The test did not pass.
+            FAILED = 2
+          end
+        end
+      end
+    end
+  end
+end