Reference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy::ConfidenceScoreIndexConfig.
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.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#field_path
deffield_path()->::String
Returns
(::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",
}
}
}
}
}
}
#field_path=
deffield_path=(value)->::String
Parameter
value (::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",
}
}
}
}
}
}
Returns
(::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",
}
}
}
}
}
}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Vision AI V1 API - Class Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy::ConfidenceScoreIndexConfig (v1.1.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.1 (latest)](/ruby/docs/reference/google-cloud-vision_ai-v1/latest/Google-Cloud-VisionAI-V1-DataSchemaDetails-SearchStrategy-ConfidenceScoreIndexConfig)\n- [1.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/1.1.0/Google-Cloud-VisionAI-V1-DataSchemaDetails-SearchStrategy-ConfidenceScoreIndexConfig)\n- [1.0.1](/ruby/docs/reference/google-cloud-vision_ai-v1/1.0.1/Google-Cloud-VisionAI-V1-DataSchemaDetails-SearchStrategy-ConfidenceScoreIndexConfig)\n- [0.4.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.4.0/Google-Cloud-VisionAI-V1-DataSchemaDetails-SearchStrategy-ConfidenceScoreIndexConfig)\n- [0.3.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.3.0/Google-Cloud-VisionAI-V1-DataSchemaDetails-SearchStrategy-ConfidenceScoreIndexConfig)\n- [0.2.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.2.0/Google-Cloud-VisionAI-V1-DataSchemaDetails-SearchStrategy-ConfidenceScoreIndexConfig)\n- [0.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.1.0/Google-Cloud-VisionAI-V1-DataSchemaDetails-SearchStrategy-ConfidenceScoreIndexConfig) \nReference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::DataSchemaDetails::SearchStrategy::ConfidenceScoreIndexConfig.\n\nFilter on the confidence score. Only adds to index if the confidence\nscore is higher than the threshold.\nExample data schema:\nkey: \"name-confidence-pair\"\ntype: CUSTOMIZED_STRUCT\ngranularity: GRANULARITY_PARTITION_LEVEL\ncustomized_struct_config {\nfield_schemas {\nkey: \"name\"\ntype: STRING\ngranularity: GRANULARITY_PARTITION_LEVEL\nsearch_strategy {\nsearch_strategy_type: SMART_SEARCH\nconfidence_score_index_config {\nfield_path: \"name-confidence-pair.score\"\nthreshold: 0.6\n}\n}\n}\nfield_schemas {\nkey: \"score\"\ntype: FLOAT\ngranularity: GRANULARITY_PARTITION_LEVEL\n}\n}\nThis means only \"name\" with score \\\u003e 0.6 will be indexed. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #field_path\n\n def field_path() -\u003e ::String\n\n**Returns**\n\n- (::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\", } } } } } }\n\n### #field_path=\n\n def field_path=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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\", } } } } } } \n**Returns**\n\n- (::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\", } } } } } }\n\n### #threshold\n\n def threshold() -\u003e ::Float\n\n**Returns**\n\n- (::Float) --- Required. The threshold.\n\n### #threshold=\n\n def threshold=(value) -\u003e ::Float\n\n**Parameter**\n\n- **value** (::Float) --- Required. The threshold. \n**Returns**\n\n- (::Float) --- Required. The threshold."]]
