Skip to navigation

What gets imported

Every Algolia setting, synonym type and rule gets one of three results: mapped, approximated or not mapped.

You’ll need: an import that has finished, or an Algolia index you’re planning to import.

ResultMeaning
MappedCaptain does the same thing.
ApproximatedCaptain does something close. The notes below say how.
Not mappedCaptain has no equivalent yet, so the setting is left out.

The console’s summary lists the synonyms and rules that didn’t come over. The full report, one row per setting, synonym type and rule with its reason, is at GET /v1/indexes/{index}/import/report and needs an admin key. Ask Captain support for it if you don’t have one.

Products

  • objectID becomes the product’s ID.
  • The first searchable attribute that holds short text becomes the title. Attributes named like brand, category and description keep that role.
  • hierarchicalCategories.lvl0, lvl1 and so on, or a list of categories, become the category path.
  • Nested objects are flattened to dotted field names, for example price.value.
  • Algolia’s response-only fields (_highlightResult, _snippetResult, _rankingInfo) are dropped.

Search settings

Algolia settingResultNotes
attributesForFacetingMappedBecomes the catalog’s facets. filterOnly(x) on a number becomes a numeric filter.
numericAttributesForFilteringMapped
typoTolerance, minWordSizefor1Typo, minWordSizefor2TyposMappedSame defaults as Algolia: 1 typo from 4 letters, 2 from 8.
ignorePluralsMappedStemming covers plurals.
hitsPerPage, paginationLimitedTo, maxValuesPerFacetMapped
attributesToRetrieve, attributesToHighlight, highlightPreTag, highlightPostTag, responseFieldsMapped
enableRulesMapped
searchableAttributesApproximatedCaptain searches fixed fields (title, category, brand, attributes, description) with its own weights. The order within a field and unordered() are not reproduced.
customRankingApproximatedCaptain ranks by relevance. The attributes are kept as typed fields for sorting and boosts.
rankingApproximatedAlgolia’s tie-break order is not reproduced.
removeStopWordsApproximatedCaptain’s own English stop words.
queryLanguages, indexLanguagesApproximatedEnglish analysis only.
optionalWords, removeWordsIfNoResultsApproximatedNo Captain search requires every word.
decompoundQueryApproximatedHyphens, and words joined or split, only.
allowTyposOnNumericTokensApproximatedNumbers and codes are matched exactly, never corrected.
replicasNot mappedSorted copies of an index aren’t built.
distinct, attributeForDistinctNot mappedVariant grouping isn’t built yet.
enablePersonalizationNot mapped
renderingContentMapped when it holds only facet orderingFacet ordering becomes the catalog’s facet order. Anything else in it, such as redirects and widgets, is left out, and the row is then approximated.
advancedSyntax, disableTypoToleranceOnWords, disableTypoToleranceOnAttributes, unretrievableAttributes, relevancyStrictness, separatorsToIndex, camelCaseAttributes, attributesToSnippet, userDataNot mapped

A setting with a value that isn’t in this table is reported as not mapped. A setting with no value is reported as not used.

Synonyms

Algolia typeResult
synonym (two-way)Mapped
oneWaySynonymMapped
altCorrection1, altCorrection2Approximated: they become one-way synonyms, without a typo penalty.
placeholderNot mapped

Merchandising rules

Algolia rule partResult
Query pattern with is, startsWith, endsWith or containsMapped
promote (pins) and hideMapped
params.filtersMapped
optionalFiltersApproximated: they become a boost.
userData, facet ordering in renderingContent, and a context conditionMapped
Query edits, automaticFacetFilters, redirects and widgets in renderingContent, condition filtersNot mapped
  • Captain skips a disabled rule, and a rule whose validity windows have all ended.
  • A rule with a current or future validity window is imported without the window, so it applies all the time. Check scheduled rules, such as a holiday promotion, after the import.