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

Class GoogleCloudDiscoveryengineV1CheckGroundingSpec

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Specification for the grounding check.

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
GoogleCloudDiscoveryengineV1CheckGroundingSpec()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1CheckGroundingSpec	clone()
Double	getCitationThreshold() The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate.
Boolean	getEnableClaimLevelScore() The control flag that enables claim-level grounding score in the response.
GoogleCloudDiscoveryengineV1CheckGroundingSpec	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1CheckGroundingSpec	setCitationThreshold(Double citationThreshold) The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate.
GoogleCloudDiscoveryengineV1CheckGroundingSpec	setEnableClaimLevelScore(Boolean enableClaimLevelScore) The control flag that enables claim-level grounding score in the response.

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

GoogleCloudDiscoveryengineV1CheckGroundingSpec

public GoogleCloudDiscoveryengineV1CheckGroundingSpec()

Method Detail

getCitationThreshold

public Double getCitationThreshold()

The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6.

Returns:

value or null for none

setCitationThreshold

public GoogleCloudDiscoveryengineV1CheckGroundingSpec setCitationThreshold(Double citationThreshold)

The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6.

Parameters:

citationThreshold - citationThreshold or null for none

getEnableClaimLevelScore

public Boolean getEnableClaimLevelScore()

The control flag that enables claim-level grounding score in the response.

Returns:

value or null for none

setEnableClaimLevelScore

public GoogleCloudDiscoveryengineV1CheckGroundingSpec setEnableClaimLevelScore(Boolean enableClaimLevelScore)

The control flag that enables claim-level grounding score in the response.

Parameters:

enableClaimLevelScore - enableClaimLevelScore or null for none

set

public GoogleCloudDiscoveryengineV1CheckGroundingSpec set(String fieldName,
                                                          Object value)

Overrides:

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

clone

public GoogleCloudDiscoveryengineV1CheckGroundingSpec clone()

Overrides:

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