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

Class GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Text and citation info for a claim in the answer candidate.

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

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim	clone()
List<Integer>	getCitationIndices() A list of indices (into 'cited_chunks') specifying the citations associated with the claim.
String	getClaimText() Text for the claim in the answer candidate.
Integer	getEndPos() Position indicating the end of the claim in the answer candidate, exclusive, in bytes.
Boolean	getGroundingCheckRequired() Indicates that this claim required grounding check.
Double	getScore() Confidence score for the claim in the answer candidate, in the range of [0, 1].
Integer	getStartPos() Position indicating the start of the claim in the answer candidate, measured in bytes.
GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim	setCitationIndices(List<Integer> citationIndices) A list of indices (into 'cited_chunks') specifying the citations associated with the claim.
GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim	setClaimText(String claimText) Text for the claim in the answer candidate.
GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim	setEndPos(Integer endPos) Position indicating the end of the claim in the answer candidate, exclusive, in bytes.
GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim	setGroundingCheckRequired(Boolean groundingCheckRequired) Indicates that this claim required grounding check.
GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim	setScore(Double score) Confidence score for the claim in the answer candidate, in the range of [0, 1].
GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim	setStartPos(Integer startPos) Position indicating the start of the claim in the answer candidate, measured in bytes.

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

GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim

public GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim()

Method Detail

getCitationIndices

public List<Integer> getCitationIndices()

A list of indices (into 'cited_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited supporting for the claim. A citation to a fact indicates that the claim is supported by the fact.

Returns:

value or null for none

setCitationIndices

public GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim setCitationIndices(List<Integer> citationIndices)

A list of indices (into 'cited_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited supporting for the claim. A citation to a fact indicates that the claim is supported by the fact.

Parameters:

citationIndices - citationIndices or null for none

getClaimText

public String getClaimText()

Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.

Returns:

value or null for none

setClaimText

public GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim setClaimText(String claimText)

Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.

Parameters:

claimText - claimText or null for none

getEndPos

public Integer getEndPos()

Position indicating the end of the claim in the answer candidate, exclusive, in bytes. Note that this is not measured in characters and, therefore, must be rendered as such. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming- language-independent).

Returns:

value or null for none

setEndPos

public GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim setEndPos(Integer endPos)

Position indicating the end of the claim in the answer candidate, exclusive, in bytes. Note that this is not measured in characters and, therefore, must be rendered as such. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming- language-independent).

Parameters:

endPos - endPos or null for none

getGroundingCheckRequired

public Boolean getGroundingCheckRequired()

Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices should not be returned.

Returns:

value or null for none

setGroundingCheckRequired

public GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim setGroundingCheckRequired(Boolean groundingCheckRequired)

Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices should not be returned.

Parameters:

groundingCheckRequired - groundingCheckRequired or null for none

getScore

public Double getScore()

Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true.

Returns:

value or null for none

setScore

public GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim setScore(Double score)

Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true.

Parameters:

score - score or null for none

getStartPos

public Integer getStartPos()

Position indicating the start of the claim in the answer candidate, measured in bytes. Note that this is not measured in characters and, therefore, must be rendered in the user interface keeping in mind that some characters may take more than one byte. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language- independent).

Returns:

value or null for none

setStartPos

public GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim setStartPos(Integer startPos)

Position indicating the start of the claim in the answer candidate, measured in bytes. Note that this is not measured in characters and, therefore, must be rendered in the user interface keeping in mind that some characters may take more than one byte. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language- independent).

Parameters:

startPos - startPos or null for none

set

public GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim set(String fieldName,
                                                                   Object value)

Overrides:

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

clone

public GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim clone()

Overrides:

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