@bigfootai/bigfoot-types 2.9.2 → 2.9.4

package/model.ts

@@ -115,6 +115,66 @@ export enum ProcessingStage {
 	Failed = 'failed',
 }
 
+// Referenced here: https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-entity-types-version-2
+export enum EntityType {
+	Date = 'Date',
+	Duration = 'Duration',
+	EmailAddress = 'EmailAddress',
+	Facility = 'Facility',
+	GeographicFeature = 'GeographicFeature',
+	Hashtag = 'Hashtag',
+	IPAddress = 'IPAddress',
+	JobTitle = 'JobTitle',
+	Location = 'Location',
+	Measure = 'Measure',
+	Money = 'Money',
+	Number = 'Number',
+	Ordinal = 'Ordinal',
+	Organization = 'Organization',
+	Percent = 'Percent',
+	Person = 'Person',
+	PhoneNumber = 'PhoneNumber',
+	Time = 'Time',
+	TwitterHandle = 'TwitterHandle',
+	URL = 'URL',
+}
+
+// Referenced here: https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-relation-types-version-2
+export enum RelationType {
+	AffiliatedWith = 'affiliatedWith',
+	BasedIn = 'basedIn',
+	BornAt = 'bornAt',
+	BornOn = 'bornOn',
+	ClientOf = 'clientOf',
+	Colleague = 'colleague',
+	Competitor = 'competitor',
+	ContactOf = 'contactOf',
+	DiedAt = 'diedAt',
+	DiedOn = 'diedOn',
+	DissolvedOn = 'dissolvedOn',
+	EducatedAt = 'educatedAt',
+	EmployedBy = 'employedBy',
+	FoundedOn = 'foundedOn',
+	FounderOf = 'founderOf',
+	LocatedAt = 'locatedAt',
+	ManagerOf = 'managerOf',
+	MemberOf = 'memberOf',
+	OwnerOf = 'ownerOf',
+	ParentOf = 'parentOf',
+	Partner = 'partner',
+	PartOf = 'partOf',
+	PartOfMany = 'partOfMany',
+	PopulationOf = 'populationOf',
+	MeasureOf = 'measureOf',
+	Relative = 'relative',
+	ResidesIn = 'residesIn',
+	ShareholdersOf = 'shareholdersOf',
+	SiblingOf = 'siblingOf',
+	SpokespersonFor = 'spokespersonFor',
+	SpouseOf = 'spouseOf',
+	SubsidiaryOf = 'subsidiaryOf',
+}
+
 export interface Mark {
 	type: string;
 	attrs?: Map<string, string>;
@@ -179,14 +239,19 @@ export interface DocumentSentiment {
 	score: number;
 }
 
+export interface EntityReference {
+	name: string;
+	type: EntityType;
+}
+
 export interface ArgumentEntry {
 	text: string;
 	highlight: Highlight;
-	entities: EntityEntry[];
+	entities: EntityReference[];
 }
 
 export interface RelationEntry {
-	name: string;
+	type: RelationType;
 	score: number;
 	highlight: Highlight;
 	arguments: ArgumentEntry[];
@@ -194,6 +259,7 @@ export interface RelationEntry {
 
 export interface EntityEntry extends MachineLearningEntry {
 	name: string;
+	type: EntityType;
 	score: number;
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"author": "Bigfoot",
 	"name": "@bigfootai/bigfoot-types",
-	"version": "2.9.2",
+	"version": "2.9.4",
 	"description": "The internal library for the types used in the Bigfoot platform",
 	"main": "model.js",
 	"license": "ISC",