com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec
extends com.google.api.client.json.GenericJson

A specification for configuring a summary returned in a search response.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec	clone()
Boolean	getIgnoreAdversarialQuery() Specifies whether to filter out adversarial queries.
Boolean	getIgnoreJailBreakingQuery() Optional.
Boolean	getIgnoreLowRelevantContent() Specifies whether to filter out queries that have low relevance.
Boolean	getIgnoreNonSummarySeekingQuery() Specifies whether to filter out queries that are not summary-seeking.
Boolean	getIncludeCitations() Specifies whether to include citations in the summary.
String	getLanguageCode() Language code for Summary.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec	getModelPromptSpec() If specified, the spec will be used to modify the prompt provided to the LLM.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec	getModelSpec() If specified, the spec will be used to modify the model specification provided to the LLM.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec	getMultimodalSpec() Optional.
Integer	getSummaryResultCount() The number of top results to generate the summary from.
Boolean	getUseSemanticChunks() If true, answer will be generated from most relevant chunks from top search results.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec	setIgnoreAdversarialQuery(Boolean ignoreAdversarialQuery) Specifies whether to filter out adversarial queries.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec	setIgnoreJailBreakingQuery(Boolean ignoreJailBreakingQuery) Optional.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec	setIgnoreLowRelevantContent(Boolean ignoreLowRelevantContent) Specifies whether to filter out queries that have low relevance.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec	setIgnoreNonSummarySeekingQuery(Boolean ignoreNonSummarySeekingQuery) Specifies whether to filter out queries that are not summary-seeking.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec	setIncludeCitations(Boolean includeCitations) Specifies whether to include citations in the summary.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec	setLanguageCode(String languageCode) Language code for Summary.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec	setModelPromptSpec(GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec modelPromptSpec) If specified, the spec will be used to modify the prompt provided to the LLM.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec	setModelSpec(GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec modelSpec) If specified, the spec will be used to modify the model specification provided to the LLM.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec	setMultimodalSpec(GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec multimodalSpec) Optional.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec	setSummaryResultCount(Integer summaryResultCount) The number of top results to generate the summary from.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec	setUseSemanticChunks(Boolean useSemanticChunks) If true, answer will be generated from most relevant chunks from top search results.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec()

Method Detail

getIgnoreAdversarialQuery

public Boolean getIgnoreAdversarialQuery()

Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.

Returns:

value or null for none

setIgnoreAdversarialQuery

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec setIgnoreAdversarialQuery(Boolean ignoreAdversarialQuery)

Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.

Parameters:

ignoreAdversarialQuery - ignoreAdversarialQuery or null for none

getIgnoreJailBreakingQuery

public Boolean getIgnoreJailBreakingQuery()

Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.

Returns:

value or null for none

setIgnoreJailBreakingQuery

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec setIgnoreJailBreakingQuery(Boolean ignoreJailBreakingQuery)

Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.

Parameters:

ignoreJailBreakingQuery - ignoreJailBreakingQuery or null for none

getIgnoreLowRelevantContent

public Boolean getIgnoreLowRelevantContent()

Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.

Returns:

value or null for none

setIgnoreLowRelevantContent

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec setIgnoreLowRelevantContent(Boolean ignoreLowRelevantContent)

Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.

Parameters:

ignoreLowRelevantContent - ignoreLowRelevantContent or null for none

getIgnoreNonSummarySeekingQuery

public Boolean getIgnoreNonSummarySeekingQuery()

Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary- seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non- summary seeking queries and return fallback messages instead.

Returns:

value or null for none

setIgnoreNonSummarySeekingQuery

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec setIgnoreNonSummarySeekingQuery(Boolean ignoreNonSummarySeekingQuery)

Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary- seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non- summary seeking queries and return fallback messages instead.

Parameters:

ignoreNonSummarySeekingQuery - ignoreNonSummarySeekingQuery or null for none

getIncludeCitations

public Boolean getIncludeCitations()

Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.

Returns:

value or null for none

setIncludeCitations

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec setIncludeCitations(Boolean includeCitations)

Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.

Parameters:

includeCitations - includeCitations or null for none

getLanguageCode

public String getLanguageCode()

Language code for Summary. Use language tags defined by [BCP47](https://www.rfc- editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.

Returns:

value or null for none

setLanguageCode

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec setLanguageCode(String languageCode)

Language code for Summary. Use language tags defined by [BCP47](https://www.rfc- editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.

Parameters:

languageCode - languageCode or null for none

getModelPromptSpec

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec getModelPromptSpec()

If specified, the spec will be used to modify the prompt provided to the LLM.

Returns:

value or null for none

setModelPromptSpec

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec setModelPromptSpec(GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec modelPromptSpec)

If specified, the spec will be used to modify the prompt provided to the LLM.

Parameters:

modelPromptSpec - modelPromptSpec or null for none

getModelSpec

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec getModelSpec()

If specified, the spec will be used to modify the model specification provided to the LLM.

Returns:

value or null for none

setModelSpec

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec setModelSpec(GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec modelSpec)

If specified, the spec will be used to modify the model specification provided to the LLM.

Parameters:

modelSpec - modelSpec or null for none

getMultimodalSpec

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec getMultimodalSpec()

Optional. Multimodal specification.

Returns:

value or null for none

setMultimodalSpec

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec setMultimodalSpec(GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec multimodalSpec)

Optional. Multimodal specification.

Parameters:

multimodalSpec - multimodalSpec or null for none

getSummaryResultCount

public Integer getSummaryResultCount()

The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.

Returns:

value or null for none

setSummaryResultCount

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec setSummaryResultCount(Integer summaryResultCount)

The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.

Parameters:

summaryResultCount - summaryResultCount or null for none

getUseSemanticChunks

public Boolean getUseSemanticChunks()

If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.

Returns:

value or null for none

setUseSemanticChunks

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec setUseSemanticChunks(Boolean useSemanticChunks)

If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.

Parameters:

useSemanticChunks - useSemanticChunks or null for none

set

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec set(String fieldName,
                                                                                     Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec clone()

Overrides:

clone in class com.google.api.client.json.GenericJson