google-apis-discoveryengine_v1alpha 0.38.0 → 0.39.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9e25f816eeee6bc3cb74ea8b3ff5057a078e5f37c7987f7e439e28d0c371470
-  data.tar.gz: 56a5aa458029eddca8dd0b098597d0210f43470b7c5dc1602eadb5aa35954f32
+  metadata.gz: 7f69c25fa5eb9499ef358d5ff65686c8b0c703fedabd02d2639d9a38825b5fbf
+  data.tar.gz: defab04a61a4fd91528bac55521a3dcd8c352065ecdb40da17dbc7b6d4905f10
 SHA512:
-  metadata.gz: ef6adf8cc1c10a0835677ddfba32be1584f15a5466713310d5a2121a291a509c5e9459afb7fce331520469c317159dd0f206f389e936c81cf5c50530e401418e
-  data.tar.gz: 611bfc46fff73d591c9dc236aa5557dccb257dba9552a3b5e25b790549ae5660419a081ffeff0cd9d6ee01e01148e6e3d3f986c16fa120fa9e48591b469a9eba
+  metadata.gz: 6f4156d1949151b4eb7fe9ac1f2fccd1edb2b2ae9ed5357b335366e5df57334e963f0538c9e34aa1ab0828df491f8150401deebdc65d7f04b00b2e094c6b6ae4
+  data.tar.gz: e46077bdc0bbd22dd881e1915b3eb287af8b3b73570ae0a116c6b39003354e168baec9d64f7ad3946aca96869065004c302aa78aafe93bae9b6493de8fa2cf9d

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-discoveryengine_v1alpha
 
+### v0.39.0 (2024-03-10)
+
+* Regenerated from discovery document revision 20240229
+
 ### v0.38.0 (2024-03-03)
 
 * Regenerated from discovery document revision 20240227

data/lib/google/apis/discoveryengine_v1alpha/classes.rb

@@ -1823,6 +1823,81 @@ module Google
         end
       end
       
+      # Chunk captures all raw metadata information of items to be recommended or
+      # searched in the chunk mode.
+      class GoogleCloudDiscoveryengineV1alphaChunk
+        include Google::Apis::Core::Hashable
+      
+        # Content is a string from a document (parsed content).
+        # Corresponds to the JSON property `content`
+        # @return [String]
+        attr_accessor :content
+      
+        # Output only. This field is OUTPUT_ONLY. It contains derived data that are not
+        # in the original input document.
+        # Corresponds to the JSON property `derivedStructData`
+        # @return [Hash<String,Object>]
+        attr_accessor :derived_struct_data
+      
+        # Document metadata contains the information of the document of the current
+        # chunk.
+        # Corresponds to the JSON property `documentMetadata`
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata]
+        attr_accessor :document_metadata
+      
+        # Unique chunk id of the current chunk.
+        # Corresponds to the JSON property `id`
+        # @return [String]
+        attr_accessor :id
+      
+        # The full resource name of the chunk. Format: `projects/`project`/locations/`
+        # location`/collections/`collection`/dataStores/`data_store`/branches/`branch`/
+        # documents/`document_id`/chunks/`chunk_id``. This field must be a UTF-8 encoded
+        # string with a length limit of 1024 characters.
+        # Corresponds to the JSON property `name`
+        # @return [String]
+        attr_accessor :name
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @content = args[:content] if args.key?(:content)
+          @derived_struct_data = args[:derived_struct_data] if args.key?(:derived_struct_data)
+          @document_metadata = args[:document_metadata] if args.key?(:document_metadata)
+          @id = args[:id] if args.key?(:id)
+          @name = args[:name] if args.key?(:name)
+        end
+      end
+      
+      # Document metadata contains the information of the document of the current
+      # chunk.
+      class GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata
+        include Google::Apis::Core::Hashable
+      
+        # Title of the document.
+        # Corresponds to the JSON property `title`
+        # @return [String]
+        attr_accessor :title
+      
+        # Uri of the document.
+        # Corresponds to the JSON property `uri`
+        # @return [String]
+        attr_accessor :uri
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @title = args[:title] if args.key?(:title)
+          @uri = args[:uri] if args.key?(:uri)
+        end
+      end
+      
       # Request message for CompletionService.CompleteQuery method.
       class GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest
         include Google::Apis::Core::Hashable
@@ -1857,7 +1932,7 @@ module Google
         # imported search events. * `document-completable` - Using suggestions taken
         # directly from user-imported document fields marked as completable. Default
         # values: * `document` is the default model for regular dataStores. * `search-
-        # history` is the default model for site search dataStores.
+        # history` is the default model for site search dataStores. *
         # Corresponds to the JSON property `queryModel`
         # @return [String]
         attr_accessor :query_model
@@ -2906,6 +2981,11 @@ module Google
       class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
         include Google::Apis::Core::Hashable
       
+        # Configuration for chunking config.
+        # Corresponds to the JSON property `chunkingConfig`
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig]
+        attr_accessor :chunking_config
+      
         # Related configurations applied to a specific type of document parser.
         # Corresponds to the JSON property `defaultParsingConfig`
         # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig]
@@ -2938,6 +3018,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @chunking_config = args[:chunking_config] if args.key?(:chunking_config)
           @default_parsing_config = args[:default_parsing_config] if args.key?(:default_parsing_config)
           @name = args[:name] if args.key?(:name)
           @ocr_config = args[:ocr_config] if args.key?(:ocr_config)
@@ -2945,6 +3026,53 @@ module Google
         end
       end
       
+      # Configuration for chunking config.
+      class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig
+        include Google::Apis::Core::Hashable
+      
+        # Configuration for the layout based chunking.
+        # Corresponds to the JSON property `layoutBasedChunkingConfig`
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig]
+        attr_accessor :layout_based_chunking_config
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @layout_based_chunking_config = args[:layout_based_chunking_config] if args.key?(:layout_based_chunking_config)
+        end
+      end
+      
+      # Configuration for the layout based chunking.
+      class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig
+        include Google::Apis::Core::Hashable
+      
+        # The token size limit for each chunk. Supported values: 100-500 (inclusive).
+        # Default value: 500.
+        # Corresponds to the JSON property `chunkSize`
+        # @return [Fixnum]
+        attr_accessor :chunk_size
+      
+        # Whether to include appending different levels of headings to chunks from the
+        # middle of the document to prevent context loss. Default value: False.
+        # Corresponds to the JSON property `includeAncestorHeadings`
+        # @return [Boolean]
+        attr_accessor :include_ancestor_headings
+        alias_method :include_ancestor_headings?, :include_ancestor_headings
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @chunk_size = args[:chunk_size] if args.key?(:chunk_size)
+          @include_ancestor_headings = args[:include_ancestor_headings] if args.key?(:include_ancestor_headings)
+        end
+      end
+      
       # Related configurations applied to a specific type of document parser.
       class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig
         include Google::Apis::Core::Hashable
@@ -5914,6 +6042,14 @@ module Google
         # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec]
         attr_accessor :extractive_content_spec
       
+        # Specifies the search result mode. If unspecified, the search result mode is
+        # based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.
+        # DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`.
+        # * Otherwise, it defaults to `DOCUMENTS`.
+        # Corresponds to the JSON property `searchResultMode`
+        # @return [String]
+        attr_accessor :search_result_mode
+      
         # A specification for configuring snippets in a search response.
         # Corresponds to the JSON property `snippetSpec`
         # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec]
@@ -5931,6 +6067,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @extractive_content_spec = args[:extractive_content_spec] if args.key?(:extractive_content_spec)
+          @search_result_mode = args[:search_result_mode] if args.key?(:search_result_mode)
           @snippet_spec = args[:snippet_spec] if args.key?(:snippet_spec)
           @summary_spec = args[:summary_spec] if args.key?(:summary_spec)
         end
@@ -6681,6 +6818,12 @@ module Google
       class GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult
         include Google::Apis::Core::Hashable
       
+        # Chunk captures all raw metadata information of items to be recommended or
+        # searched in the chunk mode.
+        # Corresponds to the JSON property `chunk`
+        # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunk]
+        attr_accessor :chunk
+      
         # Document captures all raw metadata information of items to be recommended or
         # searched.
         # Corresponds to the JSON property `document`
@@ -6703,6 +6846,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @chunk = args[:chunk] if args.key?(:chunk)
           @document = args[:document] if args.key?(:document)
           @id = args[:id] if args.key?(:id)
           @model_scores = args[:model_scores] if args.key?(:model_scores)

data/lib/google/apis/discoveryengine_v1alpha/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DiscoveryengineV1alpha
       # Version of the google-apis-discoveryengine_v1alpha gem
-      GEM_VERSION = "0.38.0"
+      GEM_VERSION = "0.39.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.14.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20240227"
+      REVISION = "20240229"
     end
   end
 end

data/lib/google/apis/discoveryengine_v1alpha/representations.rb

@@ -364,6 +364,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaChunk
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -550,6 +562,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -2225,6 +2249,26 @@ module Google
         end
       end
       
+      class GoogleCloudDiscoveryengineV1alphaChunk
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :content, as: 'content'
+          hash :derived_struct_data, as: 'derivedStructData'
+          property :document_metadata, as: 'documentMetadata', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata::Representation
+      
+          property :id, as: 'id'
+          property :name, as: 'name'
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :title, as: 'title'
+          property :uri, as: 'uri'
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2516,6 +2560,8 @@ module Google
       class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :chunking_config, as: 'chunkingConfig', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig::Representation
+      
           property :default_parsing_config, as: 'defaultParsingConfig', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig::Representation
       
           property :name, as: 'name'
@@ -2526,6 +2572,22 @@ module Google
         end
       end
       
+      class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :layout_based_chunking_config, as: 'layoutBasedChunkingConfig', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig::Representation
+      
+        end
+      end
+      
+      class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :chunk_size, as: 'chunkSize'
+          property :include_ancestor_headings, as: 'includeAncestorHeadings'
+        end
+      end
+      
       class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -3344,6 +3406,7 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :extractive_content_spec, as: 'extractiveContentSpec', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec::Representation
       
+          property :search_result_mode, as: 'searchResultMode'
           property :snippet_spec, as: 'snippetSpec', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec::Representation
       
           property :summary_spec, as: 'summarySpec', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec::Representation
@@ -3542,6 +3605,8 @@ module Google
       class GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :chunk, as: 'chunk', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunk, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunk::Representation
+      
           property :document, as: 'document', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaDocument::Representation
       
           property :id, as: 'id'

data/lib/google/apis/discoveryengine_v1alpha/service.rb

@@ -388,7 +388,7 @@ module Google
         #   imported search events. * `document-completable` - Using suggestions taken
         #   directly from user-imported document fields marked as completable. Default
         #   values: * `document` is the default model for regular dataStores. * `search-
-        #   history` is the default model for site search dataStores.
+        #   history` is the default model for site search dataStores. *
         # @param [String] user_pseudo_id
         #   A unique identifier for tracking visitors. For example, this could be
         #   implemented with an HTTP cookie, which should be able to uniquely identify a
@@ -3595,7 +3595,7 @@ module Google
         #   imported search events. * `document-completable` - Using suggestions taken
         #   directly from user-imported document fields marked as completable. Default
         #   values: * `document` is the default model for regular dataStores. * `search-
-        #   history` is the default model for site search dataStores.
+        #   history` is the default model for site search dataStores. *
         # @param [String] user_pseudo_id
         #   A unique identifier for tracking visitors. For example, this could be
         #   implemented with an HTTP cookie, which should be able to uniquely identify a

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-discoveryengine_v1alpha
 version: !ruby/object:Gem::Version
-  version: 0.38.0
+  version: 0.39.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-03 00:00:00.000000000 Z
+date: 2024-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.38.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.39.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha
 post_install_message: 
 rdoc_options: []