Vector Search V1 API - Class Google::Cloud::VectorSearch::V1::VertexRanker (v0.3.0)

0.3.0 (latest) 0.1.1

Reference documentation and code samples for the Vector Search V1 API class Google::Cloud::VectorSearch::V1::VertexRanker.

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

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#model

def model() -> ::String

Returns

• (::String) — 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.

#model=

def model=(value) -> ::String

Parameter

• value (::String) — 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.

Returns

• (::String) — 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.

#text_record_spec

def text_record_spec() -> ::Google::Cloud::VectorSearch::V1::VertexRanker::TextRecordSpec

Returns

• (::Google::Cloud::VectorSearch::V1::VertexRanker::TextRecordSpec) — The record spec for text search.

#text_record_spec=

def text_record_spec=(value) -> ::Google::Cloud::VectorSearch::V1::VertexRanker::TextRecordSpec

Parameter

• value (::Google::Cloud::VectorSearch::V1::VertexRanker::TextRecordSpec) — The record spec for text search.

Returns

• (::Google::Cloud::VectorSearch::V1::VertexRanker::TextRecordSpec) — The record spec for text search.

#top_n

def top_n() -> ::Integer

Returns

• (::Integer) — Required. The number of documents to be processed for ranking.

#top_n=

def top_n=(value) -> ::Integer

Parameter

• value (::Integer) — Required. The number of documents to be processed for ranking.

Returns

• (::Integer) — Required. The number of documents to be processed for ranking.