Reference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::SearchCriteriaProperty.
Central configuration for custom search criteria.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#mapped_fields
defmapped_fields()->::Array<::String>
Returns
(::Array<::String>) — Each mapped_field corresponds to a UGA key. To understand how this property
works, take the following example. In the SearchConfig table, the
user adds this entry:
search_config {
name: "person"
search_criteria_property {
mapped_fields: "player"
mapped_fields: "coach"
}
}
Now, when a user issues a query like:
criteria {
field: "person"
text_array {
txt_values: "Tom Brady"
txt_values: "Bill Belichick"
}
}
MWH search will return search documents where (player=Tom Brady ||
coach=Tom Brady || player=Bill Belichick || coach=Bill Belichick).
#mapped_fields=
defmapped_fields=(value)->::Array<::String>
Parameter
value (::Array<::String>) — Each mapped_field corresponds to a UGA key. To understand how this property
works, take the following example. In the SearchConfig table, the
user adds this entry:
search_config {
name: "person"
search_criteria_property {
mapped_fields: "player"
mapped_fields: "coach"
}
}
Now, when a user issues a query like:
criteria {
field: "person"
text_array {
txt_values: "Tom Brady"
txt_values: "Bill Belichick"
}
}
MWH search will return search documents where (player=Tom Brady ||
coach=Tom Brady || player=Bill Belichick || coach=Bill Belichick).
Returns
(::Array<::String>) — Each mapped_field corresponds to a UGA key. To understand how this property
works, take the following example. In the SearchConfig table, the
user adds this entry:
search_config {
name: "person"
search_criteria_property {
mapped_fields: "player"
mapped_fields: "coach"
}
}
Now, when a user issues a query like:
criteria {
field: "person"
text_array {
txt_values: "Tom Brady"
txt_values: "Bill Belichick"
}
}
MWH search will return search documents where (player=Tom Brady ||
coach=Tom Brady || player=Bill Belichick || coach=Bill Belichick).
[[["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::SearchCriteriaProperty (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-SearchCriteriaProperty)\n- [1.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/1.1.0/Google-Cloud-VisionAI-V1-SearchCriteriaProperty)\n- [1.0.1](/ruby/docs/reference/google-cloud-vision_ai-v1/1.0.1/Google-Cloud-VisionAI-V1-SearchCriteriaProperty)\n- [0.4.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.4.0/Google-Cloud-VisionAI-V1-SearchCriteriaProperty)\n- [0.3.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.3.0/Google-Cloud-VisionAI-V1-SearchCriteriaProperty)\n- [0.2.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.2.0/Google-Cloud-VisionAI-V1-SearchCriteriaProperty)\n- [0.1.0](/ruby/docs/reference/google-cloud-vision_ai-v1/0.1.0/Google-Cloud-VisionAI-V1-SearchCriteriaProperty) \nReference documentation and code samples for the Vision AI V1 API class Google::Cloud::VisionAI::V1::SearchCriteriaProperty.\n\nCentral configuration for custom search criteria. \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### #mapped_fields\n\n def mapped_fields() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Each mapped_field corresponds to a UGA key. To understand how this property works, take the following example. In the SearchConfig table, the user adds this entry: search_config { name: \"person\" search_criteria_property { mapped_fields: \"player\" mapped_fields: \"coach\" } }\n\n Now, when a user issues a query like:\n criteria {\n field: \"person\"\n text_array {\n txt_values: \"Tom Brady\"\n txt_values: \"Bill Belichick\"\n }\n }\n\n MWH search will return search documents where (player=Tom Brady \\|\\|\n coach=Tom Brady \\|\\| player=Bill Belichick \\|\\| coach=Bill Belichick).\n\n### #mapped_fields=\n\n def mapped_fields=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) --- Each mapped_field corresponds to a UGA key. To understand how this property works, take the following example. In the SearchConfig table, the user adds this entry: search_config { name: \"person\" search_criteria_property { mapped_fields: \"player\" mapped_fields: \"coach\" } }\n\n\n Now, when a user issues a query like:\n criteria {\n field: \"person\"\n text_array {\n txt_values: \"Tom Brady\"\n txt_values: \"Bill Belichick\"\n }\n }\n\n MWH search will return search documents where (player=Tom Brady \\|\\|\ncoach=Tom Brady \\|\\| player=Bill Belichick \\|\\| coach=Bill Belichick). \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- Each mapped_field corresponds to a UGA key. To understand how this property works, take the following example. In the SearchConfig table, the user adds this entry: search_config { name: \"person\" search_criteria_property { mapped_fields: \"player\" mapped_fields: \"coach\" } }\n\n Now, when a user issues a query like:\n criteria {\n field: \"person\"\n text_array {\n txt_values: \"Tom Brady\"\n txt_values: \"Bill Belichick\"\n }\n }\n\n MWH search will return search documents where (player=Tom Brady \\|\\|\n coach=Tom Brady \\|\\| player=Bill Belichick \\|\\| coach=Bill Belichick)."]]
