wink-nlp - npm Package Compare versions

Comparing version 2.2.0 to 2.2.1

.nyc_output/processinfo/index.json

@@ -1,1 +0,1 @@
-{"processes":{"20d9d875-930e-4c94-9c46-03fb21760641":{"parent":null,"children":[]}},"files":{"/Users/neilsbohr/dev/winkjs/wink-nlp/src/wink-nlp.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/dd-wrapper.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/constants.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/doc-v2.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/contained-entities.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/locate.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/get-parent-item.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/search.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-get-item.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-get-item.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-each.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-each.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-filter.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-filter.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-token-out.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/its.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/sort4FT.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/sentence-wise-importance.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/reconstruct-spaces.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/allowed.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/as.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/contained-markings.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-tokens-out.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-tokens-out.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-entity-out.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-entities-out.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-entities-out.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-sentence-out.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-sentences-out.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-document-out.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/print-tokens.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/cache.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/tokenizer.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/recursive-tokenizer.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/compile-trex.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/tokens-mappers.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/examples-compiler.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/automaton.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/compose-patterns.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/identify-marked-area.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/helper.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/utilities/similarity.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/utilities/bm25-vectorizer.js":["20d9d875-930e-4c94-9c46-03fb21760641"],"/Users/neilsbohr/dev/winkjs/wink-nlp/utilities/allowed.js":["20d9d875-930e-4c94-9c46-03fb21760641"]},"externalIds":{}}
+{"processes":{"27011fd8-728b-4251-8890-d7fa6fa15bcf":{"parent":null,"children":[]}},"files":{"/Users/neilsbohr/dev/winkjs/wink-nlp/src/wink-nlp.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/dd-wrapper.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/constants.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/doc-v2.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/contained-entities.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/locate.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/get-parent-item.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/search.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-get-item.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-get-item.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-each.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-each.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-filter.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-filter.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-token-out.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/its.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/sort4FT.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/sentence-wise-importance.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/reconstruct-spaces.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/allowed.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/as.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/contained-markings.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-tokens-out.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-tokens-out.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-entity-out.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-entities-out.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-entities-out.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-sentence-out.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-sentences-out.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-document-out.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/print-tokens.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/cache.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/tokenizer.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/recursive-tokenizer.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/compile-trex.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/tokens-mappers.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/examples-compiler.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/automaton.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/compose-patterns.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/identify-marked-area.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/helper.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/utilities/similarity.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/utilities/bm25-vectorizer.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"],"/Users/neilsbohr/dev/winkjs/wink-nlp/utilities/allowed.js":["27011fd8-728b-4251-8890-d7fa6fa15bcf"]},"externalIds":{}}

CHANGELOG.md

@@ -0,4 +1,11 @@
+# [Added missing typescript definitions](https://github.com/winkjs/wink-nlp/releases/tag/2.2.1)
+## Version 2.2.1 May 06, 2024
+
+### 🐛 Fixes
+- Added missing typescript definitions for word embeddings besides few other typescript fixes. ✅
+
 # [Added non-breaking space handling capabilities](https://github.com/winkjs/wink-nlp/releases/tag/2.2.0)
 ## Version 2.2.0 April 03, 2024
 
+
 ### ✨ Features
@@ -5,0 +12,0 @@ - Detokenization restores both regular and non-breaking spaces to their original positions. 🤓

package.json

 {
   "name": "wink-nlp",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "Developer friendly Natural Language Processing ✨",
@@ -5,0 +5,0 @@ "keywords": [

ROADMAP.md

@@ -8,3 +8,3 @@ # Roadmap 🧭
 |02.|**Text Pre-processor**:<br/>Add a text preprocessing utility that provides options to (a) filter specific tokens based on their properties such as `pos`, `isStopWordFlag`, and `type`; (b) map entity type with a definable keyword; (c) add bigrams & trigrams and (d) inject sentiment. The API should follow winkNLP style and standards.|Medium|YTS|
-|03.|**Word Vectors Integration**:<br/>Add integration with various word vectors starting with GloVe. This should include compression/decompression for fast loading, helpers for token, sentence and document vector computation. |High|WIP|
+|03.|**Word Vectors Integration**:<br/>Add integration with various word vectors starting with GloVe. This should include compression/decompression for fast loading, helpers for token, sentence and document vector computation. |High|[Completed](https://github.com/winkjs/wink-nlp/releases/tag/2.0.0)|
 |04.|**Sub-word Tokenizer**:<br/>Add sub-word tokenization feature using techniques like Byte Pair Encoding (BPE) and/or WordPiece. The processing pipeline should allow choice of tokenizer.|Very High|YTS|
@@ -11,0 +11,0 @@ |05.|**Compose Corpus**:<br/>Add a utility to produce training corpus using patterns and cartesian product.|Simple|YTS|

src/api/col-get-item.js

@@ -47,5 +47,7 @@ //     wink-nlp
   var ak = k + start;
-  return ( ( ak < start || ak > end ) ? undefined : itemFn( ak ) );
+  if ( ak < start || ak > end ) {
+    throw Error( `wink-nlp: ${k} is an invalid or out of bounds index.`);
+  } else return itemFn( ak );
 }; // colGetItemAt()
 
 module.exports = colGetItemAt;

src/api/sel-get-item.js

@@ -44,5 +44,7 @@ //     wink-nlp
 var selGetItemAt = function ( k, selection, itemFn ) {
-  return ( ( k < 0 || k >= selection.length ) ? undefined : itemFn( selection[ k ] ) );
+  if ( k < 0 || k >= selection.length ) {
+    throw Error( `wink-nlp: wink-nlp: ${k} is an invalid or out of bounds index.`);
+  } else return itemFn( selection[ k ] );
 }; // selGetItemAt()
 
 module.exports = selGetItemAt;

types/index.d.ts

@@ -7,2 +7,4 @@ // Minimum TypeScript Version: 4.0
 
+  // *** BEGIN Language Model Specific Declarations ***
+  // These should be always in sync with the langauge model's type declarations.
   // these types are internal details of the implementing model
@@ -44,2 +46,3 @@ type StemAddon = unknown;
   }
+  // *** END Language Model Specific Declarations ***
 
@@ -111,21 +114,21 @@ // its helpers
   export interface ItsHelpers {
-    case(index: number, token: Token, cache: Cache): Case;
-    uniqueId(index: number, token: Token): number;
-    negationFlag(index: number, token: Token): boolean;
-    normal(index: number, token: Token, cache: Cache): string;
-    contractionFlag(index: number, token: Token): boolean;
-    pos(index: number, token: Token, cache: Cache): PartOfSpeech;
-    precedingSpaces(index: number, token: Token): string;
-    prefix(index: number, token: Token, cache: Cache): string;
-    shape(index: number, token: Token, cache: Cache): string;
-    stopWordFlag(index: number, token: Token, cache: Cache): boolean;
-    abbrevFlag(index: number, token: Token, cache: Cache): boolean;
-    suffix(index: number, token: Token, cache: Cache): string;
-    type(index: number, token: Token, cache: Cache): string;
-    value(index: number, token: Token, cache: Cache): string;
-    stem(index: number, token: Token, cache: Cache, addons: ModelAddons): string;
-    lemma(index: number, token: Token, cache: Cache, addons: ModelAddons): string;
+    case(index: number, rdd: RawDocumentData): Case;
+    uniqueId(index: number, rdd: RawDocumentData): number;
+    negationFlag(index: number, rdd: RawDocumentData): boolean;
+    normal(index: number, rdd: RawDocumentData): string;
+    contractionFlag(index: number, rdd: RawDocumentData): boolean;
+    pos(index: number, rdd: RawDocumentData): PartOfSpeech;
+    precedingSpaces(index: number, rdd: RawDocumentData): string;
+    prefix(index: number, rdd: RawDocumentData): string;
+    shape(index: number, rdd: RawDocumentData): string;
+    stopWordFlag(index: number, rdd: RawDocumentData): boolean;
+    abbrevFlag(index: number, rdd: RawDocumentData): boolean;
+    suffix(index: number, rdd: RawDocumentData): string;
+    type(index: number, rdd: RawDocumentData): string;
+    value(index: number, rdd: RawDocumentData): string;
+    stem(index: number, rdd: RawDocumentData, addons: ModelAddons): string;
+    lemma(index: number, rdd: RawDocumentData, addons: ModelAddons): string;
     vector(): number[];
     detail(): Detail;
-    markedUpText(index: number, token: Token, cache: Cache): string;
+    markedUpText(index: number, rdd: RawDocumentData): string;
     span(spanItem: number[]): number[];
@@ -140,3 +143,3 @@ sentenceWiseImportance(rdd: RawDocumentData): SentenceImportance[];
     idf(tf: ModelTermFrequencies, idf: ModelInverseDocumentFrequencies): Array<[term: string, frequency: number]>;
-    tf(tf: ModelTermFrequencies, idf: ModelInverseDocumentFrequencies): Array<[term: string, frequency: number]>;
+    tf(tf: ModelTermFrequencies): Array<[term: string, frequency: number]>;
     modelJSON(tf: ModelTermFrequencies, idf: ModelInverseDocumentFrequencies): string;
@@ -153,2 +156,3 @@ }
     unique<T>(tokens: T[]): T[];
+    vector(token: string[]): number[];
   }
@@ -176,5 +180,5 @@
   export interface SelectedTokens {
-    each(f: (token: ItemToken) => void): void;
-    filter(f: (token: ItemToken) => boolean): SelectedTokens;
-    itemAt(k: number): ItemToken | undefined;
+    each(cb: ((item: ItemToken) => void) | ((item: ItemToken, index: number) => void)): void;
+    filter(cb: (item: ItemToken) => boolean): SelectedTokens;
+    itemAt(k: number): ItemToken;
     length(): number;
@@ -187,5 +191,5 @@ out(): string[];
   export interface Tokens {
-    each(f: (token: ItemToken) => void): void;
-    filter(f: (token: ItemToken) => boolean): SelectedTokens;
-    itemAt(k: number): ItemToken | undefined;
+    each(cb: ((item: ItemToken) => void) | ((item: ItemToken, index: number) => void)): void;
+    filter(cb: (item: ItemToken) => boolean): SelectedTokens;
+    itemAt(k: number): ItemToken;
     length(): number;
@@ -199,3 +203,3 @@ out(): string[];
     parentDocument(): Document;
-    markup(beginMarker: string, endMarker: string): void;
+    markup(beginMarker?: string, endMarker?: string): void;
     out(): string;
@@ -209,5 +213,5 @@ out<T>(itsf: ItsFunction<T>): T | string;
   export interface SelectedEntities {
-    each(f: (entity: ItemEntity) => void): void;
-    filter(f: (entity: ItemEntity) => boolean): SelectedEntities;
-    itemAt(k: number): ItemEntity | undefined;
+    each(cb: ((item: ItemEntity) => void) | ((item: ItemEntity, index: number) => void)): void;
+    filter(cb: (item: ItemEntity) => boolean): SelectedEntities;
+    itemAt(k: number): ItemEntity;
     length(): number;
@@ -220,5 +224,5 @@ out(): string[];
   export interface Entities {
-    each(f: (entity: ItemEntity) => void): void;
-    filter(f: (entity: ItemEntity) => boolean): SelectedEntities;
-    itemAt(k: number): ItemEntity | undefined;
+    each(cb: ((item: ItemEntity) => void) | ((item: ItemEntity, index: number) => void)): void;
+    filter(cb: (item: ItemEntity) => boolean): SelectedEntities;
+    itemAt(k: number): ItemEntity;
     length(): number;
@@ -232,3 +236,3 @@ out(): string[];
     parentDocument(): Document;
-    markup(beginMarker: string, endMarker: string): void;
+    markup(beginMarker?: string, endMarker?: string): void;
     out(): string;
@@ -242,5 +246,5 @@ out<T>(itsf: ItsFunction<T>): T | string;
   export interface SelectedCustomEntities {
-    each(f: (entity: ItemCustomEntity) => void): void;
-    filter(f: (entity: ItemCustomEntity) => boolean): SelectedCustomEntities;
-    itemAt(k: number): ItemCustomEntity | undefined;
+    each(cb: ((item: ItemCustomEntity) => void) | ((item: ItemCustomEntity, index: number) => void)): void;
+    filter(cb: (item: ItemCustomEntity) => boolean): SelectedCustomEntities;
+    itemAt(k: number): ItemCustomEntity;
     length(): number;
@@ -253,5 +257,5 @@ out(): string[];
   export interface CustomEntities {
-    each(f: (entity: ItemCustomEntity) => void): void;
-    filter(f: (entity: ItemCustomEntity) => boolean): SelectedCustomEntities;
-    itemAt(k: number): ItemCustomEntity | undefined;
+    each(cb: ((item: ItemCustomEntity) => void) | ((item: ItemCustomEntity, index: number) => void)): void;
+    filter(cb: (item: ItemCustomEntity) => boolean): SelectedCustomEntities;
+    itemAt(k: number): ItemCustomEntity;
     length(): number;
@@ -265,3 +269,3 @@ out(): string[];
     parentDocument(): Document;
-    markup(beginMarker: string, endMarker: string): void;
+    markup(beginMarker?: string, endMarker?: string): void;
     out(): string;
@@ -276,4 +280,4 @@ out<T>(itsf: ItsFunction<T>): T | string;
   export interface Sentences {
-    each(f: (entity: ItemSentence) => void): void;
-    itemAt(k: number): ItemSentence | undefined;
+    each(cb: ((item: ItemSentence) => void) | ((item: ItemSentence, index: number) => void)): void;
+    itemAt(k: number): ItemSentence;
     length(): number;
@@ -295,2 +299,4 @@ out(): string[];
     printTokens(): void;
+    pipeConfig(): string[];
+    contextualVectors(lemma: boolean, specifcWordVectors: string[], similarWordVectors: boolean, wordVectorsLimit: number): string;
   }
@@ -314,2 +320,14 @@
 
+  // Wink word embeddings structure, should stay in sync with emdedding repo.
+  interface WordEmbedding {
+    precision: number;
+    l2NormIndex: number;
+    wordIndex: number;
+    dimensions: number;
+    unkVector: number[];
+    size: number;
+    words: string[];
+    vectors: Record<string, number[]>;
+  }
+
   export interface WinkMethods {
@@ -323,3 +341,3 @@ readDoc(text: string): Document;
 
-  export default function WinkFn(theModel: Model, pipe?: string[]): WinkMethods;
+  export default function WinkFn(theModel: Model, pipe?: string[], wordEmbeddings?: WordEmbedding): WinkMethods;
 }
@@ -369,2 +387,5 @@
     };
+    vector: {
+      cosine(vectorA: number[], vectorB: number[]): number;
+    };
   }
@@ -371,0 +392,0 @@

No alert changes

Improved metrics

Total package byte prevSize

650680

increased by0.26%

Lines of code

6529

increased by0.37%

No dependency changes