Vector Search v1 API - Class VertexRanker (1.0.0-beta01)

public sealed class VertexRanker : IMessage<VertexRanker>, IEquatable<VertexRanker>, IDeepCloneable<VertexRanker>, IBufferMessage, IMessage

Reference documentation and code samples for the Vector Search v1 API class VertexRanker.

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

Inheritance

object > VertexRanker

Namespace

Google.Cloud.VectorSearch.V1

Assembly

Google.Cloud.VectorSearch.V1.dll

Constructors

VertexRanker()

public VertexRanker()

VertexRanker(VertexRanker)

public VertexRanker(VertexRanker other)
Parameter
Name Description
other VertexRanker

Properties

ContentTemplate

public string ContentTemplate { get; set; }

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

Property Value
Type Description
string

Model

public string Model { get; set; }

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

Property Value
Type Description
string

Query

public string Query { get; set; }

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

Property Value
Type Description
string

TitleTemplate

public string TitleTemplate { get; set; }

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

Property Value
Type Description
string