@pairsystems/goodmem-client 1.0.7 → 1.0.8

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.
package/README.md CHANGED
@@ -5,7 +5,7 @@ No description provided (generated by Openapi Generator https://github.com/opena
5
5
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
6
6
 
7
7
  - API version:
8
- - Package version: 1.0.7
8
+ - Package version: 1.0.8
9
9
  - Generator version: 7.20.0-SNAPSHOT
10
10
  - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
11
11
 
@@ -127,7 +127,7 @@ var RerankersApi = exports["default"] = /*#__PURE__*/function () {
127
127
 
128
128
  /**
129
129
  * Get a reranker by ID
130
- * Retrieves the details of a specific reranker configuration by its unique identifier. SECURITY NOTE: The credentials field is omitted from the response for security reasons. Requires READ_RERANKER_OWN permission for rerankers you own (or READ_RERANKER_ANY for admin users). This is a read-only operation with no side effects and is safe to retry.
130
+ * Retrieves the details of a specific reranker configuration by its unique identifier. Response payloads include stored credentials, matching gRPC response semantics. Requires READ_RERANKER_OWN permission for rerankers you own (or READ_RERANKER_ANY for admin users). This is a read-only operation with no side effects and is safe to retry.
131
131
  * @param {String} id The unique identifier of the reranker to retrieve
132
132
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RerankerResponse} and HTTP response
133
133
  */
@@ -154,7 +154,7 @@ var RerankersApi = exports["default"] = /*#__PURE__*/function () {
154
154
 
155
155
  /**
156
156
  * Get a reranker by ID
157
- * Retrieves the details of a specific reranker configuration by its unique identifier. SECURITY NOTE: The credentials field is omitted from the response for security reasons. Requires READ_RERANKER_OWN permission for rerankers you own (or READ_RERANKER_ANY for admin users). This is a read-only operation with no side effects and is safe to retry.
157
+ * Retrieves the details of a specific reranker configuration by its unique identifier. Response payloads include stored credentials, matching gRPC response semantics. Requires READ_RERANKER_OWN permission for rerankers you own (or READ_RERANKER_ANY for admin users). This is a read-only operation with no side effects and is safe to retry.
158
158
  * @param {String} id The unique identifier of the reranker to retrieve
159
159
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RerankerResponse}
160
160
  */
@@ -168,7 +168,7 @@ var RerankersApi = exports["default"] = /*#__PURE__*/function () {
168
168
 
169
169
  /**
170
170
  * List rerankers
171
- * Retrieves a list of reranker configurations accessible to the caller, with optional filtering. IMPORTANT: Pagination is NOT supported - all matching results are returned. Results are ordered by created_at descending. SECURITY NOTE: credentials fields are omitted from all responses. PERMISSION-BASED FILTERING: With LIST_RERANKER_OWN permission, only your own rerankers are shown. With LIST_RERANKER_ANY permission, you can see all rerankers or filter by any ownerId. Specifying ownerId without LIST_RERANKER_ANY permission returns PERMISSION_DENIED.
171
+ * Retrieves a list of reranker configurations accessible to the caller, with optional filtering. IMPORTANT: Pagination is NOT supported - all matching results are returned. Results are ordered by created_at descending. Responses include stored credentials, matching gRPC response semantics. PERMISSION-BASED FILTERING: With LIST_RERANKER_OWN permission, only your own rerankers are shown. With LIST_RERANKER_ANY permission, you can see all rerankers or filter by any ownerId. Specifying ownerId without LIST_RERANKER_ANY permission returns PERMISSION_DENIED.
172
172
  * @param {Object} opts Optional parameters
173
173
  * @param {String} [ownerId] Filter rerankers by owner ID. With LIST_RERANKER_ANY permission, omitting this shows all accessible rerankers; providing it filters by that owner. With LIST_RERANKER_OWN permission, only your own rerankers are shown regardless of this parameter (PERMISSION_DENIED if set to another user).
174
174
  * @param {String} [providerType] Filter rerankers by provider type (e.g., OPENAI, TEI, VLLM, etc.)
@@ -197,7 +197,7 @@ var RerankersApi = exports["default"] = /*#__PURE__*/function () {
197
197
 
198
198
  /**
199
199
  * List rerankers
200
- * Retrieves a list of reranker configurations accessible to the caller, with optional filtering. IMPORTANT: Pagination is NOT supported - all matching results are returned. Results are ordered by created_at descending. SECURITY NOTE: credentials fields are omitted from all responses. PERMISSION-BASED FILTERING: With LIST_RERANKER_OWN permission, only your own rerankers are shown. With LIST_RERANKER_ANY permission, you can see all rerankers or filter by any ownerId. Specifying ownerId without LIST_RERANKER_ANY permission returns PERMISSION_DENIED.
200
+ * Retrieves a list of reranker configurations accessible to the caller, with optional filtering. IMPORTANT: Pagination is NOT supported - all matching results are returned. Results are ordered by created_at descending. Responses include stored credentials, matching gRPC response semantics. PERMISSION-BASED FILTERING: With LIST_RERANKER_OWN permission, only your own rerankers are shown. With LIST_RERANKER_ANY permission, you can see all rerankers or filter by any ownerId. Specifying ownerId without LIST_RERANKER_ANY permission returns PERMISSION_DENIED.
201
201
  * @param {Object} opts Optional parameters
202
202
  * @param {String} opts.ownerId Filter rerankers by owner ID. With LIST_RERANKER_ANY permission, omitting this shows all accessible rerankers; providing it filters by that owner. With LIST_RERANKER_OWN permission, only your own rerankers are shown regardless of this parameter (PERMISSION_DENIED if set to another user).
203
203
  * @param {String} opts.providerType Filter rerankers by provider type (e.g., OPENAI, TEI, VLLM, etc.)
@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
8
  var _DistributionType = _interopRequireDefault(require("./DistributionType"));
9
+ var _EndpointAuthentication = _interopRequireDefault(require("./EndpointAuthentication"));
9
10
  var _Modality = _interopRequireDefault(require("./Modality"));
10
11
  var _ProviderType = _interopRequireDefault(require("./ProviderType"));
11
12
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
@@ -126,6 +127,9 @@ var EmbedderResponse = /*#__PURE__*/function () {
126
127
  if (data.hasOwnProperty('supportedModalities')) {
127
128
  obj['supportedModalities'] = _ApiClient["default"].convertToType(data['supportedModalities'], [_Modality["default"]]);
128
129
  }
130
+ if (data.hasOwnProperty('credentials')) {
131
+ obj['credentials'] = _EndpointAuthentication["default"].constructFromObject(data['credentials']);
132
+ }
129
133
  if (data.hasOwnProperty('labels')) {
130
134
  obj['labels'] = _ApiClient["default"].convertToType(data['labels'], {
131
135
  'String': 'String'
@@ -207,6 +211,11 @@ var EmbedderResponse = /*#__PURE__*/function () {
207
211
  if (!Array.isArray(data['supportedModalities'])) {
208
212
  throw new Error("Expected the field `supportedModalities` to be an array in the JSON data but got " + data['supportedModalities']);
209
213
  }
214
+ // validate the optional field `credentials`
215
+ if (data['credentials']) {
216
+ // data not null
217
+ _EndpointAuthentication["default"].validateJSON(data['credentials']);
218
+ }
210
219
  // ensure the json data is a string
211
220
  if (data['version'] && !(typeof data['version'] === 'string' || data['version'] instanceof String)) {
212
221
  throw new Error("Expected the field `version` to be a primitive type in the JSON string but got " + data['version']);
@@ -297,6 +306,11 @@ EmbedderResponse.prototype['maxSequenceLength'] = undefined;
297
306
  */
298
307
  EmbedderResponse.prototype['supportedModalities'] = undefined;
299
308
 
309
+ /**
310
+ * @member {module:model/EndpointAuthentication} credentials
311
+ */
312
+ EmbedderResponse.prototype['credentials'] = undefined;
313
+
300
314
  /**
301
315
  * User-defined labels for categorization
302
316
  * @member {Object.<String, String>} labels
@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _EndpointAuthentication = _interopRequireDefault(require("./EndpointAuthentication"));
8
9
  var _LLMCapabilities = _interopRequireDefault(require("./LLMCapabilities"));
9
10
  var _LLMProviderType = _interopRequireDefault(require("./LLMProviderType"));
10
11
  var _LLMSamplingParams = _interopRequireDefault(require("./LLMSamplingParams"));
@@ -116,6 +117,9 @@ var LLMResponse = /*#__PURE__*/function () {
116
117
  if (data.hasOwnProperty('supportedModalities')) {
117
118
  obj['supportedModalities'] = _ApiClient["default"].convertToType(data['supportedModalities'], [_Modality["default"]]);
118
119
  }
120
+ if (data.hasOwnProperty('credentials')) {
121
+ obj['credentials'] = _EndpointAuthentication["default"].constructFromObject(data['credentials']);
122
+ }
119
123
  if (data.hasOwnProperty('labels')) {
120
124
  obj['labels'] = _ApiClient["default"].convertToType(data['labels'], {
121
125
  'String': 'String'
@@ -211,6 +215,11 @@ var LLMResponse = /*#__PURE__*/function () {
211
215
  if (!Array.isArray(data['supportedModalities'])) {
212
216
  throw new Error("Expected the field `supportedModalities` to be an array in the JSON data but got " + data['supportedModalities']);
213
217
  }
218
+ // validate the optional field `credentials`
219
+ if (data['credentials']) {
220
+ // data not null
221
+ _EndpointAuthentication["default"].validateJSON(data['credentials']);
222
+ }
214
223
  // ensure the json data is a string
215
224
  if (data['version'] && !(typeof data['version'] === 'string' || data['version'] instanceof String)) {
216
225
  throw new Error("Expected the field `version` to be a primitive type in the JSON string but got " + data['version']);
@@ -294,6 +303,11 @@ LLMResponse.prototype['modelIdentifier'] = undefined;
294
303
  */
295
304
  LLMResponse.prototype['supportedModalities'] = undefined;
296
305
 
306
+ /**
307
+ * @member {module:model/EndpointAuthentication} credentials
308
+ */
309
+ LLMResponse.prototype['credentials'] = undefined;
310
+
297
311
  /**
298
312
  * User-defined labels for categorization
299
313
  * @member {Object.<String, String>} labels
@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports["default"] = void 0;
7
7
  var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _EndpointAuthentication = _interopRequireDefault(require("./EndpointAuthentication"));
8
9
  var _Modality = _interopRequireDefault(require("./Modality"));
9
10
  var _ProviderType = _interopRequireDefault(require("./ProviderType"));
10
11
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
@@ -112,6 +113,9 @@ var RerankerResponse = /*#__PURE__*/function () {
112
113
  if (data.hasOwnProperty('supportedModalities')) {
113
114
  obj['supportedModalities'] = _ApiClient["default"].convertToType(data['supportedModalities'], [_Modality["default"]]);
114
115
  }
116
+ if (data.hasOwnProperty('credentials')) {
117
+ obj['credentials'] = _EndpointAuthentication["default"].constructFromObject(data['credentials']);
118
+ }
115
119
  if (data.hasOwnProperty('labels')) {
116
120
  obj['labels'] = _ApiClient["default"].convertToType(data['labels'], {
117
121
  'String': 'String'
@@ -193,6 +197,11 @@ var RerankerResponse = /*#__PURE__*/function () {
193
197
  if (!Array.isArray(data['supportedModalities'])) {
194
198
  throw new Error("Expected the field `supportedModalities` to be an array in the JSON data but got " + data['supportedModalities']);
195
199
  }
200
+ // validate the optional field `credentials`
201
+ if (data['credentials']) {
202
+ // data not null
203
+ _EndpointAuthentication["default"].validateJSON(data['credentials']);
204
+ }
196
205
  // ensure the json data is a string
197
206
  if (data['version'] && !(typeof data['version'] === 'string' || data['version'] instanceof String)) {
198
207
  throw new Error("Expected the field `version` to be a primitive type in the JSON string but got " + data['version']);
@@ -266,6 +275,11 @@ RerankerResponse.prototype['modelIdentifier'] = undefined;
266
275
  */
267
276
  RerankerResponse.prototype['supportedModalities'] = undefined;
268
277
 
278
+ /**
279
+ * @member {module:model/EndpointAuthentication} credentials
280
+ */
281
+ RerankerResponse.prototype['credentials'] = undefined;
282
+
269
283
  /**
270
284
  * User-defined labels for categorization
271
285
  * @member {Object.<String, String>} labels
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pairsystems/goodmem-client",
3
- "version": "1.0.7",
3
+ "version": "1.0.8",
4
4
  "description": "JavaScript client for GoodMem API",
5
5
  "license": "Unlicense",
6
6
  "main": "dist/index.js",