Document AI V1beta3 API - Class Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType::Property (v0.37.0)

Version 0.37.0

• 0.38.0 (latest)
• 0.37.0
• 0.36.1
• 0.35.0
• 0.34.0
• 0.33.1
• 0.32.0
• 0.31.0
• 0.30.2
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.4

Reference documentation and code samples for the Document AI V1beta3 API class Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType::Property.

Defines properties that can be part of the entity type.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#description

def description() -> ::String

Returns

• (::String) — The description of the property. Could be used to provide more information about the property for model calls.

#description=

def description=(value) -> ::String

Parameter

• value (::String) — The description of the property. Could be used to provide more information about the property for model calls.

Returns

• (::String) — The description of the property. Could be used to provide more information about the property for model calls.

#display_name

def display_name() -> ::String

Returns

• (::String) — User defined name for the property.

#display_name=

def display_name=(value) -> ::String

Parameter

• value (::String) — User defined name for the property.

Returns

• (::String) — User defined name for the property.

#name

def name() -> ::String

Returns

• (::String) — The name of the property. Follows the same guidelines as the EntityType name.

#name=

def name=(value) -> ::String

Parameter

• value (::String) — The name of the property. Follows the same guidelines as the EntityType name.

Returns

• (::String) — The name of the property. Follows the same guidelines as the EntityType name.

#occurrence_type

def occurrence_type() -> ::Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType::Property::OccurrenceType

Returns

• (::Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType::Property::OccurrenceType) — Occurrence type limits the number of instances an entity type appears in the document.

#occurrence_type=

def occurrence_type=(value) -> ::Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType::Property::OccurrenceType

Parameter

• value (::Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType::Property::OccurrenceType) — Occurrence type limits the number of instances an entity type appears in the document.

Returns

• (::Google::Cloud::DocumentAI::V1beta3::DocumentSchema::EntityType::Property::OccurrenceType) — Occurrence type limits the number of instances an entity type appears in the document.

#property_metadata

def property_metadata() -> ::Google::Cloud::DocumentAI::V1beta3::PropertyMetadata

Returns

• (::Google::Cloud::DocumentAI::V1beta3::PropertyMetadata) — Any additional metadata about the property can be added here.

#property_metadata=

def property_metadata=(value) -> ::Google::Cloud::DocumentAI::V1beta3::PropertyMetadata

Parameter

• value (::Google::Cloud::DocumentAI::V1beta3::PropertyMetadata) — Any additional metadata about the property can be added here.

Returns

• (::Google::Cloud::DocumentAI::V1beta3::PropertyMetadata) — Any additional metadata about the property can be added here.

#value_type

def value_type() -> ::String

Returns

• (::String) — A reference to the value type of the property. This type is subject to the same conventions as the Entity.base_types field.

#value_type=

def value_type=(value) -> ::String

Parameter

• value (::String) — A reference to the value type of the property. This type is subject to the same conventions as the Entity.base_types field.

Returns

• (::String) — A reference to the value type of the property. This type is subject to the same conventions as the Entity.base_types field.