@pairsystems/goodmem-client 1.0.10 → 1.0.11

package/dist/model/MemoryCreationRequest.js

@@ -88,10 +88,15 @@ var MemoryCreationRequest = /*#__PURE__*/function () {
           obj['contentType'] = _ApiClient["default"].convertToType(data['contentType'], 'String');
         }
         if (data.hasOwnProperty('metadata')) {
-          obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], Object);
+          obj['metadata'] = _ApiClient["default"].convertToType(data['metadata'], {
+            'String': Object
+          });
         }
         if (data.hasOwnProperty('chunkingConfig')) {
-          obj['chunkingConfig'] = _ChunkingConfiguration["default"].constructFromObject(data['chunkingConfig']);
+          obj['chunkingConfig'] = _ApiClient["default"].convertToType(data['chunkingConfig'], _ChunkingConfiguration["default"]);
+        }
+        if (data.hasOwnProperty('extractPageImages')) {
+          obj['extractPageImages'] = _ApiClient["default"].convertToType(data['extractPageImages'], 'Boolean');
         }
         if (data.hasOwnProperty('fileField')) {
           obj['fileField'] = _ApiClient["default"].convertToType(data['fileField'], 'String');
@@ -200,15 +205,22 @@ MemoryCreationRequest.prototype['contentType'] = undefined;
 
 /**
  * Additional metadata for the memory
- * @member {Object} metadata
+ * @member {Object.<String, Object>} metadata
  */
 MemoryCreationRequest.prototype['metadata'] = undefined;
 
 /**
+ * Chunking strategy for this memory (if not provided, uses space default)
  * @member {module:model/ChunkingConfiguration} chunkingConfig
  */
 MemoryCreationRequest.prototype['chunkingConfig'] = undefined;
 
+/**
+ * Optional hint to extract page images for eligible document types (for example, PDFs)
+ * @member {Boolean} extractPageImages
+ */
+MemoryCreationRequest.prototype['extractPageImages'] = undefined;
+
 /**
  * Optional multipart file field name to bind binary content; required when multiple files are uploaded in a batch multipart request.
  * @member {String} fileField

package/dist/model/MemoryPageImage.js

@@ -0,0 +1,225 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
+ * 
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The MemoryPageImage model module.
+ * @module model/MemoryPageImage
+ * @version 1.0.0
+ */
+var MemoryPageImage = /*#__PURE__*/function () {
+  /**
+   * Constructs a new <code>MemoryPageImage</code>.
+   * Metadata for one memory page-image rendition
+   * @alias module:model/MemoryPageImage
+   * @param memoryId {String} Memory UUID
+   * @param pageIndex {Number} 0-based page index
+   * @param dpi {Number} Render DPI
+   * @param contentType {String} Image MIME type
+   * @param createdAt {Number} Creation timestamp (milliseconds since epoch)
+   * @param updatedAt {Number} Last update timestamp (milliseconds since epoch)
+   * @param createdById {String} Creator user UUID
+   * @param updatedById {String} Last updater user UUID
+   */
+  function MemoryPageImage(memoryId, pageIndex, dpi, contentType, createdAt, updatedAt, createdById, updatedById) {
+    _classCallCheck(this, MemoryPageImage);
+    MemoryPageImage.initialize(this, memoryId, pageIndex, dpi, contentType, createdAt, updatedAt, createdById, updatedById);
+  }
+
+  /**
+   * Initializes the fields of this object.
+   * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
+   * Only for internal use.
+   */
+  return _createClass(MemoryPageImage, null, [{
+    key: "initialize",
+    value: function initialize(obj, memoryId, pageIndex, dpi, contentType, createdAt, updatedAt, createdById, updatedById) {
+      obj['memoryId'] = memoryId;
+      obj['pageIndex'] = pageIndex;
+      obj['dpi'] = dpi;
+      obj['contentType'] = contentType;
+      obj['createdAt'] = createdAt;
+      obj['updatedAt'] = updatedAt;
+      obj['createdById'] = createdById;
+      obj['updatedById'] = updatedById;
+    }
+
+    /**
+     * Constructs a <code>MemoryPageImage</code> from a plain JavaScript object, optionally creating a new instance.
+     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @param {module:model/MemoryPageImage} obj Optional instance to populate.
+     * @return {module:model/MemoryPageImage} The populated <code>MemoryPageImage</code> instance.
+     */
+  }, {
+    key: "constructFromObject",
+    value: function constructFromObject(data, obj) {
+      if (data) {
+        obj = obj || new MemoryPageImage();
+        if (data.hasOwnProperty('memoryId')) {
+          obj['memoryId'] = _ApiClient["default"].convertToType(data['memoryId'], 'String');
+        }
+        if (data.hasOwnProperty('pageIndex')) {
+          obj['pageIndex'] = _ApiClient["default"].convertToType(data['pageIndex'], 'Number');
+        }
+        if (data.hasOwnProperty('dpi')) {
+          obj['dpi'] = _ApiClient["default"].convertToType(data['dpi'], 'Number');
+        }
+        if (data.hasOwnProperty('contentType')) {
+          obj['contentType'] = _ApiClient["default"].convertToType(data['contentType'], 'String');
+        }
+        if (data.hasOwnProperty('imageContentLength')) {
+          obj['imageContentLength'] = _ApiClient["default"].convertToType(data['imageContentLength'], 'Number');
+        }
+        if (data.hasOwnProperty('imageContentSha256')) {
+          obj['imageContentSha256'] = _ApiClient["default"].convertToType(data['imageContentSha256'], 'String');
+        }
+        if (data.hasOwnProperty('createdAt')) {
+          obj['createdAt'] = _ApiClient["default"].convertToType(data['createdAt'], 'Number');
+        }
+        if (data.hasOwnProperty('updatedAt')) {
+          obj['updatedAt'] = _ApiClient["default"].convertToType(data['updatedAt'], 'Number');
+        }
+        if (data.hasOwnProperty('createdById')) {
+          obj['createdById'] = _ApiClient["default"].convertToType(data['createdById'], 'String');
+        }
+        if (data.hasOwnProperty('updatedById')) {
+          obj['updatedById'] = _ApiClient["default"].convertToType(data['updatedById'], 'String');
+        }
+      }
+      return obj;
+    }
+
+    /**
+     * Validates the JSON data with respect to <code>MemoryPageImage</code>.
+     * @param {Object} data The plain JavaScript object bearing properties of interest.
+     * @return {boolean} to indicate whether the JSON data is valid with respect to <code>MemoryPageImage</code>.
+     */
+  }, {
+    key: "validateJSON",
+    value: function validateJSON(data) {
+      // check to make sure all required properties are present in the JSON string
+      var _iterator = _createForOfIteratorHelper(MemoryPageImage.RequiredProperties),
+        _step;
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var property = _step.value;
+          if (!data.hasOwnProperty(property)) {
+            throw new Error("The required field `" + property + "` is not found in the JSON data: " + JSON.stringify(data));
+          }
+        }
+        // ensure the json data is a string
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+      if (data['memoryId'] && !(typeof data['memoryId'] === 'string' || data['memoryId'] instanceof String)) {
+        throw new Error("Expected the field `memoryId` to be a primitive type in the JSON string but got " + data['memoryId']);
+      }
+      // ensure the json data is a string
+      if (data['contentType'] && !(typeof data['contentType'] === 'string' || data['contentType'] instanceof String)) {
+        throw new Error("Expected the field `contentType` to be a primitive type in the JSON string but got " + data['contentType']);
+      }
+      // ensure the json data is a string
+      if (data['imageContentSha256'] && !(typeof data['imageContentSha256'] === 'string' || data['imageContentSha256'] instanceof String)) {
+        throw new Error("Expected the field `imageContentSha256` to be a primitive type in the JSON string but got " + data['imageContentSha256']);
+      }
+      // ensure the json data is a string
+      if (data['createdById'] && !(typeof data['createdById'] === 'string' || data['createdById'] instanceof String)) {
+        throw new Error("Expected the field `createdById` to be a primitive type in the JSON string but got " + data['createdById']);
+      }
+      // ensure the json data is a string
+      if (data['updatedById'] && !(typeof data['updatedById'] === 'string' || data['updatedById'] instanceof String)) {
+        throw new Error("Expected the field `updatedById` to be a primitive type in the JSON string but got " + data['updatedById']);
+      }
+      return true;
+    }
+  }]);
+}();
+MemoryPageImage.RequiredProperties = ["memoryId", "pageIndex", "dpi", "contentType", "createdAt", "updatedAt", "createdById", "updatedById"];
+
+/**
+ * Memory UUID
+ * @member {String} memoryId
+ */
+MemoryPageImage.prototype['memoryId'] = undefined;
+
+/**
+ * 0-based page index
+ * @member {Number} pageIndex
+ */
+MemoryPageImage.prototype['pageIndex'] = undefined;
+
+/**
+ * Render DPI
+ * @member {Number} dpi
+ */
+MemoryPageImage.prototype['dpi'] = undefined;
+
+/**
+ * Image MIME type
+ * @member {String} contentType
+ */
+MemoryPageImage.prototype['contentType'] = undefined;
+
+/**
+ * Image byte length
+ * @member {Number} imageContentLength
+ */
+MemoryPageImage.prototype['imageContentLength'] = undefined;
+
+/**
+ * Hex-encoded SHA-256 digest of image content
+ * @member {String} imageContentSha256
+ */
+MemoryPageImage.prototype['imageContentSha256'] = undefined;
+
+/**
+ * Creation timestamp (milliseconds since epoch)
+ * @member {Number} createdAt
+ */
+MemoryPageImage.prototype['createdAt'] = undefined;
+
+/**
+ * Last update timestamp (milliseconds since epoch)
+ * @member {Number} updatedAt
+ */
+MemoryPageImage.prototype['updatedAt'] = undefined;
+
+/**
+ * Creator user UUID
+ * @member {String} createdById
+ */
+MemoryPageImage.prototype['createdById'] = undefined;
+
+/**
+ * Last updater user UUID
+ * @member {String} updatedById
+ */
+MemoryPageImage.prototype['updatedById'] = undefined;
+var _default = exports["default"] = MemoryPageImage;

package/dist/model/OcrCell.js

@@ -39,7 +39,7 @@ var OcrCell = /*#__PURE__*/function () {
    * Single OCR layout element.
    * @alias module:model/OcrCell
    * @param categoryLabel {String} Raw category label emitted by OCR
-   * @param category {module:model/OcrCategory} 
+   * @param category {module:model/OcrCategory} Normalized OCR category
    * @param text {String} OCR text content
    */
   function OcrCell(categoryLabel, category, text) {
@@ -73,13 +73,13 @@ var OcrCell = /*#__PURE__*/function () {
       if (data) {
         obj = obj || new OcrCell();
         if (data.hasOwnProperty('bbox')) {
-          obj['bbox'] = _BoundingBox["default"].constructFromObject(data['bbox']);
+          obj['bbox'] = _ApiClient["default"].convertToType(data['bbox'], _BoundingBox["default"]);
         }
         if (data.hasOwnProperty('categoryLabel')) {
           obj['categoryLabel'] = _ApiClient["default"].convertToType(data['categoryLabel'], 'String');
         }
         if (data.hasOwnProperty('category')) {
-          obj['category'] = _OcrCategory["default"].constructFromObject(data['category']);
+          obj['category'] = _ApiClient["default"].convertToType(data['category'], _OcrCategory["default"]);
         }
         if (data.hasOwnProperty('text')) {
           obj['text'] = _ApiClient["default"].convertToType(data['text'], 'String');
@@ -131,6 +131,7 @@ var OcrCell = /*#__PURE__*/function () {
 OcrCell.RequiredProperties = ["categoryLabel", "category", "text"];
 
 /**
+ * Bounding box in page coordinates
  * @member {module:model/BoundingBox} bbox
  */
 OcrCell.prototype['bbox'] = undefined;
@@ -142,6 +143,7 @@ OcrCell.prototype['bbox'] = undefined;
 OcrCell.prototype['categoryLabel'] = undefined;
 
 /**
+ * Normalized OCR category
  * @member {module:model/OcrCategory} category
  */
 OcrCell.prototype['category'] = undefined;

package/dist/model/OcrDocumentRequest.js

@@ -71,7 +71,7 @@ var OcrDocumentRequest = /*#__PURE__*/function () {
           obj['content'] = _ApiClient["default"].convertToType(data['content'], 'String');
         }
         if (data.hasOwnProperty('format')) {
-          obj['format'] = _OcrInputFormat["default"].constructFromObject(data['format']);
+          obj['format'] = _ApiClient["default"].convertToType(data['format'], _OcrInputFormat["default"]);
         }
         if (data.hasOwnProperty('includeRawJson')) {
           obj['includeRawJson'] = _ApiClient["default"].convertToType(data['includeRawJson'], 'Boolean');
@@ -129,6 +129,7 @@ OcrDocumentRequest.RequiredProperties = ["content"];
 OcrDocumentRequest.prototype['content'] = undefined;
 
 /**
+ * Input format hint (AUTO, PDF, TIFF, PNG, JPEG, BMP)
  * @member {module:model/OcrInputFormat} format
  */
 OcrDocumentRequest.prototype['format'] = undefined;

package/dist/model/OcrDocumentResponse.js

@@ -39,10 +39,10 @@ var OcrDocumentResponse = /*#__PURE__*/function () {
    * Constructs a new <code>OcrDocumentResponse</code>.
    * Response containing page-ordered OCR results.
    * @alias module:model/OcrDocumentResponse
-   * @param detectedFormat {module:model/OcrInputFormat} 
+   * @param detectedFormat {module:model/OcrInputFormat} Detected input format
    * @param pageCount {Number} Number of pages processed after applying the range
    * @param pages {Array.<module:model/OcrPageResult>} Ordered per-page OCR results
-   * @param timings {module:model/DocumentTimings} 
+   * @param timings {module:model/DocumentTimings} Aggregate timing statistics
    */
   function OcrDocumentResponse(detectedFormat, pageCount, pages, timings) {
     _classCallCheck(this, OcrDocumentResponse);
@@ -76,7 +76,7 @@ var OcrDocumentResponse = /*#__PURE__*/function () {
       if (data) {
         obj = obj || new OcrDocumentResponse();
         if (data.hasOwnProperty('detectedFormat')) {
-          obj['detectedFormat'] = _OcrInputFormat["default"].constructFromObject(data['detectedFormat']);
+          obj['detectedFormat'] = _ApiClient["default"].convertToType(data['detectedFormat'], _OcrInputFormat["default"]);
         }
         if (data.hasOwnProperty('pageCount')) {
           obj['pageCount'] = _ApiClient["default"].convertToType(data['pageCount'], 'Number');
@@ -85,7 +85,7 @@ var OcrDocumentResponse = /*#__PURE__*/function () {
           obj['pages'] = _ApiClient["default"].convertToType(data['pages'], [_OcrPageResult["default"]]);
         }
         if (data.hasOwnProperty('timings')) {
-          obj['timings'] = _DocumentTimings["default"].constructFromObject(data['timings']);
+          obj['timings'] = _ApiClient["default"].convertToType(data['timings'], _DocumentTimings["default"]);
         }
       }
       return obj;
@@ -147,6 +147,7 @@ var OcrDocumentResponse = /*#__PURE__*/function () {
 OcrDocumentResponse.RequiredProperties = ["detectedFormat", "pageCount", "pages", "timings"];
 
 /**
+ * Detected input format
  * @member {module:model/OcrInputFormat} detectedFormat
  */
 OcrDocumentResponse.prototype['detectedFormat'] = undefined;
@@ -164,6 +165,7 @@ OcrDocumentResponse.prototype['pageCount'] = undefined;
 OcrDocumentResponse.prototype['pages'] = undefined;
 
 /**
+ * Aggregate timing statistics
  * @member {module:model/DocumentTimings} timings
  */
 OcrDocumentResponse.prototype['timings'] = undefined;

package/dist/model/OcrPage.js

@@ -39,9 +39,9 @@ var OcrPage = /*#__PURE__*/function () {
    * Constructs a new <code>OcrPage</code>.
    * OCR output for a single page.
    * @alias module:model/OcrPage
-   * @param layout {module:model/OcrLayout} 
-   * @param timings {module:model/PageTimings} 
-   * @param image {module:model/ImageInfo} 
+   * @param layout {module:model/OcrLayout} Parsed layout output
+   * @param timings {module:model/PageTimings} Timing breakdown for the page
+   * @param image {module:model/ImageInfo} Rendered image metadata
    */
   function OcrPage(layout, timings, image) {
     _classCallCheck(this, OcrPage);
@@ -80,13 +80,13 @@ var OcrPage = /*#__PURE__*/function () {
           obj['markdown'] = _ApiClient["default"].convertToType(data['markdown'], 'String');
         }
         if (data.hasOwnProperty('layout')) {
-          obj['layout'] = _OcrLayout["default"].constructFromObject(data['layout']);
+          obj['layout'] = _ApiClient["default"].convertToType(data['layout'], _OcrLayout["default"]);
         }
         if (data.hasOwnProperty('timings')) {
-          obj['timings'] = _PageTimings["default"].constructFromObject(data['timings']);
+          obj['timings'] = _ApiClient["default"].convertToType(data['timings'], _PageTimings["default"]);
         }
         if (data.hasOwnProperty('image')) {
-          obj['image'] = _ImageInfo["default"].constructFromObject(data['image']);
+          obj['image'] = _ApiClient["default"].convertToType(data['image'], _ImageInfo["default"]);
         }
       }
       return obj;
@@ -157,16 +157,19 @@ OcrPage.prototype['rawJson'] = undefined;
 OcrPage.prototype['markdown'] = undefined;
 
 /**
+ * Parsed layout output
  * @member {module:model/OcrLayout} layout
  */
 OcrPage.prototype['layout'] = undefined;
 
 /**
+ * Timing breakdown for the page
  * @member {module:model/PageTimings} timings
  */
 OcrPage.prototype['timings'] = undefined;
 
 /**
+ * Rendered image metadata
  * @member {module:model/ImageInfo} image
  */
 OcrPage.prototype['image'] = undefined;

package/dist/model/OcrPageResult.js

@@ -72,10 +72,10 @@ var OcrPageResult = /*#__PURE__*/function () {
           obj['pageIndex'] = _ApiClient["default"].convertToType(data['pageIndex'], 'Number');
         }
         if (data.hasOwnProperty('page')) {
-          obj['page'] = _OcrPage["default"].constructFromObject(data['page']);
+          obj['page'] = _ApiClient["default"].convertToType(data['page'], _OcrPage["default"]);
         }
         if (data.hasOwnProperty('status')) {
-          obj['status'] = _RpcStatus["default"].constructFromObject(data['status']);
+          obj['status'] = _ApiClient["default"].convertToType(data['status'], _RpcStatus["default"]);
         }
       }
       return obj;
@@ -127,11 +127,13 @@ OcrPageResult.RequiredProperties = ["pageIndex"];
 OcrPageResult.prototype['pageIndex'] = undefined;
 
 /**
+ * OCR output for the page
  * @member {module:model/OcrPage} page
  */
 OcrPageResult.prototype['page'] = undefined;
 
 /**
+ * Error status for the page
  * @member {module:model/RpcStatus} status
  */
 OcrPageResult.prototype['status'] = undefined;

package/dist/model/PingEndpointInfo.js

@@ -37,7 +37,7 @@ var PingEndpointInfo = /*#__PURE__*/function () {
    * Constructs a new <code>PingEndpointInfo</code>.
    * Resolved endpoint metadata for ping responses
    * @alias module:model/PingEndpointInfo
-   * @param targetType {module:model/PingTargetType} 
+   * @param targetType {module:model/PingTargetType} Resolved resource type
    * @param targetId {String} Target resource ID (UUID)
    * @param resolvedEndpoint {String} Fully resolved endpoint URL used for the probe
    * @param provider {String} Provider name backing the resource
@@ -76,7 +76,7 @@ var PingEndpointInfo = /*#__PURE__*/function () {
       if (data) {
         obj = obj || new PingEndpointInfo();
         if (data.hasOwnProperty('targetType')) {
-          obj['targetType'] = _PingTargetType["default"].constructFromObject(data['targetType']);
+          obj['targetType'] = _ApiClient["default"].convertToType(data['targetType'], _PingTargetType["default"]);
         }
         if (data.hasOwnProperty('targetId')) {
           obj['targetId'] = _ApiClient["default"].convertToType(data['targetId'], 'String');
@@ -140,6 +140,7 @@ var PingEndpointInfo = /*#__PURE__*/function () {
 PingEndpointInfo.RequiredProperties = ["targetType", "targetId", "resolvedEndpoint", "provider", "modelIdentifier"];
 
 /**
+ * Resolved resource type
  * @member {module:model/PingTargetType} targetType
  */
 PingEndpointInfo.prototype['targetType'] = undefined;