Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class SearchResult.
Represents the search results.
Generated from protobuf message google.cloud.discoveryengine.v1.SearchResponse.SearchResult
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ SearchResponseMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ id |
string
Document.id of the searched Document. |
↳ document |
Google\Cloud\DiscoveryEngine\V1\Document
The document data snippet in the search response. Only fields that are marked as |
↳ chunk |
Google\Cloud\DiscoveryEngine\V1\Chunk
The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. |
↳ model_scores |
array|Google\Protobuf\Internal\MapField
Output only. Google provided available scores. |
↳ rank_signals |
SearchResult\RankSignals
Optional. A set of ranking signals associated with the result. |
↳ retrieval_signals |
SearchResult\RetrievalSignals
Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds. |
getId
Document.id of the searched Document.
| Returns | |
|---|---|
| Type | Description |
string |
|
setId
Document.id of the searched Document.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDocument
The document data snippet in the search response. Only fields that are
marked as retrievable are populated.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1\Document|null |
|
hasDocument
clearDocument
setDocument
The document data snippet in the search response. Only fields that are
marked as retrievable are populated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\Document
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getChunk
The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1\Chunk|null |
|
hasChunk
clearChunk
setChunk
The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\DiscoveryEngine\V1\Chunk
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getModelScores
Output only. Google provided available scores.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setModelScores
Output only. Google provided available scores.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRankSignals
Optional. A set of ranking signals associated with the result.
| Returns | |
|---|---|
| Type | Description |
SearchResult\RankSignals|null |
|
hasRankSignals
clearRankSignals
setRankSignals
Optional. A set of ranking signals associated with the result.
| Parameter | |
|---|---|
| Name | Description |
var |
SearchResult\RankSignals
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRetrievalSignals
Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds.
| Returns | |
|---|---|
| Type | Description |
SearchResult\RetrievalSignals|null |
|
hasRetrievalSignals
clearRetrievalSignals
setRetrievalSignals
Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds.
| Parameter | |
|---|---|
| Name | Description |
var |
SearchResult\RetrievalSignals
|
| Returns | |
|---|---|
| Type | Description |
$this |
|