Send feedback
Class RagRetrievalConfig (1.20.0)
Stay organized with collections
Save and categorize content based on your preferences.
public final class RagRetrievalConfig extends GeneratedMessageV3 implements RagRetrievalConfigOrBuilder
Specifies the context retrieval config.
Protobuf type google.cloud.vertexai.v1.RagRetrievalConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int
RANKING_FIELD_NUMBER
public static final int RANKING_FIELD_NUMBER
Field Value
Type Description
int
TOP_K_FIELD_NUMBER
public static final int TOP_K_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static RagRetrievalConfig getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static RagRetrievalConfig . Builder newBuilder ()
newBuilder(RagRetrievalConfig prototype)
public static RagRetrievalConfig . Builder newBuilder ( RagRetrievalConfig prototype )
public static RagRetrievalConfig parseDelimitedFrom ( InputStream input )
public static RagRetrievalConfig parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static RagRetrievalConfig parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RagRetrievalConfig parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static RagRetrievalConfig parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RagRetrievalConfig parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static RagRetrievalConfig parseFrom ( CodedInputStream input )
public static RagRetrievalConfig parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static RagRetrievalConfig parseFrom ( InputStream input )
public static RagRetrievalConfig parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static RagRetrievalConfig parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RagRetrievalConfig parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<RagRetrievalConfig> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public RagRetrievalConfig getDefaultInstanceForType ()
getFilter()
public RagRetrievalConfig . Filter getFilter ()
Optional. Config for filters.
.google.cloud.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];
getFilterOrBuilder()
public RagRetrievalConfig . FilterOrBuilder getFilterOrBuilder ()
Optional. Config for filters.
.google.cloud.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];
getParserForType()
public Parser<RagRetrievalConfig> getParserForType ()
Overrides
getRanking()
public RagRetrievalConfig . Ranking getRanking ()
Optional. Config for ranking and reranking.
.google.cloud.vertexai.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];
getRankingOrBuilder()
public RagRetrievalConfig . RankingOrBuilder getRankingOrBuilder ()
Optional. Config for ranking and reranking.
.google.cloud.vertexai.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getTopK()
Optional. The number of contexts to retrieve.
int32 top_k = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int The topK.
hasFilter()
public boolean hasFilter ()
Optional. Config for filters.
.google.cloud.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the filter field is set.
hasRanking()
public boolean hasRanking ()
Optional. Config for ranking and reranking.
.google.cloud.vertexai.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the ranking field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public RagRetrievalConfig . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RagRetrievalConfig . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public RagRetrievalConfig . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-22 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-22 UTC."],[],[]]
