com.google.cloud.aiplatform.v1beta1

Class RagQuery.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

com.google.cloud.aiplatform.v1beta1.RagQuery.Builder

All Implemented Interfaces:

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

Enclosing class:

RagQuery

public static final class RagQuery.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RagQuery.Builder>
implements RagQueryOrBuilder

 A query to retrieve relevant contexts.
 

Protobuf type google.cloud.aiplatform.v1beta1.RagQuery

Method Summary

Modifier and Type	Method and Description
RagQuery.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RagQuery	build()
RagQuery	buildPartial()
RagQuery.Builder	clear()
RagQuery.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
RagQuery.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
RagQuery.Builder	clearQuery()
RagQuery.Builder	clearRanking() Optional.
RagQuery.Builder	clearSimilarityTopK() Optional.
RagQuery.Builder	clearText() Optional.
RagQuery.Builder	clone()
RagQuery	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
RagQuery.QueryCase	getQueryCase()
RagQuery.Ranking	getRanking() Optional.
RagQuery.Ranking.Builder	getRankingBuilder() Optional.
RagQuery.RankingOrBuilder	getRankingOrBuilder() Optional.
int	getSimilarityTopK() Optional.
String	getText() Optional.
com.google.protobuf.ByteString	getTextBytes() Optional.
boolean	hasRanking() Optional.
boolean	hasText() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
RagQuery.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RagQuery.Builder	mergeFrom(com.google.protobuf.Message other)
RagQuery.Builder	mergeFrom(RagQuery other)
RagQuery.Builder	mergeRanking(RagQuery.Ranking value) Optional.
RagQuery.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
RagQuery.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RagQuery.Builder	setRanking(RagQuery.Ranking.Builder builderForValue) Optional.
RagQuery.Builder	setRanking(RagQuery.Ranking value) Optional.
RagQuery.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
RagQuery.Builder	setSimilarityTopK(int value) Optional.
RagQuery.Builder	setText(String value) Optional.
RagQuery.Builder	setTextBytes(com.google.protobuf.ByteString value) Optional.
RagQuery.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<RagQuery.Builder>

clear

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

getDefaultInstanceForType

public RagQuery getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public RagQuery build()

Specified by:

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

Specified by:

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

buildPartial

public RagQuery buildPartial()

Specified by:

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

Specified by:

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

clone

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

setField

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

clearField

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

clearOneof

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

setRepeatedField

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

addRepeatedField

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

mergeFrom

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

mergeFrom

public RagQuery.Builder mergeFrom(RagQuery other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

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

mergeFrom

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

Throws:

IOException

getQueryCase

public RagQuery.QueryCase getQueryCase()

Specified by:

getQueryCase in interface RagQueryOrBuilder

clearQuery

public RagQuery.Builder clearQuery()

hasText

public boolean hasText()

 Optional. The query in text format to get relevant contexts.
 

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasText in interface RagQueryOrBuilder

Returns:

Whether the text field is set.

getText

public String getText()

 Optional. The query in text format to get relevant contexts.
 

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getText in interface RagQueryOrBuilder

Returns:

The text.

getTextBytes

public com.google.protobuf.ByteString getTextBytes()

 Optional. The query in text format to get relevant contexts.
 

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getTextBytes in interface RagQueryOrBuilder

Returns:

The bytes for text.

setText

public RagQuery.Builder setText(String value)

 Optional. The query in text format to get relevant contexts.
 

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The text to set.

Returns:

This builder for chaining.

clearText

public RagQuery.Builder clearText()

 Optional. The query in text format to get relevant contexts.
 

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

setTextBytes

public RagQuery.Builder setTextBytes(com.google.protobuf.ByteString value)

 Optional. The query in text format to get relevant contexts.
 

string text = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The bytes for text to set.

Returns:

This builder for chaining.

getSimilarityTopK

public int getSimilarityTopK()

 Optional. The number of contexts to retrieve.
 

int32 similarity_top_k = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSimilarityTopK in interface RagQueryOrBuilder

Returns:

The similarityTopK.

setSimilarityTopK

public RagQuery.Builder setSimilarityTopK(int value)

 Optional. The number of contexts to retrieve.
 

int32 similarity_top_k = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The similarityTopK to set.

Returns:

This builder for chaining.

clearSimilarityTopK

public RagQuery.Builder clearSimilarityTopK()

 Optional. The number of contexts to retrieve.
 

int32 similarity_top_k = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

hasRanking

public boolean hasRanking()

 Optional. Configurations for hybrid search results ranking.
 

.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasRanking in interface RagQueryOrBuilder

Returns:

Whether the ranking field is set.

getRanking

public RagQuery.Ranking getRanking()

 Optional. Configurations for hybrid search results ranking.
 

.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRanking in interface RagQueryOrBuilder

Returns:

The ranking.

setRanking

public RagQuery.Builder setRanking(RagQuery.Ranking value)

 Optional. Configurations for hybrid search results ranking.
 

.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

setRanking

public RagQuery.Builder setRanking(RagQuery.Ranking.Builder builderForValue)

 Optional. Configurations for hybrid search results ranking.
 

.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

mergeRanking

public RagQuery.Builder mergeRanking(RagQuery.Ranking value)

 Optional. Configurations for hybrid search results ranking.
 

.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

clearRanking

public RagQuery.Builder clearRanking()

 Optional. Configurations for hybrid search results ranking.
 

.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

getRankingBuilder

public RagQuery.Ranking.Builder getRankingBuilder()

 Optional. Configurations for hybrid search results ranking.
 

.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

getRankingOrBuilder

public RagQuery.RankingOrBuilder getRankingOrBuilder()

 Optional. Configurations for hybrid search results ranking.
 

.google.cloud.aiplatform.v1beta1.RagQuery.Ranking ranking = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRankingOrBuilder in interface RagQueryOrBuilder

setUnknownFields

public final RagQuery.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<RagQuery.Builder>

mergeUnknownFields

public final RagQuery.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<RagQuery.Builder>