Reference documentation and code samples for the Google Cloud Document Ai V1 Client class Metadata.
Metadata for global schema behavior.
Generated from protobuf messagegoogle.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, adocumententity 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 multipledocumentannotations 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 inDocumentSchema.EntityType.nameandDocumentSchema.EntityType.Property.namewill not be checked.
getDocumentSplitter
If true, adocumententity 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, adocumententity 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 multipledocumentannotations
covering it.
Returns
Type
Description
bool
setDocumentAllowMultipleLabels
If true, on a given page, there can be multipledocumentannotations
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 inDocumentSchema.EntityType.nameandDocumentSchema.EntityType.Property.namewill not be checked.
Returns
Type
Description
bool
setSkipNamingValidation
If set, we will skip the naming format validation in the schema. So the
string values inDocumentSchema.EntityType.nameandDocumentSchema.EntityType.Property.namewill not be checked.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Document Ai V1 Client - Class Metadata (2.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.0 (latest)](/php/docs/reference/cloud-document-ai/latest/V1.DocumentSchema.Metadata)\n- [2.2.2](/php/docs/reference/cloud-document-ai/2.2.2/V1.DocumentSchema.Metadata)\n- [2.1.3](/php/docs/reference/cloud-document-ai/2.1.3/V1.DocumentSchema.Metadata)\n- [2.0.0](/php/docs/reference/cloud-document-ai/2.0.0/V1.DocumentSchema.Metadata)\n- [1.14.0](/php/docs/reference/cloud-document-ai/1.14.0/V1.DocumentSchema.Metadata)\n- [1.13.1](/php/docs/reference/cloud-document-ai/1.13.1/V1.DocumentSchema.Metadata)\n- [1.12.2](/php/docs/reference/cloud-document-ai/1.12.2/V1.DocumentSchema.Metadata)\n- [1.9.0](/php/docs/reference/cloud-document-ai/1.9.0/V1.DocumentSchema.Metadata)\n- [1.8.2](/php/docs/reference/cloud-document-ai/1.8.2/V1.DocumentSchema.Metadata)\n- [1.7.0](/php/docs/reference/cloud-document-ai/1.7.0/V1.DocumentSchema.Metadata)\n- [1.6.0](/php/docs/reference/cloud-document-ai/1.6.0/V1.DocumentSchema.Metadata)\n- [1.5.0](/php/docs/reference/cloud-document-ai/1.5.0/V1.DocumentSchema.Metadata)\n- [1.4.0](/php/docs/reference/cloud-document-ai/1.4.0/V1.DocumentSchema.Metadata)\n- [1.3.0](/php/docs/reference/cloud-document-ai/1.3.0/V1.DocumentSchema.Metadata)\n- [1.2.2](/php/docs/reference/cloud-document-ai/1.2.2/V1.DocumentSchema.Metadata)\n- [1.1.1](/php/docs/reference/cloud-document-ai/1.1.1/V1.DocumentSchema.Metadata)\n- [1.0.1](/php/docs/reference/cloud-document-ai/1.0.1/V1.DocumentSchema.Metadata) \nReference documentation and code samples for the Google Cloud Document Ai V1 Client class Metadata.\n\nMetadata for global schema behavior.\n\nGenerated from protobuf message `google.cloud.documentai.v1.DocumentSchema.Metadata`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DocumentAI \\\\ V1 \\\\ DocumentSchema\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDocumentSplitter\n\nIf true, a `document` entity type can be applied to subdocument\n(splitting). Otherwise, it can only be applied to the entire document\n(classification).\n\n### setDocumentSplitter\n\nIf true, a `document` entity type can be applied to subdocument\n(splitting). Otherwise, it can only be applied to the entire document\n(classification).\n\n### getDocumentAllowMultipleLabels\n\nIf true, on a given page, there can be multiple `document` annotations\ncovering it.\n\n### setDocumentAllowMultipleLabels\n\nIf true, on a given page, there can be multiple `document` annotations\ncovering it.\n\n### getPrefixedNamingOnProperties\n\nIf set, all the nested entities must be prefixed with the parents.\n\n### setPrefixedNamingOnProperties\n\nIf set, all the nested entities must be prefixed with the parents.\n\n### getSkipNamingValidation\n\nIf set, we will skip the naming format validation in the schema. So the\nstring values in `DocumentSchema.EntityType.name` and\n`DocumentSchema.EntityType.Property.name` will not be checked.\n\n### setSkipNamingValidation\n\nIf set, we will skip the naming format validation in the schema. So the\nstring values in `DocumentSchema.EntityType.name` and\n`DocumentSchema.EntityType.Property.name` will not be checked."]]
