com.google.cloud.aiplatform.v1beta1

Class RetrievalMetadata.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<RetrievalMetadata.Builder>

com.google.cloud.aiplatform.v1beta1.RetrievalMetadata.Builder

All Implemented Interfaces:

RetrievalMetadataOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

RetrievalMetadata

public static final class RetrievalMetadata.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RetrievalMetadata.Builder>
implements RetrievalMetadataOrBuilder

 Metadata related to retrieval in the grounding flow.
 

Protobuf type google.cloud.aiplatform.v1beta1.RetrievalMetadata

Method Summary

Modifier and Type	Method and Description
RetrievalMetadata.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RetrievalMetadata	build()
RetrievalMetadata	buildPartial()
RetrievalMetadata.Builder	clear()
RetrievalMetadata.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
RetrievalMetadata.Builder	clearGoogleSearchDynamicRetrievalScore() Optional.
RetrievalMetadata.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
RetrievalMetadata.Builder	clone()
RetrievalMetadata	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
float	getGoogleSearchDynamicRetrievalScore() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
RetrievalMetadata.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RetrievalMetadata.Builder	mergeFrom(com.google.protobuf.Message other)
RetrievalMetadata.Builder	mergeFrom(RetrievalMetadata other)
RetrievalMetadata.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
RetrievalMetadata.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RetrievalMetadata.Builder	setGoogleSearchDynamicRetrievalScore(float value) Optional.
RetrievalMetadata.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
RetrievalMetadata.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RetrievalMetadata.Builder>

clear

public RetrievalMetadata.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<RetrievalMetadata.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RetrievalMetadata.Builder>

getDefaultInstanceForType

public RetrievalMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public RetrievalMetadata build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public RetrievalMetadata buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public RetrievalMetadata.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<RetrievalMetadata.Builder>

setField

public RetrievalMetadata.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<RetrievalMetadata.Builder>

clearField

public RetrievalMetadata.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RetrievalMetadata.Builder>

clearOneof

public RetrievalMetadata.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RetrievalMetadata.Builder>

setRepeatedField

public RetrievalMetadata.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  int index,
                                                  Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RetrievalMetadata.Builder>

addRepeatedField

public RetrievalMetadata.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RetrievalMetadata.Builder>

mergeFrom

public RetrievalMetadata.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RetrievalMetadata.Builder>

mergeFrom

public RetrievalMetadata.Builder mergeFrom(RetrievalMetadata other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RetrievalMetadata.Builder>

mergeFrom

public RetrievalMetadata.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RetrievalMetadata.Builder>

Throws:

IOException

getGoogleSearchDynamicRetrievalScore

public float getGoogleSearchDynamicRetrievalScore()

 Optional. Score indicating how likely information from Google Search could
 help answer the prompt. The score is in the range `[0, 1]`, where 0 is the
 least likely and 1 is the most likely. This score is only populated when
 Google Search grounding and dynamic retrieval is enabled. It will be
 compared to the threshold to determine whether to trigger Google Search.
 

float google_search_dynamic_retrieval_score = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getGoogleSearchDynamicRetrievalScore in interface RetrievalMetadataOrBuilder

Returns:

The googleSearchDynamicRetrievalScore.

setGoogleSearchDynamicRetrievalScore

public RetrievalMetadata.Builder setGoogleSearchDynamicRetrievalScore(float value)

 Optional. Score indicating how likely information from Google Search could
 help answer the prompt. The score is in the range `[0, 1]`, where 0 is the
 least likely and 1 is the most likely. This score is only populated when
 Google Search grounding and dynamic retrieval is enabled. It will be
 compared to the threshold to determine whether to trigger Google Search.
 

float google_search_dynamic_retrieval_score = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The googleSearchDynamicRetrievalScore to set.

Returns:

This builder for chaining.

clearGoogleSearchDynamicRetrievalScore

public RetrievalMetadata.Builder clearGoogleSearchDynamicRetrievalScore()

 Optional. Score indicating how likely information from Google Search could
 help answer the prompt. The score is in the range `[0, 1]`, where 0 is the
 least likely and 1 is the most likely. This score is only populated when
 Google Search grounding and dynamic retrieval is enabled. It will be
 compared to the threshold to determine whether to trigger Google Search.
 

float google_search_dynamic_retrieval_score = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

setUnknownFields

public final RetrievalMetadata.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RetrievalMetadata.Builder>

mergeUnknownFields

public final RetrievalMetadata.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RetrievalMetadata.Builder>