.code-samples.meilisearch.yaml

# This code-samples file is used by the Meilisearch documentation
# Every example written here will be automatically fetched by
# the documentation on build
# You can read more on https://github.com/meilisearch/documentation/tree/master/.vuepress/code-samples
---
get_one_index_1: |-
  client.getIndex("movies");
list_all_indexes_1: |-
  IndexesQuery query = new IndexesQuery().setLimit(3);
  client.getIndexes(query);
create_an_index_1: |-
  client.createIndex("movies", "id");
update_an_index_1: |-
  client.updateIndex("movies", "id");
delete_an_index_1: |-
  client.deleteIndex("movies");
swap_indexes_1: |-
  SwapIndexesParams[] params =
          new SwapIndexesParams[] {
              new SwapIndexesParams().setIndexes(new String[] {"indexA", "indexB"}),
              new SwapIndexesParams().setIndexes(new String[] {"indexX", "indexY"})
          };
  TaskInfo task = client.swapIndexes(params);
get_one_document_1: |-
  DocumentQuery query = new DocumentQuery().setFields(new String[] {"id", "title", "poster", "release_date"});
  client.index("movies").getDocument("25684", query);
get_documents_1: |-
  DocumentsQuery query = new DocumentsQuery().setLimit(2).setFilter(new String[] {"genres = action"});
  client.index("movies").getDocuments(query, TargetClassName.class);
get_documents_post_1: |-
  DocumentsQuery query = new DocumentsQuery()
    .setFilter(new String[] {"(rating > 3 AND (genres = Adventure OR genres = Fiction)) AND language = English"})
    .setFields(new String[] {"title", "genres", "rating", "language"})
    .setLimit(3);
  client.index("books").getDocuments(query, TargetClassName.class);
add_or_replace_documents_1: |-
  client.index("movies").addDocuments("[{"
    + "\"id\": 287947,"
    + "\"title\": \"Shazam\","
    + "\"poster\": \"https://image.tmdb.org/t/p/w1280/xnopI5Xtky18MPhK40cZAGAOVeV.jpg\","
    + "\"overview\": \"A boy is given the ability to become an adult superhero in times of need with a single magic word.\","
    + "\"release_date\": \"2019-03-23\""
    + "}]"
  );
add_or_update_documents_1: |-
  client.index("movies").updateDocuments("[{
    + "\"id\": 287947,"
    + "\"title\": \"Shazam ⚡️\","
    + "\"genres\": \"comedy\""
    + "}]"
  );
delete_all_documents_1: |-
  client.index("movies").deleteAllDocuments();
delete_one_document_1: |-
  client.index("movies").deleteDocument("25684");
delete_documents_by_batch_1: |-
  client.index("movies").deleteDocuments(Arrays.asList(new String[]
  {
    "23488",
    "153738",
    "437035",
    "363869"
  }));
delete_documents_by_filter_1: |-
  String filter = "genres = action OR genres = adventure";
  client.index("movies").deleteDocumentsByFilter(filter);
search_post_1: |-
  client.index("movies").search("American ninja");
get_all_tasks_1: |-
  client.getTasks();
get_task_1: |-
  client.getTask(1);
delete_tasks_1: |-
  DeleteTasksQuery query = new DeleteTasksQuery().setUids(new int[] {1, 2})
  client.deleteTasks(query);
cancel_tasks_1: |-
  CancelTasksQuery query = new CancelTasksQuery().setUids(new int[] {1, 2})
  client.cancelTasks(query);
get_all_tasks_paginating_1: |-
  TasksQuery query = new TasksQuery()
        .setLimit(2)
        .setFrom(10);

  client.index("movies").getTasks(query);
get_all_tasks_paginating_2: |-
  TasksQuery query = new TasksQuery()
        .setLimit(2)
        .setFrom(8);

  client.index("movies").getTasks(query);
get_one_key_1: |-
  client.getKey("6062abda-a5aa-4414-ac91-ecd7944c0f8d");
get_all_keys_1: |-
  KeysQuery query = new KeysQuery().setLimit(3);
  client.getKeys(query);
create_a_key_1: |-
  SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
  Date dateParsed = format.parse("2042-04-02T00:42:42Z");

  Key keyInfo = new Key();

  keyInfo.setDescription("Add documents: Products API key");
  keyInfo.setActions(new String[] {"documents.add"});
  keyInfo.setIndexes(new String[] {"products"});
  keyInfo.setExpiresAt(dateParsed);

  client.createKey(keyInfo);
update_a_key_1: |-
  KeyUpdate keyChanges = new KeyUpdate();
  keyChanges.setName("Products/Reviews API key");
  keyChanges.setDescription("Manage documents: Products/Reviews API key");

  client.updateKey("6062abda-a5aa-4414-ac91-ecd7944c0f8d", keyChanges);
delete_a_key_1: |-
  client.deleteKey("6062abda-a5aa-4414-ac91-ecd7944c0f8d")
get_settings_1: |-
  client.index("movies").getSettings();
update_settings_1: |-
  Settings settings = new Settings();
  settings.setRankingRules(
    new String[] {
        "words",
        "typo",
        "proximity",
        "attribute",
        "sort",
        "exactness",
        "release_date:desc",
        "rank:desc"
    });
  settings.setDistinctAttribute("movie_id");
  settings.setSearchableAttributes(
    new String[] {
      "title",
      "overview",
      "genres"
    });
  settings.setDisplayedAttributes(
    new String[] {
      "title",
      "overview",
      "genres",
      "release_date"
    });
  settings.setStopWords(
    new String[] {
      "the",
      "a",
      "an"
    });
  settings.setSortableAttributes(
    new String[] {
      "title",
      "release_date"
    });

  HashMap<String, String[]> synonyms = new HashMap<String, String[]>();
  synonyms.put("wolverine", new String[] {"xmen", "logan"});
  synonyms.put("logan", new String[] {"wolverine"});
  settings.setSynonyms(synonyms);

  HashMap<String, Integer> minWordSizeTypos =
    new HashMap<String, Integer>() {
      {
        put("oneTypo", 8);
        put("twoTypos", 10);
      }
    };
  TypoTolerance typoTolerance = new TypoTolerance();
  typoTolerance.setMinWordSizeForTypos(minWordSizeTypos);
  settings.setTypoTolerance(typoTolerance);
  settings.setSearchCutoffMs(150);
  client.index("movies").updateSettings(settings);
reset_settings_1: |-
  client.index("movies").resetSettings();
get_synonyms_1: |-
  client.index("movies").getSynonymsSettings();
update_synonyms_1: |-
  HashMap<String, String[]> synonyms = new HashMap<String, String[]>();
  synonyms.put("wolverine", new String[] {"xmen", "logan"});
  synonyms.put("logan", new String[] {"wolverine"});
  client.index("movies").updateSynonymsSettings(synonyms);
reset_synonyms_1: |-
  client.index("movies").resetSynonymsSettings();
get_stop_words_1: |-
  client.index("movies").getStopWordsSettings();
update_stop_words_1: |-
  client.index("movies").updateStopWordsSettings(new String[] {"of", "the", "to"});
reset_stop_words_1: |-
  client.index("movies").resetStopWordsSettings();
get_ranking_rules_1: |-
  client.index("movies").getRankingRulesSettings();
update_ranking_rules_1: |-
  Settings settings = new Settings();
  settings.setRankingRules(new String[]
  {
    "words",
    "typo",
    "proximity",
    "attribute",
    "sort",
    "exactness",
    "release_date:asc",
    "rank:desc"
  });
  client.index("movies").updateSettings(settings);
reset_ranking_rules_1: |-
  client.index("movies").resetRankingRulesSettings();
get_distinct_attribute_1: |-
  client.index("shoes").getDistinctAttributeSettings();
update_distinct_attribute_1: |-
  client.index("shoes").updateDistinctAttributeSettings("skuid");
reset_distinct_attribute_1: |-
  client.index("shoes").resetDistinctAttributeSettings();
get_searchable_attributes_1: |-
  client.index("movies").getSearchableAttributesSettings();
update_searchable_attributes_1: |-
  client.index("movies").updateSearchableAttributesSettings(new String[]
  {
    "title",
    "overview",
    "genres"
  });
reset_searchable_attributes_1: |-
  client.index("movies").resetSearchableAttributesSettings();
get_filterable_attributes_1: |-
  client.index("movies").getFilterableAttributesSettings();
update_filterable_attributes_1: |-
  Settings settings = new Settings();
  settings.setFilterableAttributes(new String[] {"genres", "director"});
  client.index("movies").updateSettings(settings);
reset_filterable_attributes_1: |-
  client.index("movies").resetFilterableAttributesSettings();
get_displayed_attributes_1: |-
  client.index("movies").getDisplayedAttributesSettings();
update_displayed_attributes_1: |-
  client.index("movies").updateDisplayedAttributesSettings(new String[]
  {
    "title",
    "overview",
    "genres",
    "release_date"
  });
reset_displayed_attributes_1: |-
  client.index("movies").resetDisplayedAttributesSettings();
getting_started_typo_tolerance: |-
  HashMap<String, Integer> minWordSizeTypos =
  new HashMap<String, Integer>() {
    {
      put("oneTypo", 4);
    }
  };

  TypoTolerance typoTolerance = new TypoTolerance();
  typoTolerance.setMinWordSizeForTypos(minWordSizeTypos);

  client.index("movies").updateTypoToleranceSettings(typoTolerance);
get_typo_tolerance_1:
  client.index("books").getTypoToleranceSettings();
update_typo_tolerance_1: |-
  TypoTolerance typoTolerance = new TypoTolerance();
  HashMap<String, Integer> minWordSizeTypos =
          new HashMap<String, Integer>() {
              {
                  put("oneTypo", 4);
                  put("twoTypos", 10);
              }
          };

  typoTolerance.setMinWordSizeForTypos(minWordSizeTypos);
  typoTolerance.setDisableOnAttributes(new String[] {"title"});

  client.index("books").updateTypoToleranceSettings(typoTolerance);
reset_typo_tolerance_1: |-
  client.index("books").resetTypoToleranceSettings();
get_pagination_settings_1: |-
  client.index("books").getPaginationSettings();
update_pagination_settings_1: |-
  Pagination newPagination = new Pagination();
  newPagination.setMaxTotalHits(100);
  client.index("books").updatePaginationSettings(newPagination);
reset_pagination_settings_1: |-
  client.index("books").resetPaginationSettings();
get_faceting_settings_1: |-
  client.index("books").getFacetingSettings();
update_faceting_settings_1: |-
  Faceting newFaceting = new Faceting();
  newFaceting.setMaxValuesPerFacet(2);
  HashMap<String, FacetSortValue> facetSortValues = new HashMap<>();
  facetSortValues.put("*", FacetSortValue.ALPHA);
  facetSortValues.put("genres", FacetSortValue.COUNT);
  newFaceting.setSortFacetValuesBy(facetSortValues);
  client.index("books").updateFacetingSettings(newFaceting);
reset_faceting_settings_1: |-
  client.index("books").resetFacetingSettings();
get_separator_tokens_1: |-
  client.index("articles").getSeparatorTokensSettings();
update_separator_tokens_1: |-
  String[] newSeparatorTokens = { "|", "&hellip;" };
  client.index("articles").updateSeparatorTokensSettings(newSeparatorTokens);
reset_separator_tokens_1: |-
  client.index("articles").resetSeparatorTokensSettings();
get_non_separator_tokens_1: |-
  client.index("articles").getNonSeparatorTokensSettings();
update_non_separator_tokens_1: |-
  String[] newSeparatorTokens = { "@", "#" };
  client.index("articles").updateNonSeparatorTokensSettings(newSeparatorTokens);
reset_non_separator_tokens_1: |-
    client.index("articles").resetNonSeparatorTokensSettings();
get_dictionary_1: |-
  client.index("books").getDictionarySettings();
update_dictionary_1: |-
  client.index("books").updateDictionarySettings(new String[] {"J. R. R.", "W. E. B."});
reset_dictionary_1: |-
  client.index("books").resetDictionarySettings();
get_proximity_precision_settings_1: |-
  client.index("books").getProximityPrecisionSettings();
update_proximity_precision_settings_1: |-
  client.index("books").updateProximityPrecisionSettings("byAttribute");
reset_proximity_precision_settings_1: |-
  client.index("books").resetProximityPrecisionSettings();
get_search_cutoff_1: |-
  client.index("movies").getSearchCutoffMsSettings();
update_search_cutoff_1: |-
  client.index("movies").updateSearchCutoffMsSettings(150);
reset_search_cutoff_1: |-
  client.index("movies").resetSearchCutoffMsSettings();
get_index_stats_1: |-
  client.index("movies").getStats();
get_indexes_stats_1: |-
  client.getStats();
get_health_1: |-
  client.health();
get_version_1: |-
  client.getVersion();
distinct_attribute_guide_1: |-
  client.index("jackets").updateDistinctAttributeSettings("product_id");
field_properties_guide_searchable_1: |-
  String[] attributes = {"title", "overview", "genres"}
  client.index("movies").updateSearchableAttributesSettings(attributes);
field_properties_guide_displayed_1: |-
  String[] attributes = {"title", "overview", "genres", "release_date"}
  client.index("movies").updateDisplayedAttributesSettings(attributes);
filtering_guide_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("Avengers").filter(new String[] {"release_date > \"795484800\""}).build();
  client.index("movie_ratings").search(searchRequest);
filtering_guide_2: |-
  SearchRequest searchRequest = SearchRequest.builder().q("Batman").filter(new String[] {"release_date > 795484800 AND (director = \"Tim Burton\" OR director = \"Christopher Nolan\")"}).build();
  client.index("movie_ratings").search(searchRequest);
filtering_guide_3: |-
  SearchRequest searchRequest = SearchRequest.builder().q("Planet of the Apes").filter(new String[] {"release_date > 1577884550 AND (NOT director = \"Tim Burton\")"}).build();
  client.index("movie_ratings").search(searchRequest);
filtering_guide_nested_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("thriller").filter(new String[] {"rating.users >= 90"}).build();
  client.index("movie_ratings").search(searchRequest);
search_parameter_guide_query_1: |-
  client.index("movies").search("shifu");
search_parameter_guide_offset_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("shifu").offset(1).build();
  client.index("movies").search(searchRequest);
search_parameter_guide_limit_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("shifu").limit(2).build();
  client.index("movies").search(searchRequest);
search_parameter_guide_retrieve_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("a").attributesToRetrieve(new String[] {"overview", "title"}).build();
  client.index("movies").search(searchRequest);
search_parameter_guide_crop_1: |-
  SearchRequest searchRequest =
          SearchRequest.builder()
                  .q("shifu")
                  .attributesToCrop(new String[] {"overview"})
                  .cropLength(5)
                  .build();
  client.index("movies").search(searchRequest);
search_parameter_guide_crop_marker_1: |-
  SearchRequest searchRequest =
          SearchRequest.builder()
                  .q("shifu")
                  .attributesToCrop(new String[] {"overview"})
                  .cropMarker("[…]")
                  .build();
  client.index("movies").search(searchRequest);
search_parameter_guide_highlight_1: |-
  SearchRequest searchRequest =
    new SearchRequest("winter feast").setAttributesToHighlight(new String[] {"overview"});
  client.index("movies").search(searchRequest);
search_parameter_guide_highlight_tag_1: |-
  SearchRequest searchRequest =
          SearchRequest.builder()
                  .q("winter feast")
                  .attributesToHighlight(new String[] {"overview"})
                  .highlightPreTag("<span class=\"highlight\">")
                  .highlightPostTag("</span>")
                  .build();
  client.index("movies").search(searchRequest);
search_parameter_guide_hitsperpage_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("").hitsPerPage(15).build();
  SearchResultPaginated searchResult = client.index("movies").search(searchRequest);
search_parameter_guide_page_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("").page(15).build();
  SearchResultPaginated searchResult = client.index("movies").search(searchRequest);
search_parameter_guide_show_matches_position_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("winter feast").showMatchesPosition(true).build();
  SearchResultPaginated searchResult = client.index("movies").search(searchRequest);
search_parameter_guide_matching_strategy_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("big fat liar").matchingStrategy(MatchingStrategy.LAST).build();
  client.index("movies").search(searchRequest);
search_parameter_guide_matching_strategy_2: |-
  SearchRequest searchRequest = SearchRequest.builder().q("big fat liar").matchingStrategy(MatchingStrategy.ALL).build();
  client.index("movies").search(searchRequest);
search_parameter_guide_matching_strategy_3: |-
  SearchRequest searchRequest = SearchRequest.builder().q("white shirt").matchingStrategy(MatchingStrategy.FREQUENCY).build();
  client.index("movies").search(searchRequest);
search_parameter_guide_attributes_to_search_on_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("adventure").attributesToSearchOn(new String[] {"overview"});
  client.index("movies").searchRequest(searchRequest);
search_parameter_guide_show_ranking_score_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("dragon").showRankingScore(true).build();
  client.index("movies").search(searchRequest);
search_parameter_guide_show_ranking_score_details_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("dragon").showRankingScoreDetails(true).build();
  client.index("movies").search(searchRequest);
search_parameter_reference_ranking_score_threshold_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("badman").rankingScoreThreshold(0.2).build();
  client.index("INDEX_NAME").search(searchRequest);
synonyms_guide_1: |-
  HashMap<String, String[]> synonyms = new HashMap<String, String[]>();
  synonyms.put("great", new String[] {"fantastic"});
  synonyms.put("fantastic", new String[] {"great"});

  client.index("movies").updateSynonymsSettings(synonyms);
typo_tolerance_guide_1: |-
  TypoTolerance typoTolerance = new TypoTolerance();
  typoTolerance.setEnabled(false);
  client.index("movies").updateTypoToleranceSettings(typoTolerance);
typo_tolerance_guide_2: |-
  TypoTolerance typoTolerance = new TypoTolerance();
  typoTolerance.setDisableOnAttributes(new String[] {"title"});
  client.index("movies").updateTypoToleranceSettings(typoTolerance);
typo_tolerance_guide_3: |-
  TypoTolerance typoTolerance = new TypoTolerance();
  typoTolerance.setDisableOnWords(new String[] {"shrek"});
  client.index("movies").updateTypoToleranceSettings(typoTolerance);
typo_tolerance_guide_4: |-
  TypoTolerance typoTolerance = new TypoTolerance();
    HashMap<String, Integer> minWordSizeTypos =
          new HashMap<String, Integer>() {
              {
                  put("oneTypo", 4);
                  put("twoTypos", 10);
              }
          };
  typoTolerance.setMinWordSizeForTypos(minWordSizeTypos);
  client.index("movies").updateTypoToleranceSettings(typoTolerance);
getting_started_add_documents: |-
  // For Maven:
  // Add the following code to the `<dependencies>` section of your project:
  //
  // <dependency>
  //   <groupId>com.meilisearch.sdk</groupId>
  //   <artifactId>meilisearch-java</artifactId>
  //   <version>0.15.0</version>
  //   <type>pom</type>
  // </dependency>

  // For Gradle
  // Add the following line to the `dependencies` section of your `build.gradle`:
  //
  // implementation 'com.meilisearch.sdk:meilisearch-java:0.15.0'

  // In your .java file:
  import com.meilisearch.sdk;
  import java.nio.file.Files;
  import java.nio.file.Path;

  Path fileName = Path.of("movies.json");
  String moviesJson = Files.readString(fileName);
  Client client = new Client(new Config("http://localhost:7700", "aSampleMasterKey"));
  Index index = client.index("movies");
  index.addDocuments(moviesJson);
getting_started_check_task_status: |-
  client.getTask(0);
getting_started_search: |-
  client.index("movies").search("botman");
getting_started_add_meteorites: |-
  import com.meilisearch.sdk;
  import org.json.JSONArray;
  import java.nio.file.Files;
  import java.nio.file.Path;

  Path fileName = Path.of("meteorites.json");
  String meteoritesJson = Files.readString(fileName);
  Client client = new Client(new Config("http://localhost:7700", "masterKey"));

  client.index("meteorites").addDocuments(meteoritesJson);
getting_started_update_ranking_rules: |-
  Settings settings = new Settings();
  settings.setRankingRules(new String[]
  {
    "exactness",
    "words",
    "typo",
    "proximity",
    "attribute",
    "sort",
    "release_date:asc",
    "rank:desc"
  });
  client.index("movies").updateSettings(settings);
getting_started_update_displayed_attributes: |-
  Settings settings = new Settings();
  settings.setDisplayedAttributes(new String[]
  {
        "title",
        "overview",
        "poster"
  });
  client.index("movies").updateSettings(settings);
getting_started_update_searchable_attributes: |-
  Settings settings = new Settings();
  settings.setSearchableAttributes(new String[]
  {
    "title"
  });
getting_started_update_stop_words: |-
  Settings settings = new Settings();
  settings.setStopWords(new String[]
  {
    "the"
  });
  client.index("movies").updateSettings(settings);
getting_started_synonyms: |-
  Settings settings = new Settings();
  HashMap<String, String[]> synonyms = new HashMap<String, String[]>();
  synonyms.put("winnie", new String[] {"piglet"});
  synonyms.put("piglet", new String[] {"winnie"});
  settings.setSynonyms(synonyms);
  client.index("movies").updateSettings(settings);
getting_started_filtering: |-
  SearchRequest searchRequest = SearchRequest.builder().q("").filter(new String[] {"mass < 200"}).build();
  client.index("meteorites").search(searchRequest);
getting_started_geo_radius: |-
  SearchRequest searchRequest = SearchRequest.builder().q("").filter(new String[] {"_geoRadius(46.9480, 7.4474, 210000)"}).build();
  client.index("meteorites").search(searchRequest);
getting_started_geo_point: |-
  SearchRequest searchRequest = SearchRequest.builder().q("").sort(new String[] {"_geoPoint(48.8583701,2.2922926):asc"}).build();
  client.index("meteorites").search(searchRequest);
getting_started_sorting: |-
  SearchRequest searchRequest = SearchRequest.builder().q("").filter(new String[] {"mass < 200"}).sort(new String[] {"mass:asc"}).build();
  client.index("meteorites").search(searchRequest);
getting_started_configure_settings: |-
  Settings settings = new Settings();
  settings.setFilterableAttributes(new String[] {"mass", "_geo"});
  settings.setSortableAttributes(new String[] {"mass", "_geo"});
  client.index("meteorites").updateSettings(settings);
getting_started_faceting: |-
  Faceting newFaceting = new Faceting();
  newFaceting.setMaxValuesPerFacet(2);
  HashMap<String, FacetSortValue> facetSortValues = new HashMap<>();
  facetSortValues.put("*", FacetSortValue.COUNT);
  newFaceting.setSortFacetValuesBy(facetSortValues);
  client.index("movies").updateFacetingSettings(newFaceting);
getting_started_pagination: |-
  Pagination newPagination = new Pagination();
  newPagination.setMaxTotalHits(500);
  client.index("movies").updatePaginationSettings(newPagination);
filtering_update_settings_1: |-
  client.index("movies").updateFilterableAttributesSettings(new String[]
  {
    "genres",
    "director"
  });
faceted_search_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("classic").facets(new String[]
  {
    "genres",
    "rating",
    "language"
  }).build();
  client.index("books").search(searchRequest);
search_parameter_guide_facet_stats_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("Batman").facets(new String[]
  {
    "genres",
    "rating"
  }).build();
  client.index("movies").search(searchRequest);
faceted_search_update_settings_1:
  client.index("movie_ratings").updateFilterableAttributesSettings(new String[]
  {
    "genres",
    "director",
    "language"
  });
faceted_search_walkthrough_filter_1: |-
  SearchRequest searchRequest =
    SearchRequest.builder().q("thriller").filterArray(new String[][] {
      new String[] {"genres = Horror", "genres = Mystery"},
      new String[] {"director = \"Jordan Peele\""}}).build();
  client.index("movies").search(searchRequest);
add_movies_json_1: |-
  import com.meilisearch.sdk;
  import org.json.JSONArray;
  import java.nio.file.Files;
  import java.nio.file.Path;

  Path fileName = Path.of("movies.json");
  String moviesJson = Files.readString(fileName);
  Client client = new Client(new Config("http://localhost:7700", "masterKey"));
  Index index = client.index("movies");
  index.addDocuments(moviesJson);
landing_getting_started_1: |-
  Client client = new Client(new Config("http://localhost:7700", "masterKey"));

  client.index("movies").addDocuments("["
    + "{\"id\": 1, \"title\": \"Carol\"},"
    + "{\"id\": 2, \"title\": \"Wonder Woman\"},"
    + "{\"id\": 3, \"title\": \"Life of Pi\"},"
    + "{\"id\": 4, \"title\": \"Mad Max: Fury Road\"},"
    + "{\"id\": 5, \"title\": \"Moana\"},"
    + "{\"id\": 6, \"title\": \"Philadelphia\"}"
    + "]"
  );
post_dump_1: |-
  client.createDump();
create_snapshot_1: |-
  client.createSnapshot();
phrase_search_1: |-
  client.index("movies").search("\"african american\" horror");
sorting_guide_update_sortable_attributes_1: |-
  client.index("books").updateSortableAttributesSettings(new String[] {"price", "author"});
sorting_guide_update_ranking_rules_1: |-
  Settings settings = new Settings();
  settings.setRankingRules(new String[]
  {
    "words",
    "sort",
    "typo",
    "proximity",
    "attribute",
    "exactness"
  });
  client.index("books").updateSettings(settings);
sorting_guide_sort_parameter_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("science fiction").sort(new String[] {"price:asc"}).build();
  client.index("books").search(searchRequest);
sorting_guide_sort_parameter_2: |-
  SearchRequest searchRequest = SearchRequest.builder().q("butler").sort(new String[] {"author:desc"}).build();
  client.index("books").search(searchRequest);
sorting_guide_sort_nested_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("science fiction").sort(new String[] {"rating.users:asc"}).build();
  client.index("books").search(searchRequest);
get_sortable_attributes_1: |-
  client.index("books").getSortableAttributesSettings();
update_sortable_attributes_1: |-
  client.index("books").updateSortableAttributesSettings(new String[] {"price", "author"});
reset_sortable_attributes_1: |-
  client.index("books").resetSortableAttributesSettings();
facet_search_1: |-
  FacetSearchRequest fsr = FacetSearchRequest.builder().facetName("genres").facetQuery("fiction").filter(new String[]{"rating > 3"}).build();
  client.index("books").facetSearch(fsr);
facet_search_2: |-
  Faceting newFaceting = new Faceting();
  HashMap<String, FacetSortValue> facetSortValues = new HashMap<>();
  facetSortValues.put("genres", FacetSortValue.COUNT);
  newFaceting.setSortFacetValuesBy(facetSortValues);
  client.index("books").updateFacetingSettings(newFaceting);
facet_search_3: |-
  FacetSearchRequest fsr = FacetSearchRequest.builder().facetName("genres").facetQuery("c").build();
  client.index("books").facetSearch(fsr);
search_parameter_guide_sort_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("science fiction").sort(new String[] {"price:asc"}).build();
  client.index("search_parameter_guide_sort_1").search(searchRequest);
geosearch_guide_filter_settings_1: |-
  Settings settings = new Settings();
  settings.setFilterableAttributes(new String[] {"_geo"});
  client.index("restaurants").updateSettings(settings);
geosearch_guide_filter_usage_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("").filter(new String[] {"_geoRadius(45.472735, 9.184019, 2000)"}).build();
  client.index("restaurants").search(searchRequest);
geosearch_guide_filter_usage_2: |-
  SearchRequest searchRequest = SearchRequest.builder().q("").filter(new String[] {"_geoRadius(45.472735, 9.184019, 2000) AND type = pizza"}).build();
  client.index("restaurants").search(searchRequest);
geosearch_guide_sort_settings_1: |-
  client.index("restaurants").updateSortableAttributesSettings(new String[] {"_geo"});
geosearch_guide_sort_usage_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("").sort(new String[] {"_geoPoint(48.8561446,2.2978204):asc"}).build();
  client.index("restaurants").search(searchRequest);
geosearch_guide_sort_usage_2: |-
  SearchRequest searchRequest = SearchRequest.builder().q()("").sort(new String[] {
      "_geoPoint(48.8561446,2.2978204):asc",
      "rating:desc",
    }).build();
  client.index("restaurants").search(searchRequest);
geosearch_guide_filter_usage_3: |-
  SearchRequest searchRequest = SearchRequest.builder().q()("").filter(new String[] {
      "_geoBoundingBox([45.494181, 9.214024], [45.449484, 9.179175])"
    }).build();
  client.index("restaurants").search(searchRequest);
primary_field_guide_update_document_primary_key: |-
  client.updateIndex("books", "title");
primary_field_guide_create_index_primary_key: |-
  client.createIndex("books", "reference_number");
primary_field_guide_add_document_primary_key: |-
  client.index("books").addDocuments("[{"
    + "\"reference_number\": 2879,"
    + "\"title\": \"Diary of a Wimpy Kid\","
    + "\"author\": \"Jeff Kinney\","
    + "\"genres\": [\"comedy\", \"humor\"],"
    + "\"price\": 5.00"
    + "}]"
  , "reference_number");
security_guide_search_key_1: |-
  Client client = new Client(new Config("http://localhost:7700", "apiKey"));
  client.index("patient_medical_records").search();
security_guide_update_key_1: |-
  Client client = new Client(new Config("http://localhost:7700", "masterKey"));
  client.updateKey("74c9c733-3368-4738-bbe5-1d18a5fecb37", new KeyUpdate().setDescription("Default Search API Key"));
security_guide_create_key_1: |-
  Client client = new Client(new Config("http://localhost:7700", "masterKey"));

  SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
  Date dateParsed = format.parse("2023-01-01T00:00:00Z");

  Key keyInfo = new Key();

  keyInfo.setDescription("Search patient records key");
  keyInfo.setActions(new String[] {"search"});
  keyInfo.setIndexes(new String[] {"patient_medical_records"});
  keyInfo.setExpiresAt(dateParsed);

  client.createKey(keyInfo);
security_guide_list_keys_1: |-
  Client client = new Client(new Config("http://localhost:7700", "masterKey"));
  client.getKeys();
security_guide_delete_key_1: |-
  Client client = new Client(new Config("http://localhost:7700", "masterKey"));
  client.deleteKey("c5cd97d-5a4b-4226-a868-2d0eb6d197ab");
authorization_header_1: |-
  Client client = new Client(new Config("http://localhost:7700", "masterKey"));
  client.getKeys();
tenant_token_guide_generate_sdk_1: |-
  Map<String, Object> filters = new HashMap<String, Object>();
  filters.put("filter", "user_id = 1");
  Map<String, Object> searchRules = new HashMap<String, Object>();
  searchRules.put("patient_medical_records", filters);

  Date expiresAt = new SimpleDateFormat("yyyy-MM-dd").parse("2025-12-20");
  TimeZone.setDefault(TimeZone.getTimeZone("UTC"));
  TenantTokenOptions options = new TenantTokenOptions();
  options.setApiKey("B5KdX2MY2jV6EXfUs6scSfmC...");
  options.setExpiresAt(expiresAt);

  String token = client.generateTenantToken("85c3c2f9-bdd6-41f1-abd8-11fcf80e0f76", searchRules, options);
tenant_token_guide_search_sdk_1: |-
  Client frontEndClient = new Client(new Config("http://localhost:7700", token));
  frontEndClient.index("patient_medical_records").search("blood test");
date_guide_index_1: |-
  import com.meilisearch.sdk;
  import org.json.JSONArray;
  import java.nio.file.Files;
  import java.nio.file.Path;

  Path fileName = Path.of("games.json");
  String gamesJson = Files.readString(fileName);
  Index index = client.index("games");
  index.addDocuments(gamesJson);
date_guide_filterable_attributes_1: |-
  client.index("movies").updateFilterableAttributesSettings(new String[] { "release_timestamp" });
date_guide_filter_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("").filter(new String[] {"release_timestamp >= 1514761200 AND release_timestamp < 1672527600"}).build();
  client.index("games").search(searchRequest);
date_guide_sortable_attributes_1: |-
  Settings settings = new Settings();
  settings.setSortableAttributes(new String[] {"release_timestamp"});
  client.index("games").updateSettings(settings);
date_guide_sort_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("").sort(new String[] {"release_timestamp:desc"}).build();
  client.index("games").search(searchRequest);
async_guide_filter_by_date_1: |-
  SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
  Date date = format.parse("2020-10-11T11:49:53.000Z");
  TasksQuery query = new TasksQuery().setBeforeEnqueuedAt(date);

  client.getTasks(query);
async_guide_multiple_filters_1: |-
  TasksQuery query =
          new TasksQuery()
                  .setStatuses(new String[] {"processing"})
                  .setTypes(new String[] {"documentAdditionOrUpdate", "documentDeletion"})
                  .setIndexUids(new String[] {"movies"});

  client.getTasks(query);
async_guide_filter_by_ids_1: |-
  TasksQuery query = new TasksQuery().setUids(new int[] {5, 10, 13});
  client.getTasks(query);
async_guide_filter_by_statuses_1: |-
  TasksQuery query = new TasksQuery().setStatuses(new String[] {"failed", "canceled"});
  client.getTasks(query);
async_guide_filter_by_types_1: |-
  TasksQuery query = new TasksQuery().setTypes(new String[] {"dumpCreation", "indexSwap"});
  client.getTasks(query);
async_guide_filter_by_index_uids_1: |-
  TasksQuery query = new TasksQuery().setIndexUids(new String[] {"movies"});
  client.getTasks(query);
async_guide_canceled_by_1: |-
  TasksQuery query = new TasksQuery().setCanceledBy(new int[] {9, 15});
  client.getTasks(query);
multi_search_1: |-
  MultiSearchRequest multiSearchRequest = new MultiSearchRequest();
  multiIndexSearch.addQuery(new IndexSearchRequest("movies").setQuery("pooh").setLimit(5));
  multiIndexSearch.addQuery(new IndexSearchRequest("movies").setQuery("nemo").setLimit(5));
  multiIndexSearch.addQuery(new IndexSearchRequest("movie_ratings").setQuery("us"));

  client.multiSearch(multiSearchRequest);
get_similar_post_1:
  SimilarDocumentRequest query = new SimilarDocumentRequest()
    .setId("143")
    .setEmbedder("manual");
  client.index("movies").searchSimilarDocuments(query)
search_parameter_reference_distinct_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("QUERY TERMS").distinct("ATTRIBUTE_A").build();
  client.index("INDEX_NAME").search(searchRequest);
distinct_attribute_guide_filterable_1: |-
  Settings settings = new Settings();
  settings.setFilterableAttributes(new String[] {"product_id", "SKU", "url"});
  client.index("products").updateSettings(settings);
distinct_attribute_guide_distinct_parameter_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("white shirt").distinct("sku").build();
  client.index("products").search(searchRequest);
search_parameter_reference_locales_1: |-
  SearchRequest searchRequest = SearchRequest.builder().q("QUERY TEXT IN JAPANESE").locales(new String[]{"jpn"}).build();
  client.index("INDEX_NAME").search(searchRequest);
get_localized_attribute_settings_1: |-
  client.index("INDEX_NAME").getLocalizedAttributesSettings();
update_localized_attribute_settings_1: |-
  LocalizedAttribute attribute = new LocalizedAttribute();
  attribute.setAttributePatterns(new String[] {"jpn"});
  attribute.setLocales(new String[] {"*_ja"});

  client.index("INDEX_NAME").updateLocalizedAttributesSettings(
    new LocalizedAttributes[] {attribute}
  );
reset_localized_attribute_settings_1: |-
  client.index("INDEX_NAME").resetLocalizedAttributesSettings();