Class DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig (0.12.0)

public static final class DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig extends GeneratedMessageV3 implements DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfigOrBuilder

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.

Protobuf type google.cloud.visionai.v1.DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig

Static Fields

FIELD_PATH_FIELD_NUMBER

public static final int FIELD_PATH_FIELD_NUMBER
Field Value
Type Description
int

THRESHOLD_FIELD_NUMBER

public static final int THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig getDefaultInstance()
Returns
Type Description
DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig.Builder newBuilder()
Returns
Type Description
DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig.Builder

newBuilder(DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig prototype)

public static DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig.Builder newBuilder(DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig prototype)
Parameter
Name Description
prototype DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig
Returns
Type Description
DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig.Builder

parseDelimitedFrom(InputStream input)

public static DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig> parser()
Returns
Type Description
Parser<ConfidenceScoreIndexConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig getDefaultInstanceForType()
Returns
Type Description
DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig

getFieldPath()

public String getFieldPath()

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", } } } } } }

string field_path = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The fieldPath.

getFieldPathBytes()

public ByteString getFieldPathBytes()

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", } } } } } }

string field_path = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for fieldPath.

getParserForType()

public Parser<DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig> getParserForType()
Returns
Type Description
Parser<ConfidenceScoreIndexConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getThreshold()

public float getThreshold()

Required. The threshold.

float threshold = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
float

The threshold.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig.Builder newBuilderForType()
Returns
Type Description
DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig.Builder toBuilder()
Returns
Type Description
DataSchemaDetails.SearchStrategy.ConfidenceScoreIndexConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException