Class VertexRagStore.Builder (3.43.0)

Version 3.43.0

• 3.46.0 (latest)
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public static final class VertexRagStore.Builder extends GeneratedMessageV3.Builder<VertexRagStore.Builder> implements VertexRagStoreOrBuilder

Retrieve from Vertex RAG Store for grounding.

Protobuf type google.cloud.aiplatform.v1beta1.VertexRagStore

Inheritance

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

Implements

VertexRagStoreOrBuilder

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

addAllRagCorpora(Iterable<String> values)

public VertexRagStore.Builder addAllRagCorpora(Iterable<String> values)

Required. Vertex RAG Store corpus resource name: projects/{project}/locations/{location}/ragCorpora/{ragCorpus} Currently only one corpus is allowed. In the future we may open up multiple corpora support. However, they should be from the same project and location.

repeated string rag_corpora = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
values	Iterable<String> The ragCorpora to add.

Returns
Type	Description
VertexRagStore.Builder	This builder for chaining.

addRagCorpora(String value)

public VertexRagStore.Builder addRagCorpora(String value)

Required. Vertex RAG Store corpus resource name: projects/{project}/locations/{location}/ragCorpora/{ragCorpus} Currently only one corpus is allowed. In the future we may open up multiple corpora support. However, they should be from the same project and location.

repeated string rag_corpora = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
value	String The ragCorpora to add.

Returns
Type	Description
VertexRagStore.Builder	This builder for chaining.

addRagCorporaBytes(ByteString value)

public VertexRagStore.Builder addRagCorporaBytes(ByteString value)

Required. Vertex RAG Store corpus resource name: projects/{project}/locations/{location}/ragCorpora/{ragCorpus} Currently only one corpus is allowed. In the future we may open up multiple corpora support. However, they should be from the same project and location.

repeated string rag_corpora = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
value	ByteString The bytes of the ragCorpora to add.

Returns
Type	Description
VertexRagStore.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
VertexRagStore.Builder

Overrides

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

build()

public VertexRagStore build()

Returns
Type	Description
VertexRagStore

buildPartial()

public VertexRagStore buildPartial()

Returns
Type	Description
VertexRagStore

clear()

public VertexRagStore.Builder clear()

Returns
Type	Description
VertexRagStore.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public VertexRagStore.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
VertexRagStore.Builder

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

public VertexRagStore.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
VertexRagStore.Builder

Overrides

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

clearRagCorpora()

public VertexRagStore.Builder clearRagCorpora()

Required. Vertex RAG Store corpus resource name: projects/{project}/locations/{location}/ragCorpora/{ragCorpus} Currently only one corpus is allowed. In the future we may open up multiple corpora support. However, they should be from the same project and location.

repeated string rag_corpora = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
VertexRagStore.Builder	This builder for chaining.

clearSimilarityTopK()

public VertexRagStore.Builder clearSimilarityTopK()

Optional. Number of top k results to return from the selected corpora.

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

Returns
Type	Description
VertexRagStore.Builder	This builder for chaining.

clone()

public VertexRagStore.Builder clone()

Returns
Type	Description
VertexRagStore.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public VertexRagStore getDefaultInstanceForType()

Returns
Type	Description
VertexRagStore

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getRagCorpora(int index)

public String getRagCorpora(int index)

Required. Vertex RAG Store corpus resource name: projects/{project}/locations/{location}/ragCorpora/{ragCorpus} Currently only one corpus is allowed. In the future we may open up multiple corpora support. However, they should be from the same project and location.

repeated string rag_corpora = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The ragCorpora at the given index.

getRagCorporaBytes(int index)

public ByteString getRagCorporaBytes(int index)

Required. Vertex RAG Store corpus resource name: projects/{project}/locations/{location}/ragCorpora/{ragCorpus} Currently only one corpus is allowed. In the future we may open up multiple corpora support. However, they should be from the same project and location.

repeated string rag_corpora = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the ragCorpora at the given index.

getRagCorporaCount()

public int getRagCorporaCount()

Required. Vertex RAG Store corpus resource name: projects/{project}/locations/{location}/ragCorpora/{ragCorpus} Currently only one corpus is allowed. In the future we may open up multiple corpora support. However, they should be from the same project and location.

repeated string rag_corpora = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
int	The count of ragCorpora.

getRagCorporaList()

public ProtocolStringList getRagCorporaList()

Required. Vertex RAG Store corpus resource name: projects/{project}/locations/{location}/ragCorpora/{ragCorpus} Currently only one corpus is allowed. In the future we may open up multiple corpora support. However, they should be from the same project and location.

repeated string rag_corpora = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ProtocolStringList	A list containing the ragCorpora.

getSimilarityTopK()

public int getSimilarityTopK()

Optional. Number of top k results to return from the selected corpora.

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

Returns
Type	Description
int	The similarityTopK.

hasSimilarityTopK()

public boolean hasSimilarityTopK()

Optional. Number of top k results to return from the selected corpora.

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

Returns
Type	Description
boolean	Whether the similarityTopK 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(VertexRagStore other)

public VertexRagStore.Builder mergeFrom(VertexRagStore other)

Parameter
Name	Description
other	VertexRagStore

Returns
Type	Description
VertexRagStore.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VertexRagStore.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public VertexRagStore.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
VertexRagStore.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final VertexRagStore.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
VertexRagStore.Builder

Overrides

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

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
VertexRagStore.Builder

Overrides

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

setRagCorpora(int index, String value)

public VertexRagStore.Builder setRagCorpora(int index, String value)

Required. Vertex RAG Store corpus resource name: projects/{project}/locations/{location}/ragCorpora/{ragCorpus} Currently only one corpus is allowed. In the future we may open up multiple corpora support. However, they should be from the same project and location.

repeated string rag_corpora = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameters
Name	Description
index	int The index to set the value at.
value	String The ragCorpora to set.

Returns
Type	Description
VertexRagStore.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
VertexRagStore.Builder

Overrides

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

setSimilarityTopK(int value)

public VertexRagStore.Builder setSimilarityTopK(int value)

Optional. Number of top k results to return from the selected corpora.

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

Parameter
Name	Description
value	int The similarityTopK to set.

Returns
Type	Description
VertexRagStore.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final VertexRagStore.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
VertexRagStore.Builder

Overrides

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