1 /* 2 * Copyright 2023 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package android.app.appsearch; 18 19 import android.util.ArraySet; 20 21 import java.util.Arrays; 22 import java.util.Collections; 23 import java.util.Set; 24 25 /** 26 * A class that encapsulates all feature constants that are accessible in AppSearch framework. 27 * 28 * <p>All fields in this class is referring in {@link Features}. If you add/remove any field in this 29 * class, you should also change {@link Features}. 30 * 31 * @see Features 32 * @hide 33 */ 34 public final class FeatureConstants { 35 /** Feature constants for {@link Features#NUMERIC_SEARCH}. */ 36 public static final String NUMERIC_SEARCH = "NUMERIC_SEARCH"; 37 38 /** Feature constants for {@link Features#VERBATIM_SEARCH}. */ 39 public static final String VERBATIM_SEARCH = "VERBATIM_SEARCH"; 40 41 /** Feature constants for {@link Features#LIST_FILTER_QUERY_LANGUAGE}. */ 42 public static final String LIST_FILTER_QUERY_LANGUAGE = "LIST_FILTER_QUERY_LANGUAGE"; 43 44 /** Feature constants for {@link Features#LIST_FILTER_HAS_PROPERTY_FUNCTION}. */ 45 public static final String LIST_FILTER_HAS_PROPERTY_FUNCTION = 46 "LIST_FILTER_HAS_PROPERTY_FUNCTION"; 47 48 /** Feature constants for {@link Features#LIST_FILTER_MATCH_SCORE_EXPRESSION_FUNCTION}. */ 49 public static final String LIST_FILTER_MATCH_SCORE_EXPRESSION_FUNCTION = 50 "LIST_FILTER_MATCH_SCORE_EXPRESSION_FUNCTION"; 51 52 /** A feature constant for the "semanticSearch" function in {@link AppSearchSession#search}. */ 53 public static final String EMBEDDING_SEARCH = "EMBEDDING_SEARCH"; 54 55 /** 56 * A feature constant for the "getScorableProperty" function in {@link AppSearchSession#search}. 57 */ 58 public static final String SCHEMA_SCORABLE_PROPERTY_CONFIG = "SCHEMA_SCORABLE_PROPERTY_CONFIG"; 59 60 /** A set of scoring features. */ 61 public static final Set<String> SCORABLE_FEATURE_SET = 62 Collections.unmodifiableSet( 63 new ArraySet<>(Arrays.asList(SCHEMA_SCORABLE_PROPERTY_CONFIG))); 64 FeatureConstants()65 private FeatureConstants() {} 66 } 67