google-cloud-dialogflow-v2 0.1.0

data/proto_docs/google/cloud/dialogflow/v2/session_entity_type.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 V2
+        # Represents a session entity type.
+        #
+        # Extends or replaces a 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.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Required. The unique identifier of this session entity type. Format:
+        #     `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
+        #     Display Name>`.
+        #
+        #     `<Entity Type Display Name>` must be the display name of an existing entity
+        #     type in the same agent that will be overridden or supplemented.
+        # @!attribute [rw] entity_override_mode
+        #   @return [Google::Cloud::Dialogflow::V2::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::V2::EntityType::Entity>]
+        #     Required. The collection of entities associated with this session entity
+        #     type.
+        class SessionEntityType
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+
+          # The types of modifications for a 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::V2::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::V2::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>/agent/sessions/<Session ID>`.
+        # @!attribute [rw] page_size
+        #   @return [Integer]
+        #     Optional. The maximum number of items to return in a single page. By
+        #     default 100 and at most 1000.
+        # @!attribute [rw] page_token
+        #   @return [String]
+        #     Optional. 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::V2::SessionEntityTypes::Client#list_session_entity_types SessionEntityTypes.ListSessionEntityTypes}.
+        # @!attribute [rw] session_entity_types
+        #   @return [Array<Google::Cloud::Dialogflow::V2::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::V2::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>/agent/sessions/<Session ID>/entityTypes/<Entity Type
+        #     Display Name>`.
+        class GetSessionEntityTypeRequest
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for {Google::Cloud::Dialogflow::V2::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>/agent/sessions/<Session ID>`.
+        # @!attribute [rw] session_entity_type
+        #   @return [Google::Cloud::Dialogflow::V2::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::V2::SessionEntityTypes::Client#update_session_entity_type SessionEntityTypes.UpdateSessionEntityType}.
+        # @!attribute [rw] session_entity_type
+        #   @return [Google::Cloud::Dialogflow::V2::SessionEntityType]
+        #     Required. The entity type to update. Format:
+        #     `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
+        #     Display Name>`.
+        # @!attribute [rw] update_mask
+        #   @return [Google::Protobuf::FieldMask]
+        #     Optional. 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::V2::SessionEntityTypes::Client#delete_session_entity_type SessionEntityTypes.DeleteSessionEntityType}.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     Required. The name of the entity type to delete. Format:
+        #     `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type
+        #     Display Name>`.
+        class DeleteSessionEntityTypeRequest
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/dialogflow/v2/validation_result.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 V2
+        # Represents a single validation error.
+        # @!attribute [rw] severity
+        #   @return [Google::Cloud::Dialogflow::V2::ValidationError::Severity]
+        #     The severity of the error.
+        # @!attribute [rw] entries
+        #   @return [Array<String>]
+        #     The names of the entries that the error is associated with.
+        #     Format:
+        #
+        #     - "projects/<Project ID>/agent", if the error is associated with the entire
+        #     agent.
+        #     - "projects/<Project ID>/agent/intents/<Intent ID>", if the error is
+        #     associated with certain intents.
+        #     - "projects/<Project
+        #     ID>/agent/intents/<Intent Id>/trainingPhrases/<Training Phrase ID>", if the
+        #     error is associated with certain intent training phrases.
+        #     - "projects/<Project ID>/agent/intents/<Intent Id>/parameters/<Parameter
+        #     ID>", if the error is associated with certain intent parameters.
+        #     - "projects/<Project ID>/agent/entities/<Entity ID>", if the error is
+        #     associated with certain entities.
+        # @!attribute [rw] error_message
+        #   @return [String]
+        #     The detailed error messsage.
+        class ValidationError
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+
+          # Represents a level of severity.
+          module Severity
+            # Not specified. This value should never be used.
+            SEVERITY_UNSPECIFIED = 0
+
+            # The agent doesn't follow Dialogflow best practicies.
+            INFO = 1
+
+            # The agent may not behave as expected.
+            WARNING = 2
+
+            # The agent may experience partial failures.
+            ERROR = 3
+
+            # The agent may completely fail.
+            CRITICAL = 4
+          end
+        end
+
+        # Represents the output of agent validation.
+        # @!attribute [rw] validation_errors
+        #   @return [Array<Google::Cloud::Dialogflow::V2::ValidationError>]
+        #     Contains all validation errors.
+        class ValidationResult
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/dialogflow/v2/webhook.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 V2
+        # The request message for a webhook call.
+        # @!attribute [rw] session
+        #   @return [String]
+        #     The unique identifier of detectIntent request session.
+        #     Can be used to identify end-user inside webhook implementation.
+        #     Format: `projects/<Project ID>/agent/sessions/<Session ID>`, or
+        #     `projects/<Project ID>/agent/environments/<Environment ID>/users/<User
+        #     ID>/sessions/<Session ID>`.
+        # @!attribute [rw] response_id
+        #   @return [String]
+        #     The unique identifier of the response. Contains the same value as
+        #     `[Streaming]DetectIntentResponse.response_id`.
+        # @!attribute [rw] query_result
+        #   @return [Google::Cloud::Dialogflow::V2::QueryResult]
+        #     The result of the conversational query or event processing. Contains the
+        #     same value as `[Streaming]DetectIntentResponse.query_result`.
+        # @!attribute [rw] original_detect_intent_request
+        #   @return [Google::Cloud::Dialogflow::V2::OriginalDetectIntentRequest]
+        #     Optional. The contents of the original request that was passed to
+        #     `[Streaming]DetectIntent` call.
+        class WebhookRequest
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # 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 {Google::Cloud::Dialogflow::V2::QueryResult#diagnostic_info 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 `{}` or `null` for empty objects
+        # - Use `[]` or `null` for empty arrays
+        #
+        # For more information, see the
+        # [Protocol Buffers Language
+        # Guide](https://developers.google.com/protocol-buffers/docs/proto3#json).
+        # @!attribute [rw] fulfillment_text
+        #   @return [String]
+        #     Optional. The text to be shown on the screen. This value is passed directly
+        #     to `QueryResult.fulfillment_text`.
+        # @!attribute [rw] fulfillment_messages
+        #   @return [Array<Google::Cloud::Dialogflow::V2::Intent::Message>]
+        #     Optional. The collection of rich messages to present to the user. This
+        #     value is passed directly to `QueryResult.fulfillment_messages`.
+        # @!attribute [rw] source
+        #   @return [String]
+        #     Optional. This value is passed directly to `QueryResult.webhook_source`.
+        # @!attribute [rw] payload
+        #   @return [Google::Protobuf::Struct]
+        #     Optional. This value is passed directly to `QueryResult.webhook_payload`.
+        #     See the related `fulfillment_messages[i].payload field`, which may be used
+        #     as an alternative to this field.
+        #
+        #     This field can be used for Actions on Google responses.
+        #     It should have a structure similar to the JSON message shown here. For more
+        #     information, see
+        #     [Actions on Google Webhook
+        #     Format](https://developers.google.com/actions/dialogflow/webhook)
+        #     <pre>{
+        #       "google": {
+        #         "expectUserResponse": true,
+        #         "richResponse": {
+        #           "items": [
+        #             {
+        #               "simpleResponse": {
+        #                 "textToSpeech": "this is a simple response"
+        #               }
+        #             }
+        #           ]
+        #         }
+        #       }
+        #     }</pre>
+        # @!attribute [rw] output_contexts
+        #   @return [Array<Google::Cloud::Dialogflow::V2::Context>]
+        #     Optional. The collection of output contexts. This value is passed directly
+        #     to `QueryResult.output_contexts`.
+        # @!attribute [rw] followup_event_input
+        #   @return [Google::Cloud::Dialogflow::V2::EventInput]
+        #     Optional. Makes the platform immediately invoke another `DetectIntent` call
+        #     internally with the specified event as input.
+        #     When this field is set, Dialogflow ignores the `fulfillment_text`,
+        #     `fulfillment_messages`, and `payload` fields.
+        # @!attribute [rw] session_entity_types
+        #   @return [Array<Google::Cloud::Dialogflow::V2::SessionEntityType>]
+        #     Optional. Additional session entity types to replace or extend developer
+        #     entity types with. The entity synonyms apply to all languages and persist
+        #     for the session of this query. Setting the session entity types inside
+        #     webhook overwrites the session entity types that have been set through
+        #     `DetectIntentRequest.query_params.session_entity_types`.
+        class WebhookResponse
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Represents the contents of the original request that was passed to
+        # the `[Streaming]DetectIntent` call.
+        # @!attribute [rw] source
+        #   @return [String]
+        #     The source of this request, e.g., `google`, `facebook`, `slack`. It is set
+        #     by Dialogflow-owned servers.
+        # @!attribute [rw] version
+        #   @return [String]
+        #     Optional. The version of the protocol used for this request.
+        #     This field is AoG-specific.
+        # @!attribute [rw] payload
+        #   @return [Google::Protobuf::Struct]
+        #     Optional. This field is set to the value of the `QueryParameters.payload`
+        #     field passed in the request. Some integrations that query a Dialogflow
+        #     agent may provide additional information in the payload.
+        #
+        #     In particular for the Telephony Gateway this field has the form:
+        #     <pre>{
+        #      "telephony": {
+        #        "caller_id": "+18558363987"
+        #      }
+        #     }</pre>
+        #     Note: The caller ID field (`caller_id`) will be redacted for Standard
+        #     Edition agents and populated with the caller ID in [E.164
+        #     format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents.
+        class OriginalDetectIntentRequest
+          include Google::Protobuf::MessageExts
+          extend Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/longrunning/operations.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 Longrunning
+    # This resource represents a long-running operation that is the result of a
+    # network API call.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     The server-assigned name, which is only unique within the same service that
+    #     originally returns it. If you use the default HTTP mapping, the
+    #     `name` should have the format of `operations/some/unique/name`.
+    # @!attribute [rw] metadata
+    #   @return [Google::Protobuf::Any]
+    #     Service-specific metadata associated with the operation.  It typically
+    #     contains progress information and common metadata such as create time.
+    #     Some services might not provide such metadata.  Any method that returns a
+    #     long-running operation should document the metadata type, if any.
+    # @!attribute [rw] done
+    #   @return [Boolean]
+    #     If the value is `false`, it means the operation is still in progress.
+    #     If true, the operation is completed, and either `error` or `response` is
+    #     available.
+    # @!attribute [rw] error
+    #   @return [Google::Rpc::Status]
+    #     The error result of the operation in case of failure or cancellation.
+    # @!attribute [rw] response
+    #   @return [Google::Protobuf::Any]
+    #     The normal response of the operation in case of success.  If the original
+    #     method returns no data on success, such as `Delete`, the response is
+    #     `google.protobuf.Empty`.  If the original method is standard
+    #     `Get`/`Create`/`Update`, the response should be the resource.  For other
+    #     methods, the response should have the type `XxxResponse`, where `Xxx`
+    #     is the original method name.  For example, if the original method name
+    #     is `TakeSnapshot()`, the inferred response type is
+    #     `TakeSnapshotResponse`.
+    class Operation
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.GetOperation.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     The name of the operation resource.
+    class GetOperationRequest
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.ListOperations.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     The name of the operation collection.
+    # @!attribute [rw] filter
+    #   @return [String]
+    #     The standard list filter.
+    # @!attribute [rw] page_size
+    #   @return [Integer]
+    #     The standard list page size.
+    # @!attribute [rw] page_token
+    #   @return [String]
+    #     The standard list page token.
+    class ListOperationsRequest
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The response message for Operations.ListOperations.
+    # @!attribute [rw] operations
+    #   @return [Array<Google::Longrunning::Operation>]
+    #     A list of operations that matches the specified filter in the request.
+    # @!attribute [rw] next_page_token
+    #   @return [String]
+    #     The standard List next-page token.
+    class ListOperationsResponse
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.CancelOperation.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     The name of the operation resource to be cancelled.
+    class CancelOperationRequest
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # The request message for Operations.DeleteOperation.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     The name of the operation resource to be deleted.
+    class DeleteOperationRequest
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+    end
+
+    # A message representing the message types used by a long-running operation.
+    #
+    # Example:
+    #
+    #   rpc LongRunningRecognize(LongRunningRecognizeRequest)
+    #       returns (google.longrunning.Operation) {
+    #     option (google.longrunning.operation_info) = {
+    #       response_type: "LongRunningRecognizeResponse"
+    #       metadata_type: "LongRunningRecognizeMetadata"
+    #     };
+    #   }
+    # @!attribute [rw] response_type
+    #   @return [String]
+    #     Required. The message name of the primary return type for this
+    #     long-running operation.
+    #     This type will be used to deserialize the LRO's response.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    # @!attribute [rw] metadata_type
+    #   @return [String]
+    #     Required. The message name of the metadata type for this long-running
+    #     operation.
+    #
+    #     If the response is in a different package from the rpc, a fully-qualified
+    #     message name must be used (e.g. `google.protobuf.Struct`).
+    #
+    #     Note: Altering this value constitutes a breaking change.
+    class OperationInfo
+      include Google::Protobuf::MessageExts
+      extend Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end