Class GroundingAttribution.Builder (3.43.0)

public static final class GroundingAttribution.Builder extends GeneratedMessageV3.Builder<GroundingAttribution.Builder> implements GroundingAttributionOrBuilder

Grounding attribution.

Protobuf type google.cloud.aiplatform.v1beta1.GroundingAttribution

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GroundingAttribution.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GroundingAttribution.Builder
Overrides

build()

public GroundingAttribution build()
Returns
Type Description
GroundingAttribution

buildPartial()

public GroundingAttribution buildPartial()
Returns
Type Description
GroundingAttribution

clear()

public GroundingAttribution.Builder clear()
Returns
Type Description
GroundingAttribution.Builder
Overrides

clearConfidenceScore()

public GroundingAttribution.Builder clearConfidenceScore()

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
GroundingAttribution.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public GroundingAttribution.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
GroundingAttribution.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public GroundingAttribution.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
GroundingAttribution.Builder
Overrides

clearReference()

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

clearRetrievedContext()

public GroundingAttribution.Builder clearRetrievedContext()

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

clearSegment()

public GroundingAttribution.Builder clearSegment()

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
GroundingAttribution.Builder

clearWeb()

public GroundingAttribution.Builder clearWeb()

Optional. Attribution from the web.

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

Returns
Type Description
GroundingAttribution.Builder

clone()

public GroundingAttribution.Builder clone()
Returns
Type Description
GroundingAttribution.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

getRetrievedContextBuilder()

public GroundingAttribution.RetrievedContext.Builder getRetrievedContextBuilder()

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

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.

getSegmentBuilder()

public Segment.Builder getSegmentBuilder()

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

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

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.

getWebBuilder()

public GroundingAttribution.Web.Builder getWebBuilder()

Optional. Attribution from the web.

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

Returns
Type Description
GroundingAttribution.Web.Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(GroundingAttribution other)

public GroundingAttribution.Builder mergeFrom(GroundingAttribution other)
Parameter
Name Description
other GroundingAttribution
Returns
Type Description
GroundingAttribution.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GroundingAttribution.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GroundingAttribution.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public GroundingAttribution.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GroundingAttribution.Builder
Overrides

mergeRetrievedContext(GroundingAttribution.RetrievedContext value)

public GroundingAttribution.Builder mergeRetrievedContext(GroundingAttribution.RetrievedContext value)

Optional. Attribution from context retrieved by the retrieval tools.

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

Parameter
Name Description
value GroundingAttribution.RetrievedContext
Returns
Type Description
GroundingAttribution.Builder

mergeSegment(Segment value)

public GroundingAttribution.Builder mergeSegment(Segment value)

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

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

Parameter
Name Description
value Segment
Returns
Type Description
GroundingAttribution.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GroundingAttribution.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GroundingAttribution.Builder
Overrides

mergeWeb(GroundingAttribution.Web value)

public GroundingAttribution.Builder mergeWeb(GroundingAttribution.Web value)

Optional. Attribution from the web.

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

Parameter
Name Description
value GroundingAttribution.Web
Returns
Type Description
GroundingAttribution.Builder

setConfidenceScore(float value)

public GroundingAttribution.Builder setConfidenceScore(float value)

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];

Parameter
Name Description
value float

The confidenceScore to set.

Returns
Type Description
GroundingAttribution.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public GroundingAttribution.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GroundingAttribution.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GroundingAttribution.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
GroundingAttribution.Builder
Overrides

setRetrievedContext(GroundingAttribution.RetrievedContext value)

public GroundingAttribution.Builder setRetrievedContext(GroundingAttribution.RetrievedContext value)

Optional. Attribution from context retrieved by the retrieval tools.

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

Parameter
Name Description
value GroundingAttribution.RetrievedContext
Returns
Type Description
GroundingAttribution.Builder

setRetrievedContext(GroundingAttribution.RetrievedContext.Builder builderForValue)

public GroundingAttribution.Builder setRetrievedContext(GroundingAttribution.RetrievedContext.Builder builderForValue)

Optional. Attribution from context retrieved by the retrieval tools.

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

Parameter
Name Description
builderForValue GroundingAttribution.RetrievedContext.Builder
Returns
Type Description
GroundingAttribution.Builder

setSegment(Segment value)

public GroundingAttribution.Builder setSegment(Segment value)

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

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

Parameter
Name Description
value Segment
Returns
Type Description
GroundingAttribution.Builder

setSegment(Segment.Builder builderForValue)

public GroundingAttribution.Builder setSegment(Segment.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Segment.Builder
Returns
Type Description
GroundingAttribution.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final GroundingAttribution.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GroundingAttribution.Builder
Overrides

setWeb(GroundingAttribution.Web value)

public GroundingAttribution.Builder setWeb(GroundingAttribution.Web value)

Optional. Attribution from the web.

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

Parameter
Name Description
value GroundingAttribution.Web
Returns
Type Description
GroundingAttribution.Builder

setWeb(GroundingAttribution.Web.Builder builderForValue)

public GroundingAttribution.Builder setWeb(GroundingAttribution.Web.Builder builderForValue)

Optional. Attribution from the web.

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

Parameter
Name Description
builderForValue GroundingAttribution.Web.Builder
Returns
Type Description
GroundingAttribution.Builder