Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ExtractiveContentSpec.
A specification for configuring the extractive content in a search response.
Generated from protobuf message google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ExtractiveContentSpec
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ SearchRequest \ ContentSearchSpecMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ max_extractive_answer_count |
int
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_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 |
↳ 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 |
↳ num_previous_segments |
int
Specifies whether to also include the adjacent from each selected segments. Return at most |
↳ num_next_segments |
int
Return at most |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|