GoogleCloudDiscoveryengineV1ConverseConversationRequest (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.GoogleCloudDiscoveryengineV1ConverseConversationRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudDiscoveryengineV1ConverseConversationRequest
extends com.google.api.client.json.GenericJson
```
Request message for ConversationalSearchService.ConverseConversation method.
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

GoogleCloudDiscoveryengineV1ConverseConversationRequest()

Constructors
Constructor and Description
`GoogleCloudDiscoveryengineV1ConverseConversationRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudDiscoveryengineV1ConverseConversationRequest`	`clone()`
`GoogleCloudDiscoveryengineV1SearchRequestBoostSpec`	`getBoostSpec()` Boost specification to boost certain documents in search results which may affect the converse response.
`GoogleCloudDiscoveryengineV1Conversation`	`getConversation()` The conversation to be used by auto session only.
`String`	`getFilter()` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`GoogleCloudDiscoveryengineV1TextInput`	`getQuery()` Required.
`Boolean`	`getSafeSearch()` Whether to turn on safe search.
`String`	`getServingConfig()` The resource name of the Serving Config to use.
`GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec`	`getSummarySpec()` A specification for configuring the summary returned in the response.
`Map<String,String>`	`getUserLabels()` The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.
`GoogleCloudDiscoveryengineV1ConverseConversationRequest`	`set(String fieldName, Object value)`
`GoogleCloudDiscoveryengineV1ConverseConversationRequest`	`setBoostSpec(GoogleCloudDiscoveryengineV1SearchRequestBoostSpec boostSpec)` Boost specification to boost certain documents in search results which may affect the converse response.
`GoogleCloudDiscoveryengineV1ConverseConversationRequest`	`setConversation(GoogleCloudDiscoveryengineV1Conversation conversation)` The conversation to be used by auto session only.
`GoogleCloudDiscoveryengineV1ConverseConversationRequest`	`setFilter(String filter)` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.
`GoogleCloudDiscoveryengineV1ConverseConversationRequest`	`setQuery(GoogleCloudDiscoveryengineV1TextInput query)` Required.
`GoogleCloudDiscoveryengineV1ConverseConversationRequest`	`setSafeSearch(Boolean safeSearch)` Whether to turn on safe search.
`GoogleCloudDiscoveryengineV1ConverseConversationRequest`	`setServingConfig(String servingConfig)` The resource name of the Serving Config to use.
`GoogleCloudDiscoveryengineV1ConverseConversationRequest`	`setSummarySpec(GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec summarySpec)` A specification for configuring the summary returned in the response.
`GoogleCloudDiscoveryengineV1ConverseConversationRequest`	`setUserLabels(Map<String,String> userLabels)` The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.

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
  - GoogleCloudDiscoveryengineV1ConverseConversationRequest
```
public GoogleCloudDiscoveryengineV1ConverseConversationRequest()
```
- Method Detail
  - getBoostSpec
```
public GoogleCloudDiscoveryengineV1SearchRequestBoostSpec getBoostSpec()
```
    Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
    
    Returns:
    
    value or null for none
  - setBoostSpec
```
public GoogleCloudDiscoveryengineV1ConverseConversationRequest setBoostSpec(GoogleCloudDiscoveryengineV1SearchRequestBoostSpec boostSpec)
```
    Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
    
    Parameters:
    
    boostSpec - boostSpec or null for none
  - getConversation
```
public GoogleCloudDiscoveryengineV1Conversation getConversation()
```
    The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
    
    Returns:
    
    value or null for none
  - setConversation
```
public GoogleCloudDiscoveryengineV1ConverseConversationRequest setConversation(GoogleCloudDiscoveryengineV1Conversation conversation)
```
    The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
    
    Parameters:
    
    conversation - conversation or null for none
  - getFilter
```
public String getFilter()
```
    The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search- metadata)
    
    Returns:
    
    value or null for none
  - setFilter
```
public GoogleCloudDiscoveryengineV1ConverseConversationRequest setFilter(String filter)
```
    The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search- metadata)
    
    Parameters:
    
    filter - filter or null for none
  - getQuery
```
public GoogleCloudDiscoveryengineV1TextInput getQuery()
```
    Required. Current user input.
    
    Returns:
    
    value or null for none
  - setQuery
```
public GoogleCloudDiscoveryengineV1ConverseConversationRequest setQuery(GoogleCloudDiscoveryengineV1TextInput query)
```
    Required. Current user input.
    
    Parameters:
    
    query - query or null for none
  - getSafeSearch
```
public Boolean getSafeSearch()
```
    Whether to turn on safe search.
    
    Returns:
    
    value or null for none
  - setSafeSearch
```
public GoogleCloudDiscoveryengineV1ConverseConversationRequest setSafeSearch(Boolean safeSearch)
```
    Whether to turn on safe search.
    
    Parameters:
    
    safeSearch - safeSearch or null for none
  - getServingConfig
```
public String getServingConfig()
```
    The resource name of the Serving Config to use. Format: `projects/{project}/locations/{location }/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.
    
    Returns:
    
    value or null for none
  - setServingConfig
```
public GoogleCloudDiscoveryengineV1ConverseConversationRequest setServingConfig(String servingConfig)
```
    The resource name of the Serving Config to use. Format: `projects/{project}/locations/{location }/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.
    
    Parameters:
    
    servingConfig - servingConfig or null for none
  - getSummarySpec
```
public GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec getSummarySpec()
```
    A specification for configuring the summary returned in the response.
    
    Returns:
    
    value or null for none
  - setSummarySpec
```
public GoogleCloudDiscoveryengineV1ConverseConversationRequest setSummarySpec(GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec summarySpec)
```
    A specification for configuring the summary returned in the response.
    
    Parameters:
    
    summarySpec - summarySpec or null for none
  - getUserLabels
```
public Map<String,String> getUserLabels()
```
    The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
    
    Returns:
    
    value or null for none
  - setUserLabels
```
public GoogleCloudDiscoveryengineV1ConverseConversationRequest setUserLabels(Map<String,String> userLabels)
```
    The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
    
    Parameters:
    
    userLabels - userLabels or null for none
  - set
```
public GoogleCloudDiscoveryengineV1ConverseConversationRequest set(String fieldName,
                                                                   Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudDiscoveryengineV1ConverseConversationRequest clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudDiscoveryengineV1ConverseConversationRequest

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

GoogleCloudDiscoveryengineV1ConverseConversationRequest

Method Detail

getBoostSpec

setBoostSpec

getConversation

setConversation

getFilter

setFilter

getQuery

setQuery

getSafeSearch

setSafeSearch

getServingConfig

setServingConfig

getSummarySpec

setSummarySpec

getUserLabels

setUserLabels

set

clone