Google Cloud Document Ai V1 Client - Class Metadata (1.12.2)

Version 1.12.2

• 2.1.1 (latest)
• 2.1.0
• 2.0.0
• 1.14.0
• 1.13.1
• 1.12.2
• 1.9.0
• 1.8.2
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.2
• 1.1.1
• 1.0.1

Reference documentation and code samples for the Google Cloud Document Ai V1 Client class Metadata.

Metadata for global schema behavior.

Generated from protobuf message google.cloud.documentai.v1.DocumentSchema.Metadata

Namespace

Google \ Cloud \ DocumentAI \ V1 \ DocumentSchema

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ document_splitter	bool If true, a document entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).
↳ document_allow_multiple_labels	bool If true, on a given page, there can be multiple document annotations covering it.
↳ prefixed_naming_on_properties	bool If set, all the nested entities must be prefixed with the parents.
↳ skip_naming_validation	bool If set, we will skip the naming format validation in the schema. So the string values in DocumentSchema.EntityType.name and DocumentSchema.EntityType.Property.name will not be checked.

getDocumentSplitter

If true, a document entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).

Returns
Type	Description
bool

setDocumentSplitter

If true, a document entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getDocumentAllowMultipleLabels

If true, on a given page, there can be multiple document annotations covering it.

Returns
Type	Description
bool

setDocumentAllowMultipleLabels

If true, on a given page, there can be multiple document annotations covering it.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getPrefixedNamingOnProperties

If set, all the nested entities must be prefixed with the parents.

Returns
Type	Description
bool

setPrefixedNamingOnProperties

If set, all the nested entities must be prefixed with the parents.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getSkipNamingValidation

If set, we will skip the naming format validation in the schema. So the string values in DocumentSchema.EntityType.name and DocumentSchema.EntityType.Property.name will not be checked.

Returns
Type	Description
bool

setSkipNamingValidation

If set, we will skip the naming format validation in the schema. So the string values in DocumentSchema.EntityType.name and DocumentSchema.EntityType.Property.name will not be checked.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this