Class VertexRanker (0.1.0)

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

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

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

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

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public VertexRanker.Builder newBuilderForType()
Returns
Type Description
VertexRanker.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected VertexRanker.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
VertexRanker.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public VertexRanker.Builder toBuilder()
Returns
Type Description
VertexRanker.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException