public interface VertexRankerOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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 |
String |
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 |
ByteString |
The bytes for model. |
getRecordSpecCase()
public abstract VertexRanker.RecordSpecCase getRecordSpecCase()| Returns | |
|---|---|
| Type | Description |
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 |
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 |
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 |
int |
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 |
boolean |
Whether the textRecordSpec field is set. |