Class GroundingAttribution (3.45.0)

public final class GroundingAttribution extends GeneratedMessageV3 implements GroundingAttributionOrBuilder

Grounding attribution.

Protobuf type google.cloud.aiplatform.v1beta1.GroundingAttribution

Static Fields

CONFIDENCE_SCORE_FIELD_NUMBER

public static final int CONFIDENCE_SCORE_FIELD_NUMBER
Field Value
Type Description
int

RETRIEVED_CONTEXT_FIELD_NUMBER

public static final int RETRIEVED_CONTEXT_FIELD_NUMBER
Field Value
Type Description
int

SEGMENT_FIELD_NUMBER

public static final int SEGMENT_FIELD_NUMBER
Field Value
Type Description
int

WEB_FIELD_NUMBER

public static final int WEB_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GroundingAttribution getDefaultInstance()
Returns
Type Description
GroundingAttribution

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static GroundingAttribution.Builder newBuilder()
Returns
Type Description
GroundingAttribution.Builder

newBuilder(GroundingAttribution prototype)

public static GroundingAttribution.Builder newBuilder(GroundingAttribution prototype)
Parameter
Name Description
prototype GroundingAttribution
Returns
Type Description
GroundingAttribution.Builder

parseDelimitedFrom(InputStream input)

public static GroundingAttribution parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GroundingAttribution
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GroundingAttribution parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GroundingAttribution
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GroundingAttribution parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GroundingAttribution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GroundingAttribution parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GroundingAttribution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GroundingAttribution parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GroundingAttribution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GroundingAttribution parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GroundingAttribution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GroundingAttribution parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GroundingAttribution
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GroundingAttribution parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GroundingAttribution
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static GroundingAttribution parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GroundingAttribution
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GroundingAttribution parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GroundingAttribution
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GroundingAttribution parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GroundingAttribution
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GroundingAttribution parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GroundingAttribution
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<GroundingAttribution> parser()
Returns
Type Description
Parser<GroundingAttribution>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getConfidenceScore()

public float getConfidenceScore()

Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident.

optional float confidence_score = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
float

The confidenceScore.

getDefaultInstanceForType()

public GroundingAttribution getDefaultInstanceForType()
Returns
Type Description
GroundingAttribution

getParserForType()

public Parser<GroundingAttribution> getParserForType()
Returns
Type Description
Parser<GroundingAttribution>
Overrides

getReferenceCase()

public GroundingAttribution.ReferenceCase getReferenceCase()
Returns
Type Description
GroundingAttribution.ReferenceCase

getRetrievedContext()

public GroundingAttribution.RetrievedContext getRetrievedContext()

Optional. Attribution from context retrieved by the retrieval tools.

.google.cloud.aiplatform.v1beta1.GroundingAttribution.RetrievedContext retrieved_context = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GroundingAttribution.RetrievedContext

The retrievedContext.

getRetrievedContextOrBuilder()

public GroundingAttribution.RetrievedContextOrBuilder getRetrievedContextOrBuilder()

Optional. Attribution from context retrieved by the retrieval tools.

.google.cloud.aiplatform.v1beta1.GroundingAttribution.RetrievedContext retrieved_context = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GroundingAttribution.RetrievedContextOrBuilder

getSegment()

public Segment getSegment()

Output only. Segment of the content this attribution belongs to.

.google.cloud.aiplatform.v1beta1.Segment segment = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Segment

The segment.

getSegmentOrBuilder()

public SegmentOrBuilder getSegmentOrBuilder()

Output only. Segment of the content this attribution belongs to.

.google.cloud.aiplatform.v1beta1.Segment segment = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SegmentOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getWeb()

public GroundingAttribution.Web getWeb()

Optional. Attribution from the web.

.google.cloud.aiplatform.v1beta1.GroundingAttribution.Web web = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GroundingAttribution.Web

The web.

getWebOrBuilder()

public GroundingAttribution.WebOrBuilder getWebOrBuilder()

Optional. Attribution from the web.

.google.cloud.aiplatform.v1beta1.GroundingAttribution.Web web = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
GroundingAttribution.WebOrBuilder

hasConfidenceScore()

public boolean hasConfidenceScore()

Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident.

optional float confidence_score = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the confidenceScore field is set.

hasRetrievedContext()

public boolean hasRetrievedContext()

Optional. Attribution from context retrieved by the retrieval tools.

.google.cloud.aiplatform.v1beta1.GroundingAttribution.RetrievedContext retrieved_context = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the retrievedContext field is set.

hasSegment()

public boolean hasSegment()

Output only. Segment of the content this attribution belongs to.

.google.cloud.aiplatform.v1beta1.Segment segment = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the segment field is set.

hasWeb()

public boolean hasWeb()

Optional. Attribution from the web.

.google.cloud.aiplatform.v1beta1.GroundingAttribution.Web web = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the web field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public GroundingAttribution.Builder newBuilderForType()
Returns
Type Description
GroundingAttribution.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GroundingAttribution.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GroundingAttribution.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public GroundingAttribution.Builder toBuilder()
Returns
Type Description
GroundingAttribution.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException