# Interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder (0.87.0)

0.89.0 (latest) 0.87.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

    public static interface SearchRequest.ContentSearchSpec.SummarySpecOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getIgnoreAdversarialQuery()

    public abstract 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.

`bool ignore_adversarial_query = 3;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The ignoreAdversarialQuery. |

### getIgnoreJailBreakingQuery()

    public abstract 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.

`bool ignore_jail_breaking_query = 10 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The ignoreJailBreakingQuery. |

### getIgnoreLowRelevantContent()

    public abstract 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.

`bool ignore_low_relevant_content = 9;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The ignoreLowRelevantContent. |

### getIgnoreNonSummarySeekingQuery()

    public abstract 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.

`bool ignore_non_summary_seeking_query = 4;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The ignoreNonSummarySeekingQuery. |

### getIncludeCitations()

    public abstract 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.

`bool include_citations = 2;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The includeCitations. |

### getLanguageCode()

    public abstract 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.

`string language_code = 6;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The languageCode. |

### getLanguageCodeBytes()

    public abstract ByteString getLanguageCodeBytes()

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.

`string language_code = 6;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for languageCode. |

### getModelPromptSpec()

    public abstract SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec getModelPromptSpec()

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

`
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec model_prompt_spec = 5;
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec` | The modelPromptSpec. |

### getModelPromptSpecOrBuilder()

    public abstract SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpecOrBuilder getModelPromptSpecOrBuilder()

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

`
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec model_prompt_spec = 5;
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpecOrBuilder` |   |

### getModelSpec()

    public abstract SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec getModelSpec()

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

`
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec model_spec = 7;
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec` | The modelSpec. |

### getModelSpecOrBuilder()

    public abstract SearchRequest.ContentSearchSpec.SummarySpec.ModelSpecOrBuilder getModelSpecOrBuilder()

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

`
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec model_spec = 7;
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpecOrBuilder` |   |

### getSummaryResultCount()

    public abstract int 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.

`int32 summary_result_count = 1;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The summaryResultCount. |

### getUseSemanticChunks()

    public abstract 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.

`bool use_semantic_chunks = 8;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The useSemanticChunks. |

### hasModelPromptSpec()

    public abstract boolean hasModelPromptSpec()

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

`
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ModelPromptSpec model_prompt_spec = 5;
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the modelPromptSpec field is set. |

### hasModelSpec()

    public abstract boolean hasModelSpec()

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

`
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec.ModelSpec model_spec = 7;
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the modelSpec field is set. |