Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb

Overview

A specification for configuring the behavior of content search.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec.



9801
9802
9803
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9801

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#chunk_specGoogle::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec

Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS Corresponds to the JSON property chunkSpec



9776
9777
9778
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9776

def chunk_spec
  @chunk_spec
end

#extractive_content_specGoogle::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec

A specification for configuring the extractive content in a search response. Corresponds to the JSON property extractiveContentSpec



9781
9782
9783
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9781

def extractive_content_spec
  @extractive_content_spec
end

#search_result_modeString

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

Returns:

  • (String)


9789
9790
9791
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9789

def search_result_mode
  @search_result_mode
end

#snippet_specGoogle::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec

A specification for configuring snippets in a search response. Corresponds to the JSON property snippetSpec



9794
9795
9796
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9794

def snippet_spec
  @snippet_spec
end

#summary_specGoogle::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec

A specification for configuring a summary returned in a search response. Corresponds to the JSON property summarySpec



9799
9800
9801
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9799

def summary_spec
  @summary_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9806
9807
9808
9809
9810
9811
9812
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 9806

def update!(**args)
  @chunk_spec = args[:chunk_spec] if args.key?(:chunk_spec)
  @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