Google Cloud Discovery Engine V1 Client - Class SearchResult (0.6.0)

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 \ SearchResponse

Methods

__construct

Constructor.

Parameters
NameDescription
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 retrievable are populated.

getId

Document.id of the searched Document.

Returns
TypeDescription
string

setId

Document.id of the searched Document.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDocument

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\DiscoveryEngine\V1\Document
Returns
TypeDescription
$this