com.google.cloud.aiplatform.v1

Class RetrievalMetadata.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

com.google.cloud.aiplatform.v1.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.GeneratedMessage.Builder<RetrievalMetadata.Builder>
implements RetrievalMetadataOrBuilder

 Metadata related to retrieval in the grounding flow.
 

Protobuf type google.cloud.aiplatform.v1.RetrievalMetadata

Method Summary

Modifier and Type	Method and Description
RetrievalMetadata	build()
RetrievalMetadata	buildPartial()
RetrievalMetadata.Builder	clear()
RetrievalMetadata.Builder	clearGoogleSearchDynamicRetrievalScore() Optional.
RetrievalMetadata	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
float	getGoogleSearchDynamicRetrievalScore() Optional.
protected com.google.protobuf.GeneratedMessage.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	setGoogleSearchDynamicRetrievalScore(float value) Optional.

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

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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, mergeFrom, 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

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

mergeFrom

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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

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