Class VertexRanker (0.6.0)

Version latest

• 0.6.0 (latest)
• 0.4.0
• 0.3.0
• 0.1.0

public final class VertexRanker extends GeneratedMessage 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

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > VertexRanker

Implements

VertexRankerOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

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

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CONTENT_TEMPLATE_FIELD_NUMBER

public static final int CONTENT_TEMPLATE_FIELD_NUMBER

Field Value
Type	Description
int

MODEL_FIELD_NUMBER

public static final int MODEL_FIELD_NUMBER

Field Value
Type	Description
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER

Field Value
Type	Description
int

TITLE_TEMPLATE_FIELD_NUMBER

public static final int TITLE_TEMPLATE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static VertexRanker getDefaultInstance()

Returns
Type	Description
VertexRanker

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static VertexRanker.Builder newBuilder()

Returns
Type	Description
VertexRanker.Builder

newBuilder(VertexRanker prototype)

public static VertexRanker.Builder newBuilder(VertexRanker prototype)

Parameter
Name	Description
prototype	VertexRanker

Returns
Type	Description
VertexRanker.Builder

parseDelimitedFrom(InputStream input)

public static VertexRanker parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
VertexRanker

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VertexRanker parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VertexRanker

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static VertexRanker parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
VertexRanker

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static VertexRanker parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VertexRanker

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static VertexRanker parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
VertexRanker

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static VertexRanker parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VertexRanker

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static VertexRanker parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
VertexRanker

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static VertexRanker parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VertexRanker

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static VertexRanker parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
VertexRanker

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static VertexRanker parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VertexRanker

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static VertexRanker parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
VertexRanker

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static VertexRanker parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VertexRanker

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<VertexRanker> parser()

Returns
Type	Description
Parser<VertexRanker>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getContentTemplate()

public String getContentTemplate()

Optional. The template used to generate the record's content.

string content_template = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The contentTemplate.

getContentTemplateBytes()

public ByteString getContentTemplateBytes()

Optional. The template used to generate the record's content.

string content_template = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for contentTemplate.

getDefaultInstanceForType()

public VertexRanker getDefaultInstanceForType()

Returns
Type	Description
VertexRanker

getModel()

public String getModel()

Required. The model used for ranking documents. If no model is specified, then semantic-ranker-default@latest is used.

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. If no model is specified, then semantic-ranker-default@latest is used.

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

Returns
Type	Description
ByteString	The bytes for model.

getParserForType()

public Parser<VertexRanker> getParserForType()

Returns
Type	Description
Parser<VertexRanker>

Overrides

GeneratedMessage.getParserForType()

getQuery()

public String getQuery()

Required. The query against which the records are ranked and scored.

string query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The query.

getQueryBytes()

public ByteString getQueryBytes()

Required. The query against which the records are ranked and scored.

string query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for query.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

getTitleTemplate()

public String getTitleTemplate()

Optional. The template used to generate the record's title.

string title_template = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The titleTemplate.

getTitleTemplateBytes()

public ByteString getTitleTemplateBytes()

Optional. The template used to generate the record's title.

string title_template = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for titleTemplate.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public VertexRanker.Builder newBuilderForType()

Returns
Type	Description
VertexRanker.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected VertexRanker.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
VertexRanker.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public VertexRanker.Builder toBuilder()

Returns
Type	Description
VertexRanker.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException