Vector Search v1 API - Class VertexRanker (1.1.0)

1.1.0 (latest) 1.0.0

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

Implements

IMessageVertexRanker, IEquatableVertexRanker, IDeepCloneableVertexRanker, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

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

Model

public string Model { get; set; }

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.

Property Value
Type	Description
string

RecordSpecCase

public VertexRanker.RecordSpecOneofCase RecordSpecCase { get; }

Property Value
Type	Description
VertexRankerRecordSpecOneofCase

TextRecordSpec

public VertexRanker.Types.TextRecordSpec TextRecordSpec { get; set; }

The record spec for text search.

Property Value
Type	Description
VertexRankerTypesTextRecordSpec

TopN

public int TopN { get; set; }

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

Property Value
Type	Description
int