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

Inherits:

Object

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

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

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

Overview

The search strategy for annotations value of the key.

Defined Under Namespace

Modules: SearchStrategyType Classes: ConfidenceScoreIndexConfig

Instance Attribute Summary collapse

#confidence_score_index_config ⇒ ::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy::ConfidenceScoreIndexConfig
Optional.
#search_strategy_type ⇒ ::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy::SearchStrategyType
The type of search strategy to be applied on the key above.

Instance Attribute Details

#confidence_score_index_config ⇒ `::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy::ConfidenceScoreIndexConfig`

Returns 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.

Returns:

(::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.

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

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

#search_strategy_type ⇒ `::Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy::SearchStrategyType`

Returns 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.