Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec

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 extractive content in a search response.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec.



5499
5500
5501
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5499

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

Instance Attribute Details

#max_extractive_answer_count ⇒ Fixnum

The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the max_extractive_answer_count, return all of the answers. Otherwise, return the max_extractive_answer_count. At most five answers are returned for each SearchResult. Corresponds to the JSON property maxExtractiveAnswerCount

Returns:

  • (Fixnum) 


5473
5474
5475
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5473

def max_extractive_answer_count
  @max_extractive_answer_count
end

#max_extractive_segment_count ⇒ Fixnum

The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than max_extractive_segment_count , return all of the segments. Otherwise, return the max_extractive_segment_count. Corresponds to the JSON property maxExtractiveSegmentCount

Returns:

  • (Fixnum) 


5486
5487
5488
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5486

def max_extractive_segment_count
  @max_extractive_segment_count
end

#num_next_segments ⇒ Fixnum

Return at most num_next_segments segments after each selected segments. Corresponds to the JSON property numNextSegments

Returns:

  • (Fixnum) 


5491
5492
5493
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5491

def num_next_segments
  @num_next_segments
end

#num_previous_segments ⇒ Fixnum

Specifies whether to also include the adjacent from each selected segments. Return at most num_previous_segments segments before each selected segments. Corresponds to the JSON property numPreviousSegments

Returns:

  • (Fixnum) 


5497
5498
5499
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5497

def num_previous_segments
  @num_previous_segments
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5504
5505
5506
5507
5508
5509
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5504

def update!(**args)
  @max_extractive_answer_count = args[:max_extractive_answer_count] if args.key?(:max_extractive_answer_count)
  @max_extractive_segment_count = args[:max_extractive_segment_count] if args.key?(:max_extractive_segment_count)
  @num_next_segments = args[:num_next_segments] if args.key?(:num_next_segments)
  @num_previous_segments = args[:num_previous_segments] if args.key?(:num_previous_segments)
end