AppSearch

AppSearch to biblioteka wyszukiwania na urządzeniu służąca do zarządzania lokalnie przechowywanymi uporządkowanymi danymi. Zawiera interfejsy API do indeksowania danych i ich pobierania za pomocą wyszukiwania pełnego tekstu. Użyj go do tworzenia niestandardowych funkcji wyszukiwania w aplikacji dla użytkowników.
Ostatnia aktualizacja Wersja stabilna Wersja kandydująca Wersja Beta Wersja alfa
16 października 2024 r. - - - 1.1.0-alpha06

Deklarowanie zależności

Aby dodać zależność od AppSearch, musisz dodać do projektu repozytorium Google Maven. Więcej informacji znajdziesz w repozytorium Maven firmy Google.

W pliku build.gradle aplikacji lub modułu dodaj zależności artefaktów, których potrzebujesz:

Groovy

dependencies {
    def appsearch_version = "1.1.0-alpha05"

    implementation "androidx.appsearch:appsearch:$appsearch_version"
    // Use kapt instead of annotationProcessor if writing Kotlin classes
    annotationProcessor "androidx.appsearch:appsearch-compiler:$appsearch_version"

    implementation "androidx.appsearch:appsearch-local-storage:$appsearch_version"
    // PlatformStorage is compatible with Android 12+ devices, and offers additional features
    // to LocalStorage.
    implementation "androidx.appsearch:appsearch-platform-storage:$appsearch_version"
}

Kotlin

dependencies {
    val appsearch_version = "1.1.0-alpha05"

    implementation("androidx.appsearch:appsearch:$appsearch_version")
    // Use annotationProcessor instead of kapt if writing Java classes
    kapt("androidx.appsearch:appsearch-compiler:$appsearch_version")

    implementation("androidx.appsearch:appsearch-local-storage:$appsearch_version")
    // PlatformStorage is compatible with Android 12+ devices, and offers additional features
    // to LocalStorage.
    implementation("androidx.appsearch:appsearch-platform-storage:$appsearch_version")
}

Więcej informacji o zależnościach znajdziesz w artykule Dodawanie zależności kompilacji.

Opinia

Twoja opinia pomoże nam ulepszyć Jetpacka. Jeśli zauważysz nowe problemy lub masz pomysły na ulepszenie tej biblioteki, daj nam znać. Zanim utworzysz nową bibliotekę, przejrzyj istniejące problemy w tej bibliotece. Możesz dodać swój głos do istniejącego problemu, klikając przycisk z gwiazdką.

Tworzenie nowego zgłoszenia

Więcej informacji znajdziesz w dokumentacji narzędzia do śledzenia problemów.

Wersja 1.1

Wersja 1.1.0-alpha06

16 października 2024 r.

androidx.appsearch:appsearch-*:1.1.0-alpha06 został zwolniony. Wersja 1.1.0-alpha06 zawiera te komity.

Zmiany w interfejsie API

  • Dodano węzeł reprezentujący funkcję zapytania PropertyDefined. (I1aeaf)
  • Dodaj węzły reprezentujące liczbowe wyszukiwanie i ograniczenia właściwości. (I963a9)
  • Dodaj węzeł reprezentujący funkcję zapytania GetSearchStringParameter. (I4f99b)
  • Dodaj węzeł reprezentujący funkcję zapytania HasProperty. (I9c1c5)
  • Dodano interfejs do wdrażania funkcji w AST. (I9d42e)
  • Dodaj operatory I i LUB. (Iaa442)
  • Dodaj NegationNode, aby reprezentować logiczne zaprzeczenie zapytań w AST. (Ia855a)
  • Dodaj interfejs węzła do pliku AppSearch, aby definiować węzły. (If42fb)
  • Dodaje adnotację Experimental API dla AppSearch. (I3e57c)

Poprawki błędów

  • Dodaj TextNodes, aby określić warunki blokady. (Iefd02)

Poprawka zabezpieczeń

  • Po tej zmianie Androidx kompiluje wersję protokołu w standardzie 4.28.2, aby uwzględnić standard CVE-2024-7254. Aby zmniejszyć ryzyko luk w zabezpieczeniach, uaktualnij zależność od androidx.appsearch:appsearch-external-protobuf do najnowszej wersji 1.1.0-alfa06.

Wersja 1.1.0-alpha05

4 września 2024 r.

androidx.appsearch:appsearch-*:1.1.0-alpha05 został zwolniony. Wersja 1.1.0-alpha05 zawiera te komity.

Zmiany w interfejsie API

  • Usunięcie zbędnych elementów setEmbeddingSearchEnabled i getEmbeddingSearchEnabled. usuwa setListFilterTokenizeFunctionEnabled i getListFilterTokenizeFunctionEnabled; Usunięto funkcję zapytania „tokenize”. Zastąpiliśmy je funkcją zapytania getSearchStringParameter i funkcją addSearchStringParameter. (I09f5a)
  • Zmień nazwę Alarm#getComputingDevice na getOriginatingDevice. (I63121)

Wersja 1.1.0-alpha04

7 sierpnia 2024 r.

androidx.appsearch:appsearch-*:1.1.0-alpha04 został zwolniony. Wersja 1.1.0-alpha04 zawiera te komity.

Nowe funkcje

  • Obsługa nowej implementacji PlayServicesStorage, która umożliwia korzystanie z AppSearch na starszych urządzeniach bez ponoszenia znacznych kosztów związanych z rozmiarem pliku APK LocalStorage. Ta implementacja pamięci polega na przechowywaniu danych aplikacji w aplikacji Usługi Play.
  • Obsługa nowych interfejsów API na urządzeniach z Androidem 15.
  • Obsługa wyszukiwania w bazie danych za pomocą wektorów dystrybucyjnych, co umożliwia dopasowanie przybliżone. (I2b41b)
  • Obsługa typów nadrzędnych i polimorfizmu w ramach modelu schematu AppSearch. (I06118)
  • Obsługa interfejsu API TakenAction, który umożliwia aplikacjom zgłaszanie, kiedy wyniki zostały kliknięte lub pominięte, aby zwiększyć jakość podczas kolejnych wyszukiwań. (I54091)
  • Obsługa klas z builderami w procesorze adnotacji dzięki wprowadzeniu nowej adnotacji @Document.BuilderProducer. (Iec30a)
  • Dodanie możliwości szczegółowego określenia, które właściwości dokumentu zagnieżdżonego mają być indeksowane. (Iec30a).
  • Obsługa filtrowania wyszukiwania pod kątem określonych właściwości dokumentu. (Ib2659)
  • Obsługa bardziej szczegółowych ustawień widoczności dzięki zastosowaniu operatorów LUB i ALBO. (I0274B)
  • Obsługa zapewniania widoczności danych wszystkim aplikacjom, które mogą sprawdzić istnienie aplikacji będącej ich właścicielem (widoczność publiczna). (I992e4)
  • Obsługa pobierania tylko wyników, które mają dane wypełnione w określonej usłudze. (I7d94f)
  • Obsługa pobierania kontaktów firmowych w profilu osobistym. (IdD587).

Zmiany w interfejsie API

  • Dodaj parametry adnotacji indexableNestedPropertiesList i inheritIndexableNestedPropertiesFromSuperclass do adnotacji Document.DocumentProperty w AppSearch, aby umożliwić indeksowanie określonych zagnieżdżonych ścieżek właściwości. (Iec30a)
  • Obsługa konstruktora buildera w celu tworzenia instancji buildera w procesorze adnotacji AppSearch (I265c9)
  • Zaktualizowaliśmy procesor adnotacji AppSearch, aby obsługiwał ustawianie typów nadrzędnych w przypadku polimorfizmu (I06118)
  • Dodanie metody GetSchemaRequest do wyczyszczania ustawień widoczności (I38379)
  • Obsługa addParentType w AppSearch w celu polimorfizmu (Ida14a)
  • Dodaj interfejsy API dla dodatkowych wyrażeń rankingowych (I5d9f4)
  • Dodaj interfejs API SearchAction (I54091)
  • Dodaje pole opisu dla typów AppSearch (I84762)
  • Wdrażanie interfejsów API zapytań i rankingów wyszukiwania w AppSearch (I0f6c3)
  • Usuwa getDeletionPropagation (I21192)

Wersja 1.1.0-alpha03

24 maja 2023 r.

Usługa androidx.appsearch:appsearch-*:1.1.0-alpha03 została zwolniona. Wersja 1.1.0-alpha03 zawiera te commity.

Nowe funkcje

  • Obsługa zaawansowanego interfejsu API zapytań, zaawansowanego punktowania API i wyszukiwania liczbowego. (I02d48)
  • Dodaje interfejs API LocalStorage.createGlobalSearchSession umożliwiający przeszukiwanie wszystkich baz danych w pamięci lokalnej danej aplikacji (Id3c89).
  • Dodano interfejs API do złączania dokumentów według identyfikatora (Iaecfa).
  • Obsługa wag właściwości w celu oznaczenia niektórych właściwości jest ważniejsze, gdy używasz RANKING_STRATEGY_RELEVANCE_SCORING. (I069b9)
  • Dodaj Person i ContactPoint, aby przeszukiwać zbiór Person w AppSearch. (Ia58f9)
  • Dodano nowy typ dokumentu ImageObject modelowany na podstawie http://schema.org/ImageObject. (I6a0c0)
  • Dodaj tokenizer VERBATIM, który umożliwia dodawanie właściwości bez interpretacji przez AppSearch. (I47bc0)
  • Dodano RFC822_TOKENIZATION jako typ tokena, co umożliwia tokenizację adresów e-mail. (I8a390)
  • Włącz wyszukiwanie globalne w widoku debugowania. (I51fb2)

Zmiany w interfejsie API

  • Usunięto metody, które zwracają wartość ListenableFuture i nie mają sufiksu asynchronicznego. (I0515f)
  • Dodaliśmy możliwość konfigurowania projekcji za pomocą klasy Document. (I94576)
  • Dodaj pola Thing–Alarm, AlarmInstance, Timer, Stopwatch, StopwatchLap, ContactPoint i Person (Id876c)

Poprawki błędów

  • Pełna obsługa funkcji Androida 13 w appsearch-platform-storage (Ia8e61)
  • Rozwiązanie problemów z zastąpieniem nazw schematów i pól prywatnych podczas korzystania z dziedziczenia.

Wersja 1.1.0-alpha02

24 sierpnia 2022 r.

androidx.appsearch:appsearch-*:1.1.0-alpha02 został zwolniony. Wersja 1.1.0-alpha02 zawiera te commity.

Nowe funkcje

  • przyspieszenie procesu optymalizacji dzięki zastosowaniu kompresji indeksu zamiast odtwarzania indeksu od początku;
  • Zmieniono tag logowania natywnych z „icing” na „AppSearchIcing” i domyślnie rejestrowano wiadomości INFO.

Zmiany w interfejsie API

  • Dodaje nowy obiekt PropertyPath do pracy ze ścieżkami oraz nowe metody addProjection, aby akceptować PropertyPath. (I45588)
  • Dodano typy wbudowane builtin:Thing i AppSearch (I55427).
  • Zapobieganie wcześniejszemu pustym nazwom właściwości w GenericDocument – wcześniej były one blokowane w czasie indeksowania, a teraz są blokowane w czasie GenericDocument.Builder.build() (I9e780)

Poprawki błędów

  • Usunięto zbędne formatowanie ciągów znaków, aby poprawić wyniki punktacji RELEVANCE
  • Bardziej wydajne pobieranie stron w przypadku nieczytelnych lub usuniętych dokumentów
  • Wdrożenie czyszczenia pamięci dla porzuconych zapytań
  • Poprawiono obsługę zagnieżdżonego indeksowania w przypadku Dokumentów. Wcześniej funkcja indexNestedProperties była ignorowana. (Iae9a6)

Treści tłumaczone przez użytkowników zewnętrznych

  • Shea Smith: napraw obsługę zagnieżdżonego indeksowania dokumentów. (Iae9a6)

Wersja 1.1.0-alpha01

15 czerwca 2022 r.

androidx.appsearch:appsearch-*:1.1.0-alpha01 został zwolniony. Wersja 1.1.0-alpha01 została opracowana w ramach prywatnej gałęzi wstępnej i nie zawiera publicznych zatwierdzeń.

Zmiany interfejsu API

  • Nazwy wszystkich metod zwracających wartość ListenableFuture zostały zmienione tak, aby miały sufiks asynchroniczny. Na przykład getSchema zostało przemianowane na getSchemaAsync. Wcześniejsze wersje zostały wycofane i w przyszłej wersji zostaną usunięte.

Nowe funkcje

  • Pierwsza wersja pakietu appsearch-builtin-types. Ten projekt zawiera wbudowane typy oparte na schema.org, które mogą być wygodne dla klientów zamiast definiowania własnych typów dla typowych obiektów. W kolejnych wersjach dodamy więcej typów.
  • Możliwość konwertowania dokumentu AppSearch na dokument ShortcutInfoCompat za pomocą narzędzia ShortcutAdapter. Dzięki temu klienci mogą udostępniać dokumenty AppSearch w Google za pomocą biblioteki core-google-shortcuts.
  • Możliwość korzystania z klas @Document z dziedziczeniem. Pola nie mogą być zastępowane ani modyfikowane, ale można dodawać nowe pola, rozszerzając klasę oznaczoną adnotacją @Document.
  • Nowy interfejs Observer API, który umożliwia klientom rejestrowanie się w celu otrzymywania powiadomień, gdy typy, do których mają dostęp, ulegną zmianie lub gdy dokumenty tego typu zostaną dodane, zmodyfikowane lub usunięte. WAŻNE: obecna implementacja wysyła powiadomienia tylko wtedy, gdy aplikacja jest uruchomiona. Obecnie nie ma możliwości sprawdzenia zmian, które nastąpiły, gdy aplikacja była zatrzymana. W związku z tym nie należy polegać na tym interfejsie API w pełni.
  • Interfejs API parsera usług, który umożliwia pełną obsługę i sprawdzanie ścieżek właściwości zwracanych przez funkcję MatchInfo#getPropertyPath.
  • Globalny getById i globalny interfejs API getSchema do pobierania dokumentów i schematów z innych aplikacji, które przyznały Ci widoczność.
  • Możliwość pobierania informacji o widoczności w getSchema w przypadku danych, do których masz dostęp
  • możliwość udostępniania widoczności aplikacjom z określonym uprawnieniem Androida (ograniczona do wąskiego zestawu dozwolonych uprawnień);
  • Obsługa pobierania w stylu isFoo() dla pól wartości logicznych w procesorze adnotacji oprócz poprzedniego obsługiwanego stylu hasFoo()
  • Obsługa nowych funkcji chronionych za pomocą @RequiresFeature. Aby sprawdzić, co obsługuje bieżący backend, użyj AppSearchSession#getFeatures.
  • usunąć limit ok. 13 tys. tokenów w pojedynczych dokumentach,
  • zezwalanie na dopasowywanie znaków spoza zestawu ASCII i znaków innych niż alfanumeryczne, np. emotikonów;

Poprawki błędów

  • Napraw błąd, który powodował nieprawidłowe działanie funkcji SetSchema przy zastępowaniu zagnieżdżonego niezgodnego typu.
  • Poprawki mające na celu pełne obsługiwanie zajęć z adnotacją @AutoValue używanych jako zajęcia @Document w AppSearch
  • Rozwiązania niektórych problemów z awariami związanymi z powtarzającymi się listami klas dokumentów i innymi problemami
  • Poprawka błędu, który w pewnych okolicznościach powodował awarię wyszukiwania z prefiksem
  • Naprawiono błąd w funkcji GetStorageInfo, który powodował zwracanie nieprawidłowych wartości w przypadku niepowodzeń operacji wejścia/wyjścia.
  • Rozwiązywanie problemów z czytaniem dokumentu (BUSADDERR)
  • Naprawianie uszkodzenia logcat spowodowanego wydrukowaniem niesformatowanego odcisku palca
  • Napraw NPE wywołane przez błędy wejścia-wyjścia
  • Naprawiono wyciek pamięci w usługach GetSchemaType, Get, Delete, DeleteByNamespace i DeleteBySchemaType

Wersja 1.0.0

Wersja 1.0.0-alpha04

3 listopada 2021 r.

Usługa androidx.appsearch:appsearch-*:1.0.0-alpha04 została zwolniona. Wersja 1.0.0-alfa04 zawiera te zatwierdzenia.

Nowe funkcje

  • Zależność Guava ListenableFuture automatycznie wprowadzona jako zależność interfejsu API

Zmiany w interfejsie API

  • Aby uzyskać więcej informacji o każdym dopasowaniu, dodaj metody SearchResult#getSubmatchRange() i SearchResult#getSubmatch(). (I2fef6)
  • Doprecyzowanie dokumentacji dotyczącej generowania odcisków cyfrowych identyfikatora PackageIdentifier na potrzeby udostępniania danych według nazwy pakietu i certyfikatu

Poprawki błędów

  • Naprawianie błędu, który pojawia się, gdy użytkownik próbuje pobrać strony z wynikami po zakończeniu zestawu wyników
  • Rozwiązanie problemu z zapytaniem dotyczącym wszystkich przestrzeni nazw, jeśli jako filtry zapytań podano tylko nieprawidłowe przestrzenie nazw
  • Rozwiązanie problemu polegającego na usuwaniu wszystkich przestrzeni nazw, jeśli jako filtry usuwania według zapytania podano tylko nieprawidłowe przestrzenie nazw.
  • Rozwiązanie problemu polegającego na tym, że w przypadku bardzo dużych dokumentów dane dokumentu przestawały być indeksowane po pewnym czasie
  • Rozwiązanie problemu polegającego na tym, że tokenizacja pomijała segmenty zawierające znaki liczbowe spoza zestawu ASCII
  • Dodanie sprawdzania kolejnych nieudanych prób inicjalizacji, aby pomóc w wyjściu z potencjalnie nieprawidłowego stanu, który uniemożliwia prawidłową inicjalizację.

Wersja 1.0.0-alpha03

21 lipca 2021 r.

androidx.appsearch:appsearch-*:1.0.0-alpha03 został zwolniony. Wersja 1.0.0-alfa03 zawiera te zatwierdzenia.

Nowe funkcje

  • wydanie platformy backendowej Platform Storage, aby umożliwić klientom korzystanie z interfejsu AppSearch API w ramach nowej usługi android.app.appsearch.AppSearchManager wprowadzanej w Androidzie S; Więcej informacji znajdziesz w przewodniku dla programistów AppSearch.
  • Obsługa procesora adnotacji w AutoValue
  • Usunięcie limitu maksymalnego rozmiaru właściwości typu pojedynczy ciąg znaków
  • Nowy format pamięci masowej w celu zmniejszenia opóźnienia inicjalizacji
  • jednorazowa wewnętrzna migracja danych ze starego formatu na nowy;

Poprawki błędów

  • prawidłowo stosuje limit liczby dokumentów podczas wstawiania nowych dokumentów,
  • Usunięto awarię podczas tworzenia sesji wyszukiwania w aplikacji
  • Naprawiliśmy błędy w SetSchema, które nie wykrywały niektórych przypadków niekompatybilności wstecznej i niezgodności indeksu.

Wersja 1.0.0-alpha02

30 czerwca 2021 r.

Funkcje androidx.appsearch:appsearch:1.0.0-alpha02, androidx.appsearch:appsearch-compiler:1.0.0-alpha02 i androidx.appsearch:appsearch-local-storage:1.0.0-alpha02 są dostępne. Wersja 1.0.0-alfa02 zawiera te zatwierdzenia.

Nowe funkcje

  • Pełna obsługa języków chińskiego, japońskiego, koreańskiego i tajskiego
  • Zmniejszony rozmiar androidx.appsearch:appsearch-local-storage
  • Usunięcie limitu maksymalnego rozmiaru powtarzających się właściwości
  • Zezwalanie na ponowne używanie klas Builder
  • Ulepszenia w toString() niektórych obiektów w celu ułatwienia debugowania
  • Ulepszenia dokumentacji Javadoc

Zmiany interfejsu API

  • Zmieniono nazwę użytkownika z „SearchResult#getMatches” na „SearchResult#getMatchInfos”
  • Zmieniono nazwę użytkownika z „@Document.Int64Property” na „@Document.LongProperty”

Poprawki błędów

  • Ulepszenia i poprawki dotyczące obliczania fragmentów wyników
  • Poprawki błędów podczas inicjowania AppSearchSession

Wersja 1.0.0-alpha01

5 maja 2021 roku

Funkcje androidx.appsearch:appsearch:1.0.0-alpha01, androidx.appsearch:appsearch-compiler:1.0.0-alpha01 i androidx.appsearch:appsearch-local-storage:1.0.0-alpha01 są dostępne. Wersja 1.0.0-alpha01 zawiera te commity.

Nowe funkcje

AppSearch to biblioteka wyszukiwania służąca do zarządzania lokalnie przechowywanymi uporządkowanymi danymi. Zawiera interfejsy API do indeksowania danych i ich pobierania za pomocą wyszukiwania pełnego tekstu. Użyj go do tworzenia niestandardowych funkcji wyszukiwania w aplikacji dla użytkowników. Ta pierwsza wersja to 1.0.0-alpha01.