Cloud Natural Language V2 Client - Class AnalyzeEntitiesRequest (0.31.3)

Reference documentation and code samples for the Cloud Natural Language V2 Client class AnalyzeEntitiesRequest.

The entity analysis request message.

Generated from protobuf message google.cloud.language.v2.AnalyzeEntitiesRequest

Namespace

Google \ Cloud \ Language \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ document Google\Cloud\Language\V2\Document

Required. Input document.

↳ encoding_type int

The encoding type used by the API to calculate offsets.

getDocument

Required. Input document.

Returns
TypeDescription
Google\Cloud\Language\V2\Document|null

hasDocument

clearDocument

setDocument

Required. Input document.

Parameter
NameDescription
var Google\Cloud\Language\V2\Document
Returns
TypeDescription
$this

getEncodingType

The encoding type used by the API to calculate offsets.

Returns
TypeDescription
int

setEncodingType

The encoding type used by the API to calculate offsets.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
document Google\Cloud\Language\V2\Document

Required. Input document.

encodingType int

The encoding type used by the API to calculate offsets. For allowed values, use constants defined on Google\Cloud\Language\V2\EncodingType

Returns
TypeDescription
Google\Cloud\Language\V2\AnalyzeEntitiesRequest

static::buildFromDocument

Parameter
NameDescription
document Google\Cloud\Language\V2\Document

Required. Input document.

Returns
TypeDescription
Google\Cloud\Language\V2\AnalyzeEntitiesRequest