Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec

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) ⇒ GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec.



12013
12014
12015
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 12013

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

Instance Attribute Details

#chunk_spec ⇒ Google::Apis::DiscoveryengineV1::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

Returns:



11990
11991
11992
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11990

def chunk_spec
  @chunk_spec
end

#extractive_content_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec

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

Returns:



11995
11996
11997
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11995

def extractive_content_spec
  @extractive_content_spec
end

#search_result_mode ⇒ String

Specifies the search result mode. If unspecified, the search result mode defaults to DOCUMENTS. Corresponds to the JSON property searchResultMode

Returns:

  • (String) 


12001
12002
12003
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 12001

def search_result_mode
  @search_result_mode
end

#snippet_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec

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

Returns:



12006
12007
12008
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 12006

def snippet_spec
  @snippet_spec
end

#summary_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec

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

Returns:



12011
12012
12013
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 12011

def summary_spec
  @summary_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12018
12019
12020
12021
12022
12023
12024
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 12018

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