Class RagRetrievalConfig (1.23.0)

public final class RagRetrievalConfig extends GeneratedMessageV3 implements RagRetrievalConfigOrBuilder

Specifies the context retrieval config.

Protobuf type google.cloud.vertexai.v1.RagRetrievalConfig

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

RANKING_FIELD_NUMBER

public static final int RANKING_FIELD_NUMBER
Field Value
TypeDescription
int

TOP_K_FIELD_NUMBER

public static final int TOP_K_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RagRetrievalConfig getDefaultInstance()
Returns
TypeDescription
RagRetrievalConfig

getDescriptor()

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

newBuilder()

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

newBuilder(RagRetrievalConfig )

public static RagRetrievalConfig.Builder newBuilder(RagRetrievalConfig )
Parameter
NameDescription
RagRetrievalConfig
Returns
TypeDescription
RagRetrievalConfig.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public RagRetrievalConfig getDefaultInstanceForType()
Returns
TypeDescription
RagRetrievalConfig

getFilter()

public RagRetrievalConfig.Filter getFilter()

Optional. Config for filters.

.google.cloud.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
RagRetrievalConfig.Filter

The filter.

getFilterOrBuilder()

public RagRetrievalConfig.FilterOrBuilder getFilterOrBuilder()

Optional. Config for filters.

.google.cloud.vertexai.v1.RagRetrievalConfig.Filter filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
RagRetrievalConfig.FilterOrBuilder

getParserForType()

public Parser<RagRetrievalConfig> getParserForType()
Returns
TypeDescription
Parser<RagRetrievalConfig>
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];

Returns
TypeDescription
RagRetrievalConfig.Ranking

The ranking.

getRankingOrBuilder()

public RagRetrievalConfig.RankingOrBuilder getRankingOrBuilder()

Optional. Config for ranking and reranking.

.google.cloud.vertexai.v1.RagRetrievalConfig.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
RagRetrievalConfig.RankingOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTopK()

public int getTopK()

Optional. The number of contexts to retrieve.

int32 top_k = 1 [(.google.api.field_behavior) = OPTIONAL];

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

Whether the ranking 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 RagRetrievalConfig.Builder newBuilderForType()
Returns
TypeDescription
RagRetrievalConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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