Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ExtractiveContentSpec (v0.6.0)

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ExtractiveContentSpec.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#max_extractive_answer_count

def max_extractive_answer_count() -> ::Integer
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 one answer is returned for each SearchResult.

#max_extractive_answer_count=

def max_extractive_answer_count=(value) -> ::Integer
Parameter
  • value (::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 one answer is 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 one answer is returned for each SearchResult.

#max_extractive_segment_count

def max_extractive_segment_count() -> ::Integer
Returns
  • (::Integer) — The max number of extractive segments returned in each search result. Only applied if the [DataStore][google.cloud.discoveryengine.v1beta.DataStore] is set to [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.CONTENT_REQUIRED] or [DataStore.solution_types][google.cloud.discoveryengine.v1beta.DataStore.solution_types] is [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.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.

#max_extractive_segment_count=

def max_extractive_segment_count=(value) -> ::Integer
Parameter
  • value (::Integer) — The max number of extractive segments returned in each search result. Only applied if the [DataStore][google.cloud.discoveryengine.v1beta.DataStore] is set to [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.CONTENT_REQUIRED] or [DataStore.solution_types][google.cloud.discoveryengine.v1beta.DataStore.solution_types] is [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.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][google.cloud.discoveryengine.v1beta.DataStore] is set to [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.CONTENT_REQUIRED] or [DataStore.solution_types][google.cloud.discoveryengine.v1beta.DataStore.solution_types] is [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.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.

#num_next_segments

def num_next_segments() -> ::Integer
Returns
  • (::Integer) — Return at most num_next_segments segments after each selected segments.

#num_next_segments=

def num_next_segments=(value) -> ::Integer
Parameter
  • value (::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.

#num_previous_segments

def num_previous_segments() -> ::Integer
Returns
  • (::Integer) — Specifies whether to also include the adjacent from each selected segments. Return at most num_previous_segments segments before each selected segments.

#num_previous_segments=

def num_previous_segments=(value) -> ::Integer
Parameter
  • value (::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.

#return_extractive_segment_score

def return_extractive_segment_score() -> ::Boolean
Returns
  • (::Boolean) — Specifies whether to return the confidence score from the extractive segments in each search result. The default value is false.

#return_extractive_segment_score=

def return_extractive_segment_score=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Specifies whether to return the confidence score from the extractive segments in each search result. The default value is false.
Returns
  • (::Boolean) — Specifies whether to return the confidence score from the extractive segments in each search result. The default value is false.