google-cloud-discovery_engine-v1 0.4.2 → 0.6.0

data/proto_docs/google/cloud/discoveryengine/v1/engine.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module V1
+        # Metadata that describes the training and serving parameters of an
+        # {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}.
+        # @!attribute [rw] chat_engine_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig]
+        #     Configurations for the Chat Engine. Only applicable if
+        #     {::Google::Cloud::DiscoveryEngine::V1::Engine#solution_type solution_type} is
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT}.
+        # @!attribute [rw] search_engine_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::SearchEngineConfig]
+        #     Configurations for the Search Engine. Only applicable if
+        #     {::Google::Cloud::DiscoveryEngine::V1::Engine#solution_type solution_type} is
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
+        # @!attribute [r] chat_engine_metadata
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata]
+        #     Output only. Additional information of the Chat Engine. Only applicable
+        #     if {::Google::Cloud::DiscoveryEngine::V1::Engine#solution_type solution_type}
+        #     is
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT}.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. The fully qualified resource name of the engine.
+        #
+        #     This field must be a UTF-8 encoded string with a length limit of 1024
+        #     characters.
+        #
+        #     Format:
+        #     `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`
+        #     engine should be 1-63 characters, and valid characters are
+        #     /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     Required. The display name of the engine. Should be human readable. UTF-8
+        #     encoded string with limit of 1024 characters.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp the Recommendation Engine was created at.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp the Recommendation Engine was last updated.
+        # @!attribute [rw] data_store_ids
+        #   @return [::Array<::String>]
+        #     The data stores associated with this engine.
+        #
+        #     For
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}
+        #     and
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}
+        #     type of engines, they can only associate with at most one data store.
+        #
+        #     If {::Google::Cloud::DiscoveryEngine::V1::Engine#solution_type solution_type} is
+        #     {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT},
+        #     multiple {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}s in the
+        #     same [Collection][google.cloud.discoveryengine.v1.Collection] can be
+        #     associated here.
+        #
+        #     Note that when used in
+        #     {::Google::Cloud::DiscoveryEngine::V1::CreateEngineRequest CreateEngineRequest},
+        #     one DataStore id must be provided as the system will use it for necessary
+        #     initializations.
+        # @!attribute [rw] solution_type
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::SolutionType]
+        #     Required. The solutions of the engine.
+        # @!attribute [rw] industry_vertical
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::IndustryVertical]
+        #     The industry vertical that the engine registers.
+        #     The restriction of the Engine industry vertical is based on
+        #     {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}: If unspecified,
+        #     default to `GENERIC`. Vertical on Engine has to match vertical of the
+        #     DataStore liniked to the engine.
+        # @!attribute [rw] common_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::CommonConfig]
+        #     Common config spec that specifies the metadata of the engine.
+        class Engine
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Configurations for a Search Engine.
+          # @!attribute [rw] search_tier
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
+          #     The search feature tier of this engine.
+          #
+          #     Different tiers might have different
+          #     pricing. To learn more, please check the pricing documentation.
+          #
+          #     Defaults to
+          #     {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
+          #     if not specified.
+          # @!attribute [rw] search_add_ons
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
+          #     The add-on that this search engine enables.
+          class SearchEngineConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Configurations for a Chat Engine.
+          # @!attribute [rw] agent_creation_config
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
+          #     The configurationt generate the Dialogflow agent that is associated to
+          #     this Engine.
+          #
+          #     Note that these configurations are one-time consumed by
+          #     and passed to Dialogflow service. It means they cannot be retrieved using
+          #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
+          #     or
+          #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
+          #     API after engine creation.
+          # @!attribute [rw] dialogflow_agent_to_link
+          #   @return [::String]
+          #     The resource name of an exist Dialogflow agent to link to this Chat
+          #     Engine. Customers can either provide `agent_creation_config` to create
+          #     agent or provide an agent name that links the agent with the Chat engine.
+          #
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>`.
+          #
+          #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
+          #     passed to Dialogflow service. It means they cannot be retrieved using
+          #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
+          #     or
+          #     {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
+          #     API after engine creation. Please use
+          #     {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
+          #     for actual agent association after Engine is created.
+          class ChatEngineConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Configurations for generating a Dialogflow agent.
+            #
+            # Note that these configurations are one-time consumed by
+            # and passed to Dialogflow service. It means they cannot be retrieved using
+            # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
+            # or
+            # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
+            # API after engine creation.
+            # @!attribute [rw] business
+            #   @return [::String]
+            #     Name of the company, organization or other entity that the agent
+            #     represents. Used for knowledge connector LLM prompt and for knowledge
+            #     search.
+            # @!attribute [rw] default_language_code
+            #   @return [::String]
+            #     Required. The default language of the agent as a language tag.
+            #     See [Language
+            #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
+            #     for a list of the currently supported language codes.
+            # @!attribute [rw] time_zone
+            #   @return [::String]
+            #     Required. The time zone of the agent from the [time zone
+            #     database](https://www.iana.org/time-zones), e.g., America/New_York,
+            #     Europe/Paris.
+            # @!attribute [rw] location
+            #   @return [::String]
+            #     Agent location for Agent creation, supported values: global/us/eu.
+            #     If not provided, us Engine will create Agent using us-central-1 by
+            #     default; eu Engine will create Agent using eu-west-1 by default.
+            class AgentCreationConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Common configurations for an Engine.
+          # @!attribute [rw] company_name
+          #   @return [::String]
+          #     Immutable. The name of the company, business or entity that is associated
+          #     with the engine. Setting this may help improve LLM related features.
+          class CommonConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Additional information of a Chat Engine.
+          # Fields in this message are output only.
+          # @!attribute [rw] dialogflow_agent
+          #   @return [::String]
+          #     The resource name of a Dialogflow agent, that this Chat Engine refers
+          #     to.
+          #
+          #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+          #     ID>`.
+          class ChatEngineMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/discoveryengine/v1/engine_service.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module V1
+        # Request for
+        # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#create_engine EngineService.CreateEngine}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource name, such as
+        #     `projects/{project}/locations/{location}/collections/{collection}`.
+        # @!attribute [rw] engine
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine]
+        #     Required. The {::Google::Cloud::DiscoveryEngine::V1::Engine Engine} to create.
+        # @!attribute [rw] engine_id
+        #   @return [::String]
+        #     Required. The ID to use for the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}, which will become the
+        #     final component of the {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}'s
+        #     resource name.
+        #
+        #     This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
+        #     standard with a length limit of 63 characters. Otherwise, an
+        #     INVALID_ARGUMENT error is returned.
+        class CreateEngineRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the
+        # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#create_engine EngineService.CreateEngine}
+        # operation. This will be returned by the google.longrunning.Operation.metadata
+        # field.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation create time.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation last update time. If the operation is done, this is also the
+        #     finish time.
+        class CreateEngineMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#delete_engine EngineService.DeleteEngine}
+        # method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Full resource name of
+        #     {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}, such as
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
+        #
+        #     If the caller does not have permission to delete the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}, regardless of whether or
+        #     not it exists, a PERMISSION_DENIED error is returned.
+        #
+        #     If the {::Google::Cloud::DiscoveryEngine::V1::Engine Engine} to delete does not
+        #     exist, a NOT_FOUND error is returned.
+        class DeleteEngineRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the
+        # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#delete_engine EngineService.DeleteEngine}
+        # operation. This will be returned by the google.longrunning.Operation.metadata
+        # field.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation create time.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation last update time. If the operation is done, this is also the
+        #     finish time.
+        class DeleteEngineMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
+        # method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Full resource name of
+        #     {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}, such as
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
+        class GetEngineRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource name, such as
+        #     `projects/{project}/locations/{location}/collections/{collection_id}`.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Not supported.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. Not supported.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. Filter by solution type. For example:
+        #     solution_type=SOLUTION_TYPE_SEARCH
+        class ListEnginesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
+        # method.
+        # @!attribute [rw] engines
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Engine>]
+        #     All the customer's {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}s.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Not supported.
+        class ListEnginesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#update_engine EngineService.UpdateEngine}
+        # method.
+        # @!attribute [rw] engine
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Engine]
+        #     Required. The {::Google::Cloud::DiscoveryEngine::V1::Engine Engine} to update.
+        #
+        #     If the caller does not have permission to update the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}, regardless of whether or
+        #     not it exists, a PERMISSION_DENIED error is returned.
+        #
+        #     If the {::Google::Cloud::DiscoveryEngine::V1::Engine Engine} to update does not
+        #     exist, a NOT_FOUND error is returned.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Indicates which fields in the provided
+        #     {::Google::Cloud::DiscoveryEngine::V1::Engine Engine} to update.
+        #
+        #     If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
+        #     is returned.
+        class UpdateEngineRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb

@@ -334,6 +334,72 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::CompletionService::Client#import_suggestion_deny_list_entries CompletionService.ImportSuggestionDenyListEntries}
+        # method.
+        # @!attribute [rw] inline_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::ImportSuggestionDenyListEntriesRequest::InlineSource]
+        #     The Inline source for the input content for suggestion deny list entries.
+        # @!attribute [rw] gcs_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::GcsSource]
+        #     Cloud Storage location for the input content.
+        #
+        #     Only 1 file can be specified that contains all entries to import.
+        #     Supported values `gcs_source.schema` for autocomplete suggestion deny
+        #     list entry imports:
+        #
+        #     * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry]
+        #     per line.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent data store resource name for which to import denylist
+        #     entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
+        class ImportSuggestionDenyListEntriesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The inline source for SuggestionDenyListEntry.
+          # @!attribute [rw] entries
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SuggestionDenyListEntry>]
+          #     Required. A list of all denylist entries to import. Max of 1000 items.
+          class InlineSource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1::CompletionService::Client#import_suggestion_deny_list_entries CompletionService.ImportSuggestionDenyListEntries}
+        # method.
+        # @!attribute [rw] error_samples
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     A sample of errors encountered while processing the request.
+        # @!attribute [rw] imported_entries_count
+        #   @return [::Integer]
+        #     Count of deny list entries successfully imported.
+        # @!attribute [rw] failed_entries_count
+        #   @return [::Integer]
+        #     Count of deny list entries that failed to be imported.
+        class ImportSuggestionDenyListEntriesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the ImportSuggestionDenyListEntries
+        # operation. This is returned by the google.longrunning.Operation.metadata
+        # field.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation create time.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation last update time. If the operation is done, this is also the
+        #     finish time.
+        class ImportSuggestionDenyListEntriesMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

data/proto_docs/google/cloud/discoveryengine/v1/purge_config.rb

@@ -78,6 +78,47 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::CompletionService::Client#purge_suggestion_deny_list_entries CompletionService.PurgeSuggestionDenyListEntries}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent data store resource name for which to import denylist
+        #     entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
+        class PurgeSuggestionDenyListEntriesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1::CompletionService::Client#purge_suggestion_deny_list_entries CompletionService.PurgeSuggestionDenyListEntries}
+        # method.
+        # @!attribute [rw] purge_count
+        #   @return [::Integer]
+        #     Number of suggestion deny list entries purged.
+        # @!attribute [rw] error_samples
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     A sample of errors encountered while processing the request.
+        class PurgeSuggestionDenyListEntriesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the PurgeSuggestionDenyListEntries
+        # operation. This is returned by the google.longrunning.Operation.metadata
+        # field.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation create time.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation last update time. If the operation is done, this is also the
+        #     finish time.
+        class PurgeSuggestionDenyListEntriesMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end