diff --git a/functions/index.createStringSameness.html b/functions/index.createStringSameness.html index c652070..90a6f31 100644 --- a/functions/index.createStringSameness.html +++ b/functions/index.createStringSameness.html @@ -1 +1 @@ -
Optionaloptions: StringComparisonOptionsOptionaloptions: StringComparisonOptionsOptionaloptions: StringComparisonOptionsOptionaloptions: StringComparisonOptionsGenerate scores that represents how similar two strings are based on different string comparison algorithms.
+Generate scores that represents how similar two strings are based on different string comparison algorithms.
Scores from all used algorithms are averaged and then weighted by the length of the content being compared (more weight for longer content).
The sameness is then given a score of 0 to 100.
OptionalrawThe raw value returned by the comparison (not normalized)
+OptionaltransformsAn array of transformations to apply to each string before comparing similarity
-OptionalstrategiesAn array of strategies used to score similarity. All strategies scores are combined for an average high score.
-OptionalreorderReorder second string so its token match order of first string as closely as possible
+OptionalstrategiesAn array of strategies used to score similarity. All strategies scores are combined for an average high score.
+OptionalreorderReorder second string so its token match order of first string as closely as possible
Useful when only the differences in content are important, but not the order of the content
-OptionaldelimiterWhen reorder is used this determines how to split each string into the tokens that will be reordered.
OptionaldelimiterWhen reorder is used this determines how to split each string into the tokens that will be reordered.
The value of this property is used in String.split() -- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/split#separator
A function that accepts two string arguments and returns a number
+OptionalisAn optional function that accepts two string arguments and returns whether this strategy should be used
+OptionalrawThe raw value returned by the comparison (not normalized)
+ConstConstConstConstConstConstConstCompares whole tokens (words) within a string independent of order
+ConstCompares whole tokens (words) within a string independent of order
This strategy is automatically disabled for strings with less than 4 words because it can lead to inaccurate scores due to not comparing characters IE it is not very useful for short sentences and comparing single words with typos
If you'd like to use it even in these scenarios build your own strategy array using cosineStrategyAggressive instead of this one
-ConstAlways runs (strings are always valid) which may lead to inaccurate scores in low token-count strings
-ConstAlways runs (strings are always valid) which may lead to inaccurate scores in low token-count strings
+ConstConstConstConstConstConstConstConst
The normalized (0 to 100) score of this comparison
-