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.
↳ max_extractive_segment_count
int
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.
↳ return_extractive_segment_score
bool
Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is false.
↳ num_previous_segments
int
Specifies whether to also include the adjacent from each selected segments. Return at most num_previous_segments segments before each selected segments.
↳ num_next_segments
int
Return at most num_next_segments segments after each selected segments.
getMaxExtractiveAnswerCount
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
Type
Description
int
setMaxExtractiveAnswerCount
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getMaxExtractiveSegmentCount
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
Type
Description
int
setMaxExtractiveSegmentCount
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getReturnExtractiveSegmentScore
Specifies whether to return the confidence score from the extractive
segments in each search result. This feature is available only for new
or allowlisted data stores. To allowlist your data store,
contact your Customer Engineer. The default value is false.
Returns
Type
Description
bool
setReturnExtractiveSegmentScore
Specifies whether to return the confidence score from the extractive
segments in each search result. This feature is available only for new
or allowlisted data stores. To allowlist your data store,
contact your Customer Engineer. The default value is false.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getNumPreviousSegments
Specifies whether to also include the adjacent from each selected
segments.
Return at most num_previous_segments segments before each selected
segments.
Returns
Type
Description
int
setNumPreviousSegments
Specifies whether to also include the adjacent from each selected
segments.
Return at most num_previous_segments segments before each selected
segments.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getNumNextSegments
Return at most num_next_segments segments after each selected
segments.
Returns
Type
Description
int
setNumNextSegments
Return at most num_next_segments segments after each selected
segments.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Discovery Engine V1 Client - Class ExtractiveContentSpec (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ExtractiveContentSpec.\n\nA specification for configuring the extractive content in a search\nresponse.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1 \\\\ SearchRequest \\\\ ContentSearchSpec\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getMaxExtractiveAnswerCount\n\nThe maximum number of extractive answers returned in each search\nresult.\n\nAn extractive answer is a verbatim answer extracted from the original\ndocument, which provides a precise and contextually relevant answer to\nthe search query.\nIf the number of matching answers is less than the\n`max_extractive_answer_count`, return all of the answers. Otherwise,\nreturn the `max_extractive_answer_count`.\nAt most five answers are returned for each\n[SearchResult](/php/docs/reference/cloud-discoveryengine/latest/V1.SearchResponse.SearchResult).\n\n### setMaxExtractiveAnswerCount\n\nThe maximum number of extractive answers returned in each search\nresult.\n\nAn extractive answer is a verbatim answer extracted from the original\ndocument, which provides a precise and contextually relevant answer to\nthe search query.\nIf the number of matching answers is less than the\n`max_extractive_answer_count`, return all of the answers. Otherwise,\nreturn the `max_extractive_answer_count`.\nAt most five answers are returned for each\n[SearchResult](/php/docs/reference/cloud-discoveryengine/latest/V1.SearchResponse.SearchResult).\n\n### getMaxExtractiveSegmentCount\n\nThe max number of extractive segments returned in each search result.\n\nOnly applied if the\n[DataStore](/php/docs/reference/cloud-discoveryengine/latest/V1.DataStore) is set to\n[DataStore.ContentConfig.CONTENT_REQUIRED](/php/docs/reference/cloud-discoveryengine/latest/V1.DataStore.ContentConfig#_Google_Cloud_DiscoveryEngine_V1_DataStore_ContentConfig__CONTENT_REQUIRED)\nor\n[DataStore.solution_types](/php/docs/reference/cloud-discoveryengine/latest/V1.DataStore#_Google_Cloud_DiscoveryEngine_V1_DataStore__getSolutionTypes__)\nis\n[SOLUTION_TYPE_CHAT](/php/docs/reference/cloud-discoveryengine/latest/V1.SolutionType#_Google_Cloud_DiscoveryEngine_V1_SolutionType__SOLUTION_TYPE_CHAT).\nAn extractive segment is a text segment extracted from the original\ndocument that is relevant to the search query, and, in general, more\nverbose than an extractive answer. The segment could then be used as\ninput for LLMs to generate summaries and answers.\nIf the number of matching segments is less than\n`max_extractive_segment_count`, return all of the segments. Otherwise,\nreturn the `max_extractive_segment_count`.\n\n### setMaxExtractiveSegmentCount\n\nThe max number of extractive segments returned in each search result.\n\nOnly applied if the\n[DataStore](/php/docs/reference/cloud-discoveryengine/latest/V1.DataStore) is set to\n[DataStore.ContentConfig.CONTENT_REQUIRED](/php/docs/reference/cloud-discoveryengine/latest/V1.DataStore.ContentConfig#_Google_Cloud_DiscoveryEngine_V1_DataStore_ContentConfig__CONTENT_REQUIRED)\nor\n[DataStore.solution_types](/php/docs/reference/cloud-discoveryengine/latest/V1.DataStore#_Google_Cloud_DiscoveryEngine_V1_DataStore__getSolutionTypes__)\nis\n[SOLUTION_TYPE_CHAT](/php/docs/reference/cloud-discoveryengine/latest/V1.SolutionType#_Google_Cloud_DiscoveryEngine_V1_SolutionType__SOLUTION_TYPE_CHAT).\nAn extractive segment is a text segment extracted from the original\ndocument that is relevant to the search query, and, in general, more\nverbose than an extractive answer. The segment could then be used as\ninput for LLMs to generate summaries and answers.\nIf the number of matching segments is less than\n`max_extractive_segment_count`, return all of the segments. Otherwise,\nreturn the `max_extractive_segment_count`.\n\n### getReturnExtractiveSegmentScore\n\nSpecifies whether to return the confidence score from the extractive\nsegments in each search result. This feature is available only for new\nor allowlisted data stores. To allowlist your data store,\ncontact your Customer Engineer. The default value is `false`.\n\n### setReturnExtractiveSegmentScore\n\nSpecifies whether to return the confidence score from the extractive\nsegments in each search result. This feature is available only for new\nor allowlisted data stores. To allowlist your data store,\ncontact your Customer Engineer. The default value is `false`.\n\n### getNumPreviousSegments\n\nSpecifies whether to also include the adjacent from each selected\nsegments.\n\nReturn at most `num_previous_segments` segments before each selected\nsegments.\n\n### setNumPreviousSegments\n\nSpecifies whether to also include the adjacent from each selected\nsegments.\n\nReturn at most `num_previous_segments` segments before each selected\nsegments.\n\n### getNumNextSegments\n\nReturn at most `num_next_segments` segments after each selected\nsegments.\n\n### setNumNextSegments\n\nReturn at most `num_next_segments` segments after each selected\nsegments."]]