# Interface VertexRankerOrBuilder (0.15.0)

0.15.0 (latest) 0.12.0 0.9.0 0.8.0 0.6.0 0.4.0 0.3.0 0.1.0

    public interface VertexRankerOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getModel()

    public abstract String getModel()

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.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The model. |

### getModelBytes()

    public abstract ByteString getModelBytes()

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.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for model. |

### getRecordSpecCase()

    public abstract VertexRanker.RecordSpecCase getRecordSpecCase()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-vectorsearch/latest/com.google.cloud.vectorsearch.v1beta.VertexRanker.RecordSpecCase` |   |

### getTextRecordSpec()

    public abstract VertexRanker.TextRecordSpec getTextRecordSpec()

The record spec for text search.

`.google.cloud.vectorsearch.v1beta.VertexRanker.TextRecordSpec text_record_spec = 6;
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-vectorsearch/latest/com.google.cloud.vectorsearch.v1beta.VertexRanker.TextRecordSpec` | The textRecordSpec. |

### getTextRecordSpecOrBuilder()

    public abstract VertexRanker.TextRecordSpecOrBuilder getTextRecordSpecOrBuilder()

The record spec for text search.

`.google.cloud.vectorsearch.v1beta.VertexRanker.TextRecordSpec text_record_spec = 6;
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-vectorsearch/latest/com.google.cloud.vectorsearch.v1beta.VertexRanker.TextRecordSpecOrBuilder` |   |

### getTopN()

    public abstract int getTopN()

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

`int32 top_n = 5 [(.google.api.field_behavior) = REQUIRED];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The topN. |

### hasTextRecordSpec()

    public abstract boolean hasTextRecordSpec()

The record spec for text search.

`.google.cloud.vectorsearch.v1beta.VertexRanker.TextRecordSpec text_record_spec = 6;
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the textRecordSpec field is set. |