@pairsystems/goodmem-client 1.0.10 → 1.0.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. package/README.md +24 -4
  2. package/dist/api/EmbeddersApi.js +25 -10
  3. package/dist/api/LLMsApi.js +25 -10
  4. package/dist/api/MemoriesApi.js +186 -61
  5. package/dist/api/RerankersApi.js +25 -10
  6. package/dist/api/SpacesApi.js +31 -16
  7. package/dist/index.js +133 -7
  8. package/dist/model/ActiveLicenseMetadata.js +5 -1
  9. package/dist/model/AdminDrainRequest.js +3 -0
  10. package/dist/model/AdminDrainResponse.js +33 -2
  11. package/dist/model/AdminPurgeJobsRequest.js +4 -0
  12. package/dist/model/AdminPurgeJobsResponse.js +8 -4
  13. package/dist/model/AdminReloadLicenseResponse.js +4 -1
  14. package/dist/model/ApiKeyAuth.js +7 -3
  15. package/dist/model/ApiKeyResponse.js +67 -5
  16. package/dist/model/BackgroundJobSummary.js +35 -2
  17. package/dist/model/BatchDeleteMemorySelectorRequest.js +2 -1
  18. package/dist/model/BatchMemoryResult.js +4 -2
  19. package/dist/model/ChunkReference.js +3 -2
  20. package/dist/model/ChunkingConfiguration.js +109 -47
  21. package/dist/model/ChunkingConfigurationOneOf.js +109 -0
  22. package/dist/model/ChunkingConfigurationOneOf1.js +109 -0
  23. package/dist/model/ChunkingConfigurationOneOf2.js +109 -0
  24. package/dist/model/ContextItem.js +91 -73
  25. package/dist/model/ContextItemOneOf.js +109 -0
  26. package/dist/model/ContextItemOneOf1.js +109 -0
  27. package/dist/model/CreateApiKeyResponse.js +2 -1
  28. package/dist/model/CreateLLMResponse.js +3 -2
  29. package/dist/model/EmbedderCreationRequest.js +8 -5
  30. package/dist/model/EmbedderResponse.js +16 -11
  31. package/dist/model/EndpointAuthentication.js +7 -4
  32. package/dist/model/HnswOptions.js +2 -1
  33. package/dist/model/JsonBatchMemoryCreationRequest.js +132 -0
  34. package/dist/model/JsonMemoryCreationContentRequirement.js +151 -0
  35. package/dist/model/JsonMemoryCreationContentRequirementOneOf.js +109 -0
  36. package/dist/model/JsonMemoryCreationContentRequirementOneOf1.js +109 -0
  37. package/dist/model/JsonMemoryCreationRequest.js +289 -0
  38. package/dist/model/LLMCreationRequest.js +12 -6
  39. package/dist/model/LLMResponse.js +18 -12
  40. package/dist/model/LLMUpdateRequest.js +6 -3
  41. package/dist/model/LLMUpdateRequestNot.js +118 -0
  42. package/dist/model/ListApiKeysResponse.js +29 -9
  43. package/dist/model/ListMemoryPageImagesResponse.js +145 -0
  44. package/dist/model/ListSpacesResponse.js +29 -9
  45. package/dist/model/Memory.js +106 -10
  46. package/dist/model/MemoryChunkResponse.js +30 -2
  47. package/dist/model/MemoryCreationRequest.js +15 -3
  48. package/dist/model/MemoryPageImage.js +225 -0
  49. package/dist/model/OcrCell.js +5 -3
  50. package/dist/model/OcrDocumentRequest.js +2 -1
  51. package/dist/model/OcrDocumentResponse.js +6 -4
  52. package/dist/model/OcrPage.js +9 -6
  53. package/dist/model/OcrPageResult.js +4 -2
  54. package/dist/model/PingEndpointInfo.js +3 -2
  55. package/dist/model/PingEvent.js +108 -50
  56. package/dist/model/PingEventOneOf.js +109 -0
  57. package/dist/model/PingEventOneOf1.js +109 -0
  58. package/dist/model/PingEventOneOf2.js +109 -0
  59. package/dist/model/PingOnceRequest.js +4 -2
  60. package/dist/model/PingResult.js +6 -4
  61. package/dist/model/PingStreamRequest.js +7 -3
  62. package/dist/model/PingSummary.js +3 -2
  63. package/dist/model/ProcessingHistory.js +2 -1
  64. package/dist/model/RecursiveChunkingConfiguration.js +6 -4
  65. package/dist/model/RerankerCreationRequest.js +5 -3
  66. package/dist/model/RerankerResponse.js +13 -9
  67. package/dist/model/ResultSetBoundary.js +20 -2
  68. package/dist/model/RetrieveMemoryEvent.js +10 -5
  69. package/dist/model/RetrieveMemoryRequest.js +12 -6
  70. package/dist/model/RetrievedItem.js +91 -42
  71. package/dist/model/RetrievedItemOneOf.js +109 -0
  72. package/dist/model/RetrievedItemOneOf1.js +109 -0
  73. package/dist/model/SecretReference.js +27 -4
  74. package/dist/model/SentenceChunkingConfiguration.js +3 -2
  75. package/dist/model/SortOrder.js +63 -0
  76. package/dist/model/Space.js +8 -5
  77. package/dist/model/SpaceCreationRequest.js +13 -8
  78. package/dist/model/SpaceEmbedderConfig.js +3 -1
  79. package/dist/model/SystemInfoResponse.js +13 -4
  80. package/dist/model/UpdateApiKeyRequest.js +19 -9
  81. package/dist/model/UpdateEmbedderRequest.js +2 -9
  82. package/dist/model/UpdateRerankerRequest.js +2 -9
  83. package/dist/model/UpdateSpaceRequest.js +0 -22
  84. package/package.json +1 -1
@@ -54,6 +54,7 @@ var PingStreamRequest = /*#__PURE__*/function () {
54
54
  key: "initialize",
55
55
  value: function initialize(obj, targetId) {
56
56
  obj['targetId'] = targetId;
57
+ obj['maxInFlight'] = 1;
57
58
  }
58
59
 
59
60
  /**
@@ -72,7 +73,7 @@ var PingStreamRequest = /*#__PURE__*/function () {
72
73
  obj['targetId'] = _ApiClient["default"].convertToType(data['targetId'], 'String');
73
74
  }
74
75
  if (data.hasOwnProperty('targetTypeHint')) {
75
- obj['targetTypeHint'] = _PingTargetType["default"].constructFromObject(data['targetTypeHint']);
76
+ obj['targetTypeHint'] = _ApiClient["default"].convertToType(data['targetTypeHint'], _PingTargetType["default"]);
76
77
  }
77
78
  if (data.hasOwnProperty('count')) {
78
79
  obj['count'] = _ApiClient["default"].convertToType(data['count'], 'Number');
@@ -84,7 +85,7 @@ var PingStreamRequest = /*#__PURE__*/function () {
84
85
  obj['timeoutMs'] = _ApiClient["default"].convertToType(data['timeoutMs'], 'Number');
85
86
  }
86
87
  if (data.hasOwnProperty('payloadType')) {
87
- obj['payloadType'] = _PingPayloadType["default"].constructFromObject(data['payloadType']);
88
+ obj['payloadType'] = _ApiClient["default"].convertToType(data['payloadType'], _PingPayloadType["default"]);
88
89
  }
89
90
  if (data.hasOwnProperty('payload')) {
90
91
  obj['payload'] = _ApiClient["default"].convertToType(data['payload'], 'String');
@@ -151,6 +152,7 @@ PingStreamRequest.RequiredProperties = ["targetId"];
151
152
  PingStreamRequest.prototype['targetId'] = undefined;
152
153
 
153
154
  /**
155
+ * Optional hint for the target resource type
154
156
  * @member {module:model/PingTargetType} targetTypeHint
155
157
  */
156
158
  PingStreamRequest.prototype['targetTypeHint'] = undefined;
@@ -174,6 +176,7 @@ PingStreamRequest.prototype['intervalMs'] = undefined;
174
176
  PingStreamRequest.prototype['timeoutMs'] = undefined;
175
177
 
176
178
  /**
179
+ * Desired payload type (defaults to provider-specific value)
177
180
  * @member {module:model/PingPayloadType} payloadType
178
181
  */
179
182
  PingStreamRequest.prototype['payloadType'] = undefined;
@@ -193,8 +196,9 @@ PingStreamRequest.prototype['payloadSizeBytes'] = undefined;
193
196
  /**
194
197
  * Maximum concurrent probes (defaults to 1)
195
198
  * @member {Number} maxInFlight
199
+ * @default 1
196
200
  */
197
- PingStreamRequest.prototype['maxInFlight'] = undefined;
201
+ PingStreamRequest.prototype['maxInFlight'] = 1;
198
202
 
199
203
  /**
200
204
  * Add jitter to probe scheduling
@@ -37,7 +37,7 @@ var PingSummary = /*#__PURE__*/function () {
37
37
  * Constructs a new <code>PingSummary</code>.
38
38
  * Summary emitted at the end of a ping session
39
39
  * @alias module:model/PingSummary
40
- * @param endpoint {module:model/PingEndpointInfo}
40
+ * @param endpoint {module:model/PingEndpointInfo} Endpoint metadata copied from the final probe
41
41
  * @param requests {Number} Total number of probes scheduled
42
42
  * @param responses {Number} Number of responses received (including timeouts/errors)
43
43
  * @param ok {Number} Count of probes that succeeded
@@ -94,7 +94,7 @@ var PingSummary = /*#__PURE__*/function () {
94
94
  if (data) {
95
95
  obj = obj || new PingSummary();
96
96
  if (data.hasOwnProperty('endpoint')) {
97
- obj['endpoint'] = _PingEndpointInfo["default"].constructFromObject(data['endpoint']);
97
+ obj['endpoint'] = _ApiClient["default"].convertToType(data['endpoint'], _PingEndpointInfo["default"]);
98
98
  }
99
99
  if (data.hasOwnProperty('requests')) {
100
100
  obj['requests'] = _ApiClient["default"].convertToType(data['requests'], 'Number');
@@ -179,6 +179,7 @@ var PingSummary = /*#__PURE__*/function () {
179
179
  PingSummary.RequiredProperties = ["endpoint", "requests", "responses", "ok", "timeouts", "errors", "rttMinMs", "rttAvgMs", "rttP50Ms", "rttP90Ms", "rttP99Ms", "rttMaxMs", "requestsPerSecond", "bytesPerSecond"];
180
180
 
181
181
  /**
182
+ * Endpoint metadata copied from the final probe
182
183
  * @member {module:model/PingEndpointInfo} endpoint
183
184
  */
184
185
  PingSummary.prototype['endpoint'] = undefined;
@@ -66,7 +66,7 @@ var ProcessingHistory = /*#__PURE__*/function () {
66
66
  if (data) {
67
67
  obj = obj || new ProcessingHistory();
68
68
  if (data.hasOwnProperty('latestJob')) {
69
- obj['latestJob'] = _BackgroundJobSummary["default"].constructFromObject(data['latestJob']);
69
+ obj['latestJob'] = _ApiClient["default"].convertToType(data['latestJob'], _BackgroundJobSummary["default"]);
70
70
  }
71
71
  if (data.hasOwnProperty('attempts')) {
72
72
  obj['attempts'] = _ApiClient["default"].convertToType(data['attempts'], [_BackgroundJobAttempt["default"]]);
@@ -114,6 +114,7 @@ var ProcessingHistory = /*#__PURE__*/function () {
114
114
  }]);
115
115
  }();
116
116
  /**
117
+ * Summary of the most recent background job
117
118
  * @member {module:model/BackgroundJobSummary} latestJob
118
119
  */
119
120
  ProcessingHistory.prototype['latestJob'] = undefined;
@@ -40,8 +40,8 @@ var RecursiveChunkingConfiguration = /*#__PURE__*/function () {
40
40
  * @alias module:model/RecursiveChunkingConfiguration
41
41
  * @param chunkSize {Number} Maximum size of a chunk (should be ≤ context window)
42
42
  * @param chunkOverlap {Number} Sliding overlap between chunks
43
- * @param keepStrategy {module:model/SeparatorKeepStrategy}
44
- * @param lengthMeasurement {module:model/LengthMeasurement}
43
+ * @param keepStrategy {module:model/SeparatorKeepStrategy} How to handle separators after splitting. KEEP_NONE is deprecated and behaves as KEEP_END.
44
+ * @param lengthMeasurement {module:model/LengthMeasurement} How to measure chunk length
45
45
  */
46
46
  function RecursiveChunkingConfiguration(chunkSize, chunkOverlap, keepStrategy, lengthMeasurement) {
47
47
  _classCallCheck(this, RecursiveChunkingConfiguration);
@@ -84,13 +84,13 @@ var RecursiveChunkingConfiguration = /*#__PURE__*/function () {
84
84
  obj['separators'] = _ApiClient["default"].convertToType(data['separators'], ['String']);
85
85
  }
86
86
  if (data.hasOwnProperty('keepStrategy')) {
87
- obj['keepStrategy'] = _SeparatorKeepStrategy["default"].constructFromObject(data['keepStrategy']);
87
+ obj['keepStrategy'] = _ApiClient["default"].convertToType(data['keepStrategy'], _SeparatorKeepStrategy["default"]);
88
88
  }
89
89
  if (data.hasOwnProperty('separatorIsRegex')) {
90
90
  obj['separatorIsRegex'] = _ApiClient["default"].convertToType(data['separatorIsRegex'], 'Boolean');
91
91
  }
92
92
  if (data.hasOwnProperty('lengthMeasurement')) {
93
- obj['lengthMeasurement'] = _LengthMeasurement["default"].constructFromObject(data['lengthMeasurement']);
93
+ obj['lengthMeasurement'] = _ApiClient["default"].convertToType(data['lengthMeasurement'], _LengthMeasurement["default"]);
94
94
  }
95
95
  }
96
96
  return obj;
@@ -148,6 +148,7 @@ RecursiveChunkingConfiguration.prototype['chunkOverlap'] = undefined;
148
148
  RecursiveChunkingConfiguration.prototype['separators'] = undefined;
149
149
 
150
150
  /**
151
+ * How to handle separators after splitting. KEEP_NONE is deprecated and behaves as KEEP_END.
151
152
  * @member {module:model/SeparatorKeepStrategy} keepStrategy
152
153
  */
153
154
  RecursiveChunkingConfiguration.prototype['keepStrategy'] = undefined;
@@ -159,6 +160,7 @@ RecursiveChunkingConfiguration.prototype['keepStrategy'] = undefined;
159
160
  RecursiveChunkingConfiguration.prototype['separatorIsRegex'] = undefined;
160
161
 
161
162
  /**
163
+ * How to measure chunk length
162
164
  * @member {module:model/LengthMeasurement} lengthMeasurement
163
165
  */
164
166
  RecursiveChunkingConfiguration.prototype['lengthMeasurement'] = undefined;
@@ -40,7 +40,7 @@ var RerankerCreationRequest = /*#__PURE__*/function () {
40
40
  * Request body for creating a new Reranker. A Reranker represents a configuration for reranking search results.
41
41
  * @alias module:model/RerankerCreationRequest
42
42
  * @param displayName {String} User-facing name of the reranker
43
- * @param providerType {module:model/ProviderType}
43
+ * @param providerType {module:model/ProviderType} Type of reranking provider
44
44
  * @param endpointUrl {String} API endpoint URL
45
45
  * @param modelIdentifier {String} Model identifier
46
46
  */
@@ -82,7 +82,7 @@ var RerankerCreationRequest = /*#__PURE__*/function () {
82
82
  obj['description'] = _ApiClient["default"].convertToType(data['description'], 'String');
83
83
  }
84
84
  if (data.hasOwnProperty('providerType')) {
85
- obj['providerType'] = _ProviderType["default"].constructFromObject(data['providerType']);
85
+ obj['providerType'] = _ApiClient["default"].convertToType(data['providerType'], _ProviderType["default"]);
86
86
  }
87
87
  if (data.hasOwnProperty('endpointUrl')) {
88
88
  obj['endpointUrl'] = _ApiClient["default"].convertToType(data['endpointUrl'], 'String');
@@ -97,7 +97,7 @@ var RerankerCreationRequest = /*#__PURE__*/function () {
97
97
  obj['supportedModalities'] = _ApiClient["default"].convertToType(data['supportedModalities'], [_Modality["default"]]);
98
98
  }
99
99
  if (data.hasOwnProperty('credentials')) {
100
- obj['credentials'] = _EndpointAuthentication["default"].constructFromObject(data['credentials']);
100
+ obj['credentials'] = _ApiClient["default"].convertToType(data['credentials'], _EndpointAuthentication["default"]);
101
101
  }
102
102
  if (data.hasOwnProperty('labels')) {
103
103
  obj['labels'] = _ApiClient["default"].convertToType(data['labels'], {
@@ -207,6 +207,7 @@ RerankerCreationRequest.prototype['displayName'] = undefined;
207
207
  RerankerCreationRequest.prototype['description'] = undefined;
208
208
 
209
209
  /**
210
+ * Type of reranking provider
210
211
  * @member {module:model/ProviderType} providerType
211
212
  */
212
213
  RerankerCreationRequest.prototype['providerType'] = undefined;
@@ -236,6 +237,7 @@ RerankerCreationRequest.prototype['modelIdentifier'] = undefined;
236
237
  RerankerCreationRequest.prototype['supportedModalities'] = undefined;
237
238
 
238
239
  /**
240
+ * Structured credential payload describing how to authenticate with the provider. Required for SaaS providers; optional for local deployments.
239
241
  * @member {module:model/EndpointAuthentication} credentials
240
242
  */
241
243
  RerankerCreationRequest.prototype['credentials'] = undefined;
@@ -41,19 +41,20 @@ var RerankerResponse = /*#__PURE__*/function () {
41
41
  * @alias module:model/RerankerResponse
42
42
  * @param rerankerId {String} Unique identifier of the reranker
43
43
  * @param displayName {String} User-facing name of the reranker
44
- * @param providerType {module:model/ProviderType}
44
+ * @param providerType {module:model/ProviderType} Type of reranking provider
45
45
  * @param endpointUrl {String} API endpoint URL
46
- * @param apiPath {String} API path for reranking request
47
46
  * @param modelIdentifier {String} Model identifier
47
+ * @param supportedModalities {Array.<module:model/Modality>} Supported content modalities
48
+ * @param labels {Object.<String, String>} User-defined labels for categorization
48
49
  * @param ownerId {String} Owner ID of the reranker
49
50
  * @param createdAt {Number} Creation timestamp (milliseconds since epoch)
50
51
  * @param updatedAt {Number} Last update timestamp (milliseconds since epoch)
51
52
  * @param createdById {String} ID of the user who created the reranker
52
53
  * @param updatedById {String} ID of the user who last updated the reranker
53
54
  */
54
- function RerankerResponse(rerankerId, displayName, providerType, endpointUrl, apiPath, modelIdentifier, ownerId, createdAt, updatedAt, createdById, updatedById) {
55
+ function RerankerResponse(rerankerId, displayName, providerType, endpointUrl, modelIdentifier, supportedModalities, labels, ownerId, createdAt, updatedAt, createdById, updatedById) {
55
56
  _classCallCheck(this, RerankerResponse);
56
- RerankerResponse.initialize(this, rerankerId, displayName, providerType, endpointUrl, apiPath, modelIdentifier, ownerId, createdAt, updatedAt, createdById, updatedById);
57
+ RerankerResponse.initialize(this, rerankerId, displayName, providerType, endpointUrl, modelIdentifier, supportedModalities, labels, ownerId, createdAt, updatedAt, createdById, updatedById);
57
58
  }
58
59
 
59
60
  /**
@@ -63,13 +64,14 @@ var RerankerResponse = /*#__PURE__*/function () {
63
64
  */
64
65
  return _createClass(RerankerResponse, null, [{
65
66
  key: "initialize",
66
- value: function initialize(obj, rerankerId, displayName, providerType, endpointUrl, apiPath, modelIdentifier, ownerId, createdAt, updatedAt, createdById, updatedById) {
67
+ value: function initialize(obj, rerankerId, displayName, providerType, endpointUrl, modelIdentifier, supportedModalities, labels, ownerId, createdAt, updatedAt, createdById, updatedById) {
67
68
  obj['rerankerId'] = rerankerId;
68
69
  obj['displayName'] = displayName;
69
70
  obj['providerType'] = providerType;
70
71
  obj['endpointUrl'] = endpointUrl;
71
- obj['apiPath'] = apiPath;
72
72
  obj['modelIdentifier'] = modelIdentifier;
73
+ obj['supportedModalities'] = supportedModalities;
74
+ obj['labels'] = labels;
73
75
  obj['ownerId'] = ownerId;
74
76
  obj['createdAt'] = createdAt;
75
77
  obj['updatedAt'] = updatedAt;
@@ -99,7 +101,7 @@ var RerankerResponse = /*#__PURE__*/function () {
99
101
  obj['description'] = _ApiClient["default"].convertToType(data['description'], 'String');
100
102
  }
101
103
  if (data.hasOwnProperty('providerType')) {
102
- obj['providerType'] = _ProviderType["default"].constructFromObject(data['providerType']);
104
+ obj['providerType'] = _ApiClient["default"].convertToType(data['providerType'], _ProviderType["default"]);
103
105
  }
104
106
  if (data.hasOwnProperty('endpointUrl')) {
105
107
  obj['endpointUrl'] = _ApiClient["default"].convertToType(data['endpointUrl'], 'String');
@@ -114,7 +116,7 @@ var RerankerResponse = /*#__PURE__*/function () {
114
116
  obj['supportedModalities'] = _ApiClient["default"].convertToType(data['supportedModalities'], [_Modality["default"]]);
115
117
  }
116
118
  if (data.hasOwnProperty('credentials')) {
117
- obj['credentials'] = _EndpointAuthentication["default"].constructFromObject(data['credentials']);
119
+ obj['credentials'] = _ApiClient["default"].convertToType(data['credentials'], _EndpointAuthentication["default"]);
118
120
  }
119
121
  if (data.hasOwnProperty('labels')) {
120
122
  obj['labels'] = _ApiClient["default"].convertToType(data['labels'], {
@@ -226,7 +228,7 @@ var RerankerResponse = /*#__PURE__*/function () {
226
228
  }
227
229
  }]);
228
230
  }();
229
- RerankerResponse.RequiredProperties = ["rerankerId", "displayName", "providerType", "endpointUrl", "apiPath", "modelIdentifier", "ownerId", "createdAt", "updatedAt", "createdById", "updatedById"];
231
+ RerankerResponse.RequiredProperties = ["rerankerId", "displayName", "providerType", "endpointUrl", "modelIdentifier", "supportedModalities", "labels", "ownerId", "createdAt", "updatedAt", "createdById", "updatedById"];
230
232
 
231
233
  /**
232
234
  * Unique identifier of the reranker
@@ -247,6 +249,7 @@ RerankerResponse.prototype['displayName'] = undefined;
247
249
  RerankerResponse.prototype['description'] = undefined;
248
250
 
249
251
  /**
252
+ * Type of reranking provider
250
253
  * @member {module:model/ProviderType} providerType
251
254
  */
252
255
  RerankerResponse.prototype['providerType'] = undefined;
@@ -276,6 +279,7 @@ RerankerResponse.prototype['modelIdentifier'] = undefined;
276
279
  RerankerResponse.prototype['supportedModalities'] = undefined;
277
280
 
278
281
  /**
282
+ * Structured credential payload used for upstream authentication
279
283
  * @member {module:model/EndpointAuthentication} credentials
280
284
  */
281
285
  RerankerResponse.prototype['credentials'] = undefined;
@@ -37,7 +37,7 @@ var ResultSetBoundary = /*#__PURE__*/function () {
37
37
  * Boundary marker for logical result sets in streaming memory retrieval
38
38
  * @alias module:model/ResultSetBoundary
39
39
  * @param resultSetId {String} Unique identifier for this result set (UUID)
40
- * @param kind {String} Type of boundary marker
40
+ * @param kind {module:model/ResultSetBoundary.KindEnum} Type of boundary marker
41
41
  * @param stageName {String} Free-form label describing the pipeline stage
42
42
  */
43
43
  function ResultSetBoundary(resultSetId, kind, stageName) {
@@ -135,7 +135,7 @@ ResultSetBoundary.prototype['resultSetId'] = undefined;
135
135
 
136
136
  /**
137
137
  * Type of boundary marker
138
- * @member {String} kind
138
+ * @member {module:model/ResultSetBoundary.KindEnum} kind
139
139
  */
140
140
  ResultSetBoundary.prototype['kind'] = undefined;
141
141
 
@@ -150,4 +150,22 @@ ResultSetBoundary.prototype['stageName'] = undefined;
150
150
  * @member {Number} expectedItems
151
151
  */
152
152
  ResultSetBoundary.prototype['expectedItems'] = undefined;
153
+
154
+ /**
155
+ * Allowed values for the <code>kind</code> property.
156
+ * @enum {String}
157
+ * @readonly
158
+ */
159
+ ResultSetBoundary['KindEnum'] = {
160
+ /**
161
+ * value: "BEGIN"
162
+ * @const
163
+ */
164
+ "BEGIN": "BEGIN",
165
+ /**
166
+ * value: "END"
167
+ * @const
168
+ */
169
+ "END": "END"
170
+ };
153
171
  var _default = exports["default"] = ResultSetBoundary;
@@ -66,19 +66,19 @@ var RetrieveMemoryEvent = /*#__PURE__*/function () {
66
66
  if (data) {
67
67
  obj = obj || new RetrieveMemoryEvent();
68
68
  if (data.hasOwnProperty('resultSetBoundary')) {
69
- obj['resultSetBoundary'] = _ResultSetBoundary["default"].constructFromObject(data['resultSetBoundary']);
69
+ obj['resultSetBoundary'] = _ApiClient["default"].convertToType(data['resultSetBoundary'], _ResultSetBoundary["default"]);
70
70
  }
71
71
  if (data.hasOwnProperty('abstractReply')) {
72
- obj['abstractReply'] = _AbstractReply["default"].constructFromObject(data['abstractReply']);
72
+ obj['abstractReply'] = _ApiClient["default"].convertToType(data['abstractReply'], _AbstractReply["default"]);
73
73
  }
74
74
  if (data.hasOwnProperty('retrievedItem')) {
75
- obj['retrievedItem'] = _RetrievedItem["default"].constructFromObject(data['retrievedItem']);
75
+ obj['retrievedItem'] = _ApiClient["default"].convertToType(data['retrievedItem'], _RetrievedItem["default"]);
76
76
  }
77
77
  if (data.hasOwnProperty('memoryDefinition')) {
78
- obj['memoryDefinition'] = _Memory["default"].constructFromObject(data['memoryDefinition']);
78
+ obj['memoryDefinition'] = _ApiClient["default"].convertToType(data['memoryDefinition'], _Memory["default"]);
79
79
  }
80
80
  if (data.hasOwnProperty('status')) {
81
- obj['status'] = _GoodMemStatus["default"].constructFromObject(data['status']);
81
+ obj['status'] = _ApiClient["default"].convertToType(data['status'], _GoodMemStatus["default"]);
82
82
  }
83
83
  }
84
84
  return obj;
@@ -122,26 +122,31 @@ var RetrieveMemoryEvent = /*#__PURE__*/function () {
122
122
  }]);
123
123
  }();
124
124
  /**
125
+ * Result set boundary marker (BEGIN/END)
125
126
  * @member {module:model/ResultSetBoundary} resultSetBoundary
126
127
  */
127
128
  RetrieveMemoryEvent.prototype['resultSetBoundary'] = undefined;
128
129
 
129
130
  /**
131
+ * Generated abstractive reply
130
132
  * @member {module:model/AbstractReply} abstractReply
131
133
  */
132
134
  RetrieveMemoryEvent.prototype['abstractReply'] = undefined;
133
135
 
134
136
  /**
137
+ * A retrieved memory or chunk
135
138
  * @member {module:model/RetrievedItem} retrievedItem
136
139
  */
137
140
  RetrieveMemoryEvent.prototype['retrievedItem'] = undefined;
138
141
 
139
142
  /**
143
+ * Memory object to add to client's memories array
140
144
  * @member {module:model/Memory} memoryDefinition
141
145
  */
142
146
  RetrieveMemoryEvent.prototype['memoryDefinition'] = undefined;
143
147
 
144
148
  /**
149
+ * Warning or non-fatal status with granular codes (operation continues)
145
150
  * @member {module:model/GoodMemStatus} status
146
151
  */
147
152
  RetrieveMemoryEvent.prototype['status'] = undefined;
@@ -58,6 +58,8 @@ var RetrieveMemoryRequest = /*#__PURE__*/function () {
58
58
  value: function initialize(obj, message, spaceKeys) {
59
59
  obj['message'] = message;
60
60
  obj['spaceKeys'] = spaceKeys;
61
+ obj['fetchMemory'] = true;
62
+ obj['fetchMemoryContent'] = false;
61
63
  }
62
64
 
63
65
  /**
@@ -91,10 +93,10 @@ var RetrieveMemoryRequest = /*#__PURE__*/function () {
91
93
  obj['fetchMemoryContent'] = _ApiClient["default"].convertToType(data['fetchMemoryContent'], 'Boolean');
92
94
  }
93
95
  if (data.hasOwnProperty('hnsw')) {
94
- obj['hnsw'] = _HnswOptions["default"].constructFromObject(data['hnsw']);
96
+ obj['hnsw'] = _ApiClient["default"].convertToType(data['hnsw'], _HnswOptions["default"]);
95
97
  }
96
98
  if (data.hasOwnProperty('postProcessor')) {
97
- obj['postProcessor'] = _PostProcessor["default"].constructFromObject(data['postProcessor']);
99
+ obj['postProcessor'] = _ApiClient["default"].convertToType(data['postProcessor'], _PostProcessor["default"]);
98
100
  }
99
101
  }
100
102
  return obj;
@@ -210,23 +212,27 @@ RetrieveMemoryRequest.prototype['spaceKeys'] = undefined;
210
212
  RetrieveMemoryRequest.prototype['requestedSize'] = undefined;
211
213
 
212
214
  /**
213
- * Whether to include full Memory objects in the response.
215
+ * Whether to include streamed memory-definition records in the response. Defaults to true when omitted. These records include memory metadata and audit fields, but omit originalContent unless fetchMemoryContent is true.
214
216
  * @member {Boolean} fetchMemory
217
+ * @default true
215
218
  */
216
- RetrieveMemoryRequest.prototype['fetchMemory'] = undefined;
219
+ RetrieveMemoryRequest.prototype['fetchMemory'] = true;
217
220
 
218
221
  /**
219
- * Whether to include memory content in the response. Requires fetchMemory=true.
222
+ * Whether streamed memory-definition records include originalContent bytes. Requires fetchMemory=true. Defaults to false when omitted.
220
223
  * @member {Boolean} fetchMemoryContent
224
+ * @default false
221
225
  */
222
- RetrieveMemoryRequest.prototype['fetchMemoryContent'] = undefined;
226
+ RetrieveMemoryRequest.prototype['fetchMemoryContent'] = false;
223
227
 
224
228
  /**
229
+ * Optional request-level HNSW tuning overrides. Advanced usage; available on POST retrieve.
225
230
  * @member {module:model/HnswOptions} hnsw
226
231
  */
227
232
  RetrieveMemoryRequest.prototype['hnsw'] = undefined;
228
233
 
229
234
  /**
235
+ * Optional post-processor configuration to transform retrieval results.
230
236
  * @member {module:model/PostProcessor} postProcessor
231
237
  */
232
238
  RetrieveMemoryRequest.prototype['postProcessor'] = undefined;
@@ -7,11 +7,15 @@ exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
8
  var _ChunkReference = _interopRequireDefault(require("./ChunkReference"));
9
9
  var _Memory = _interopRequireDefault(require("./Memory"));
10
+ var _RetrievedItemOneOf = _interopRequireDefault(require("./RetrievedItemOneOf"));
11
+ var _RetrievedItemOneOf2 = _interopRequireDefault(require("./RetrievedItemOneOf1"));
12
+ var _RetrievedItem;
10
13
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
11
14
  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); }
12
15
  function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
13
16
  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); } }
14
17
  function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
18
+ function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
15
19
  function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
16
20
  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); } /**
17
21
  *
@@ -35,72 +39,117 @@ var RetrievedItem = /*#__PURE__*/function () {
35
39
  * Constructs a new <code>RetrievedItem</code>.
36
40
  * A retrieved result that can be either a Memory or MemoryChunk
37
41
  * @alias module:model/RetrievedItem
42
+ * @param {(module:model/RetrievedItemOneOf|module:model/RetrievedItemOneOf1)} instance The actual instance to initialize RetrievedItem.
38
43
  */
39
44
  function RetrievedItem() {
45
+ var instance = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
40
46
  _classCallCheck(this, RetrievedItem);
41
- RetrievedItem.initialize(this);
47
+ /**
48
+ * Returns the JSON representation of the actual instance.
49
+ * @return {string}
50
+ */
51
+ _defineProperty(this, "toJSON", function () {
52
+ return this.getActualInstance();
53
+ });
54
+ if (instance === null) {
55
+ this.actualInstance = null;
56
+ return;
57
+ }
58
+ var match = 0;
59
+ var errorMessages = [];
60
+ try {
61
+ if (instance instanceof _RetrievedItemOneOf["default"]) {
62
+ this.actualInstance = instance;
63
+ } else {
64
+ // plain JS object
65
+ // validate the object
66
+ _RetrievedItemOneOf["default"].validateJSON(instance); // throw an exception if no match
67
+ // create RetrievedItemOneOf from JS object
68
+ this.actualInstance = _RetrievedItemOneOf["default"].constructFromObject(instance);
69
+ }
70
+ match++;
71
+ } catch (err) {
72
+ // json data failed to deserialize into RetrievedItemOneOf
73
+ errorMessages.push("Failed to construct RetrievedItemOneOf: " + err);
74
+ }
75
+ try {
76
+ if (instance instanceof _RetrievedItemOneOf2["default"]) {
77
+ this.actualInstance = instance;
78
+ } else {
79
+ // plain JS object
80
+ // validate the object
81
+ _RetrievedItemOneOf2["default"].validateJSON(instance); // throw an exception if no match
82
+ // create RetrievedItemOneOf1 from JS object
83
+ this.actualInstance = _RetrievedItemOneOf2["default"].constructFromObject(instance);
84
+ }
85
+ match++;
86
+ } catch (err) {
87
+ // json data failed to deserialize into RetrievedItemOneOf1
88
+ errorMessages.push("Failed to construct RetrievedItemOneOf1: " + err);
89
+ }
90
+ if (match > 1) {
91
+ throw new Error("Multiple matches found constructing `RetrievedItem` with oneOf schemas RetrievedItemOneOf, RetrievedItemOneOf1. Input: " + JSON.stringify(instance));
92
+ } else if (match === 0) {
93
+ this.actualInstance = null; // clear the actual instance in case there are multiple matches
94
+ throw new Error("No match found constructing `RetrievedItem` with oneOf schemas RetrievedItemOneOf, RetrievedItemOneOf1. Details: " + errorMessages.join(", "));
95
+ } else {// only 1 match
96
+ // the input is valid
97
+ }
42
98
  }
43
99
 
44
100
  /**
45
- * Initializes the fields of this object.
46
- * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
47
- * Only for internal use.
101
+ * Constructs a <code>RetrievedItem</code> from a plain JavaScript object, optionally creating a new instance.
102
+ * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
103
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
104
+ * @param {module:model/RetrievedItem} obj Optional instance to populate.
105
+ * @return {module:model/RetrievedItem} The populated <code>RetrievedItem</code> instance.
48
106
  */
49
- return _createClass(RetrievedItem, null, [{
50
- key: "initialize",
51
- value: function initialize(obj) {}
52
-
107
+ return _createClass(RetrievedItem, [{
108
+ key: "getActualInstance",
109
+ value:
53
110
  /**
54
- * Constructs a <code>RetrievedItem</code> from a plain JavaScript object, optionally creating a new instance.
55
- * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
56
- * @param {Object} data The plain JavaScript object bearing properties of interest.
57
- * @param {module:model/RetrievedItem} obj Optional instance to populate.
58
- * @return {module:model/RetrievedItem} The populated <code>RetrievedItem</code> instance.
111
+ * Gets the actual instance, which can be <code>RetrievedItemOneOf</code>, <code>RetrievedItemOneOf1</code>.
112
+ * @return {(module:model/RetrievedItemOneOf|module:model/RetrievedItemOneOf1)} The actual instance.
59
113
  */
60
- }, {
61
- key: "constructFromObject",
62
- value: function constructFromObject(data, obj) {
63
- if (data) {
64
- obj = obj || new RetrievedItem();
65
- if (data.hasOwnProperty('memory')) {
66
- obj['memory'] = _Memory["default"].constructFromObject(data['memory']);
67
- }
68
- if (data.hasOwnProperty('chunk')) {
69
- obj['chunk'] = _ChunkReference["default"].constructFromObject(data['chunk']);
70
- }
71
- }
72
- return obj;
114
+ function getActualInstance() {
115
+ return this.actualInstance;
73
116
  }
74
117
 
75
118
  /**
76
- * Validates the JSON data with respect to <code>RetrievedItem</code>.
77
- * @param {Object} data The plain JavaScript object bearing properties of interest.
78
- * @return {boolean} to indicate whether the JSON data is valid with respect to <code>RetrievedItem</code>.
119
+ * Sets the actual instance, which can be <code>RetrievedItemOneOf</code>, <code>RetrievedItemOneOf1</code>.
120
+ * @param {(module:model/RetrievedItemOneOf|module:model/RetrievedItemOneOf1)} obj The actual instance.
79
121
  */
80
122
  }, {
81
- key: "validateJSON",
82
- value: function validateJSON(data) {
83
- // validate the optional field `memory`
84
- if (data['memory']) {
85
- // data not null
86
- _Memory["default"].validateJSON(data['memory']);
87
- }
88
- // validate the optional field `chunk`
89
- if (data['chunk']) {
90
- // data not null
91
- _ChunkReference["default"].validateJSON(data['chunk']);
92
- }
93
- return true;
123
+ key: "setActualInstance",
124
+ value: function setActualInstance(obj) {
125
+ this.actualInstance = RetrievedItem.constructFromObject(obj).getActualInstance();
126
+ }
127
+ }], [{
128
+ key: "constructFromObject",
129
+ value: function constructFromObject(data, obj) {
130
+ return new RetrievedItem(data);
94
131
  }
95
132
  }]);
96
133
  }();
97
134
  /**
135
+ * Complete memory object (if retrieved)
98
136
  * @member {module:model/Memory} memory
99
137
  */
138
+ _RetrievedItem = RetrievedItem;
139
+ /**
140
+ * Create an instance of RetrievedItem from a JSON string.
141
+ * @param {string} json_string JSON string.
142
+ * @return {module:model/RetrievedItem} An instance of RetrievedItem.
143
+ */
144
+ _defineProperty(RetrievedItem, "fromJSON", function (json_string) {
145
+ return _RetrievedItem.constructFromObject(JSON.parse(json_string));
146
+ });
100
147
  RetrievedItem.prototype['memory'] = undefined;
101
148
 
102
149
  /**
150
+ * Reference to a memory chunk (if retrieved)
103
151
  * @member {module:model/ChunkReference} chunk
104
152
  */
105
153
  RetrievedItem.prototype['chunk'] = undefined;
154
+ RetrievedItem.OneOf = ["RetrievedItemOneOf", "RetrievedItemOneOf1"];
106
155
  var _default = exports["default"] = RetrievedItem;