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

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class SearchResult.

Generated from protobuf message google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ Answer \ Step \ Action \ Observation

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ document string

Document resource name.

↳ uri string

URI for the document.

↳ title string

Title.

↳ snippet_info array<Google\Cloud\DiscoveryEngine\V1\Answer\Step\Action\Observation\SearchResult\SnippetInfo>

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

↳ chunk_info array<Google\Cloud\DiscoveryEngine\V1\Answer\Step\Action\Observation\SearchResult\ChunkInfo>

If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.

↳ struct_data Google\Protobuf\Struct

Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.

getDocument

Document resource name.

Returns
Type Description
string

setDocument

Document resource name.

Parameter
Name Description
var string
Returns
Type Description
$this

getUri

URI for the document.

Returns
Type Description
string

setUri

URI for the document.

Parameter
Name Description
var string
Returns
Type Description
$this

getTitle

Title.

Returns
Type Description
string

setTitle

Title.

Parameter
Name Description
var string
Returns
Type Description
$this

getSnippetInfo

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSnippetInfo

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

Parameter
Name Description
var array<Google\Cloud\DiscoveryEngine\V1\Answer\Step\Action\Observation\SearchResult\SnippetInfo>
Returns
Type Description
$this

getChunkInfo

If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setChunkInfo

If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.

Parameter
Name Description
var array<Google\Cloud\DiscoveryEngine\V1\Answer\Step\Action\Observation\SearchResult\ChunkInfo>
Returns
Type Description
$this

getStructData

Data representation.

The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.

Returns
Type Description
Google\Protobuf\Struct|null

hasStructData

clearStructData

setStructData

Data representation.

The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.

Parameter
Name Description
var Google\Protobuf\Struct
Returns
Type Description
$this