Package 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.GeneratedMessage.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.GeneratedMessage.Builder<RagQuery.Builder>
implements RagQueryOrBuilder

 A query to retrieve relevant contexts.
 

Protobuf type google.cloud.aiplatform.v1beta1.RagQuery

Method Summary

Modifier and Type	Method	Description
RagQuery	build()
RagQuery	buildPartial()
RagQuery.Builder	clear()
RagQuery.Builder	clearQuery()
RagQuery.Builder	clearRagRetrievalConfig()	Optional.
RagQuery.Builder	clearRanking()	Deprecated.
RagQuery.Builder	clearSimilarityTopK()	Deprecated. google.cloud.aiplatform.v1beta1.RagQuery.similarity_top_k is deprecated.
RagQuery.Builder	clearText()	Optional.
RagQuery	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
RagQuery.QueryCase	getQueryCase()
RagRetrievalConfig	getRagRetrievalConfig()	Optional.
RagRetrievalConfig.Builder	getRagRetrievalConfigBuilder()	Optional.
RagRetrievalConfigOrBuilder	getRagRetrievalConfigOrBuilder()	Optional.
RagQuery.Ranking	getRanking()	Deprecated. google.cloud.aiplatform.v1beta1.RagQuery.ranking is deprecated.
RagQuery.Ranking.Builder	getRankingBuilder()	Deprecated.
RagQuery.RankingOrBuilder	getRankingOrBuilder()	Deprecated.
int	getSimilarityTopK()	Deprecated. google.cloud.aiplatform.v1beta1.RagQuery.similarity_top_k is deprecated.
String	getText()	Optional.
com.google.protobuf.ByteString	getTextBytes()	Optional.
boolean	hasRagRetrievalConfig()	Optional.
boolean	hasRanking()	Deprecated. google.cloud.aiplatform.v1beta1.RagQuery.ranking is deprecated.
boolean	hasText()	Optional.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
RagQuery.Builder	mergeFrom(RagQuery other)
RagQuery.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RagQuery.Builder	mergeFrom(com.google.protobuf.Message other)
RagQuery.Builder	mergeRagRetrievalConfig(RagRetrievalConfig value)	Optional.
RagQuery.Builder	mergeRanking(RagQuery.Ranking value)	Deprecated.
RagQuery.Builder	setRagRetrievalConfig(RagRetrievalConfig value)	Optional.
RagQuery.Builder	setRagRetrievalConfig(RagRetrievalConfig.Builder builderForValue)	Optional.
RagQuery.Builder	setRanking(RagQuery.Ranking value)	Deprecated.
RagQuery.Builder	setRanking(RagQuery.Ranking.Builder builderForValue)	Deprecated.
RagQuery.Builder	setSimilarityTopK(int value)	Deprecated. google.cloud.aiplatform.v1beta1.RagQuery.similarity_top_k is deprecated.
RagQuery.Builder	setText(String value)	Optional.
RagQuery.Builder	setTextBytes(com.google.protobuf.ByteString 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.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

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

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Details

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

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

@Deprecated
public int getSimilarityTopK()

Deprecated.

google.cloud.aiplatform.v1beta1.RagQuery.similarity_top_k is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=117

 Optional. The number of contexts to retrieve.
 

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

Specified by:

getSimilarityTopK in interface RagQueryOrBuilder

Returns:

The similarityTopK.

setSimilarityTopK

@Deprecated
public RagQuery.Builder setSimilarityTopK(int value)

Deprecated.

google.cloud.aiplatform.v1beta1.RagQuery.similarity_top_k is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=117

 Optional. The number of contexts to retrieve.
 

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

Parameters:

value - The similarityTopK to set.

Returns:

This builder for chaining.

clearSimilarityTopK

@Deprecated
public RagQuery.Builder clearSimilarityTopK()

Deprecated.

google.cloud.aiplatform.v1beta1.RagQuery.similarity_top_k is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=117

 Optional. The number of contexts to retrieve.
 

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

Returns:

This builder for chaining.

hasRanking

@Deprecated
public boolean hasRanking()

Deprecated.

google.cloud.aiplatform.v1beta1.RagQuery.ranking is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=121

 Optional. Configurations for hybrid search results ranking.
 

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

Specified by:

hasRanking in interface RagQueryOrBuilder

Returns:

Whether the ranking field is set.

getRanking

@Deprecated
public RagQuery.Ranking getRanking()

Deprecated.

google.cloud.aiplatform.v1beta1.RagQuery.ranking is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=121

 Optional. Configurations for hybrid search results ranking.
 

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

Specified by:

getRanking in interface RagQueryOrBuilder

Returns:

The ranking.

setRanking

@Deprecated
public RagQuery.Builder setRanking(RagQuery.Ranking value)

Deprecated.

 Optional. Configurations for hybrid search results ranking.
 

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

setRanking

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

Deprecated.

 Optional. Configurations for hybrid search results ranking.
 

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

mergeRanking

@Deprecated
public RagQuery.Builder mergeRanking(RagQuery.Ranking value)

Deprecated.

 Optional. Configurations for hybrid search results ranking.
 

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

clearRanking

@Deprecated
public RagQuery.Builder clearRanking()

Deprecated.

 Optional. Configurations for hybrid search results ranking.
 

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

getRankingBuilder

@Deprecated
public RagQuery.Ranking.Builder getRankingBuilder()

Deprecated.

 Optional. Configurations for hybrid search results ranking.
 

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

getRankingOrBuilder

@Deprecated
public RagQuery.RankingOrBuilder getRankingOrBuilder()

Deprecated.

 Optional. Configurations for hybrid search results ranking.
 

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

Specified by:

getRankingOrBuilder in interface RagQueryOrBuilder

hasRagRetrievalConfig

public boolean hasRagRetrievalConfig()

 Optional. The retrieval config for the query.
 

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasRagRetrievalConfig in interface RagQueryOrBuilder

Returns:

Whether the ragRetrievalConfig field is set.

getRagRetrievalConfig

public RagRetrievalConfig getRagRetrievalConfig()

 Optional. The retrieval config for the query.
 

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRagRetrievalConfig in interface RagQueryOrBuilder

Returns:

The ragRetrievalConfig.

setRagRetrievalConfig

public RagQuery.Builder setRagRetrievalConfig(RagRetrievalConfig value)

 Optional. The retrieval config for the query.
 

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

setRagRetrievalConfig

public RagQuery.Builder setRagRetrievalConfig(RagRetrievalConfig.Builder builderForValue)

 Optional. The retrieval config for the query.
 

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

mergeRagRetrievalConfig

public RagQuery.Builder mergeRagRetrievalConfig(RagRetrievalConfig value)

 Optional. The retrieval config for the query.
 

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

clearRagRetrievalConfig

public RagQuery.Builder clearRagRetrievalConfig()

 Optional. The retrieval config for the query.
 

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

getRagRetrievalConfigBuilder

public RagRetrievalConfig.Builder getRagRetrievalConfigBuilder()

 Optional. The retrieval config for the query.
 

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

getRagRetrievalConfigOrBuilder

public RagRetrievalConfigOrBuilder getRagRetrievalConfigOrBuilder()

 Optional. The retrieval config for the query.
 

.google.cloud.aiplatform.v1beta1.RagRetrievalConfig rag_retrieval_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRagRetrievalConfigOrBuilder in interface RagQueryOrBuilder