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.



3112
3113
3114
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3112

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 one answer is returned for each SearchResult. Corresponds to the JSON property maxExtractiveAnswerCount

Returns:

  • (Fixnum) 


3086
3087
3088
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3086

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) 


3099
3100
3101
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3099

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) 


3104
3105
3106
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3104

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) 


3110
3111
3112
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3110

def num_previous_segments
  @num_previous_segments
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3117
3118
3119
3120
3121
3122
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 3117

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