value (::Boolean) — If true, on a given page, there can be multiple document annotations
covering it.
Returns
(::Boolean) — If true, on a given page, there can be multiple document annotations
covering it.
#document_splitter
defdocument_splitter()->::Boolean
Returns
(::Boolean) — If true, a document entity type can be applied to subdocument
(splitting). Otherwise, it can only be applied to the entire document
(classification).
#document_splitter=
defdocument_splitter=(value)->::Boolean
Parameter
value (::Boolean) — If true, a document entity type can be applied to subdocument
(splitting). Otherwise, it can only be applied to the entire document
(classification).
Returns
(::Boolean) — If true, a document entity type can be applied to subdocument
(splitting). Otherwise, it can only be applied to the entire document
(classification).
#prefixed_naming_on_properties
defprefixed_naming_on_properties()->::Boolean
Returns
(::Boolean) — If set, all the nested entities must be prefixed with the parents.
value (::Boolean) — If set, all the nested entities must be prefixed with the parents.
Returns
(::Boolean) — If set, all the nested entities must be prefixed with the parents.
#skip_naming_validation
defskip_naming_validation()->::Boolean
Returns
(::Boolean) — 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.
#skip_naming_validation=
defskip_naming_validation=(value)->::Boolean
Parameter
value (::Boolean) — 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
(::Boolean) — 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.
[[["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,["# Document AI V1beta3 API - Class Google::Cloud::DocumentAI::V1beta3::DocumentSchema::Metadata (v0.43.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.43.1 (latest)](/ruby/docs/reference/google-cloud-document_ai-v1beta3/latest/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.43.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.43.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.42.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.42.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.41.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.41.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.40.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.40.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.39.1](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.39.1/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.38.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.38.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.37.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.37.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.36.1](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.36.1/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.35.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.35.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.34.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.34.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.33.1](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.33.1/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.32.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.32.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.31.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.31.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.30.2](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.30.2/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.29.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.29.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.28.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.28.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.27.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.27.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.26.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.26.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.25.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.25.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.24.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.24.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.23.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.23.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.22.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.22.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.21.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.21.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.20.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.20.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.19.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.19.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.18.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.18.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.17.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.17.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.16.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.16.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.15.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.15.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.14.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.14.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.13.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.13.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.12.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.12.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.11.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.11.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.10.0](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.10.0/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata)\n- [0.9.4](/ruby/docs/reference/google-cloud-document_ai-v1beta3/0.9.4/Google-Cloud-DocumentAI-V1beta3-DocumentSchema-Metadata) \nReference documentation and code samples for the Document AI V1beta3 API class Google::Cloud::DocumentAI::V1beta3::DocumentSchema::Metadata.\n\nMetadata for global schema behavior. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #document_allow_multiple_labels\n\n def document_allow_multiple_labels() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- If true, on a given page, there can be multiple `document` annotations covering it.\n\n### #document_allow_multiple_labels=\n\n def document_allow_multiple_labels=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- If true, on a given page, there can be multiple `document` annotations covering it. \n**Returns**\n\n- (::Boolean) --- If true, on a given page, there can be multiple `document` annotations covering it.\n\n### #document_splitter\n\n def document_splitter() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).\n\n### #document_splitter=\n\n def document_splitter=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification). \n**Returns**\n\n- (::Boolean) --- If true, a `document` entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).\n\n### #prefixed_naming_on_properties\n\n def prefixed_naming_on_properties() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- If set, all the nested entities must be prefixed with the parents.\n\n### #prefixed_naming_on_properties=\n\n def prefixed_naming_on_properties=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- If set, all the nested entities must be prefixed with the parents. \n**Returns**\n\n- (::Boolean) --- If set, all the nested entities must be prefixed with the parents.\n\n### #skip_naming_validation\n\n def skip_naming_validation() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- 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.\n\n### #skip_naming_validation=\n\n def skip_naming_validation=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- 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. \n**Returns**\n\n- (::Boolean) --- 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."]]