Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1beta3/classes.rb,
lib/google/apis/documentai_v1beta3/representations.rb,
lib/google/apis/documentai_v1beta3/representations.rb

Overview

Metadata for global schema behavior.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata

Returns a new instance of GoogleCloudDocumentaiV1beta3DocumentSchemaMetadata.



8902
8903
8904
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8902

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#document_allow_multiple_labels ⇒ Boolean Also known as: document_allow_multiple_labels?

If true, on a given page, there can be multiple document annotations covering it. Corresponds to the JSON property documentAllowMultipleLabels

Returns:

  • (Boolean) 


8878
8879
8880
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8878

def document_allow_multiple_labels
  @document_allow_multiple_labels
end

#document_splitter ⇒ Boolean Also known as: document_splitter?

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

Returns:

  • (Boolean) 


8885
8886
8887
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8885

def document_splitter
  @document_splitter
end

#prefixed_naming_on_properties ⇒ Boolean Also known as: prefixed_naming_on_properties?

If set, all the nested entities must be prefixed with the parents. Corresponds to the JSON property prefixedNamingOnProperties

Returns:

  • (Boolean) 


8891
8892
8893
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8891

def prefixed_naming_on_properties
  @prefixed_naming_on_properties
end

#skip_naming_validation ⇒ Boolean Also known as: skip_naming_validation?

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. Corresponds to the JSON property skipNamingValidation

Returns:

  • (Boolean) 


8899
8900
8901
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8899

def skip_naming_validation
  @skip_naming_validation
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8907
8908
8909
8910
8911
8912
 
# File 'lib/google/apis/documentai_v1beta3/classes.rb', line 8907

def update!(**args)
  @document_allow_multiple_labels = args[:document_allow_multiple_labels] if args.key?(:document_allow_multiple_labels)
  @document_splitter = args[:document_splitter] if args.key?(:document_splitter)
  @prefixed_naming_on_properties = args[:prefixed_naming_on_properties] if args.key?(:prefixed_naming_on_properties)
  @skip_naming_validation = args[:skip_naming_validation] if args.key?(:skip_naming_validation)
end