Optional Syntax Elements for NGramSplitter - Analytics Database

Database Analytic Functions

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
VMware
Product
Analytics Database
Release Number
17.20
Published
June 2022
Language
English (United States)
Last Update
2024-04-06
dita:mapPath
gjn1627595495337.ditamap
dita:ditavalPath
ayr1485454803741.ditaval
dita:id
jmh1512506877710
Product Category
Teradata Vantageā„¢
OverLapping
Specify whether the function allows overlapping n-grams.
Default: 'true' (Each word in each sentence starts an n-gram, if enough words follow it in the same sentence to form a whole n-gram of the specified size. For information on sentences, see the Reset syntax element description.)
ConvertToLowerCase
Specify whether the function converts all letters in the input text to lowercase.
Default: 'true'
Reset
Specify, in a string, the characters that can end 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.
Default: '.,?!'
Punctuation
Specify, in a string, the punctuation characters for the function to remove before evaluating the input text.
Punctuation characters can be from both Unicode and Latin character sets.
Default: '`~#^&*()-'
Delimiter
Specify the character or string that separates words in the input text.
Default: ' ' (space)
OutputTotalGramCount
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.
The total number of n-grams is not necessarily the number of unique n-grams.
Default: 'false'
TotalCountColName
Specify the name of the output table column that appears if the value of the OutputTotalGramCount syntax element is 'true'.
Default: 'totalcnt'
Accumulate
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.
Default: All input columns for each n-gram
NGramColName
Specify the name of the output table column that is to contain the created n-grams.
Default: 'ngram'
GramLengthColName
Specify the name of the output table column that is to contain the length of n-gram (in words).
Default: 'n'
FrequencyColName
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).
Default: 'frequency'