Class DataSchemaDetails (0.1.6)

DataSchemaDetails(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Data schema details indicates the data type and the data struct corresponding to the key of user specified annotation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
`type_`	`google.cloud.visionai_v1.types.DataSchemaDetails.DataType` Type of the annotation. This field is a member of `oneof`_ `_type`.
`proto_any_config`	`google.cloud.visionai_v1.types.DataSchemaDetails.ProtoAnyConfig` Config for protobuf any type.
`list_config`	`google.cloud.visionai_v1.types.DataSchemaDetails.ListConfig` Config for List data type.
`customized_struct_config`	`google.cloud.visionai_v1.types.DataSchemaDetails.CustomizedStructConfig` Config for CustomizedStruct data type.
`granularity`	`google.cloud.visionai_v1.types.DataSchemaDetails.Granularity` The granularity associated with this DataSchema. This field is a member of `oneof`_ `_granularity`.
`search_strategy`	`google.cloud.visionai_v1.types.DataSchemaDetails.SearchStrategy` The search strategy to be applied on the `key` above.

Classes

CustomizedStructConfig

CustomizedStructConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The configuration for CUSTOMIZED_STRUCT data type.

DataType

DataType(value)

Data type of the annotation.

    -  DataSchema.SearchStrategy.NO_SEARCH,
    -  DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by
       IntRangeArray.
FLOAT (2):
    Float type. Allowed search strategies:

    -  DataSchema.SearchStrategy.NO_SEARCH,
    -  DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by
       FloatRangeArray.
STRING (3):
    String type. Allowed search strategies:

    -  DataSchema.SearchStrategy.NO_SEARCH,
    -  DataSchema.SearchStrategy.EXACT_SEARCH,
    -  DataSchema.SearchStrategy.SMART_SEARCH.
DATETIME (5):
    Supported formats: %Y-%m-%dT%H:%M:%E\ *S%E*\ z
    (absl::RFC3339_full) %Y-%m-%dT%H:%M:%E\ *S
    %Y-%m-%dT%H:%M%E*\ z %Y-%m-%dT%H:%M %Y-%m-%dT%H%E\ *z
    %Y-%m-%dT%H %Y-%m-%d%E*\ z %Y-%m-%d %Y-%m %Y Allowed search
    strategies:

    -  DataSchema.SearchStrategy.NO_SEARCH,
    -  DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by
       DateTimeRangeArray.
GEO_COORDINATE (7):
    Geo coordinate type. Allowed search strategies:

    -  DataSchema.SearchStrategy.NO_SEARCH,
    -  DataSchema.SearchStrategy.EXACT_SEARCH. Supports query by
       GeoLocationArray.
PROTO_ANY (8):
    Type to pass any proto as available in annotations.proto.
    Only use internally. Available proto types and its
    corresponding search behavior:

    -  ImageObjectDetectionPredictionResult, allows SMART_SEARCH
       on display_names and NO_SEARCH.
    -  ClassificationPredictionResult, allows SMART_SEARCH on
       display_names and NO_SEARCH.
    -  ImageSegmentationPredictionResult, allows NO_SEARCH.
    -  VideoActionRecognitionPredictionResult, allows
       SMART_SEARCH on display_name and NO_SEARCH.
    -  VideoObjectTrackingPredictionResult, allows SMART_SEARCH
       on display_name and NO_SEARCH.
    -  VideoClassificationPredictionResult, allows SMART_SEARCH
       on display_name and NO_SEARCH.
    -  OccupancyCountingPredictionResult, allows EXACT_SEARCH on
       stats.full_frame_count.count and NO_SEARCH.
    -  ObjectDetectionPredictionResult, allows SMART_SEARCH on
       identified_boxes.entity.label_string and NO_SEARCH.
BOOLEAN (9):
    Boolean type. Allowed search strategies:

    -  DataSchema.SearchStrategy.NO_SEARCH,
    -  DataSchema.SearchStrategy.EXACT_SEARCH.
LIST (10):
    List type.

    -  Each element in the list must be of the exact same data
       schema; otherwise, they are invalid arguments.
    -  List level cannot set search strategy. Leaf node level
       can do.
    -  Elements cannot be another list (no list of list).
    -  Elements can be CUSTOMIZED_STRUCT, and max number of
       layers is 10.
CUSTOMIZED_STRUCT (6):
    Struct type.

    -  SearchStrategy:

       -  Data Schema that's CUSTOMIZED_STRUCT cannot set search
          strategy.
       -  Leaf-node elements allow setting search strategy based
          on element's SearchStrategy restriction.

    -  Nested layer restrictions:

       -  Data Schema that's CUSTOMIZED_STRUCT allows its fields
          to be of CUSTOMIZED_STRUCT as well, but the overall
          layers restriction is 10.

Granularity

Granularity(value)

The granularity of annotations under this DataSchema.

ListConfig

ListConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The configuration for LIST data type.

ProtoAnyConfig

ProtoAnyConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The configuration for PROTO_ANY data type.

SearchStrategy

SearchStrategy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The search strategy for annotations value of the key.