@d19n/youfibre-odin-sdk 2.0.374 → 2.0.376

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

@@ -0,0 +1,219 @@
+/**
+ * QaBatchSummary Entity Definition
+ *
+ * The AI-written overall report on one bulk QA run: the agent or team, what they do well, what recurs, what to coach, with the case numbers behind each point. Written only by youfibre-api-support.
+ *
+ * @module SupportModule
+ * @entity QaBatchSummary
+ * @schemaId c932a484-143a-4b2d-bf01-88b9fb9fc9df
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+import { OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/core';
+import { QaBatchProperties } from './QaBatch';
+/**
+ * Available types for QaBatchSummary records
+ */
+export declare enum QaBatchSummaryEntityTypes {
+    /** This is the default record type */
+    DEFAULT = "DEFAULT"
+}
+/**
+ * Valid values for QaBatchSummary.Scope
+ *
+ * AGENT: one agent. TEAM: a team, with a per-agent section and a team synthesis.
+ *
+ * @remarks Available options:
+ * - `AGENT` - Agent
+ * - `TEAM` - Team
+ */
+export declare enum QaBatchSummaryScope {
+    AGENT = "AGENT",
+    TEAM = "TEAM"
+}
+/**
+ * Valid values for QaBatchSummary.Status
+ *
+ * PENDING while the model writes it; COMPLETE when the files are stored; FAILED with Error when it could not be written.
+ *
+ * @remarks Available options:
+ * - `COMPLETE` - Complete
+ * - `FAILED` - Failed
+ * - `PENDING` - Pending
+ */
+export declare enum QaBatchSummaryStatus {
+    COMPLETE = "COMPLETE",
+    FAILED = "FAILED",
+    PENDING = "PENDING"
+}
+/**
+ * Property keys for QaBatchSummary
+ * Use these constants instead of string literals for type safety
+ */
+export declare enum QaBatchSummaryPropertyKeys {
+    /** AGENT: one agent. TEAM: a team, with a per-agent section and a team synthesis. */
+    Scope = "Scope",
+    /** The agent summarised, for an AGENT summary. */
+    AgentId = "AgentId",
+    /** The agent's display name at the time. */
+    AgentName = "AgentName",
+    /** The team summarised, for a TEAM summary. */
+    TeamId = "TeamId",
+    /** The team's name at the time. */
+    TeamName = "TeamName",
+    /** PENDING while the model writes it; COMPLETE when the files are stored; FAILED with Error when it could not be written. */
+    Status = "Status",
+    /** How many COMPLETE QA reports of the run the summary was built from. */
+    ReportCount = "ReportCount",
+    /** The mean score of the reports read, computed in code. */
+    AverageScore = "AverageScore",
+    /** S3 URL of the rendered summary. */
+    ReportUrl = "ReportUrl",
+    /** S3 URL of the structured summary: the model's sections plus the figures computed in code. */
+    SummaryUrl = "SummaryUrl",
+    /** The model that wrote it, and the prompt version. */
+    Model = "Model",
+    /** How many model calls the reports were split across before the final synthesis. */
+    Chunks = "Chunks",
+    /** When the summary was stored. */
+    GeneratedAt = "GeneratedAt",
+    /** Why the summary could not be written, when Status is FAILED. */
+    Error = "Error",
+    /** The bulk QA run this summary is about. */
+    BatchId = "BatchId"
+}
+/**
+ * Properties for QaBatchSummary records
+ *
+ * @see SupportModule:QaBatchSummary
+ */
+export interface QaBatchSummaryProperties {
+    /** AGENT: one agent. TEAM: a team, with a per-agent section and a team synthesis.
+     *
+     * @type {ENUM}
+     * @default AGENT
+     * @enum {QaBatchSummaryScope}
+     */
+    Scope: QaBatchSummaryScope;
+    /** The agent summarised, for an AGENT summary.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    AgentId: string;
+    /** The agent's display name at the time.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    AgentName: string;
+    /** The team summarised, for a TEAM summary.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    TeamId: string;
+    /** The team's name at the time.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    TeamName: string;
+    /** PENDING while the model writes it; COMPLETE when the files are stored; FAILED with Error when it could not be written.
+     *
+     * @type {ENUM}
+     * @default PENDING
+     * @enum {QaBatchSummaryStatus}
+     */
+    Status: QaBatchSummaryStatus;
+    /** How many COMPLETE QA reports of the run the summary was built from.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    ReportCount: number;
+    /** The mean score of the reports read, computed in code.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    AverageScore: number;
+    /** S3 URL of the rendered summary.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    ReportUrl: string;
+    /** S3 URL of the structured summary: the model's sections plus the figures computed in code.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    SummaryUrl: string;
+    /** The model that wrote it, and the prompt version.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Model: string;
+    /** How many model calls the reports were split across before the final synthesis.
+     *
+     * @type {NUMBER}
+     * @default
+     */
+    Chunks: number;
+    /** When the summary was stored.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    GeneratedAt: string;
+    /** Why the summary could not be written, when Status is FAILED.
+     *
+     * @type {TEXT_LONG}
+     * @default
+     */
+    Error: string;
+    /** The bulk QA run this summary is about.
+     *
+     * @type {LOOKUP}
+     * @default
+     */
+    BatchId: string;
+}
+/**
+ * QaBatchSummary entity from SupportModule
+ *
+ * The AI-written overall report on one bulk QA run: the agent or team, what they do well, what recurs, what to coach, with the case numbers behind each point. Written only by youfibre-api-support.
+ *
+ * @module SupportModule
+ * @entity QaBatchSummary
+ * @schemaId c932a484-143a-4b2d-bf01-88b9fb9fc9df
+ * @recordPrefix QAS
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+export declare class QaBatchSummary extends OdinRecord<QaBatchSummaryProperties> {
+    entity: 'SupportModule:QaBatchSummary';
+    type: QaBatchSummaryEntityTypes;
+    schemaId: 'c932a484-143a-4b2d-bf01-88b9fb9fc9df';
+    properties: QaBatchSummaryProperties;
+    /** Linked QaBatch records (QaBatch__Summary) */
+    QaBatch: OdinLink<LinkedOdinRecord<QaBatchProperties>>;
+}
+/**
+ * RabbitMQ routing keys for QaBatchSummary events
+ */
+export declare const ROUTING_KEY_QA_BATCH_SUMMARY_CREATED = "SupportModule.QaBatchSummary.SubDbRecordCreated";
+export declare const ROUTING_KEY_QA_BATCH_SUMMARY_UPDATED = "SupportModule.QaBatchSummary.SubDbRecordUpdated";
+export declare const ROUTING_KEY_QA_BATCH_SUMMARY_DELETED = "SupportModule.QaBatchSummary.SubDbRecordDeleted";
+/**
+ * Type-specific routing keys for QaBatchSummary events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+export declare const ROUTING_KEY_QA_BATCH_SUMMARY_DEFAULT_CREATED = "SupportModule.QaBatchSummary.DEFAULT.SubDbRecordCreated";
+/** This is the default record type updated */
+export declare const ROUTING_KEY_QA_BATCH_SUMMARY_DEFAULT_UPDATED = "SupportModule.QaBatchSummary.DEFAULT.SubDbRecordUpdated";
+/** This is the default record type deleted */
+export declare const ROUTING_KEY_QA_BATCH_SUMMARY_DEFAULT_DELETED = "SupportModule.QaBatchSummary.DEFAULT.SubDbRecordDeleted";

package/dist/entities-v2/QaBatchSummary.js

@@ -0,0 +1,124 @@
+"use strict";
+/**
+ * QaBatchSummary Entity Definition
+ *
+ * The AI-written overall report on one bulk QA run: the agent or team, what they do well, what recurs, what to coach, with the case numbers behind each point. Written only by youfibre-api-support.
+ *
+ * @module SupportModule
+ * @entity QaBatchSummary
+ * @schemaId c932a484-143a-4b2d-bf01-88b9fb9fc9df
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ROUTING_KEY_QA_BATCH_SUMMARY_DEFAULT_DELETED = exports.ROUTING_KEY_QA_BATCH_SUMMARY_DEFAULT_UPDATED = exports.ROUTING_KEY_QA_BATCH_SUMMARY_DEFAULT_CREATED = exports.ROUTING_KEY_QA_BATCH_SUMMARY_DELETED = exports.ROUTING_KEY_QA_BATCH_SUMMARY_UPDATED = exports.ROUTING_KEY_QA_BATCH_SUMMARY_CREATED = exports.QaBatchSummary = exports.QaBatchSummaryPropertyKeys = exports.QaBatchSummaryStatus = exports.QaBatchSummaryScope = exports.QaBatchSummaryEntityTypes = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * Available types for QaBatchSummary records
+ */
+var QaBatchSummaryEntityTypes;
+(function (QaBatchSummaryEntityTypes) {
+    /** This is the default record type */
+    QaBatchSummaryEntityTypes["DEFAULT"] = "DEFAULT";
+})(QaBatchSummaryEntityTypes = exports.QaBatchSummaryEntityTypes || (exports.QaBatchSummaryEntityTypes = {}));
+/**
+ * Valid values for QaBatchSummary.Scope
+ *
+ * AGENT: one agent. TEAM: a team, with a per-agent section and a team synthesis.
+ *
+ * @remarks Available options:
+ * - `AGENT` - Agent
+ * - `TEAM` - Team
+ */
+var QaBatchSummaryScope;
+(function (QaBatchSummaryScope) {
+    QaBatchSummaryScope["AGENT"] = "AGENT";
+    QaBatchSummaryScope["TEAM"] = "TEAM";
+})(QaBatchSummaryScope = exports.QaBatchSummaryScope || (exports.QaBatchSummaryScope = {}));
+/**
+ * Valid values for QaBatchSummary.Status
+ *
+ * PENDING while the model writes it; COMPLETE when the files are stored; FAILED with Error when it could not be written.
+ *
+ * @remarks Available options:
+ * - `COMPLETE` - Complete
+ * - `FAILED` - Failed
+ * - `PENDING` - Pending
+ */
+var QaBatchSummaryStatus;
+(function (QaBatchSummaryStatus) {
+    QaBatchSummaryStatus["COMPLETE"] = "COMPLETE";
+    QaBatchSummaryStatus["FAILED"] = "FAILED";
+    QaBatchSummaryStatus["PENDING"] = "PENDING";
+})(QaBatchSummaryStatus = exports.QaBatchSummaryStatus || (exports.QaBatchSummaryStatus = {}));
+/**
+ * Property keys for QaBatchSummary
+ * Use these constants instead of string literals for type safety
+ */
+var QaBatchSummaryPropertyKeys;
+(function (QaBatchSummaryPropertyKeys) {
+    /** AGENT: one agent. TEAM: a team, with a per-agent section and a team synthesis. */
+    QaBatchSummaryPropertyKeys["Scope"] = "Scope";
+    /** The agent summarised, for an AGENT summary. */
+    QaBatchSummaryPropertyKeys["AgentId"] = "AgentId";
+    /** The agent's display name at the time. */
+    QaBatchSummaryPropertyKeys["AgentName"] = "AgentName";
+    /** The team summarised, for a TEAM summary. */
+    QaBatchSummaryPropertyKeys["TeamId"] = "TeamId";
+    /** The team's name at the time. */
+    QaBatchSummaryPropertyKeys["TeamName"] = "TeamName";
+    /** PENDING while the model writes it; COMPLETE when the files are stored; FAILED with Error when it could not be written. */
+    QaBatchSummaryPropertyKeys["Status"] = "Status";
+    /** How many COMPLETE QA reports of the run the summary was built from. */
+    QaBatchSummaryPropertyKeys["ReportCount"] = "ReportCount";
+    /** The mean score of the reports read, computed in code. */
+    QaBatchSummaryPropertyKeys["AverageScore"] = "AverageScore";
+    /** S3 URL of the rendered summary. */
+    QaBatchSummaryPropertyKeys["ReportUrl"] = "ReportUrl";
+    /** S3 URL of the structured summary: the model's sections plus the figures computed in code. */
+    QaBatchSummaryPropertyKeys["SummaryUrl"] = "SummaryUrl";
+    /** The model that wrote it, and the prompt version. */
+    QaBatchSummaryPropertyKeys["Model"] = "Model";
+    /** How many model calls the reports were split across before the final synthesis. */
+    QaBatchSummaryPropertyKeys["Chunks"] = "Chunks";
+    /** When the summary was stored. */
+    QaBatchSummaryPropertyKeys["GeneratedAt"] = "GeneratedAt";
+    /** Why the summary could not be written, when Status is FAILED. */
+    QaBatchSummaryPropertyKeys["Error"] = "Error";
+    /** The bulk QA run this summary is about. */
+    QaBatchSummaryPropertyKeys["BatchId"] = "BatchId";
+})(QaBatchSummaryPropertyKeys = exports.QaBatchSummaryPropertyKeys || (exports.QaBatchSummaryPropertyKeys = {}));
+/**
+ * QaBatchSummary entity from SupportModule
+ *
+ * The AI-written overall report on one bulk QA run: the agent or team, what they do well, what recurs, what to coach, with the case numbers behind each point. Written only by youfibre-api-support.
+ *
+ * @module SupportModule
+ * @entity QaBatchSummary
+ * @schemaId c932a484-143a-4b2d-bf01-88b9fb9fc9df
+ * @recordPrefix QAS
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+class QaBatchSummary extends core_1.OdinRecord {
+}
+exports.QaBatchSummary = QaBatchSummary;
+// ============================================
+// RABBITMQ EVENT ROUTING KEYS
+// ============================================
+/**
+ * RabbitMQ routing keys for QaBatchSummary events
+ */
+exports.ROUTING_KEY_QA_BATCH_SUMMARY_CREATED = 'SupportModule.QaBatchSummary.SubDbRecordCreated';
+exports.ROUTING_KEY_QA_BATCH_SUMMARY_UPDATED = 'SupportModule.QaBatchSummary.SubDbRecordUpdated';
+exports.ROUTING_KEY_QA_BATCH_SUMMARY_DELETED = 'SupportModule.QaBatchSummary.SubDbRecordDeleted';
+/**
+ * Type-specific routing keys for QaBatchSummary events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+exports.ROUTING_KEY_QA_BATCH_SUMMARY_DEFAULT_CREATED = 'SupportModule.QaBatchSummary.DEFAULT.SubDbRecordCreated';
+/** This is the default record type updated */
+exports.ROUTING_KEY_QA_BATCH_SUMMARY_DEFAULT_UPDATED = 'SupportModule.QaBatchSummary.DEFAULT.SubDbRecordUpdated';
+/** This is the default record type deleted */
+exports.ROUTING_KEY_QA_BATCH_SUMMARY_DEFAULT_DELETED = 'SupportModule.QaBatchSummary.DEFAULT.SubDbRecordDeleted';