- TextColumn
- Specify the name of the column that contains the input text. This column must have a SQL string data type.
- Delimiter
- [Optional] Specify, with a regular expression, the character or string that separates words in the input text.
- Grams
- Specify the length, in words, of each n-gram (that is, the value of n). A value_range has the syntax integer1-integer2, where integer1 <= integer2. The values of n, integer1, and integer2 must be positive.
- OverLapping
- [Optional] Specify whether the function allows overlapping n-grams.
- ConvertToLowerCase
- [Optional] Specify whether the function converts all letters in the input text to lowercase.
- Reset
- [Optional] Specify, with a regular expression, the character or string that ends a sentence. At the end of a sentence, the function discards any partial n-grams and searches for the next n-gram at the beginning of the next sentence. An n-gram cannot span sentences.The function applies the Reset syntax element before the Punctuation syntax element; that is, it splits the input into sentences before removing punctuation characters.
- Punctuation
- [Optional] Specify, with a regular expression, the punctuation characters for the function to remove before evaluating the input text.The function applies the Reset syntax element before the Punctuation syntax element; that is, it splits the input into sentences before removing punctuation characters.
- OutputTotalGramCount
- [Optional] Specify whether the function returns the total number of n-grams in the document (that is, in the row) for each length n specified in the Grams syntax element. If you specify 'true', the TotalCountColName syntax element determines the name of the output table column that contains these totals.
- TotalCountColName
- [Optional] Specify the name of the output table column that appears if the value of the OutputTotalGramCount syntax element is 'true'.
- Accumulate
- [Optional] Specify the names of the input table columns to copy to the output table for each n-gram. These columns cannot have the same names as those specified by the syntax elements NGramColName, GramLengthColName, and TotalCountColName.
- NGramColName
- [Optional] Specify the name of the output table column that is to contain the created n-grams.
- GramLengthColName
- [Optional] Specify the name of the output table column that is to contain the length of n-gram (in words).
- FrequencyColName
- [Optional] Specify the name of the output table column that is to contain the count of each unique n-gram (that is, the number of times that each unique n-gram appears in the document).