Class VertexRanker.Builder (0.15.0)

0.15.0 (latest) 0.12.0 0.9.0 0.8.0 0.6.0 0.4.0 0.3.0 0.1.0

public static final class VertexRanker.Builder extends GeneratedMessage.Builder<VertexRanker.Builder> implements VertexRankerOrBuilder

Defines a ranker using the Vertex AI ranking service. See https://cloud.google.com/generative-ai-app-builder/docs/ranking for details.

Protobuf type google.cloud.vectorsearch.v1beta.VertexRanker

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > VertexRanker.Builder

Implements

VertexRankerOrBuilder

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)

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

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

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

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

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

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

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

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

GeneratedMessage.Builder.internalGetMutableMapField(int)

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

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

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

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

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

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

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

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

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

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.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

build()

public VertexRanker build()

Returns
Type	Description
VertexRanker

buildPartial()

public VertexRanker buildPartial()

Returns
Type	Description
VertexRanker

clear()

public VertexRanker.Builder clear()

Returns
Type	Description
VertexRanker.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearModel()

public VertexRanker.Builder clearModel()

Required. The model used for ranking documents. The list of available models is described in https://docs.cloud.google.com/generative-ai-app-builder/docs/ranking#models. Currently, only semantic-ranker-fast@latest is supported.

string model = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
VertexRanker.Builder	This builder for chaining.

clearRecordSpec()

public VertexRanker.Builder clearRecordSpec()

Returns
Type	Description
VertexRanker.Builder

clearTextRecordSpec()

public VertexRanker.Builder clearTextRecordSpec()

The record spec for text search.

.google.cloud.vectorsearch.v1beta.VertexRanker.TextRecordSpec text_record_spec = 6;

Returns
Type	Description
VertexRanker.Builder

clearTopN()

public VertexRanker.Builder clearTopN()

Required. The number of documents to be processed for ranking.

int32 top_n = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
VertexRanker.Builder	This builder for chaining.

getDefaultInstanceForType()

public VertexRanker getDefaultInstanceForType()

Returns
Type	Description
VertexRanker

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getModel()

public String getModel()

Required. The model used for ranking documents. The list of available models is described in https://docs.cloud.google.com/generative-ai-app-builder/docs/ranking#models. Currently, only semantic-ranker-fast@latest is supported.

string model = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The model.

getModelBytes()

public ByteString getModelBytes()

Required. The model used for ranking documents. The list of available models is described in https://docs.cloud.google.com/generative-ai-app-builder/docs/ranking#models. Currently, only semantic-ranker-fast@latest is supported.

string model = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for model.

getRecordSpecCase()

public VertexRanker.RecordSpecCase getRecordSpecCase()

Returns
Type	Description
VertexRanker.RecordSpecCase

getTextRecordSpec()

public VertexRanker.TextRecordSpec getTextRecordSpec()

The record spec for text search.

.google.cloud.vectorsearch.v1beta.VertexRanker.TextRecordSpec text_record_spec = 6;

Returns
Type	Description
VertexRanker.TextRecordSpec	The textRecordSpec.

getTextRecordSpecBuilder()

public VertexRanker.TextRecordSpec.Builder getTextRecordSpecBuilder()

The record spec for text search.

.google.cloud.vectorsearch.v1beta.VertexRanker.TextRecordSpec text_record_spec = 6;

Returns
Type	Description
VertexRanker.TextRecordSpec.Builder

getTextRecordSpecOrBuilder()

public VertexRanker.TextRecordSpecOrBuilder getTextRecordSpecOrBuilder()

The record spec for text search.

.google.cloud.vectorsearch.v1beta.VertexRanker.TextRecordSpec text_record_spec = 6;

Returns
Type	Description
VertexRanker.TextRecordSpecOrBuilder

getTopN()

public int getTopN()

Required. The number of documents to be processed for ranking.

int32 top_n = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The topN.

hasTextRecordSpec()

public boolean hasTextRecordSpec()

The record spec for text search.

.google.cloud.vectorsearch.v1beta.VertexRanker.TextRecordSpec text_record_spec = 6;

Returns
Type	Description
boolean	Whether the textRecordSpec field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(VertexRanker other)

public VertexRanker.Builder mergeFrom(VertexRanker other)

Parameter
Name	Description
other	VertexRanker

Returns
Type	Description
VertexRanker.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VertexRanker.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public VertexRanker.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
VertexRanker.Builder

Overrides

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

mergeTextRecordSpec(VertexRanker.TextRecordSpec value)

public VertexRanker.Builder mergeTextRecordSpec(VertexRanker.TextRecordSpec value)

The record spec for text search.

.google.cloud.vectorsearch.v1beta.VertexRanker.TextRecordSpec text_record_spec = 6;

Parameter
Name	Description
value	VertexRanker.TextRecordSpec

Returns
Type	Description
VertexRanker.Builder

setModel(String value)

public VertexRanker.Builder setModel(String value)

Required. The model used for ranking documents. The list of available models is described in https://docs.cloud.google.com/generative-ai-app-builder/docs/ranking#models. Currently, only semantic-ranker-fast@latest is supported.

string model = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The model to set.

Returns
Type	Description
VertexRanker.Builder	This builder for chaining.

setModelBytes(ByteString value)

public VertexRanker.Builder setModelBytes(ByteString value)

Required. The model used for ranking documents. The list of available models is described in https://docs.cloud.google.com/generative-ai-app-builder/docs/ranking#models. Currently, only semantic-ranker-fast@latest is supported.

string model = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for model to set.

Returns
Type	Description
VertexRanker.Builder	This builder for chaining.

setTextRecordSpec(VertexRanker.TextRecordSpec value)

public VertexRanker.Builder setTextRecordSpec(VertexRanker.TextRecordSpec value)

The record spec for text search.

.google.cloud.vectorsearch.v1beta.VertexRanker.TextRecordSpec text_record_spec = 6;

Parameter
Name	Description
value	VertexRanker.TextRecordSpec

Returns
Type	Description
VertexRanker.Builder

setTextRecordSpec(VertexRanker.TextRecordSpec.Builder builderForValue)

public VertexRanker.Builder setTextRecordSpec(VertexRanker.TextRecordSpec.Builder builderForValue)

The record spec for text search.

.google.cloud.vectorsearch.v1beta.VertexRanker.TextRecordSpec text_record_spec = 6;

Parameter
Name	Description
builderForValue	VertexRanker.TextRecordSpec.Builder

Returns
Type	Description
VertexRanker.Builder

setTopN(int value)

public VertexRanker.Builder setTopN(int value)

Required. The number of documents to be processed for ranking.

int32 top_n = 5 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	int The topN to set.

Returns
Type	Description
VertexRanker.Builder	This builder for chaining.