A ultra-nlp binding for Node.js.
npm install --save ultra-nlp-js
# or
yarn add ultra-nlp-js
enum BehaviorForUnmatched {
Ignore
, KeepAsWords
, KeepAsChars
}
class Match implements JSONSerializable<{
range: TextRange
indexOfPatterns: number | null
}> {
constructor(
range: TextRange
, indexOfPatterns: number | null
)
getRange(): TextRange
getIndexOfPatterns(): number | null
getValueFrom<T>(map: Record<number, T>): T | null
}
class TextRange implements JSONSerializable<{
startIndex: number
endIndex: number
}> {
/**
* @param startIndex byte index
* @param endIndex byte index
*/
constructor(
startIndex: number
, endIndex: number
)
/**
* @returns byte index
*/
getStartIndex(): number
/**
* @returns byte index
*/
getEndIndex(): number
/**
* @returns byte length
*/
len(): number
extract(bufferUTF8: Buffer): string
extract(text: string): string
}
class ForwardDictionary {
instance: NativeCedarwoodFowardDictionary
constructor(patterns: string[])
}
class BackwardDictionary {
instance: NativeCedarwoodFowardDictionary
constructor(patterns: string[])
}
function segmentFull(
text: string
, dict: StandardDictionary
, behaviorForUnmatched: BehaviorForUnmatched
): Match[]
function segmentForwardLongest(
text: string
, dict: ForwardDictionary
, behaviorForUnmatched: BehaviorForUnmatched
): Match[]
function segmentBackwardLongest(
text: string
, dict: BackwardDictionary
, behaviorForUnmatched: BehaviorForUnmatched
): Match[]
function segmentBidirectionalLongest(
text: string
, forwardDict: ForwardDictionary
, backwardDict: BackwardDictionary
, behaviorForUnmatched: BehaviorForUnmatched
): Match[]
class StandardDictionary {
instance: NativeDaachorseStandardDictionary
constructor(patterns: string[])
}
class ForwardDictionary {
instance: NativeDaachorseFowardDictionary
constructor(patterns: string[])
}
class BackwardDictionary {
instance: NativeDaachorseFowardDictionary
constructor(patterns: string[])
}
function segmentFull(
text: string
, dict: StandardDictionary
, behaviorForUnmatched: BehaviorForUnmatched
): Match[]
function segmentForwardLongest(
text: string
, dict: ForwardDictionary
, behaviorForUnmatched: BehaviorForUnmatched
): Match[]
function segmentBackwardLongest(
text: string
, dict: BackwardDictionary
, behaviorForUnmatched: BehaviorForUnmatched
): Match[]
function segmentBidirectionalLongest(
text: string
, forwardDict: ForwardDictionary
, backwardDict: BackwardDictionary
, behaviorForUnmatched: BehaviorForUnmatched
): Match[]
class Dictionary {
instance: NativeHashmapDictionary
constructor(patterns: string[])
}
function segmentFull(
text: string
, dict: Dictionary
, behaviorForUnmatched: BehaviorForUnmatched
): Match[]
function segmentForwardLongest(
text: string
, dict: Dictionary
, behaviorForUnmatched: BehaviorForUnmatched
): Match[]
function segmentBackwardLongest(
text: string
, dict: Dictionary
, behaviorForUnmatched: BehaviorForUnmatched
): Match[]
function segmentBidirectionalLongest(
text: string
, dict: Dictionary
, behaviorForUnmatched: BehaviorForUnmatched
): Match[]