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

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

Document metadata.

Generated from protobuf message google.cloud.discoveryengine.v1.Answer.Reference.ChunkInfo.DocumentMetadata

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ Answer \ Reference \ ChunkInfo

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.

↳ page_identifier string

Page identifier.

↳ struct_data Google\Protobuf\Struct

The structured JSON metadata for the document. It is populated from the struct data from 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

getPageIdentifier

Page identifier.

Returns
Type Description
string

setPageIdentifier

Page identifier.

Parameter
Name Description
var string
Returns
Type Description
$this

getStructData

The structured JSON metadata for the document.

It is populated from the struct data from the Chunk in search result.

Returns
Type Description
Google\Protobuf\Struct|null

hasStructData

clearStructData

setStructData

The structured JSON metadata for the document.

It is populated from the struct data from the Chunk in search result.

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