google-cloud-discovery_engine-v1beta 0.11.0 → 0.13.0

data/proto_docs/google/cloud/discoveryengine/v1beta/control_service.rb

@@ -0,0 +1,126 @@
+# 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 V1beta
+        # Request for CreateControl method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Full resource name of parent data store. Format:
+        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
+        #     or
+        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
+        # @!attribute [rw] control
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Control]
+        #     Required. The Control to create.
+        # @!attribute [rw] control_id
+        #   @return [::String]
+        #     Required. The ID to use for the Control, which will become the final
+        #     component of the Control's resource name.
+        #
+        #     This value must be within 1-63 characters.
+        #     Valid characters are /[a-z][0-9]-_/.
+        class CreateControlRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for UpdateControl method.
+        # @!attribute [rw] control
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Control]
+        #     Required. The Control to update.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. Indicates which fields in the provided
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Control Control} to update. The
+        #     following are NOT supported:
+        #
+        #     * {::Google::Cloud::DiscoveryEngine::V1beta::Control#name Control.name}
+        #     * {::Google::Cloud::DiscoveryEngine::V1beta::Control#solution_type Control.solution_type}
+        #
+        #     If not set or empty, all supported fields are updated.
+        class UpdateControlRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for DeleteControl method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the Control to delete. Format:
+        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
+        class DeleteControlRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for GetControl method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the Control to get. Format:
+        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
+        class GetControlRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for ListControls method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The data store resource name. Format:
+        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
+        #     or
+        #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Maximum number of results to return. If unspecified, defaults
+        #     to 50. Max allowed value is 1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous `ListControls` call.
+        #     Provide this to retrieve the subsequent page.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. A filter to apply on the list results. Supported features:
+        #
+        #     * List all the products under the parent branch if
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::ListControlsRequest#filter filter} is
+        #     unset. Currently this field is unsupported.
+        class ListControlsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response for ListControls method.
+        # @!attribute [rw] controls
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Control>]
+        #     All the Controls for a given data store.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Pagination token, if not returned indicates the last page.
+        class ListControlsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/discoveryengine/v1beta/conversation.rb

@@ -25,9 +25,9 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Immutable. Fully qualified name
-        #     `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`
+        #     `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*`
         #     or
-        #     `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
+        #     `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.
         # @!attribute [rw] state
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Conversation::State]
         #     The state of the Conversation.

data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb

@@ -247,8 +247,8 @@ module Google
         #
         #     When session field is not set, the API is in sessionless mode.
         #
-        #     We support auto session mode: users can use the wildcard symbol “-” as
-        #     session id.  A new id will be automatically generated and assigned.
+        #     We support auto session mode: users can use the wildcard symbol `-` as
+        #     session ID.  A new ID will be automatically generated and assigned.
         # @!attribute [rw] safety_spec
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SafetySpec]
         #     Model specification.
@@ -347,6 +347,13 @@ module Google
           #     non-answer seeking query. If this field is set to `true`, we skip
           #     generating answers for non-answer seeking queries and return
           #     fallback messages instead.
+          # @!attribute [rw] ignore_low_relevant_content
+          #   @return [::Boolean]
+          #     Specifies whether to filter out queries that have low relevance.
+          #
+          #     If this field is set to `false`, all search results are used regardless
+          #     of relevance to generate answers. If set to `true` or unset, the behavior
+          #     will be determined automatically by the service.
           class AnswerGenerationSpec
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -421,6 +428,18 @@ module Google
             #     [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
             #
             #     If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+            # @!attribute [rw] search_result_mode
+            #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode]
+            #     Specifies the search result mode. If unspecified, the
+            #     search result mode defaults to `DOCUMENTS`.
+            #     See [parse and chunk
+            #     documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
+            # @!attribute [rw] data_store_specs
+            #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec>]
+            #     Specs defining dataStores to filter on in a search call and
+            #     configurations for those dataStores. This is only considered for
+            #     engines with multiple dataStores use case. For single dataStore within
+            #     an engine, they should use the specs at the top level.
             class SearchParams
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -561,7 +580,7 @@ module Google
             # @!attribute [rw] max_rephrase_steps
             #   @return [::Integer]
             #     Max rephrase steps.
-            #     The max number is 10 steps.
+            #     The max number is 5 steps.
             #     If not set or set to < 1, it will be set to 1 by default.
             class QueryRephraserSpec
               include ::Google::Protobuf::MessageExts
@@ -576,8 +595,10 @@ module Google
         # @!attribute [rw] answer
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Answer]
         #     Answer resource object.
-        #     If [AnswerQueryRequest.StepSpec.max_step_count][] is greater than 1,
-        #     use {::Google::Cloud::DiscoveryEngine::V1beta::Answer#name Answer.name} to fetch
+        #     If
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec::QueryRephraserSpec#max_rephrase_steps AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps}
+        #     is greater than 1, use
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Answer#name Answer.name} to fetch
         #     answer information using
         #     {::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::Client#get_answer ConversationalSearchService.GetAnswer}
         #     API.
@@ -587,6 +608,9 @@ module Google
         #     It will be only available when session field is set and valid in the
         #     {::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest AnswerQueryRequest}
         #     request.
+        # @!attribute [rw] answer_query_token
+        #   @return [::String]
+        #     A global unique ID used for logging.
         class AnswerQueryResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb

@@ -0,0 +1,75 @@
+# 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 V1beta
+        # Metadata that describes a custom tuned model.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The fully qualified resource name of the model.
+        #
+        #     Format:
+        #     `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`
+        #     model must be an alpha-numerical string with limit of 40 characters.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     The display name of the model.
+        # @!attribute [rw] model_version
+        #   @return [::Integer]
+        #     The version of the model.
+        # @!attribute [rw] model_state
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::CustomTuningModel::ModelState]
+        #     The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Timestamp the Model was created at.
+        # @!attribute [rw] training_start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Timestamp the model training was initiated.
+        class CustomTuningModel
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The state of the model.
+          module ModelState
+            # Default value.
+            MODEL_STATE_UNSPECIFIED = 0
+
+            # The model is in a paused training state.
+            TRAINING_PAUSED = 1
+
+            # The model is currently training.
+            TRAINING = 2
+
+            # The model has successfully completed training.
+            TRAINING_COMPLETE = 3
+
+            # The model is ready for serving.
+            READY_FOR_SERVING = 4
+
+            # The model training failed.
+            TRAINING_FAILED = 5
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/discoveryengine/v1beta/data_store_service.rb

@@ -124,8 +124,8 @@ module Google
         #     INVALID_ARGUMENT error is returned.
         # @!attribute [rw] filter
         #   @return [::String]
-        #     Filter by solution type. For example: filter =
-        #     'solution_type:SOLUTION_TYPE_SEARCH'
+        #     Filter by solution type .
+        #     For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`
         class ListDataStoresRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb

@@ -92,7 +92,7 @@ module Google
           #   @return [::String]
           #     The URI of the content. Only Cloud Storage URIs (e.g.
           #     `gs://bucket-name/path/to/file`) are supported. The maximum file size
-          #     is 2.5 MB for text-based formats, 100 MB for other formats.
+          #     is 2.5 MB for text-based formats, 200 MB for other formats.
           # @!attribute [rw] mime_type
           #   @return [::String]
           #     The MIME type of the content. Supported types:

data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb

@@ -32,6 +32,9 @@ module Google
         #     The full resource name of the Document Processing Config.
         #     Format:
         #     `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
+        # @!attribute [rw] chunking_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig::ChunkingConfig]
+        #     Whether chunking mode is enabled.
         # @!attribute [rw] default_parsing_config
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig::ParsingConfig]
         #     Configurations for default Document parser.
@@ -42,16 +45,46 @@ module Google
         #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig::ParsingConfig}]
         #     Map from file type to override the default parsing configuration based on
         #     the file type. Supported keys:
+        #
         #     * `pdf`: Override parsing config for PDF files, either digital parsing, ocr
         #     parsing or layout parsing is supported.
         #     * `html`: Override parsing config for HTML files, only digital parsing and
-        #     or layout parsing are supported.
+        #     layout parsing are supported.
         #     * `docx`: Override parsing config for DOCX files, only digital parsing and
-        #     or layout parsing are supported.
+        #     layout parsing are supported.
+        #     * `pptx`: Override parsing config for PPTX files, only digital parsing and
+        #     layout parsing are supported.
         class DocumentProcessingConfig
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
+          # Configuration for chunking config.
+          # @!attribute [rw] layout_based_chunking_config
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig::ChunkingConfig::LayoutBasedChunkingConfig]
+          #     Configuration for the layout based chunking.
+          class ChunkingConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Configuration for the layout based chunking.
+            # @!attribute [rw] chunk_size
+            #   @return [::Integer]
+            #     The token size limit for each chunk.
+            #
+            #     Supported values: 100-500 (inclusive).
+            #     Default value: 500.
+            # @!attribute [rw] include_ancestor_headings
+            #   @return [::Boolean]
+            #     Whether to include appending different levels of headings to chunks
+            #     from the middle of the document to prevent context loss.
+            #
+            #     Default value: False.
+            class LayoutBasedChunkingConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
           # Related configurations applied to a specific type of document parser.
           # @!attribute [rw] digital_parsing_config
           #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig::ParsingConfig::DigitalParsingConfig]
@@ -60,6 +93,9 @@ module Google
           #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig::ParsingConfig::OcrParsingConfig]
           #     Configurations applied to OCR parser. Currently it only applies to
           #     PDFs.
+          # @!attribute [rw] layout_parsing_config
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig::ParsingConfig::LayoutParsingConfig]
+          #     Configurations applied to layout parser.
           class ParsingConfig
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -84,6 +120,12 @@ module Google
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
+
+            # The layout parsing configurations for documents.
+            class LayoutParsingConfig
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
           end
 
           # @!attribute [rw] key

data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb

@@ -59,7 +59,7 @@ module Google
         #   @return [::Integer]
         #     Maximum number of {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s
         #     to return. If unspecified, defaults to 100. The maximum allowed value is
-        #     1000. Values above 1000 will be coerced to 1000.
+        #     1000. Values above 1000 are set to 1000.
         #
         #     If this field is negative, an `INVALID_ARGUMENT` error is returned.
         # @!attribute [rw] page_token
@@ -110,8 +110,8 @@ module Google
         # @!attribute [rw] document_id
         #   @return [::String]
         #     Required. The ID to use for the
-        #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}, which will become
-        #     the final component of the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}, which becomes the
+        #     final component of the
         #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#name Document.name}.
         #
         #     If the caller does not have permission to create the
@@ -148,14 +148,13 @@ module Google
         #     is not set, a `NOT_FOUND` error is returned.
         # @!attribute [rw] allow_missing
         #   @return [::Boolean]
-        #     If set to true, and the
+        #     If set to `true` and the
         #     {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} is not found, a
-        #     new {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} will be
-        #     created.
+        #     new {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} is be created.
         # @!attribute [rw] update_mask
         #   @return [::Google::Protobuf::FieldMask]
         #     Indicates which fields in the provided imported 'document' to update. If
-        #     not set, will by default update all fields.
+        #     not set, by default updates all fields.
         class UpdateDocumentRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -94,7 +94,7 @@ module Google
         #     The restriction of the Engine industry vertical is based on
         #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}: If unspecified,
         #     default to `GENERIC`. Vertical on Engine has to match vertical of the
-        #     DataStore liniked to the engine.
+        #     DataStore linked to the engine.
         # @!attribute [rw] common_config
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::CommonConfig]
         #     Common config spec that specifies the metadata of the engine.
@@ -192,8 +192,8 @@ module Google
           # 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.
+          #     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