# Interface SearchResponse.SearchResultOrBuilder (0.89.0)

0.89.0 (latest) 0.87.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

    public static interface SearchResponse.SearchResultOrBuilder extends MessageOrBuilder

## Implements

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

## Methods

### containsModelScores(String key)

    public abstract boolean containsModelScores(String key)

Google provided available scores.

`map<string, .google.cloud.discoveryengine.v1alpha.DoubleList> model_scores = 4;
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `key` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

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

### getChunk()

    public abstract Chunk getChunk()

The chunk data in the search response if the
SearchRequest.ContentSearchSpec.search_result_mode
is set to
CHUNKS.

`.google.cloud.discoveryengine.v1alpha.Chunk chunk = 18;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1alpha.Chunk` | The chunk. |

### getChunkOrBuilder()

    public abstract ChunkOrBuilder getChunkOrBuilder()

The chunk data in the search response if the
SearchRequest.ContentSearchSpec.search_result_mode
is set to
CHUNKS.

`.google.cloud.discoveryengine.v1alpha.Chunk chunk = 18;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1alpha.ChunkOrBuilder` |   |

### getDocument()

    public abstract Document getDocument()

The document data snippet in the search response. Only fields that are
marked as `retrievable` are populated.

`.google.cloud.discoveryengine.v1alpha.Document document = 2;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1alpha.Document` | The document. |

### getDocumentOrBuilder()

    public abstract DocumentOrBuilder getDocumentOrBuilder()

The document data snippet in the search response. Only fields that are
marked as `retrievable` are populated.

`.google.cloud.discoveryengine.v1alpha.Document document = 2;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1alpha.DocumentOrBuilder` |   |

### getId()

    public abstract String getId()

Document.id of the
searched Document.

`string id = 1;`

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

### getIdBytes()

    public abstract ByteString getIdBytes()

Document.id of the
searched Document.

`string id = 1;`

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

### getModelScores() (deprecated)

    public abstract Map<String,DoubleList> getModelScores()

Use [#getModelScoresMap()](https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResultOrBuilder#com_google_cloud_discoveryengine_v1alpha_SearchResponse_SearchResultOrBuilder_getModelScoresMap__) instead.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/Map.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html,https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1alpha.DoubleList>` |   |

### getModelScoresCount()

    public abstract int getModelScoresCount()

Google provided available scores.

`map<string, .google.cloud.discoveryengine.v1alpha.DoubleList> model_scores = 4;
`

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

### getModelScoresMap()

    public abstract Map<String,DoubleList> getModelScoresMap()

Google provided available scores.

`map<string, .google.cloud.discoveryengine.v1alpha.DoubleList> model_scores = 4;
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/Map.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html,https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1alpha.DoubleList>` |   |

### getModelScoresOrDefault(String key, DoubleList defaultValue)

    public abstract DoubleList getModelScoresOrDefault(String key, DoubleList defaultValue)

Google provided available scores.

`map<string, .google.cloud.discoveryengine.v1alpha.DoubleList> model_scores = 4;
`

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `key` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |
| `defaultValue` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1alpha.DoubleList` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1alpha.DoubleList` |   |

### getModelScoresOrThrow(String key)

    public abstract DoubleList getModelScoresOrThrow(String key)

Google provided available scores.

`map<string, .google.cloud.discoveryengine.v1alpha.DoubleList> model_scores = 4;
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `key` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1alpha.DoubleList` |   |

### getRankSignals()

    public abstract SearchResponse.SearchResult.RankSignals getRankSignals()

A set of ranking signals associated with the result.

`
.google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals` | The rankSignals. |

### getRankSignalsOrBuilder()

    public abstract SearchResponse.SearchResult.RankSignalsOrBuilder getRankSignalsOrBuilder()

A set of ranking signals associated with the result.

`
.google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-discoveryengine/latest/com.google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignalsOrBuilder` |   |

### hasChunk()

    public abstract boolean hasChunk()

The chunk data in the search response if the
SearchRequest.ContentSearchSpec.search_result_mode
is set to
CHUNKS.

`.google.cloud.discoveryengine.v1alpha.Chunk chunk = 18;`

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

### hasDocument()

    public abstract boolean hasDocument()

The document data snippet in the search response. Only fields that are
marked as `retrievable` are populated.

`.google.cloud.discoveryengine.v1alpha.Document document = 2;`

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

### hasRankSignals()

    public abstract boolean hasRankSignals()

A set of ranking signals associated with the result.

`
.google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals rank_signals = 7 [(.google.api.field_behavior) = OPTIONAL];
`

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