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

Class GoogleCloudDiscoveryengineV1AnswerGroundingSupport

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Grounding support for a claim in `answer_text`.

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

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1AnswerGroundingSupport	clone()
Long	getEndIndex() Required.
Boolean	getGroundingCheckRequired() Indicates that this claim required grounding check.
Double	getGroundingScore() A score in the range of [0, 1] describing how grounded is a specific claim by the references.
List<GoogleCloudDiscoveryengineV1AnswerCitationSource>	getSources() Optional.
Long	getStartIndex() Required.
GoogleCloudDiscoveryengineV1AnswerGroundingSupport	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1AnswerGroundingSupport	setEndIndex(Long endIndex) Required.
GoogleCloudDiscoveryengineV1AnswerGroundingSupport	setGroundingCheckRequired(Boolean groundingCheckRequired) Indicates that this claim required grounding check.
GoogleCloudDiscoveryengineV1AnswerGroundingSupport	setGroundingScore(Double groundingScore) A score in the range of [0, 1] describing how grounded is a specific claim by the references.
GoogleCloudDiscoveryengineV1AnswerGroundingSupport	setSources(List<GoogleCloudDiscoveryengineV1AnswerCitationSource> sources) Optional.
GoogleCloudDiscoveryengineV1AnswerGroundingSupport	setStartIndex(Long startIndex) Required.

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

GoogleCloudDiscoveryengineV1AnswerGroundingSupport

public GoogleCloudDiscoveryengineV1AnswerGroundingSupport()

Method Detail

getEndIndex

public Long getEndIndex()

Required. End of the claim, exclusive.

Returns:

value or null for none

setEndIndex

public GoogleCloudDiscoveryengineV1AnswerGroundingSupport setEndIndex(Long endIndex)

Required. End of the claim, exclusive.

Parameters:

endIndex - endIndex or null for none

getGroundingCheckRequired

public Boolean getGroundingCheckRequired()

Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore `grounding_score`, `sources` is not returned.

Returns:

value or null for none

setGroundingCheckRequired

public GoogleCloudDiscoveryengineV1AnswerGroundingSupport setGroundingCheckRequired(Boolean groundingCheckRequired)

Indicates that this claim required grounding check. When the system decided this claim didn't require attribution/grounding check, this field is set to false. In that case, no grounding check was done for the claim and therefore `grounding_score`, `sources` is not returned.

Parameters:

groundingCheckRequired - groundingCheckRequired or null for none

getGroundingScore

public Double getGroundingScore()

A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks.

Returns:

value or null for none

setGroundingScore

public GoogleCloudDiscoveryengineV1AnswerGroundingSupport setGroundingScore(Double groundingScore)

A score in the range of [0, 1] describing how grounded is a specific claim by the references. Higher value means that the claim is better supported by the reference chunks.

Parameters:

groundingScore - groundingScore or null for none

getSources

public List<GoogleCloudDiscoveryengineV1AnswerCitationSource> getSources()

Optional. Citation sources for the claim.

Returns:

value or null for none

setSources

public GoogleCloudDiscoveryengineV1AnswerGroundingSupport setSources(List<GoogleCloudDiscoveryengineV1AnswerCitationSource> sources)

Optional. Citation sources for the claim.

Parameters:

sources - sources or null for none

getStartIndex

public Long getStartIndex()

Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).

Returns:

value or null for none

setStartIndex

public GoogleCloudDiscoveryengineV1AnswerGroundingSupport setStartIndex(Long startIndex)

Required. Index indicates the start of the claim, measured in bytes (UTF-8 unicode).

Parameters:

startIndex - startIndex or null for none

set

public GoogleCloudDiscoveryengineV1AnswerGroundingSupport set(String fieldName,
                                                              Object value)

Overrides:

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

clone

public GoogleCloudDiscoveryengineV1AnswerGroundingSupport clone()

Overrides:

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