typesense java Télécharger - typesense java Téléchargement du code source

Client Java Typesense ☕ ?

Bibliothèque client Java pour accéder à l'API HTTP du moteur de recherche Typesense.

Installation

Le client est disponible sur Maven central :

dependencies {
    implementation ' org.typesense:typesense-java:1.1.0 '
}

< dependency >
    < groupId >org.typesense</ groupId >
    < artifactId >typesense-java</ artifactId >
    < version >1.1.0</ version >
</ dependency >

 import org . typesense . api .*;
import org . typesense . model .*;
import org . typesense . resources .*;

Usage

Créer un nouveau client

 List < Node > nodes = new ArrayList <>();
nodes . add (
  new Node (
    "http" ,       // For Typesense Cloud use https
    "localhost" ,  // For Typesense Cloud use xxx.a1.typesense.net
    "8108"        // For Typesense Cloud use 443
  )
);

Configuration configuration = new Configuration ( nodes , Duration . ofSeconds ( 2 ), "<API_KEY>" );

Client client = new Client ( configuration );

Créer une nouvelle collection

 List < Field > fields = new ArrayList <>();
fields . add ( new Field (). name ( "countryName" ). type ( FieldTypes . STRING ));
fields . add ( new Field (). name ( "capital" ). type ( FieldTypes . STRING ));
fields . add ( new Field (). name ( "gdp" ). type ( FieldTypes . INT32 ). facet ( true ). sort ( true ));

CollectionSchema collectionSchema = new CollectionSchema ();
collectionSchema . name ( "Countries" ). fields ( fields ). defaultSortingField ( "gdp" );

client . collections (). create ( collectionSchema );

Créer une nouvelle collection à partir du fichier JSON

 String schemaJson = new String (
    Files . readAllBytes ( Paths . get ( "schema.json" )),
    StandardCharsets . UTF_8
);
client . collections (). create ( schemaJson );

Indexer un document

 Map < String , Object > hmap = new HashMap <>();
hmap . put ( "countryName" , "India" );
hmap . put ( "capital" , "Delhi" );
hmap . put ( "gdp" , 10 );

client . collections ( "Countries" ). documents (). create ( hmap );

Insertion d'un document

 Map < String , Object > hmap = new HashMap <>();
hmap . put ( "countryName" , "India" );
hmap . put ( "capital" , "Delhi" );
hmap . put ( "gdp" , 5 );

client . collections ( "Countries" ). documents (). upsert ( hmap );

Importer un lot de documents

 ImportDocumentsParameters queryParameters = new ImportDocumentsParameters ();
queryParameters . action ( "create" );

String documentList = "{ " countryName " : " India " , " capital " : " Washington " , " gdp " : 5215} n " +
                      "{ " countryName " : " Iran " , " capital " : " London " , " gdp " : 5215}" ;
// Import your document as JSONL string from a file.
client . collections ( "Countries" ). documents (). import_ ( documentList , queryParameters )

Rechercher dans une collection

 SearchParameters searchParameters = new SearchParameters ()
                                        . q ( "tokoyo" )
                                        . queryBy ( "countryName,capital" )
                                        . prefix ( "true,false" );
SearchResult searchResult = client . collections ( "Countries" ). documents (). search ( searchParameters );

Mettre à jour un document

 Map < String , Object > hmap = new HashMap <>();
hmap . put ( "gdp" , 8 );
client . collections ( "Countries" ). documents ( "28" ). update ( hmap );

Récupérer un document

 client . collections ( "Countries" ). documents ( "28" ). retrieve ();

Supprimer un document

 client . collections ( "Countries" ). documents ( "28" ). delete ();

Supprimer des documents à l'aide d'une requête

 DeleteDocumentsParameters deleteDocumentsParameters = new DeleteDocumentsParameters ();
deleteDocumentsParameters . filterBy ( "gdp:=[2,8]" );
deleteDocumentsParameters . batchSize ( 10 );

Récupérer une collection

 client . collections ( "Countries" ). retrieve ();

Récupérer toutes les collections

 client . collections (). retrieve ();

Déposer une collection

 client . collections ( "Countries" ). delete ();

Exporter une collection

 client . collections ( "Countries" ). documents (). export ();

Créer une règle d'analyse

 AnalyticsRuleSchema analyticsRule = new AnalyticsRuleSchema ();
analyticsRule . setName ( "popular-queries" );
analyticsRule . setType ( AnalyticsRuleSchema . TypeEnum . POPULAR_QUERIES );
analyticsRule . setParams ( new AnalyticsRuleParameters ()
        . source ( new AnalyticsRuleParametersSource ()
                . collections ( Arrays . asList ( "Countries" )))
        . destination ( new AnalyticsRuleParametersDestination ()
                . collection ( "top_searches" )));

client . analytics (). rules (). create ( analyticsRule );

Insérer une règle d'analyse

 AnalyticsRuleUpsertSchema analyticsRule = new AnalyticsRuleUpsertSchema ()
        . type ( AnalyticsRuleUpsertSchema . TypeEnum . NOHITS_QUERIES )
        . params ( new AnalyticsRuleParameters ()
                . source ( new AnalyticsRuleParametersSource ()
                        . collections ( Arrays . asList ( "Countries" )))
                . destination ( new AnalyticsRuleParametersDestination ()
                        . collection ( "failed_searches" )));

client . analytics (). rules (). upsert ( "failed-searches" , analyticsRule );

Récupérer toutes les règles d'analyse

 AnalyticsRulesRetrieveSchema rules = client . analytics (). rules (). retrieve ();

Récupérer une seule règle d'analyse

 AnalyticsRuleSchema rule = client . analytics (). rules ( "failed-searches" ). retrieve ();

Supprimer une règle d'analyse

 client . analytics (). rules ( "failed-searches" ). delete ();

Créer un événement d'analyse

 AnalyticsEventCreateSchema analyticsEvent = new AnalyticsEventCreateSchema ()
        . type ( "conversion" )
        . name ( "purchase_made" )
        . data ( Map . of (
                "product_id" , "123" ,
                "user_id" , "user_456" ,
                "amount" , "99.99"
        ));

client . analytics (). events (). create ( analyticsEvent );

Insérer un ensemble de mots vides

 List < String > stopwords = new ArrayList <>();
stopwords . add ( "the" );
stopwords . add ( "of" );
stopwords . add ( "and" );

StopwordsSetUpsertSchema stopwordsSet = new StopwordsSetUpsertSchema ();
stopwordsSet . stopwords ( stopwords );

client . stopwords (). upsert ( "common-words" , stopwordsSet );

Récupérer un ensemble de mots vides

 StopwordsSetRetrieveSchema set = client . stopwords ( "common-words" ). retrieve ();

Récupérer tous les ensembles de mots vides

 StopwordsSetsRetrieveAllSchema sets = client . stopwords (). retrieve ();

Supprimer un ensemble de mots vides

 client . stopwords ( "common-words" ). delete ();

Créer une clé API

 ApiKeySchema apiKeySchema = new ApiKeySchema ();
List < String > actionValues = new ArrayList <>();
List < String > collectionValues = new ArrayList <>();

actionValues . add ( "*" );
collectionValues . add ( "*" );

apiKeySchema . description ( "Admin Key" ). actions ( actionValues ). collections ( collectionValues );

client . keys (). create ( apiKeySchema );

Créer une clé API de recherche uniquement

 ApiKeySchema apiKeySchema = new ApiKeySchema ();
List < String > actionValues = new ArrayList <>();
List < String > collectionValues = new ArrayList <>();

actionValues . add ( "documents:search" );
collectionValues . add ( "Countries" );

apiKeySchema . description ( "Search only Key" ). actions ( actionValues ). collections ( collectionValues );

client . keys (). create ( apiKeySchema );

Récupérer une clé API

 client . keys ( "6" ). retrieve ();

Lister toutes les clés API

 client . keys (). retrieve ();

Supprimer une clé API

 client . keys ( "6" ). delete ();

Créer ou mettre à jour un remplacement

 SearchOverrideSchema searchOverrideSchema = new SearchOverrideSchema ();

List < SearchOverrideInclude > searchOverrideIncludes = new ArrayList <>();
searchOverrideIncludes . add ( new SearchOverrideInclude (). id ( "422" ). position ( 1 ));
searchOverrideIncludes . add ( new SearchOverrideInclude (). id ( "54" ). position ( 2 ));

List < SearchOverrideExclude > searchOverrideExcludes = new ArrayList <>();
searchOverrideExcludes . add ( new SearchOverrideExclude (). id ( "287" ));

searchOverrideSchema . rule ( new SearchOverrideRule (). query ( "new york" ). match ( "exact" ))
                    . includes ( searchOverrideIncludes )
                    . excludes ( searchOverrideExcludes );

client . collections ( "Countries" ). overrides (). upsert ( "new-york" , searchOverrideSchema )

Récupérer un alias

 client . collections ( "Countries" ). overrides ( "new-york" ). retrieve ();

Répertorier tous les remplacements

 client . collections ( "Countries" ). overrides (). retrieve ();

Supprimer un remplacement

 client . collections ( "Countries" ). overrides ( "new-york" ). delete ();

Insérer un alias

 CollectionAliasSchema collectionAliasSchema = new CollectionAliasSchema ();
collectionAliasSchema . collectionName ( "Countries" );

client . aliases (). upsert ( "countries2" , collectionAliasSchema )

Récupérer un alias

 client . aliases ( "countries2" ). retrieve ();

Répertorier tous les alias

 client . aliases (). retrieve ();

Supprimer un alias

 client . aliases ( "countries2" ). delete ();

Insérer un synonyme multidirectionnel

 SearchSynonymSchema synonym = new SearchSynonymSchema ();
synonym . addSynonymsItem ( "France" ). addSynonymsItem ( "Germany" ). addSynonymsItem ( "Sweden" );

client . collections ( "Countries" ). synonyms (). upsert ( "country-synonyms" , synonym )

Insérer un synonyme à sens unique

 SearchSynonymSchema synonym = new SearchSynonymSchema ();
synonym . root ( "europe" );
synonym . addSynonymsItem ( "France" ). addSynonymsItem ( "Germany" ). addSynonymsItem ( "Sweden" );

client . collections ( "Countries" ). synonyms (). upsert ( "continent-synonyms" , synonym )

Récupérer un synonyme

 client . collections ( "Countries" ). synonyms ( "continent-synonyms" ). retrieve ();

Récupérer tous les synonymes

 client . collections ( "Countries" ). synonyms (). retrieve ();

Supprimer un synonyme

 client . collections ( "Countries" ). synonyms ( "continent-synonyms" ). delete ();

Créer un instantané (pour les sauvegardes)

 Map < String , String > query = new HashMap <>();
query . put ( "snapshot_path" , "/tmp/typesense-data-snapshot" );

client . operations . perform ( "snapshot" , query );

Réélire le chef

 client . operations . perform ( "vote" );

Vérifier la santé

 client . health . retrieve ();

Contribuer

Veuillez lire CONTRIBUTING.md pour plus de détails sur le processus de soumission des demandes d'extraction à ce référentiel.

Licence

typesense-java est distribué sous la licence Apache 2.

Soutien

Veuillez ouvrir un ticket Github ou rejoindre notre communauté Slack

Développer