Google Cloud Document Ai V1 Client - Class Metadata (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

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).

Generated from protobuf field bool document_splitter = 1;

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).

Generated from protobuf field bool document_splitter = 1;

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getDocumentAllowMultipleLabels

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

Generated from protobuf field bool document_allow_multiple_labels = 2;

Returns
Type	Description
`bool`

setDocumentAllowMultipleLabels

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

Generated from protobuf field bool document_allow_multiple_labels = 2;

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getPrefixedNamingOnProperties

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

Generated from protobuf field bool prefixed_naming_on_properties = 6;

Returns
Type	Description
`bool`

setPrefixedNamingOnProperties

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

Generated from protobuf field bool prefixed_naming_on_properties = 6;

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.

Generated from protobuf field bool skip_naming_validation = 7;

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.

Generated from protobuf field bool skip_naming_validation = 7;

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`