Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec

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

Overview

A specification for configuring the behavior of content search.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec

Returns a new instance of GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec.



5942
5943
5944
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5942

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

Instance Attribute Details

#chunk_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecChunkSpec

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

Returns:



5917
5918
5919
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5917

def chunk_spec
  @chunk_spec
end

#extractive_content_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec

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

Returns:



5922
5923
5924
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5922

def extractive_content_spec
  @extractive_content_spec
end

#search_result_mode ⇒ String

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) 


5930
5931
5932
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5930

def search_result_mode
  @search_result_mode
end

#snippet_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec

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

Returns:



5935
5936
5937
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5935

def snippet_spec
  @snippet_spec
end

#summary_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec

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

Returns:



5940
5941
5942
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5940

def summary_spec
  @summary_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5947
5948
5949
5950
5951
5952
5953
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 5947

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