@bigfootai/bigfoot-types 2.13.3 → 3.0.0

package/model.ts

@@ -24,6 +24,7 @@ export enum BlockType {
 
 export enum TagType {
 	Person = 'person',
+	Organization = 'organization',
 	Topic = 'topic',
 }
 
@@ -226,12 +227,16 @@ type SharingTag {
   isShared: Boolean!
   sharingApproach: String!
   sharingLevel: String!
+	confidence: Float
+	text: String
 }`;
 export interface SharingTag {
 	tagId: string;
 	isShared: boolean;
 	sharingApproach: SharingApproach;
 	sharingLevel: SharingLevel;
+	confidence?: number;
+	text?: string;
 }
 
 export interface SharingDomain {
@@ -295,45 +300,39 @@ export interface EntityReference {
 export const ArgumentEntryQL = `
 type ArgumentEntry {
   text: String!
-  highlight: Highlight!
   entities: [EntityReference]!
 }`;
 export interface ArgumentEntry {
 	text: string;
-	highlight: Highlight;
 	entities: EntityReference[];
+	_highlight?: Highlight;
 }
 
 export const RelationEntryQL = `
 type RelationEntry {
   type: String!
-  score: Int!
-  highlight: Highlight!
+  confidence: Int!
   arguments: [ArgumentEntry]!
 }`;
 export interface RelationEntry {
 	type: RelationType;
-	score: number;
-	highlight: Highlight;
+	confidence: number;
 	arguments: ArgumentEntry[];
+	_highlight?: Highlight;
 }
 
-export const MachineLearningEntryFields = `
-  highlights: [Highlight]`;
 export interface MachineLearningEntry {
-	highlights?: Highlight[];
+	_highlights?: Highlight[];
 }
 
 export const EntityEntryQL = `
-type EntityEntry {${MachineLearningEntryFields}
-  name: String!
-  type: String!
-  score: Int!
+type EntityEntry {
+  text: String!
+  confidence: Int!
 }`;
 export interface EntityEntry extends MachineLearningEntry {
-	name: string;
-	type: EntityType;
-	score: number;
+	text: string;
+	confidence: number;
 }
 
 export interface DateEntityEntry extends EntityEntry {
@@ -586,21 +585,22 @@ export class Domain extends Primitive {
 	}
 }
 
+export class Organization extends Tag {
+	url?: string;
+	favicon?: string;
+
+	constructor(tenantIdCreated: string, alias: string) {
+		super(tenantIdCreated, alias, TagType.Organization);
+	}
+}
+
 export class Person extends Tag {
-	tenantIdVerified: string; // The tenant._id that claimed/verified this tag as being them
-	email: string;
+	email?: string;
 	inviteStatus?: InviteStatus;
+	tenantIdVerified?: string; // The tenant._id that claimed/verified this tag as being them
 
-	constructor(
-		tenantIdCreated: string,
-		alias: string,
-		tenantIdVerified: string,
-		email: string
-	) {
+	constructor(tenantIdCreated: string, alias: string) {
 		super(tenantIdCreated, alias, TagType.Person);
-
-		this.tenantIdVerified = tenantIdVerified;
-		this.email = email;
 	}
 }
 
@@ -624,17 +624,14 @@ export class Article extends Primitive {
 	sentiment?: DocumentSentiment;
 	dates?: EntityEntry[];
 	locations?: EntityEntry[];
-	organizations?: EntityEntry[];
-	names?: EntityEntry[];
 	sentiments?: EntityEntry[];
-	topics?: EntityEntry[];
-	mentions?: EntityEntry[];
 	relations?: RelationEntry[];
 	linkUrls?: string[];
 	sharingTags?: SharingTag[];
 	archived: boolean;
 	_changes?: Changes;
 	_tasks?: Task[];
+	_entities?: EntityEntry[];
 
 	constructor(referenceBlock: ReferenceBlock) {
 		super();

package/package.json

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