@d19n/youfibre-odin-sdk 2.0.375 → 2.0.377

package/dist/entities-v2/DocumentValue.d.ts

@@ -0,0 +1,213 @@
+/**
+ * DocumentValue Entity Definition
+ *
+ * One extracted value of a document: the field, the value, where it came from (section, quote, page), the model's confidence, and its review state. Linked to the Document.
+ *
+ * @module AiModule
+ * @entity DocumentValue
+ * @schemaId 96afdaae-fb15-4a46-bb1c-67ef9509e02d
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+import { OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/core';
+import { DocumentProperties } from './Document';
+/**
+ * Available types for DocumentValue records
+ */
+export declare enum DocumentValueEntityTypes {
+    /** This is the default record type */
+    DEFAULT = "DEFAULT"
+}
+/**
+ * Valid values for DocumentValue.Kind
+ *
+ * The type of the value, from the field list.
+ *
+ * @remarks Available options:
+ * - `BOOLEAN` - Boolean
+ * - `DATE` - Date
+ * - `MONEY` - Money
+ * - `NUMBER` - Number
+ * - `PARTY` - Party
+ * - `TEXT` - Text
+ */
+export declare enum DocumentValueKind {
+    BOOLEAN = "BOOLEAN",
+    DATE = "DATE",
+    MONEY = "MONEY",
+    NUMBER = "NUMBER",
+    PARTY = "PARTY",
+    TEXT = "TEXT"
+}
+/**
+ * Valid values for DocumentValue.ReviewState
+ *
+ * Where the value stands with a person: needs review, confirmed, corrected, or not found in the document.
+ *
+ * @remarks Available options:
+ * - `CONFIRMED` - Confirmed
+ * - `CORRECTED` - Corrected
+ * - `NEEDS_REVIEW` - Needs review
+ * - `NOT_FOUND` - Not found
+ */
+export declare enum DocumentValueReviewState {
+    CONFIRMED = "CONFIRMED",
+    CORRECTED = "CORRECTED",
+    NEEDS_REVIEW = "NEEDS_REVIEW",
+    NOT_FOUND = "NOT_FOUND"
+}
+/**
+ * Property keys for DocumentValue
+ * Use these constants instead of string literals for type safety
+ */
+export declare enum DocumentValuePropertyKeys {
+    /** The field name from the field list for the document type, e.g. GoverningLaw, PaymentDays. */
+    Field = "Field",
+    /** The type of the value, from the field list. */
+    Kind = "Kind",
+    /** The value as text, after any correction. Blank when the document does not state it (see ReviewState NOT_FOUND). */
+    Value = "Value",
+    /** What the model extracted, kept beside a correction. Equal to Value until a person corrects it. */
+    ModelValue = "ModelValue",
+    /** The field list the value was extracted with, e.g. NDA. */
+    SchemaName = "SchemaName",
+    /** The version of that field list. */
+    SchemaVersion = "SchemaVersion",
+    /** How sure the model was, 0 to 1. */
+    Confidence = "Confidence",
+    /** The id of the section in sections.json the value was read from. */
+    SectionId = "SectionId",
+    /** The passage, copied word for word from that section, the value rests on; checked against the stored text before the row is written. */
+    Quote = "Quote",
+    /** The page of the section. */
+    Page = "Page",
+    /** Where the value stands with a person: needs review, confirmed, corrected, or not found in the document. */
+    ReviewState = "ReviewState",
+    /** The user who confirmed or corrected the value. */
+    ReviewedBy = "ReviewedBy",
+    /** When the value was confirmed or corrected. */
+    ReviewedAt = "ReviewedAt"
+}
+/**
+ * Properties for DocumentValue records
+ *
+ * @see AiModule:DocumentValue
+ */
+export interface DocumentValueProperties {
+    /** The field name from the field list for the document type, e.g. GoverningLaw, PaymentDays.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Field: string;
+    /** The type of the value, from the field list.
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {DocumentValueKind}
+     */
+    Kind: DocumentValueKind;
+    /** The value as text, after any correction. Blank when the document does not state it (see ReviewState NOT_FOUND).
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Value: string;
+    /** What the model extracted, kept beside a correction. Equal to Value until a person corrects it.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ModelValue: string;
+    /** The field list the value was extracted with, e.g. NDA.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SchemaName: string;
+    /** The version of that field list.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    SchemaVersion: number;
+    /** How sure the model was, 0 to 1.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    Confidence: number;
+    /** The id of the section in sections.json the value was read from.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SectionId: string;
+    /** The passage, copied word for word from that section, the value rests on; checked against the stored text before the row is written.
+     *
+     * @type {TEXT_LONG}
+     * @default
+     */
+    Quote: string;
+    /** The page of the section.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    Page: number;
+    /** Where the value stands with a person: needs review, confirmed, corrected, or not found in the document.
+     *
+     * @type {ENUM}
+     * @default NEEDS_REVIEW
+     * @enum {DocumentValueReviewState}
+     */
+    ReviewState: DocumentValueReviewState;
+    /** The user who confirmed or corrected the value.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ReviewedBy: string;
+    /** When the value was confirmed or corrected.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    ReviewedAt: string;
+}
+/**
+ * DocumentValue entity from AiModule
+ *
+ * One extracted value of a document: the field, the value, where it came from (section, quote, page), the model's confidence, and its review state. Linked to the Document.
+ *
+ * @module AiModule
+ * @entity DocumentValue
+ * @schemaId 96afdaae-fb15-4a46-bb1c-67ef9509e02d
+ * @recordPrefix DOV
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+export declare class DocumentValue extends OdinRecord<DocumentValueProperties> {
+    entity: 'AiModule:DocumentValue';
+    type: DocumentValueEntityTypes;
+    schemaId: '96afdaae-fb15-4a46-bb1c-67ef9509e02d';
+    properties: DocumentValueProperties;
+    /** Linked Document records (Document__DocumentValue) */
+    Document: OdinLink<LinkedOdinRecord<DocumentProperties>>;
+}
+/**
+ * RabbitMQ routing keys for DocumentValue events
+ */
+export declare const ROUTING_KEY_DOCUMENT_VALUE_CREATED = "AiModule.DocumentValue.SubDbRecordCreated";
+export declare const ROUTING_KEY_DOCUMENT_VALUE_UPDATED = "AiModule.DocumentValue.SubDbRecordUpdated";
+export declare const ROUTING_KEY_DOCUMENT_VALUE_DELETED = "AiModule.DocumentValue.SubDbRecordDeleted";
+/**
+ * Type-specific routing keys for DocumentValue events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+export declare const ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_CREATED = "AiModule.DocumentValue.DEFAULT.SubDbRecordCreated";
+/** This is the default record type updated */
+export declare const ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_UPDATED = "AiModule.DocumentValue.DEFAULT.SubDbRecordUpdated";
+/** This is the default record type deleted */
+export declare const ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_DELETED = "AiModule.DocumentValue.DEFAULT.SubDbRecordDeleted";

package/dist/entities-v2/DocumentValue.js

@@ -0,0 +1,130 @@
+"use strict";
+/**
+ * DocumentValue Entity Definition
+ *
+ * One extracted value of a document: the field, the value, where it came from (section, quote, page), the model's confidence, and its review state. Linked to the Document.
+ *
+ * @module AiModule
+ * @entity DocumentValue
+ * @schemaId 96afdaae-fb15-4a46-bb1c-67ef9509e02d
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_DELETED = exports.ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_UPDATED = exports.ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_CREATED = exports.ROUTING_KEY_DOCUMENT_VALUE_DELETED = exports.ROUTING_KEY_DOCUMENT_VALUE_UPDATED = exports.ROUTING_KEY_DOCUMENT_VALUE_CREATED = exports.DocumentValue = exports.DocumentValuePropertyKeys = exports.DocumentValueReviewState = exports.DocumentValueKind = exports.DocumentValueEntityTypes = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * Available types for DocumentValue records
+ */
+var DocumentValueEntityTypes;
+(function (DocumentValueEntityTypes) {
+    /** This is the default record type */
+    DocumentValueEntityTypes["DEFAULT"] = "DEFAULT";
+})(DocumentValueEntityTypes = exports.DocumentValueEntityTypes || (exports.DocumentValueEntityTypes = {}));
+/**
+ * Valid values for DocumentValue.Kind
+ *
+ * The type of the value, from the field list.
+ *
+ * @remarks Available options:
+ * - `BOOLEAN` - Boolean
+ * - `DATE` - Date
+ * - `MONEY` - Money
+ * - `NUMBER` - Number
+ * - `PARTY` - Party
+ * - `TEXT` - Text
+ */
+var DocumentValueKind;
+(function (DocumentValueKind) {
+    DocumentValueKind["BOOLEAN"] = "BOOLEAN";
+    DocumentValueKind["DATE"] = "DATE";
+    DocumentValueKind["MONEY"] = "MONEY";
+    DocumentValueKind["NUMBER"] = "NUMBER";
+    DocumentValueKind["PARTY"] = "PARTY";
+    DocumentValueKind["TEXT"] = "TEXT";
+})(DocumentValueKind = exports.DocumentValueKind || (exports.DocumentValueKind = {}));
+/**
+ * Valid values for DocumentValue.ReviewState
+ *
+ * Where the value stands with a person: needs review, confirmed, corrected, or not found in the document.
+ *
+ * @remarks Available options:
+ * - `CONFIRMED` - Confirmed
+ * - `CORRECTED` - Corrected
+ * - `NEEDS_REVIEW` - Needs review
+ * - `NOT_FOUND` - Not found
+ */
+var DocumentValueReviewState;
+(function (DocumentValueReviewState) {
+    DocumentValueReviewState["CONFIRMED"] = "CONFIRMED";
+    DocumentValueReviewState["CORRECTED"] = "CORRECTED";
+    DocumentValueReviewState["NEEDS_REVIEW"] = "NEEDS_REVIEW";
+    DocumentValueReviewState["NOT_FOUND"] = "NOT_FOUND";
+})(DocumentValueReviewState = exports.DocumentValueReviewState || (exports.DocumentValueReviewState = {}));
+/**
+ * Property keys for DocumentValue
+ * Use these constants instead of string literals for type safety
+ */
+var DocumentValuePropertyKeys;
+(function (DocumentValuePropertyKeys) {
+    /** The field name from the field list for the document type, e.g. GoverningLaw, PaymentDays. */
+    DocumentValuePropertyKeys["Field"] = "Field";
+    /** The type of the value, from the field list. */
+    DocumentValuePropertyKeys["Kind"] = "Kind";
+    /** The value as text, after any correction. Blank when the document does not state it (see ReviewState NOT_FOUND). */
+    DocumentValuePropertyKeys["Value"] = "Value";
+    /** What the model extracted, kept beside a correction. Equal to Value until a person corrects it. */
+    DocumentValuePropertyKeys["ModelValue"] = "ModelValue";
+    /** The field list the value was extracted with, e.g. NDA. */
+    DocumentValuePropertyKeys["SchemaName"] = "SchemaName";
+    /** The version of that field list. */
+    DocumentValuePropertyKeys["SchemaVersion"] = "SchemaVersion";
+    /** How sure the model was, 0 to 1. */
+    DocumentValuePropertyKeys["Confidence"] = "Confidence";
+    /** The id of the section in sections.json the value was read from. */
+    DocumentValuePropertyKeys["SectionId"] = "SectionId";
+    /** The passage, copied word for word from that section, the value rests on; checked against the stored text before the row is written. */
+    DocumentValuePropertyKeys["Quote"] = "Quote";
+    /** The page of the section. */
+    DocumentValuePropertyKeys["Page"] = "Page";
+    /** Where the value stands with a person: needs review, confirmed, corrected, or not found in the document. */
+    DocumentValuePropertyKeys["ReviewState"] = "ReviewState";
+    /** The user who confirmed or corrected the value. */
+    DocumentValuePropertyKeys["ReviewedBy"] = "ReviewedBy";
+    /** When the value was confirmed or corrected. */
+    DocumentValuePropertyKeys["ReviewedAt"] = "ReviewedAt";
+})(DocumentValuePropertyKeys = exports.DocumentValuePropertyKeys || (exports.DocumentValuePropertyKeys = {}));
+/**
+ * DocumentValue entity from AiModule
+ *
+ * One extracted value of a document: the field, the value, where it came from (section, quote, page), the model's confidence, and its review state. Linked to the Document.
+ *
+ * @module AiModule
+ * @entity DocumentValue
+ * @schemaId 96afdaae-fb15-4a46-bb1c-67ef9509e02d
+ * @recordPrefix DOV
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+class DocumentValue extends core_1.OdinRecord {
+}
+exports.DocumentValue = DocumentValue;
+// ============================================
+// RABBITMQ EVENT ROUTING KEYS
+// ============================================
+/**
+ * RabbitMQ routing keys for DocumentValue events
+ */
+exports.ROUTING_KEY_DOCUMENT_VALUE_CREATED = 'AiModule.DocumentValue.SubDbRecordCreated';
+exports.ROUTING_KEY_DOCUMENT_VALUE_UPDATED = 'AiModule.DocumentValue.SubDbRecordUpdated';
+exports.ROUTING_KEY_DOCUMENT_VALUE_DELETED = 'AiModule.DocumentValue.SubDbRecordDeleted';
+/**
+ * Type-specific routing keys for DocumentValue events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+exports.ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_CREATED = 'AiModule.DocumentValue.DEFAULT.SubDbRecordCreated';
+/** This is the default record type updated */
+exports.ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_UPDATED = 'AiModule.DocumentValue.DEFAULT.SubDbRecordUpdated';
+/** This is the default record type deleted */
+exports.ROUTING_KEY_DOCUMENT_VALUE_DEFAULT_DELETED = 'AiModule.DocumentValue.DEFAULT.SubDbRecordDeleted';

package/dist/entities-v2/QaBatch.d.ts

@@ -12,6 +12,7 @@
  */
 import { OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/core';
 import { QaReportProperties } from './QaReport';
+import { QaBatchSummaryProperties } from './QaBatchSummary';
 /**
  * Available types for QaBatch records
  */
@@ -36,6 +37,19 @@ export declare enum QaBatchStatus {
     RUNNING = "RUNNING",
     STOPPED = "STOPPED"
 }
+/**
+ * Valid values for QaBatch.Scope
+ *
+ * AGENT: one agent's cases. TEAM: the cases of every agent in a team, the target split equally across them.
+ *
+ * @remarks Available options:
+ * - `AGENT` - Agent
+ * - `TEAM` - Team
+ */
+export declare enum QaBatchScope {
+    AGENT = "AGENT",
+    TEAM = "TEAM"
+}
 /**
  * Property keys for QaBatch
  * Use these constants instead of string literals for type safety
@@ -76,7 +90,13 @@ export declare enum QaBatchPropertyKeys {
     /** When the runner wrote its last count. */
     FinishedAt = "FinishedAt",
     /** Why the run FAILED, when it did. */
-    Error = "Error"
+    Error = "Error",
+    /** AGENT: one agent's cases. TEAM: the cases of every agent in a team, the target split equally across them. */
+    Scope = "Scope",
+    /** The IdentityModule:Team the run is for, when Scope is TEAM. */
+    TeamId = "TeamId",
+    /** The team's name at the time of the run. */
+    TeamName = "TeamName"
 }
 /**
  * Properties for QaBatch records
@@ -193,6 +213,25 @@ export interface QaBatchProperties {
      * @default
      */
     Error: string;
+    /** AGENT: one agent's cases. TEAM: the cases of every agent in a team, the target split equally across them.
+     *
+     * @type {ENUM}
+     * @default AGENT
+     * @enum {QaBatchScope}
+     */
+    Scope: QaBatchScope;
+    /** The IdentityModule:Team the run is for, when Scope is TEAM.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    TeamId: string;
+    /** The team's name at the time of the run.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    TeamName: string;
 }
 /**
  * QaBatch entity from SupportModule
@@ -212,6 +251,8 @@ export declare class QaBatch extends OdinRecord<QaBatchProperties> {
     properties: QaBatchProperties;
     /** Linked QaReport records (QaBatch__Report) */
     QaReport: OdinLink<LinkedOdinRecord<QaReportProperties>>;
+    /** Linked QaBatchSummary records (QaBatch__Summary) */
+    QaBatchSummary: OdinLink<LinkedOdinRecord<QaBatchSummaryProperties>>;
 }
 /**
  * RabbitMQ routing keys for QaBatch events
@@ -233,3 +274,7 @@ export declare const ROUTING_KEY_QA_BATCH_DEFAULT_DELETED = "SupportModule.QaBat
 export declare const ROUTING_KEY_LINK_QA_BATCH_REPORT_CREATED = "SupportModule.QaBatch.QaReport.SubDbRecordAssociationCreated";
 /** Event: QaBatch__Report link deleted */
 export declare const ROUTING_KEY_LINK_QA_BATCH_REPORT_DELETED = "SupportModule.QaBatch.QaReport.SubDbRecordAssociationDeleted";
+/** Event: QaBatch__Summary link created */
+export declare const ROUTING_KEY_LINK_QA_BATCH_SUMMARY_CREATED = "SupportModule.QaBatch.QaBatchSummary.SubDbRecordAssociationCreated";
+/** Event: QaBatch__Summary link deleted */
+export declare const ROUTING_KEY_LINK_QA_BATCH_SUMMARY_DELETED = "SupportModule.QaBatch.QaBatchSummary.SubDbRecordAssociationDeleted";

package/dist/entities-v2/QaBatch.js

@@ -12,7 +12,7 @@
  * Generated from Odin schema definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ROUTING_KEY_LINK_QA_BATCH_REPORT_DELETED = exports.ROUTING_KEY_LINK_QA_BATCH_REPORT_CREATED = exports.ROUTING_KEY_QA_BATCH_DEFAULT_DELETED = exports.ROUTING_KEY_QA_BATCH_DEFAULT_UPDATED = exports.ROUTING_KEY_QA_BATCH_DEFAULT_CREATED = exports.ROUTING_KEY_QA_BATCH_DELETED = exports.ROUTING_KEY_QA_BATCH_UPDATED = exports.ROUTING_KEY_QA_BATCH_CREATED = exports.QaBatch = exports.QaBatchPropertyKeys = exports.QaBatchStatus = exports.QaBatchEntityTypes = void 0;
+exports.ROUTING_KEY_LINK_QA_BATCH_SUMMARY_DELETED = exports.ROUTING_KEY_LINK_QA_BATCH_SUMMARY_CREATED = exports.ROUTING_KEY_LINK_QA_BATCH_REPORT_DELETED = exports.ROUTING_KEY_LINK_QA_BATCH_REPORT_CREATED = exports.ROUTING_KEY_QA_BATCH_DEFAULT_DELETED = exports.ROUTING_KEY_QA_BATCH_DEFAULT_UPDATED = exports.ROUTING_KEY_QA_BATCH_DEFAULT_CREATED = exports.ROUTING_KEY_QA_BATCH_DELETED = exports.ROUTING_KEY_QA_BATCH_UPDATED = exports.ROUTING_KEY_QA_BATCH_CREATED = exports.QaBatch = exports.QaBatchPropertyKeys = exports.QaBatchScope = exports.QaBatchStatus = exports.QaBatchEntityTypes = void 0;
 const core_1 = require("@d19n/odin-types/dist/core");
 /**
  * Available types for QaBatch records
@@ -40,6 +40,20 @@ var QaBatchStatus;
     QaBatchStatus["RUNNING"] = "RUNNING";
     QaBatchStatus["STOPPED"] = "STOPPED";
 })(QaBatchStatus = exports.QaBatchStatus || (exports.QaBatchStatus = {}));
+/**
+ * Valid values for QaBatch.Scope
+ *
+ * AGENT: one agent's cases. TEAM: the cases of every agent in a team, the target split equally across them.
+ *
+ * @remarks Available options:
+ * - `AGENT` - Agent
+ * - `TEAM` - Team
+ */
+var QaBatchScope;
+(function (QaBatchScope) {
+    QaBatchScope["AGENT"] = "AGENT";
+    QaBatchScope["TEAM"] = "TEAM";
+})(QaBatchScope = exports.QaBatchScope || (exports.QaBatchScope = {}));
 /**
  * Property keys for QaBatch
  * Use these constants instead of string literals for type safety
@@ -82,6 +96,12 @@ var QaBatchPropertyKeys;
     QaBatchPropertyKeys["FinishedAt"] = "FinishedAt";
     /** Why the run FAILED, when it did. */
     QaBatchPropertyKeys["Error"] = "Error";
+    /** AGENT: one agent's cases. TEAM: the cases of every agent in a team, the target split equally across them. */
+    QaBatchPropertyKeys["Scope"] = "Scope";
+    /** The IdentityModule:Team the run is for, when Scope is TEAM. */
+    QaBatchPropertyKeys["TeamId"] = "TeamId";
+    /** The team's name at the time of the run. */
+    QaBatchPropertyKeys["TeamName"] = "TeamName";
 })(QaBatchPropertyKeys = exports.QaBatchPropertyKeys || (exports.QaBatchPropertyKeys = {}));
 /**
  * QaBatch entity from SupportModule
@@ -120,3 +140,7 @@ exports.ROUTING_KEY_QA_BATCH_DEFAULT_DELETED = 'SupportModule.QaBatch.DEFAULT.Su
 exports.ROUTING_KEY_LINK_QA_BATCH_REPORT_CREATED = 'SupportModule.QaBatch.QaReport.SubDbRecordAssociationCreated';
 /** Event: QaBatch__Report link deleted */
 exports.ROUTING_KEY_LINK_QA_BATCH_REPORT_DELETED = 'SupportModule.QaBatch.QaReport.SubDbRecordAssociationDeleted';
+/** Event: QaBatch__Summary link created */
+exports.ROUTING_KEY_LINK_QA_BATCH_SUMMARY_CREATED = 'SupportModule.QaBatch.QaBatchSummary.SubDbRecordAssociationCreated';
+/** Event: QaBatch__Summary link deleted */
+exports.ROUTING_KEY_LINK_QA_BATCH_SUMMARY_DELETED = 'SupportModule.QaBatch.QaBatchSummary.SubDbRecordAssociationDeleted';