@bigfootai/bigfoot-types 2.9.3 → 2.9.5

package/model.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Table = exports.FieldVariation = exports.FieldType = exports.Template = exports.Thread = exports.ExternalTask = exports.Event = exports.Calendar = exports.ResponseStatus = exports.EventStatus = exports.Conference = exports.Task = exports.Block = exports.Note = exports.Article = exports.Person = exports.Domain = exports.Tenant = exports.BusinessObject = exports.Tag = exports.Provider = exports.Sync = exports.Primitive = exports.ProcessingStage = exports.MutationType = exports.MarkType = exports.DocumentType = exports.RecurrenceRFC = exports.InviteStatus = exports.SharingApproach = exports.StepStatus = exports.TaskStatus = exports.SharingLevel = exports.ClientType = exports.TagType = exports.BlockType = exports.BusinessObjectType = void 0;
+exports.Table = exports.FieldVariation = exports.FieldType = exports.Template = exports.Thread = exports.ExternalTask = exports.Event = exports.Calendar = exports.ResponseStatus = exports.EventStatus = exports.Conference = exports.Task = exports.Block = exports.Note = exports.Article = exports.Person = exports.Domain = exports.Tenant = exports.BusinessObject = exports.Tag = exports.Provider = exports.Sync = exports.Primitive = exports.RelationType = exports.EntityType = exports.ProcessingStage = exports.MutationType = exports.MarkType = exports.DocumentType = exports.RecurrenceRFC = exports.InviteStatus = exports.SharingApproach = exports.StepStatus = exports.TaskStatus = exports.SharingLevel = exports.ClientType = exports.TagType = exports.BlockType = exports.BusinessObjectType = void 0;
 const uuid_1 = require("uuid");
 /*
 These are the core primitives of our model. These represent the entities that show
@@ -117,6 +117,66 @@ var ProcessingStage;
     ProcessingStage["Processed"] = "processed";
     ProcessingStage["Failed"] = "failed";
 })(ProcessingStage || (exports.ProcessingStage = ProcessingStage = {}));
+// Referenced here: https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-entity-types-version-2
+var EntityType;
+(function (EntityType) {
+    EntityType["Date"] = "Date";
+    EntityType["Duration"] = "Duration";
+    EntityType["EmailAddress"] = "EmailAddress";
+    EntityType["Facility"] = "Facility";
+    EntityType["GeographicFeature"] = "GeographicFeature";
+    EntityType["Hashtag"] = "Hashtag";
+    EntityType["IPAddress"] = "IPAddress";
+    EntityType["JobTitle"] = "JobTitle";
+    EntityType["Location"] = "Location";
+    EntityType["Measure"] = "Measure";
+    EntityType["Money"] = "Money";
+    EntityType["Number"] = "Number";
+    EntityType["Ordinal"] = "Ordinal";
+    EntityType["Organization"] = "Organization";
+    EntityType["Percent"] = "Percent";
+    EntityType["Person"] = "Person";
+    EntityType["PhoneNumber"] = "PhoneNumber";
+    EntityType["Time"] = "Time";
+    EntityType["TwitterHandle"] = "TwitterHandle";
+    EntityType["URL"] = "URL";
+})(EntityType || (exports.EntityType = EntityType = {}));
+// Referenced here: https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-relation-types-version-2
+var RelationType;
+(function (RelationType) {
+    RelationType["AffiliatedWith"] = "affiliatedWith";
+    RelationType["BasedIn"] = "basedIn";
+    RelationType["BornAt"] = "bornAt";
+    RelationType["BornOn"] = "bornOn";
+    RelationType["ClientOf"] = "clientOf";
+    RelationType["Colleague"] = "colleague";
+    RelationType["Competitor"] = "competitor";
+    RelationType["ContactOf"] = "contactOf";
+    RelationType["DiedAt"] = "diedAt";
+    RelationType["DiedOn"] = "diedOn";
+    RelationType["DissolvedOn"] = "dissolvedOn";
+    RelationType["EducatedAt"] = "educatedAt";
+    RelationType["EmployedBy"] = "employedBy";
+    RelationType["FoundedOn"] = "foundedOn";
+    RelationType["FounderOf"] = "founderOf";
+    RelationType["LocatedAt"] = "locatedAt";
+    RelationType["ManagerOf"] = "managerOf";
+    RelationType["MemberOf"] = "memberOf";
+    RelationType["OwnerOf"] = "ownerOf";
+    RelationType["ParentOf"] = "parentOf";
+    RelationType["Partner"] = "partner";
+    RelationType["PartOf"] = "partOf";
+    RelationType["PartOfMany"] = "partOfMany";
+    RelationType["PopulationOf"] = "populationOf";
+    RelationType["MeasureOf"] = "measureOf";
+    RelationType["Relative"] = "relative";
+    RelationType["ResidesIn"] = "residesIn";
+    RelationType["ShareholdersOf"] = "shareholdersOf";
+    RelationType["SiblingOf"] = "siblingOf";
+    RelationType["SpokespersonFor"] = "spokespersonFor";
+    RelationType["SpouseOf"] = "spouseOf";
+    RelationType["SubsidiaryOf"] = "subsidiaryOf";
+})(RelationType || (exports.RelationType = RelationType = {}));
 class Primitive {
     constructor() {
         this._id = (0, uuid_1.v4)();

package/model.ts

@@ -239,10 +239,15 @@ 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 {
@@ -273,7 +278,7 @@ export interface ProviderInfo {
 
 export interface ProviderRequest {
 	providerInfo: ProviderInfo;
-	email: string;
+	connectionId: string;
 }
 
 export interface ProviderResponse {
@@ -503,6 +508,7 @@ export class Article extends Primitive {
 	topics?: EntityEntry[];
 	mentions?: EntityEntry[];
 	relations?: RelationEntry[];
+	linkUrls?: string[];
 
 	constructor(referenceNote: ReferenceNote) {
 		super();
@@ -519,7 +525,6 @@ export class Note extends Primitive {
 	changes?: Changes;
 	_sharedTags?: string[];
 	reactions?: Reaction[];
-	linkUrls?: string[];
 
 	constructor(
 		tenantIdCreated: string,

package/package.json

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