Class: Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ExtractiveContentSpec

Inherits:

Object

• Object
• Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ExtractiveContentSpec

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb

Overview

A specification for configuring the extractive content in a search response.

Instance Attribute Summary

• #max_extractive_answer_count ⇒ ::Integer

  The maximum number of extractive answers returned in each search result.

• #max_extractive_segment_count ⇒ ::Integer

  The max number of extractive segments returned in each search result.

• #num_next_segments ⇒ ::Integer

  Return at most num_next_segments segments after each selected segments.

• #num_previous_segments ⇒ ::Integer

  Specifies whether to also include the adjacent from each selected segments.

• #return_extractive_segment_score ⇒ ::Boolean

  Specifies whether to return the confidence score from the extractive segments in each search result.

Instance Attribute Details

#max_extractive_answer_count ⇒ ::Integer

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.

Returns:

• (::Integer) —

  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.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 700

class ExtractiveContentSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#max_extractive_segment_count ⇒ ::Integer

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.

Returns:

• (::Integer) —

  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.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 700

class ExtractiveContentSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#num_next_segments ⇒ ::Integer

Return at most num_next_segments segments after each selected segments.

Returns:

• (::Integer) —

  Return at most num_next_segments segments after each selected segments.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 700

class ExtractiveContentSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#num_previous_segments ⇒ ::Integer

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

Returns:

• (::Integer) —

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

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 700

class ExtractiveContentSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#return_extractive_segment_score ⇒ ::Boolean

Returns Specifies whether to return the confidence score from the extractive segments in each search result. The default value is false.

Note: this is a priavte preview feature and only works for allowlisted users, please reach out to Cloud Support team if you want to use it.

Returns:

• (::Boolean) —

  Specifies whether to return the confidence score from the extractive segments in each search result. The default value is false.

  Note: this is a priavte preview feature and only works for allowlisted users, please reach out to Cloud Support team if you want to use it.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 700

class ExtractiveContentSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end