Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class RagQuery.Builder (3.77.0)

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

A query to retrieve relevant contexts.

Protobuf type google.cloud.aiplatform.v1beta1.RagQuery

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RagQuery.Builder

Implements

RagQueryOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RagQuery.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`RagQuery.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public RagQuery build()

Returns
Type	Description
`RagQuery`

buildPartial()

public RagQuery buildPartial()

Returns
Type	Description
`RagQuery`

clear()

public RagQuery.Builder clear()

Returns
Type	Description
`RagQuery.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public RagQuery.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`RagQuery.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public RagQuery.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`RagQuery.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearQuery()

public RagQuery.Builder clearQuery()

Returns
Type	Description
`RagQuery.Builder`

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];

Returns
Type	Description
`RagQuery.Builder`

clearRanking() (deprecated)

public RagQuery.Builder clearRanking()

Optional. Configurations for hybrid search results ranking.

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

Returns
Type	Description
`RagQuery.Builder`

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=92

Optional. The number of contexts to retrieve.

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

Returns
Type	Description
`RagQuery.Builder`	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
Type	Description
`RagQuery.Builder`	This builder for chaining.

clone()

public RagQuery.Builder clone()

Returns
Type	Description
`RagQuery.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public RagQuery getDefaultInstanceForType()

Returns
Type	Description
`RagQuery`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getQueryCase()

public RagQuery.QueryCase getQueryCase()

Returns
Type	Description
`RagQuery.QueryCase`

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];

Returns
Type	Description
`RagRetrievalConfig`	The ragRetrievalConfig.

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];

Returns
Type	Description
`RagRetrievalConfig.Builder`

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];

Returns
Type	Description
`RagRetrievalConfigOrBuilder`

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=96

Optional. Configurations for hybrid search results ranking.

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

Returns
Type	Description
`RagQuery.Ranking`	The ranking.

getRankingBuilder() (deprecated)

public RagQuery.Ranking.Builder getRankingBuilder()

Optional. Configurations for hybrid search results ranking.

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

Returns
Type	Description
`RagQuery.Ranking.Builder`

getRankingOrBuilder() (deprecated)

public RagQuery.RankingOrBuilder getRankingOrBuilder()

Optional. Configurations for hybrid search results ranking.

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

Returns
Type	Description
`RagQuery.RankingOrBuilder`

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=92

Optional. The number of contexts to retrieve.

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

Returns
Type	Description
`int`	The similarityTopK.

getText()

public String getText()

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

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

Returns
Type	Description
`String`	The text.

getTextBytes()

public ByteString getTextBytes()

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

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

Returns
Type	Description
`ByteString`	The bytes for text.

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];

Returns
Type	Description
`boolean`	Whether the ragRetrievalConfig field is set.

hasRanking() (deprecated)

public boolean hasRanking()

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

Optional. Configurations for hybrid search results ranking.

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

Returns
Type	Description
`boolean`	Whether the ranking field is set.

hasText()

public boolean hasText()

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

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

Returns
Type	Description
`boolean`	Whether the text field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(RagQuery other)

public RagQuery.Builder mergeFrom(RagQuery other)

Parameter
Name	Description
`other`	`RagQuery`

Returns
Type	Description
`RagQuery.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RagQuery.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`RagQuery.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public RagQuery.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`RagQuery.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeRagRetrievalConfig(RagRetrievalConfig value)

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];

Parameter
Name	Description
`value`	`RagRetrievalConfig`

Returns
Type	Description
`RagQuery.Builder`

mergeRanking(RagQuery.Ranking value) (deprecated)

public RagQuery.Builder mergeRanking(RagQuery.Ranking value)

Optional. Configurations for hybrid search results ranking.

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

Parameter
Name	Description
`value`	`RagQuery.Ranking`

Returns
Type	Description
`RagQuery.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RagQuery.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`RagQuery.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public RagQuery.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`RagQuery.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRagRetrievalConfig(RagRetrievalConfig value)

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];

Parameter
Name	Description
`value`	`RagRetrievalConfig`

Returns
Type	Description
`RagQuery.Builder`

setRagRetrievalConfig(RagRetrievalConfig.Builder builderForValue)

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];

Parameter
Name	Description
`builderForValue`	`RagRetrievalConfig.Builder`

Returns
Type	Description
`RagQuery.Builder`

setRanking(RagQuery.Ranking value) (deprecated)

public RagQuery.Builder setRanking(RagQuery.Ranking value)

Optional. Configurations for hybrid search results ranking.

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

Parameter
Name	Description
`value`	`RagQuery.Ranking`

Returns
Type	Description
`RagQuery.Builder`

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

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

Optional. Configurations for hybrid search results ranking.

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

Parameter
Name	Description
`builderForValue`	`RagQuery.Ranking.Builder`

Returns
Type	Description
`RagQuery.Builder`

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RagQuery.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`RagQuery.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSimilarityTopK(int value) (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=92

Optional. The number of contexts to retrieve.

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

Parameter
Name	Description
`value`	`int` The similarityTopK to set.

Returns
Type	Description
`RagQuery.Builder`	This builder for chaining.

setText(String value)

public RagQuery.Builder setText(String value)

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

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

Parameter
Name	Description
`value`	`String` The text to set.

Returns
Type	Description
`RagQuery.Builder`	This builder for chaining.

setTextBytes(ByteString value)

public RagQuery.Builder setTextBytes(ByteString value)

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

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

Parameter
Name	Description
`value`	`ByteString` The bytes for text to set.

Returns
Type	Description
`RagQuery.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RagQuery.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`RagQuery.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)