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

Class GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Session 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
GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec	clone()
String	getQueryId() If set, the search result gets stored to the "turn" specified by this query ID.
Integer	getSearchResultPersistenceCount() The number of top search results to persist.
GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec	setQueryId(String queryId) If set, the search result gets stored to the "turn" specified by this query ID.
GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec	setSearchResultPersistenceCount(Integer searchResultPersistenceCount) The number of top search results to persist.

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

GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec

public GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec()

Method Detail

getQueryId

public String getQueryId()

If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.

Returns:

value or null for none

setQueryId

public GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec setQueryId(String queryId)

If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.

Parameters:

queryId - queryId or null for none

getSearchResultPersistenceCount

public Integer getSearchResultPersistenceCount()

The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.

Returns:

value or null for none

setSearchResultPersistenceCount

public GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec setSearchResultPersistenceCount(Integer searchResultPersistenceCount)

The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is similar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.

Parameters:

searchResultPersistenceCount - searchResultPersistenceCount or null for none

set

public GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec set(String fieldName,
                                                                     Object value)

Overrides:

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

clone

public GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec clone()

Overrides:

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