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

Version 0.4.0

• 0.12.0 (latest)
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.2
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.1
• 0.1.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.

  Currently one segment is returned for each SearchResult.

#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.

  Currently one segment is returned for each SearchResult.

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.

  Currently one segment is returned for each SearchResult.