Class: Google::Cloud::VisionAI::V1::DataSchemaDetails

Inherits:

Object

Object
Google::Cloud::VisionAI::V1::DataSchemaDetails

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/visionai/v1/warehouse.rb

Overview

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

Defined Under Namespace

Modules: DataType, Granularity Classes: CustomizedStructConfig, ListConfig, ProtoAnyConfig, SearchStrategy

Instance Attribute Summary collapse

#customized_struct_config ⇒ ::Google::Cloud::VisionAI::V1::DataSchemaDetails::CustomizedStructConfig
Config for CustomizedStruct data type.
#granularity ⇒ ::Google::Cloud::VisionAI::V1::DataSchemaDetails::Granularity
The granularity associated with this DataSchema.
#list_config ⇒ ::Google::Cloud::VisionAI::V1::DataSchemaDetails::ListConfig
Config for List data type.
#proto_any_config ⇒ ::Google::Cloud::VisionAI::V1::DataSchemaDetails::ProtoAnyConfig
Config for protobuf any type.
#search_strategy ⇒ ::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy
The search strategy to be applied on the key above.
#type ⇒ ::Google::Cloud::VisionAI::V1::DataSchemaDetails::DataType
Type of the annotation.

Instance Attribute Details

#customized_struct_config ⇒ `::Google::Cloud::VisionAI::V1::DataSchemaDetails::CustomizedStructConfig`

Returns Config for CustomizedStruct data type.

Returns:

(::Google::Cloud::VisionAI::V1::DataSchemaDetails::CustomizedStructConfig) —
Config for CustomizedStruct data type.

# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 1153

class DataSchemaDetails
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The configuration for `PROTO_ANY` data type.
  # @!attribute [rw] type_uri
  #   @return [::String]
  #     The type URI of the proto message.
  class ProtoAnyConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration for `LIST` data type.
  # @!attribute [rw] value_schema
  #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails]
  #     The value's data schema in the list.
  class ListConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration for `CUSTOMIZED_STRUCT` data type.
  # @!attribute [rw] field_schemas
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::VisionAI::V1::DataSchemaDetails}]
  #     Direct child elements data schemas.
  class CustomizedStructConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails]
    class FieldSchemasEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The search strategy for annotations value of the `key`.
  # @!attribute [rw] search_strategy_type
  #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy::SearchStrategyType]
  #     The type of search strategy to be applied on the `key` above.
  #     The allowed `search_strategy_type` is different for different data types,
  #     which is documented in the DataSchemaDetails.DataType. Specifying
  #     unsupported `search_strategy_type` for data types will result in
  #     INVALID_ARGUMENT error.
  # @!attribute [rw] confidence_score_index_config
  #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy::ConfidenceScoreIndexConfig]
  #     Optional. Configs the path to the confidence score, and the threshold.
  #     Only if the score is greater than the threshold, current field will be
  #     built into the index. Only applies to leaf nodes using EXACT_SEARCH or
  #     SMART_SEARCH.
  class SearchStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Filter on the confidence score. Only adds to index if the confidence
    # score is higher than the threshold.
    # Example data schema:
    # key: "name-confidence-pair"
    # type: CUSTOMIZED_STRUCT
    # granularity: GRANULARITY_PARTITION_LEVEL
    # customized_struct_config {
    #   field_schemas {
    #     key: "name"
    #     type: STRING
    #     granularity: GRANULARITY_PARTITION_LEVEL
    #     search_strategy {
    #       search_strategy_type: SMART_SEARCH
    #       confidence_score_index_config {
    #         field_path: "name-confidence-pair.score"
    #         threshold: 0.6
    #       }
    #     }
    #   }
    #   field_schemas {
    #     key: "score"
    #     type: FLOAT
    #     granularity: GRANULARITY_PARTITION_LEVEL
    #   }
    # }
    # This means only "name" with score > 0.6 will be indexed.
    # @!attribute [rw] field_path
    #   @return [::String]
    #     Required. The path to the confidence score field. It is a string that
    #     concatenates all the data schema keys along the path. See the example
    #     above. If the data schema contains LIST, use '_ENTRIES' to concatenate.
    #     Example data schema contains a list:
    #     "key": "list-name-score",
    #     "schemaDetails": {
    #       "type": "LIST",
    #       "granularity": "GRANULARITY_PARTITION_LEVEL",
    #       "listConfig": {
    #         "valueSchema": {
    #           "type": "CUSTOMIZED_STRUCT",
    #           "granularity": "GRANULARITY_PARTITION_LEVEL",
    #           "customizedStructConfig": {
    #             "fieldSchemas": {
    #               "name": {
    #                 "type": "STRING",
    #                 "granularity": "GRANULARITY_PARTITION_LEVEL",
    #                 "searchStrategy": {
    #                   "searchStrategyType": "SMART_SEARCH"
    #                   "confidence_score_index_config": {
    #                     "field_path": "list-name-score._ENTRIES.score",
    #                     "threshold": "0.9",
    #                   }
    #                 }
    #               },
    #               "score": {
    #                 "type": "FLOAT",
    #                 "granularity": "GRANULARITY_PARTITION_LEVEL",
    #               }
    #             }
    #           }
    #         }
    #       }
    #     }
    # @!attribute [rw] threshold
    #   @return [::Float]
    #     Required. The threshold.
    class ConfidenceScoreIndexConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The types of search strategies to be applied on the annotation key.
    module SearchStrategyType
      # Annotatation values of the `key` above will not be searchable.
      NO_SEARCH = 0

      # When searching with `key`, the value must be exactly as the annotation
      # value that has been ingested.
      EXACT_SEARCH = 1

      # When searching with `key`, Warehouse will perform broad search based on
      # semantic of the annotation value.
      SMART_SEARCH = 2
    end
  end

  # Data type of the annotation.
  module DataType
    # Unspecified type.
    DATA_TYPE_UNSPECIFIED = 0

    # Integer type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    #   Supports query by IntRangeArray.
    INTEGER = 1

    # Float type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    #   Supports query by FloatRangeArray.
    FLOAT = 2

    # String type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH,
    # - DataSchema.SearchStrategy.SMART_SEARCH.
    STRING = 3

    # 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.
    DATETIME = 5

    # Geo coordinate type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    #   Supports query by GeoLocationArray.
    GEO_COORDINATE = 7

    # 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.
    PROTO_ANY = 8

    # Boolean type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    BOOLEAN = 9

    # 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.
    LIST = 10

    # 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.
    CUSTOMIZED_STRUCT = 6
  end

  # The granularity of annotations under this DataSchema.
  module Granularity
    # Unspecified granularity.
    GRANULARITY_UNSPECIFIED = 0

    # Asset-level granularity (annotations must not contain partition info).
    GRANULARITY_ASSET_LEVEL = 1

    # Partition-level granularity (annotations must contain partition info).
    GRANULARITY_PARTITION_LEVEL = 2
  end
end

#granularity ⇒ `::Google::Cloud::VisionAI::V1::DataSchemaDetails::Granularity`

Returns The granularity associated with this DataSchema.

Returns:

(::Google::Cloud::VisionAI::V1::DataSchemaDetails::Granularity) —
The granularity associated with this DataSchema.

# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 1153

class DataSchemaDetails
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The configuration for `PROTO_ANY` data type.
  # @!attribute [rw] type_uri
  #   @return [::String]
  #     The type URI of the proto message.
  class ProtoAnyConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration for `LIST` data type.
  # @!attribute [rw] value_schema
  #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails]
  #     The value's data schema in the list.
  class ListConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration for `CUSTOMIZED_STRUCT` data type.
  # @!attribute [rw] field_schemas
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::VisionAI::V1::DataSchemaDetails}]
  #     Direct child elements data schemas.
  class CustomizedStructConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails]
    class FieldSchemasEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The search strategy for annotations value of the `key`.
  # @!attribute [rw] search_strategy_type
  #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy::SearchStrategyType]
  #     The type of search strategy to be applied on the `key` above.
  #     The allowed `search_strategy_type` is different for different data types,
  #     which is documented in the DataSchemaDetails.DataType. Specifying
  #     unsupported `search_strategy_type` for data types will result in
  #     INVALID_ARGUMENT error.
  # @!attribute [rw] confidence_score_index_config
  #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy::ConfidenceScoreIndexConfig]
  #     Optional. Configs the path to the confidence score, and the threshold.
  #     Only if the score is greater than the threshold, current field will be
  #     built into the index. Only applies to leaf nodes using EXACT_SEARCH or
  #     SMART_SEARCH.
  class SearchStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Filter on the confidence score. Only adds to index if the confidence
    # score is higher than the threshold.
    # Example data schema:
    # key: "name-confidence-pair"
    # type: CUSTOMIZED_STRUCT
    # granularity: GRANULARITY_PARTITION_LEVEL
    # customized_struct_config {
    #   field_schemas {
    #     key: "name"
    #     type: STRING
    #     granularity: GRANULARITY_PARTITION_LEVEL
    #     search_strategy {
    #       search_strategy_type: SMART_SEARCH
    #       confidence_score_index_config {
    #         field_path: "name-confidence-pair.score"
    #         threshold: 0.6
    #       }
    #     }
    #   }
    #   field_schemas {
    #     key: "score"
    #     type: FLOAT
    #     granularity: GRANULARITY_PARTITION_LEVEL
    #   }
    # }
    # This means only "name" with score > 0.6 will be indexed.
    # @!attribute [rw] field_path
    #   @return [::String]
    #     Required. The path to the confidence score field. It is a string that
    #     concatenates all the data schema keys along the path. See the example
    #     above. If the data schema contains LIST, use '_ENTRIES' to concatenate.
    #     Example data schema contains a list:
    #     "key": "list-name-score",
    #     "schemaDetails": {
    #       "type": "LIST",
    #       "granularity": "GRANULARITY_PARTITION_LEVEL",
    #       "listConfig": {
    #         "valueSchema": {
    #           "type": "CUSTOMIZED_STRUCT",
    #           "granularity": "GRANULARITY_PARTITION_LEVEL",
    #           "customizedStructConfig": {
    #             "fieldSchemas": {
    #               "name": {
    #                 "type": "STRING",
    #                 "granularity": "GRANULARITY_PARTITION_LEVEL",
    #                 "searchStrategy": {
    #                   "searchStrategyType": "SMART_SEARCH"
    #                   "confidence_score_index_config": {
    #                     "field_path": "list-name-score._ENTRIES.score",
    #                     "threshold": "0.9",
    #                   }
    #                 }
    #               },
    #               "score": {
    #                 "type": "FLOAT",
    #                 "granularity": "GRANULARITY_PARTITION_LEVEL",
    #               }
    #             }
    #           }
    #         }
    #       }
    #     }
    # @!attribute [rw] threshold
    #   @return [::Float]
    #     Required. The threshold.
    class ConfidenceScoreIndexConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The types of search strategies to be applied on the annotation key.
    module SearchStrategyType
      # Annotatation values of the `key` above will not be searchable.
      NO_SEARCH = 0

      # When searching with `key`, the value must be exactly as the annotation
      # value that has been ingested.
      EXACT_SEARCH = 1

      # When searching with `key`, Warehouse will perform broad search based on
      # semantic of the annotation value.
      SMART_SEARCH = 2
    end
  end

  # Data type of the annotation.
  module DataType
    # Unspecified type.
    DATA_TYPE_UNSPECIFIED = 0

    # Integer type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    #   Supports query by IntRangeArray.
    INTEGER = 1

    # Float type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    #   Supports query by FloatRangeArray.
    FLOAT = 2

    # String type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH,
    # - DataSchema.SearchStrategy.SMART_SEARCH.
    STRING = 3

    # 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.
    DATETIME = 5

    # Geo coordinate type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    #   Supports query by GeoLocationArray.
    GEO_COORDINATE = 7

    # 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.
    PROTO_ANY = 8

    # Boolean type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    BOOLEAN = 9

    # 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.
    LIST = 10

    # 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.
    CUSTOMIZED_STRUCT = 6
  end

  # The granularity of annotations under this DataSchema.
  module Granularity
    # Unspecified granularity.
    GRANULARITY_UNSPECIFIED = 0

    # Asset-level granularity (annotations must not contain partition info).
    GRANULARITY_ASSET_LEVEL = 1

    # Partition-level granularity (annotations must contain partition info).
    GRANULARITY_PARTITION_LEVEL = 2
  end
end

#list_config ⇒ `::Google::Cloud::VisionAI::V1::DataSchemaDetails::ListConfig`

Returns Config for List data type.

Returns:

(::Google::Cloud::VisionAI::V1::DataSchemaDetails::ListConfig) —
Config for List data type.

# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 1153

class DataSchemaDetails
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The configuration for `PROTO_ANY` data type.
  # @!attribute [rw] type_uri
  #   @return [::String]
  #     The type URI of the proto message.
  class ProtoAnyConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration for `LIST` data type.
  # @!attribute [rw] value_schema
  #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails]
  #     The value's data schema in the list.
  class ListConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration for `CUSTOMIZED_STRUCT` data type.
  # @!attribute [rw] field_schemas
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::VisionAI::V1::DataSchemaDetails}]
  #     Direct child elements data schemas.
  class CustomizedStructConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails]
    class FieldSchemasEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The search strategy for annotations value of the `key`.
  # @!attribute [rw] search_strategy_type
  #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy::SearchStrategyType]
  #     The type of search strategy to be applied on the `key` above.
  #     The allowed `search_strategy_type` is different for different data types,
  #     which is documented in the DataSchemaDetails.DataType. Specifying
  #     unsupported `search_strategy_type` for data types will result in
  #     INVALID_ARGUMENT error.
  # @!attribute [rw] confidence_score_index_config
  #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy::ConfidenceScoreIndexConfig]
  #     Optional. Configs the path to the confidence score, and the threshold.
  #     Only if the score is greater than the threshold, current field will be
  #     built into the index. Only applies to leaf nodes using EXACT_SEARCH or
  #     SMART_SEARCH.
  class SearchStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Filter on the confidence score. Only adds to index if the confidence
    # score is higher than the threshold.
    # Example data schema:
    # key: "name-confidence-pair"
    # type: CUSTOMIZED_STRUCT
    # granularity: GRANULARITY_PARTITION_LEVEL
    # customized_struct_config {
    #   field_schemas {
    #     key: "name"
    #     type: STRING
    #     granularity: GRANULARITY_PARTITION_LEVEL
    #     search_strategy {
    #       search_strategy_type: SMART_SEARCH
    #       confidence_score_index_config {
    #         field_path: "name-confidence-pair.score"
    #         threshold: 0.6
    #       }
    #     }
    #   }
    #   field_schemas {
    #     key: "score"
    #     type: FLOAT
    #     granularity: GRANULARITY_PARTITION_LEVEL
    #   }
    # }
    # This means only "name" with score > 0.6 will be indexed.
    # @!attribute [rw] field_path
    #   @return [::String]
    #     Required. The path to the confidence score field. It is a string that
    #     concatenates all the data schema keys along the path. See the example
    #     above. If the data schema contains LIST, use '_ENTRIES' to concatenate.
    #     Example data schema contains a list:
    #     "key": "list-name-score",
    #     "schemaDetails": {
    #       "type": "LIST",
    #       "granularity": "GRANULARITY_PARTITION_LEVEL",
    #       "listConfig": {
    #         "valueSchema": {
    #           "type": "CUSTOMIZED_STRUCT",
    #           "granularity": "GRANULARITY_PARTITION_LEVEL",
    #           "customizedStructConfig": {
    #             "fieldSchemas": {
    #               "name": {
    #                 "type": "STRING",
    #                 "granularity": "GRANULARITY_PARTITION_LEVEL",
    #                 "searchStrategy": {
    #                   "searchStrategyType": "SMART_SEARCH"
    #                   "confidence_score_index_config": {
    #                     "field_path": "list-name-score._ENTRIES.score",
    #                     "threshold": "0.9",
    #                   }
    #                 }
    #               },
    #               "score": {
    #                 "type": "FLOAT",
    #                 "granularity": "GRANULARITY_PARTITION_LEVEL",
    #               }
    #             }
    #           }
    #         }
    #       }
    #     }
    # @!attribute [rw] threshold
    #   @return [::Float]
    #     Required. The threshold.
    class ConfidenceScoreIndexConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The types of search strategies to be applied on the annotation key.
    module SearchStrategyType
      # Annotatation values of the `key` above will not be searchable.
      NO_SEARCH = 0

      # When searching with `key`, the value must be exactly as the annotation
      # value that has been ingested.
      EXACT_SEARCH = 1

      # When searching with `key`, Warehouse will perform broad search based on
      # semantic of the annotation value.
      SMART_SEARCH = 2
    end
  end

  # Data type of the annotation.
  module DataType
    # Unspecified type.
    DATA_TYPE_UNSPECIFIED = 0

    # Integer type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    #   Supports query by IntRangeArray.
    INTEGER = 1

    # Float type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    #   Supports query by FloatRangeArray.
    FLOAT = 2

    # String type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH,
    # - DataSchema.SearchStrategy.SMART_SEARCH.
    STRING = 3

    # 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.
    DATETIME = 5

    # Geo coordinate type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    #   Supports query by GeoLocationArray.
    GEO_COORDINATE = 7

    # 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.
    PROTO_ANY = 8

    # Boolean type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    BOOLEAN = 9

    # 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.
    LIST = 10

    # 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.
    CUSTOMIZED_STRUCT = 6
  end

  # The granularity of annotations under this DataSchema.
  module Granularity
    # Unspecified granularity.
    GRANULARITY_UNSPECIFIED = 0

    # Asset-level granularity (annotations must not contain partition info).
    GRANULARITY_ASSET_LEVEL = 1

    # Partition-level granularity (annotations must contain partition info).
    GRANULARITY_PARTITION_LEVEL = 2
  end
end

#proto_any_config ⇒ `::Google::Cloud::VisionAI::V1::DataSchemaDetails::ProtoAnyConfig`

Returns Config for protobuf any type.

Returns:

(::Google::Cloud::VisionAI::V1::DataSchemaDetails::ProtoAnyConfig) —
Config for protobuf any type.

# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 1153

class DataSchemaDetails
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The configuration for `PROTO_ANY` data type.
  # @!attribute [rw] type_uri
  #   @return [::String]
  #     The type URI of the proto message.
  class ProtoAnyConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration for `LIST` data type.
  # @!attribute [rw] value_schema
  #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails]
  #     The value's data schema in the list.
  class ListConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration for `CUSTOMIZED_STRUCT` data type.
  # @!attribute [rw] field_schemas
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::VisionAI::V1::DataSchemaDetails}]
  #     Direct child elements data schemas.
  class CustomizedStructConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails]
    class FieldSchemasEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The search strategy for annotations value of the `key`.
  # @!attribute [rw] search_strategy_type
  #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy::SearchStrategyType]
  #     The type of search strategy to be applied on the `key` above.
  #     The allowed `search_strategy_type` is different for different data types,
  #     which is documented in the DataSchemaDetails.DataType. Specifying
  #     unsupported `search_strategy_type` for data types will result in
  #     INVALID_ARGUMENT error.
  # @!attribute [rw] confidence_score_index_config
  #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy::ConfidenceScoreIndexConfig]
  #     Optional. Configs the path to the confidence score, and the threshold.
  #     Only if the score is greater than the threshold, current field will be
  #     built into the index. Only applies to leaf nodes using EXACT_SEARCH or
  #     SMART_SEARCH.
  class SearchStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Filter on the confidence score. Only adds to index if the confidence
    # score is higher than the threshold.
    # Example data schema:
    # key: "name-confidence-pair"
    # type: CUSTOMIZED_STRUCT
    # granularity: GRANULARITY_PARTITION_LEVEL
    # customized_struct_config {
    #   field_schemas {
    #     key: "name"
    #     type: STRING
    #     granularity: GRANULARITY_PARTITION_LEVEL
    #     search_strategy {
    #       search_strategy_type: SMART_SEARCH
    #       confidence_score_index_config {
    #         field_path: "name-confidence-pair.score"
    #         threshold: 0.6
    #       }
    #     }
    #   }
    #   field_schemas {
    #     key: "score"
    #     type: FLOAT
    #     granularity: GRANULARITY_PARTITION_LEVEL
    #   }
    # }
    # This means only "name" with score > 0.6 will be indexed.
    # @!attribute [rw] field_path
    #   @return [::String]
    #     Required. The path to the confidence score field. It is a string that
    #     concatenates all the data schema keys along the path. See the example
    #     above. If the data schema contains LIST, use '_ENTRIES' to concatenate.
    #     Example data schema contains a list:
    #     "key": "list-name-score",
    #     "schemaDetails": {
    #       "type": "LIST",
    #       "granularity": "GRANULARITY_PARTITION_LEVEL",
    #       "listConfig": {
    #         "valueSchema": {
    #           "type": "CUSTOMIZED_STRUCT",
    #           "granularity": "GRANULARITY_PARTITION_LEVEL",
    #           "customizedStructConfig": {
    #             "fieldSchemas": {
    #               "name": {
    #                 "type": "STRING",
    #                 "granularity": "GRANULARITY_PARTITION_LEVEL",
    #                 "searchStrategy": {
    #                   "searchStrategyType": "SMART_SEARCH"
    #                   "confidence_score_index_config": {
    #                     "field_path": "list-name-score._ENTRIES.score",
    #                     "threshold": "0.9",
    #                   }
    #                 }
    #               },
    #               "score": {
    #                 "type": "FLOAT",
    #                 "granularity": "GRANULARITY_PARTITION_LEVEL",
    #               }
    #             }
    #           }
    #         }
    #       }
    #     }
    # @!attribute [rw] threshold
    #   @return [::Float]
    #     Required. The threshold.
    class ConfidenceScoreIndexConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The types of search strategies to be applied on the annotation key.
    module SearchStrategyType
      # Annotatation values of the `key` above will not be searchable.
      NO_SEARCH = 0

      # When searching with `key`, the value must be exactly as the annotation
      # value that has been ingested.
      EXACT_SEARCH = 1

      # When searching with `key`, Warehouse will perform broad search based on
      # semantic of the annotation value.
      SMART_SEARCH = 2
    end
  end

  # Data type of the annotation.
  module DataType
    # Unspecified type.
    DATA_TYPE_UNSPECIFIED = 0

    # Integer type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    #   Supports query by IntRangeArray.
    INTEGER = 1

    # Float type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    #   Supports query by FloatRangeArray.
    FLOAT = 2

    # String type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH,
    # - DataSchema.SearchStrategy.SMART_SEARCH.
    STRING = 3

    # 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.
    DATETIME = 5

    # Geo coordinate type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    #   Supports query by GeoLocationArray.
    GEO_COORDINATE = 7

    # 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.
    PROTO_ANY = 8

    # Boolean type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    BOOLEAN = 9

    # 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.
    LIST = 10

    # 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.
    CUSTOMIZED_STRUCT = 6
  end

  # The granularity of annotations under this DataSchema.
  module Granularity
    # Unspecified granularity.
    GRANULARITY_UNSPECIFIED = 0

    # Asset-level granularity (annotations must not contain partition info).
    GRANULARITY_ASSET_LEVEL = 1

    # Partition-level granularity (annotations must contain partition info).
    GRANULARITY_PARTITION_LEVEL = 2
  end
end

#search_strategy ⇒ `::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy`

Returns The search strategy to be applied on the key above.

Returns:

(::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy) —
The search strategy to be applied on the key above.

# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 1153

class DataSchemaDetails
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The configuration for `PROTO_ANY` data type.
  # @!attribute [rw] type_uri
  #   @return [::String]
  #     The type URI of the proto message.
  class ProtoAnyConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration for `LIST` data type.
  # @!attribute [rw] value_schema
  #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails]
  #     The value's data schema in the list.
  class ListConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration for `CUSTOMIZED_STRUCT` data type.
  # @!attribute [rw] field_schemas
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::VisionAI::V1::DataSchemaDetails}]
  #     Direct child elements data schemas.
  class CustomizedStructConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails]
    class FieldSchemasEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The search strategy for annotations value of the `key`.
  # @!attribute [rw] search_strategy_type
  #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy::SearchStrategyType]
  #     The type of search strategy to be applied on the `key` above.
  #     The allowed `search_strategy_type` is different for different data types,
  #     which is documented in the DataSchemaDetails.DataType. Specifying
  #     unsupported `search_strategy_type` for data types will result in
  #     INVALID_ARGUMENT error.
  # @!attribute [rw] confidence_score_index_config
  #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy::ConfidenceScoreIndexConfig]
  #     Optional. Configs the path to the confidence score, and the threshold.
  #     Only if the score is greater than the threshold, current field will be
  #     built into the index. Only applies to leaf nodes using EXACT_SEARCH or
  #     SMART_SEARCH.
  class SearchStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Filter on the confidence score. Only adds to index if the confidence
    # score is higher than the threshold.
    # Example data schema:
    # key: "name-confidence-pair"
    # type: CUSTOMIZED_STRUCT
    # granularity: GRANULARITY_PARTITION_LEVEL
    # customized_struct_config {
    #   field_schemas {
    #     key: "name"
    #     type: STRING
    #     granularity: GRANULARITY_PARTITION_LEVEL
    #     search_strategy {
    #       search_strategy_type: SMART_SEARCH
    #       confidence_score_index_config {
    #         field_path: "name-confidence-pair.score"
    #         threshold: 0.6
    #       }
    #     }
    #   }
    #   field_schemas {
    #     key: "score"
    #     type: FLOAT
    #     granularity: GRANULARITY_PARTITION_LEVEL
    #   }
    # }
    # This means only "name" with score > 0.6 will be indexed.
    # @!attribute [rw] field_path
    #   @return [::String]
    #     Required. The path to the confidence score field. It is a string that
    #     concatenates all the data schema keys along the path. See the example
    #     above. If the data schema contains LIST, use '_ENTRIES' to concatenate.
    #     Example data schema contains a list:
    #     "key": "list-name-score",
    #     "schemaDetails": {
    #       "type": "LIST",
    #       "granularity": "GRANULARITY_PARTITION_LEVEL",
    #       "listConfig": {
    #         "valueSchema": {
    #           "type": "CUSTOMIZED_STRUCT",
    #           "granularity": "GRANULARITY_PARTITION_LEVEL",
    #           "customizedStructConfig": {
    #             "fieldSchemas": {
    #               "name": {
    #                 "type": "STRING",
    #                 "granularity": "GRANULARITY_PARTITION_LEVEL",
    #                 "searchStrategy": {
    #                   "searchStrategyType": "SMART_SEARCH"
    #                   "confidence_score_index_config": {
    #                     "field_path": "list-name-score._ENTRIES.score",
    #                     "threshold": "0.9",
    #                   }
    #                 }
    #               },
    #               "score": {
    #                 "type": "FLOAT",
    #                 "granularity": "GRANULARITY_PARTITION_LEVEL",
    #               }
    #             }
    #           }
    #         }
    #       }
    #     }
    # @!attribute [rw] threshold
    #   @return [::Float]
    #     Required. The threshold.
    class ConfidenceScoreIndexConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The types of search strategies to be applied on the annotation key.
    module SearchStrategyType
      # Annotatation values of the `key` above will not be searchable.
      NO_SEARCH = 0

      # When searching with `key`, the value must be exactly as the annotation
      # value that has been ingested.
      EXACT_SEARCH = 1

      # When searching with `key`, Warehouse will perform broad search based on
      # semantic of the annotation value.
      SMART_SEARCH = 2
    end
  end

  # Data type of the annotation.
  module DataType
    # Unspecified type.
    DATA_TYPE_UNSPECIFIED = 0

    # Integer type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    #   Supports query by IntRangeArray.
    INTEGER = 1

    # Float type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    #   Supports query by FloatRangeArray.
    FLOAT = 2

    # String type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH,
    # - DataSchema.SearchStrategy.SMART_SEARCH.
    STRING = 3

    # 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.
    DATETIME = 5

    # Geo coordinate type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    #   Supports query by GeoLocationArray.
    GEO_COORDINATE = 7

    # 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.
    PROTO_ANY = 8

    # Boolean type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    BOOLEAN = 9

    # 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.
    LIST = 10

    # 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.
    CUSTOMIZED_STRUCT = 6
  end

  # The granularity of annotations under this DataSchema.
  module Granularity
    # Unspecified granularity.
    GRANULARITY_UNSPECIFIED = 0

    # Asset-level granularity (annotations must not contain partition info).
    GRANULARITY_ASSET_LEVEL = 1

    # Partition-level granularity (annotations must contain partition info).
    GRANULARITY_PARTITION_LEVEL = 2
  end
end

#type ⇒ `::Google::Cloud::VisionAI::V1::DataSchemaDetails::DataType`

Returns Type of the annotation.

Returns:

(::Google::Cloud::VisionAI::V1::DataSchemaDetails::DataType) —
Type of the annotation.

# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 1153

class DataSchemaDetails
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The configuration for `PROTO_ANY` data type.
  # @!attribute [rw] type_uri
  #   @return [::String]
  #     The type URI of the proto message.
  class ProtoAnyConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration for `LIST` data type.
  # @!attribute [rw] value_schema
  #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails]
  #     The value's data schema in the list.
  class ListConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The configuration for `CUSTOMIZED_STRUCT` data type.
  # @!attribute [rw] field_schemas
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::VisionAI::V1::DataSchemaDetails}]
  #     Direct child elements data schemas.
  class CustomizedStructConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails]
    class FieldSchemasEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # The search strategy for annotations value of the `key`.
  # @!attribute [rw] search_strategy_type
  #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy::SearchStrategyType]
  #     The type of search strategy to be applied on the `key` above.
  #     The allowed `search_strategy_type` is different for different data types,
  #     which is documented in the DataSchemaDetails.DataType. Specifying
  #     unsupported `search_strategy_type` for data types will result in
  #     INVALID_ARGUMENT error.
  # @!attribute [rw] confidence_score_index_config
  #   @return [::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy::ConfidenceScoreIndexConfig]
  #     Optional. Configs the path to the confidence score, and the threshold.
  #     Only if the score is greater than the threshold, current field will be
  #     built into the index. Only applies to leaf nodes using EXACT_SEARCH or
  #     SMART_SEARCH.
  class SearchStrategy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Filter on the confidence score. Only adds to index if the confidence
    # score is higher than the threshold.
    # Example data schema:
    # key: "name-confidence-pair"
    # type: CUSTOMIZED_STRUCT
    # granularity: GRANULARITY_PARTITION_LEVEL
    # customized_struct_config {
    #   field_schemas {
    #     key: "name"
    #     type: STRING
    #     granularity: GRANULARITY_PARTITION_LEVEL
    #     search_strategy {
    #       search_strategy_type: SMART_SEARCH
    #       confidence_score_index_config {
    #         field_path: "name-confidence-pair.score"
    #         threshold: 0.6
    #       }
    #     }
    #   }
    #   field_schemas {
    #     key: "score"
    #     type: FLOAT
    #     granularity: GRANULARITY_PARTITION_LEVEL
    #   }
    # }
    # This means only "name" with score > 0.6 will be indexed.
    # @!attribute [rw] field_path
    #   @return [::String]
    #     Required. The path to the confidence score field. It is a string that
    #     concatenates all the data schema keys along the path. See the example
    #     above. If the data schema contains LIST, use '_ENTRIES' to concatenate.
    #     Example data schema contains a list:
    #     "key": "list-name-score",
    #     "schemaDetails": {
    #       "type": "LIST",
    #       "granularity": "GRANULARITY_PARTITION_LEVEL",
    #       "listConfig": {
    #         "valueSchema": {
    #           "type": "CUSTOMIZED_STRUCT",
    #           "granularity": "GRANULARITY_PARTITION_LEVEL",
    #           "customizedStructConfig": {
    #             "fieldSchemas": {
    #               "name": {
    #                 "type": "STRING",
    #                 "granularity": "GRANULARITY_PARTITION_LEVEL",
    #                 "searchStrategy": {
    #                   "searchStrategyType": "SMART_SEARCH"
    #                   "confidence_score_index_config": {
    #                     "field_path": "list-name-score._ENTRIES.score",
    #                     "threshold": "0.9",
    #                   }
    #                 }
    #               },
    #               "score": {
    #                 "type": "FLOAT",
    #                 "granularity": "GRANULARITY_PARTITION_LEVEL",
    #               }
    #             }
    #           }
    #         }
    #       }
    #     }
    # @!attribute [rw] threshold
    #   @return [::Float]
    #     Required. The threshold.
    class ConfidenceScoreIndexConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The types of search strategies to be applied on the annotation key.
    module SearchStrategyType
      # Annotatation values of the `key` above will not be searchable.
      NO_SEARCH = 0

      # When searching with `key`, the value must be exactly as the annotation
      # value that has been ingested.
      EXACT_SEARCH = 1

      # When searching with `key`, Warehouse will perform broad search based on
      # semantic of the annotation value.
      SMART_SEARCH = 2
    end
  end

  # Data type of the annotation.
  module DataType
    # Unspecified type.
    DATA_TYPE_UNSPECIFIED = 0

    # Integer type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    #   Supports query by IntRangeArray.
    INTEGER = 1

    # Float type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    #   Supports query by FloatRangeArray.
    FLOAT = 2

    # String type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH,
    # - DataSchema.SearchStrategy.SMART_SEARCH.
    STRING = 3

    # 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.
    DATETIME = 5

    # Geo coordinate type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    #   Supports query by GeoLocationArray.
    GEO_COORDINATE = 7

    # 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.
    PROTO_ANY = 8

    # Boolean type.
    # Allowed search strategies:
    # - DataSchema.SearchStrategy.NO_SEARCH,
    # - DataSchema.SearchStrategy.EXACT_SEARCH.
    BOOLEAN = 9

    # 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.
    LIST = 10

    # 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.
    CUSTOMIZED_STRUCT = 6
  end

  # The granularity of annotations under this DataSchema.
  module Granularity
    # Unspecified granularity.
    GRANULARITY_UNSPECIFIED = 0

    # Asset-level granularity (annotations must not contain partition info).
    GRANULARITY_ASSET_LEVEL = 1

    # Partition-level granularity (annotations must contain partition info).
    GRANULARITY_PARTITION_LEVEL = 2
  end
end

Class: Google::Cloud::VisionAI::V1::DataSchemaDetails

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#customized_struct_config ⇒ ::Google::Cloud::VisionAI::V1::DataSchemaDetails::CustomizedStructConfig

#granularity ⇒ ::Google::Cloud::VisionAI::V1::DataSchemaDetails::Granularity

#list_config ⇒ ::Google::Cloud::VisionAI::V1::DataSchemaDetails::ListConfig

#proto_any_config ⇒ ::Google::Cloud::VisionAI::V1::DataSchemaDetails::ProtoAnyConfig

#search_strategy ⇒ ::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy

#type ⇒ ::Google::Cloud::VisionAI::V1::DataSchemaDetails::DataType

#customized_struct_config ⇒ `::Google::Cloud::VisionAI::V1::DataSchemaDetails::CustomizedStructConfig`

#granularity ⇒ `::Google::Cloud::VisionAI::V1::DataSchemaDetails::Granularity`

#list_config ⇒ `::Google::Cloud::VisionAI::V1::DataSchemaDetails::ListConfig`

#proto_any_config ⇒ `::Google::Cloud::VisionAI::V1::DataSchemaDetails::ProtoAnyConfig`

#search_strategy ⇒ `::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy`

#type ⇒ `::Google::Cloud::VisionAI::V1::DataSchemaDetails::DataType`