GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec (Discovery Engine API v1-rev20260427-2.0.0)

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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec
extends com.google.api.client.json.GenericJson
```
Answer generation specification.
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

GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec()

Constructors
Constructor and Description
`GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec`	`clone()`
`String`	`getAnswerLanguageCode()` Language code for Answer.
`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`	`getIgnoreNonAnswerSeekingQuery()` Specifies whether to filter out queries that are not answer-seeking.
`Boolean`	`getIncludeCitations()` Specifies whether to include citation metadata in the answer.
`GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec`	`getModelSpec()` Answer generation model specification.
`GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec`	`getPromptSpec()` Answer generation prompt specification.
`GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec`	`set(String fieldName, Object value)`
`GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec`	`setAnswerLanguageCode(String answerLanguageCode)` Language code for Answer.
`GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec`	`setIgnoreAdversarialQuery(Boolean ignoreAdversarialQuery)` Specifies whether to filter out adversarial queries.
`GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec`	`setIgnoreJailBreakingQuery(Boolean ignoreJailBreakingQuery)` Optional.
`GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec`	`setIgnoreLowRelevantContent(Boolean ignoreLowRelevantContent)` Specifies whether to filter out queries that have low relevance.
`GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec`	`setIgnoreNonAnswerSeekingQuery(Boolean ignoreNonAnswerSeekingQuery)` Specifies whether to filter out queries that are not answer-seeking.
`GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec`	`setIncludeCitations(Boolean includeCitations)` Specifies whether to include citation metadata in the answer.
`GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec`	`setModelSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec modelSpec)` Answer generation model specification.
`GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec`	`setPromptSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec promptSpec)` Answer generation prompt specification.

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
  - GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec()
```
- Method Detail
  - getAnswerLanguageCode
```
public String getAnswerLanguageCode()
```
    Language code for Answer. 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
  - setAnswerLanguageCode
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec setAnswerLanguageCode(String answerLanguageCode)
```
    Language code for Answer. Use language tags defined by [BCP47](https://www.rfc- editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
    
    Parameters:
    
    answerLanguageCode - answerLanguageCode or null for none
  - 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 answer 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 answers for adversarial queries and return fallback messages instead.
    
    Returns:
    
    value or null for none
  - setIgnoreAdversarialQuery
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec 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 answer 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 answers 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 GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec 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. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service.
    
    Returns:
    
    value or null for none
  - setIgnoreLowRelevantContent
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec setIgnoreLowRelevantContent(Boolean ignoreLowRelevantContent)
```
    Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service.
    
    Parameters:
    
    ignoreLowRelevantContent - ignoreLowRelevantContent or null for none
  - getIgnoreNonAnswerSeekingQuery
```
public Boolean getIgnoreNonAnswerSeekingQuery()
```
    Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.
    
    Returns:
    
    value or null for none
  - setIgnoreNonAnswerSeekingQuery
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec setIgnoreNonAnswerSeekingQuery(Boolean ignoreNonAnswerSeekingQuery)
```
    Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.
    
    Parameters:
    
    ignoreNonAnswerSeekingQuery - ignoreNonAnswerSeekingQuery or null for none
  - getIncludeCitations
```
public Boolean getIncludeCitations()
```
    Specifies whether to include citation metadata in the answer. The default value is `false`.
    
    Returns:
    
    value or null for none
  - setIncludeCitations
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec setIncludeCitations(Boolean includeCitations)
```
    Specifies whether to include citation metadata in the answer. The default value is `false`.
    
    Parameters:
    
    includeCitations - includeCitations or null for none
  - getModelSpec
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec getModelSpec()
```
    Answer generation model specification.
    
    Returns:
    
    value or null for none
  - setModelSpec
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec setModelSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec modelSpec)
```
    Answer generation model specification.
    
    Parameters:
    
    modelSpec - modelSpec or null for none
  - getPromptSpec
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec getPromptSpec()
```
    Answer generation prompt specification.
    
    Returns:
    
    value or null for none
  - setPromptSpec
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec setPromptSpec(GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec promptSpec)
```
    Answer generation prompt specification.
    
    Parameters:
    
    promptSpec - promptSpec or null for none
  - set
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec set(String fieldName,
                                                                              Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec

Method Detail

getAnswerLanguageCode

setAnswerLanguageCode

getIgnoreAdversarialQuery

setIgnoreAdversarialQuery

getIgnoreJailBreakingQuery

setIgnoreJailBreakingQuery

getIgnoreLowRelevantContent

setIgnoreLowRelevantContent

getIgnoreNonAnswerSeekingQuery

setIgnoreNonAnswerSeekingQuery

getIncludeCitations

setIncludeCitations

getModelSpec

setModelSpec

getPromptSpec

setPromptSpec

set

clone