Class GroundingAttribution (3.40.0)

public final class GroundingAttribution extends GeneratedMessageV3 implements GroundingAttributionOrBuilder

Grounding attribution.

Protobuf type google.cloud.aiplatform.v1.GroundingAttribution

Static Fields

CONFIDENCE_SCORE_FIELD_NUMBER

public static final int CONFIDENCE_SCORE_FIELD_NUMBER
Field Value
TypeDescription
int

SEGMENT_FIELD_NUMBER

public static final int SEGMENT_FIELD_NUMBER
Field Value
TypeDescription
int

WEB_FIELD_NUMBER

public static final int WEB_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static GroundingAttribution getDefaultInstance()
Returns
TypeDescription
GroundingAttribution

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static GroundingAttribution.Builder newBuilder()
Returns
TypeDescription
GroundingAttribution.Builder

newBuilder(GroundingAttribution prototype)

public static GroundingAttribution.Builder newBuilder(GroundingAttribution prototype)
Parameter
NameDescription
prototypeGroundingAttribution
Returns
TypeDescription
GroundingAttribution.Builder

parseDelimitedFrom(InputStream input)

public static GroundingAttribution parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GroundingAttribution
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GroundingAttribution parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GroundingAttribution
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static GroundingAttribution parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
GroundingAttribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GroundingAttribution parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GroundingAttribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GroundingAttribution parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
GroundingAttribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GroundingAttribution parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GroundingAttribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GroundingAttribution parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
GroundingAttribution
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GroundingAttribution parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GroundingAttribution
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static GroundingAttribution parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GroundingAttribution
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GroundingAttribution parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GroundingAttribution
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static GroundingAttribution parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
GroundingAttribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GroundingAttribution parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GroundingAttribution
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<GroundingAttribution> parser()
Returns
TypeDescription
Parser<GroundingAttribution>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
float

The confidenceScore.

getDefaultInstanceForType()

public GroundingAttribution getDefaultInstanceForType()
Returns
TypeDescription
GroundingAttribution

getParserForType()

public Parser<GroundingAttribution> getParserForType()
Returns
TypeDescription
Parser<GroundingAttribution>
Overrides

getReferenceCase()

public GroundingAttribution.ReferenceCase getReferenceCase()
Returns
TypeDescription
GroundingAttribution.ReferenceCase

getSegment()

public Segment getSegment()

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

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

Returns
TypeDescription
Segment

The segment.

getSegmentOrBuilder()

public SegmentOrBuilder getSegmentOrBuilder()

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

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

Returns
TypeDescription
SegmentOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getWeb()

public GroundingAttribution.Web getWeb()

Optional. Attribution from the web.

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

Returns
TypeDescription
GroundingAttribution.Web

The web.

getWebOrBuilder()

public GroundingAttribution.WebOrBuilder getWebOrBuilder()

Optional. Attribution from the web.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the confidenceScore field is set.

hasSegment()

public boolean hasSegment()

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

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

Returns
TypeDescription
boolean

Whether the segment field is set.

hasWeb()

public boolean hasWeb()

Optional. Attribution from the web.

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

Returns
TypeDescription
boolean

Whether the web field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public GroundingAttribution.Builder newBuilderForType()
Returns
TypeDescription
GroundingAttribution.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GroundingAttribution.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
GroundingAttribution.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public GroundingAttribution.Builder toBuilder()
Returns
TypeDescription
GroundingAttribution.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException