@pairsystems/goodmem-client 1.0.2 → 1.0.3

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
@@ -6,7 +6,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
6
6
 
7
7
  - API version:
8
8
  - Package version: 1.0.0
9
- - Generator version: 7.14.0
9
+ - Generator version: 7.16.0-SNAPSHOT
10
10
  - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
11
11
 
12
12
  ## Installation
@@ -143,6 +143,7 @@ Class | Method | HTTP request | Description
143
143
  *GoodMemClient.MemoriesApi* | [**getMemory**](docs/MemoriesApi.md#getMemory) | **GET** /v1/memories/{id} | Get a memory by ID
144
144
  *GoodMemClient.MemoriesApi* | [**listMemories**](docs/MemoriesApi.md#listMemories) | **GET** /v1/spaces/{spaceId}/memories | List memories in a space
145
145
  *GoodMemClient.MemoriesApi* | [**retrieveMemory**](docs/MemoriesApi.md#retrieveMemory) | **GET** /v1/memories/retrieve | Stream semantic memory retrieval
146
+ *GoodMemClient.MemoriesApi* | [**retrieveMemoryAdvanced**](docs/MemoriesApi.md#retrieveMemoryAdvanced) | **POST** /v1/memories/retrieve | Advanced semantic memory retrieval with JSON
146
147
  *GoodMemClient.RerankersApi* | [**createReranker**](docs/RerankersApi.md#createReranker) | **POST** /v1/rerankers | Create a new reranker
147
148
  *GoodMemClient.RerankersApi* | [**deleteReranker**](docs/RerankersApi.md#deleteReranker) | **DELETE** /v1/rerankers/{id} | Delete a reranker
148
149
  *GoodMemClient.RerankersApi* | [**getReranker**](docs/RerankersApi.md#getReranker) | **GET** /v1/rerankers/{id} | Get a reranker by ID
@@ -154,7 +155,9 @@ Class | Method | HTTP request | Description
154
155
  *GoodMemClient.SpacesApi* | [**listSpaces**](docs/SpacesApi.md#listSpaces) | **GET** /v1/spaces | List spaces
155
156
  *GoodMemClient.SpacesApi* | [**updateSpace**](docs/SpacesApi.md#updateSpace) | **PUT** /v1/spaces/{id} | Update a space
156
157
  *GoodMemClient.SystemApi* | [**initializeSystem**](docs/SystemApi.md#initializeSystem) | **POST** /v1/system/init | Initialize the system
158
+ *GoodMemClient.UsersApi* | [**getCurrentUser**](docs/UsersApi.md#getCurrentUser) | **GET** /v1/users/me | Get current user profile
157
159
  *GoodMemClient.UsersApi* | [**getUser**](docs/UsersApi.md#getUser) | **GET** /v1/users/{id} | Get a user by ID
160
+ *GoodMemClient.UsersApi* | [**getUserByEmail**](docs/UsersApi.md#getUserByEmail) | **GET** /v1/users/email/{email} | Get user by email address
158
161
 
159
162
 
160
163
  ## Documentation for Models
@@ -164,12 +167,16 @@ Class | Method | HTTP request | Description
164
167
  - [GoodMemClient.BatchMemoryCreationRequest](docs/BatchMemoryCreationRequest.md)
165
168
  - [GoodMemClient.BatchMemoryDeletionRequest](docs/BatchMemoryDeletionRequest.md)
166
169
  - [GoodMemClient.BatchMemoryRetrievalRequest](docs/BatchMemoryRetrievalRequest.md)
170
+ - [GoodMemClient.BinaryContent](docs/BinaryContent.md)
167
171
  - [GoodMemClient.ChunkReference](docs/ChunkReference.md)
168
172
  - [GoodMemClient.ChunkingConfiguration](docs/ChunkingConfiguration.md)
173
+ - [GoodMemClient.ContextItem](docs/ContextItem.md)
169
174
  - [GoodMemClient.CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
170
175
  - [GoodMemClient.CreateApiKeyResponse](docs/CreateApiKeyResponse.md)
176
+ - [GoodMemClient.DistributionType](docs/DistributionType.md)
171
177
  - [GoodMemClient.EmbedderCreationRequest](docs/EmbedderCreationRequest.md)
172
178
  - [GoodMemClient.EmbedderResponse](docs/EmbedderResponse.md)
179
+ - [GoodMemClient.EmbedderWeight](docs/EmbedderWeight.md)
173
180
  - [GoodMemClient.GoodMemStatus](docs/GoodMemStatus.md)
174
181
  - [GoodMemClient.LengthMeasurement](docs/LengthMeasurement.md)
175
182
  - [GoodMemClient.ListApiKeysResponse](docs/ListApiKeysResponse.md)
@@ -177,15 +184,18 @@ Class | Method | HTTP request | Description
177
184
  - [GoodMemClient.ListRerankersResponse](docs/ListRerankersResponse.md)
178
185
  - [GoodMemClient.ListSpacesResponse](docs/ListSpacesResponse.md)
179
186
  - [GoodMemClient.Memory](docs/Memory.md)
187
+ - [GoodMemClient.MemoryChunkResponse](docs/MemoryChunkResponse.md)
180
188
  - [GoodMemClient.MemoryCreationRequest](docs/MemoryCreationRequest.md)
181
189
  - [GoodMemClient.MemoryListResponse](docs/MemoryListResponse.md)
182
190
  - [GoodMemClient.Modality](docs/Modality.md)
191
+ - [GoodMemClient.PostProcessor](docs/PostProcessor.md)
183
192
  - [GoodMemClient.ProviderType](docs/ProviderType.md)
184
193
  - [GoodMemClient.RecursiveChunkingConfiguration](docs/RecursiveChunkingConfiguration.md)
185
194
  - [GoodMemClient.RerankerCreationRequest](docs/RerankerCreationRequest.md)
186
195
  - [GoodMemClient.RerankerResponse](docs/RerankerResponse.md)
187
196
  - [GoodMemClient.ResultSetBoundary](docs/ResultSetBoundary.md)
188
197
  - [GoodMemClient.RetrieveMemoryEvent](docs/RetrieveMemoryEvent.md)
198
+ - [GoodMemClient.RetrieveMemoryRequest](docs/RetrieveMemoryRequest.md)
189
199
  - [GoodMemClient.RetrievedItem](docs/RetrievedItem.md)
190
200
  - [GoodMemClient.SentenceChunkingConfiguration](docs/SentenceChunkingConfiguration.md)
191
201
  - [GoodMemClient.SeparatorKeepStrategy](docs/SeparatorKeepStrategy.md)
@@ -193,6 +203,7 @@ Class | Method | HTTP request | Description
193
203
  - [GoodMemClient.SpaceCreationRequest](docs/SpaceCreationRequest.md)
194
204
  - [GoodMemClient.SpaceEmbedder](docs/SpaceEmbedder.md)
195
205
  - [GoodMemClient.SpaceEmbedderConfig](docs/SpaceEmbedderConfig.md)
206
+ - [GoodMemClient.SpaceKey](docs/SpaceKey.md)
196
207
  - [GoodMemClient.SystemInitResponse](docs/SystemInitResponse.md)
197
208
  - [GoodMemClient.UpdateApiKeyRequest](docs/UpdateApiKeyRequest.md)
198
209
  - [GoodMemClient.UpdateEmbedderRequest](docs/UpdateEmbedderRequest.md)
@@ -48,7 +48,7 @@ var APIKeysApi = exports["default"] = /*#__PURE__*/function () {
48
48
 
49
49
  /**
50
50
  * Create a new API key
51
- * Creates a new API key for authenticating with the API. The response includes the one-time raw API key value which will not be retrievable later.
51
+ * Creates a new API key for authenticating with the API. New keys start in ACTIVE status and can be used immediately for authentication. The response includes the one-time raw API key value which will not be retrievable later - clients must save this value as it cannot be recovered. Requires CREATE_APIKEY_OWN permission (or CREATE_APIKEY_ANY for admin users). Side effects include generating cryptographically secure key material, recording creation timestamp, and tracking creator ID. Returns INVALID_ARGUMENT if expires_at is set to a time in the past.
52
52
  * @param {module:model/CreateApiKeyRequest} createApiKeyRequest API key configuration
53
53
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateApiKeyResponse} and HTTP response
54
54
  */
@@ -73,7 +73,7 @@ var APIKeysApi = exports["default"] = /*#__PURE__*/function () {
73
73
 
74
74
  /**
75
75
  * Create a new API key
76
- * Creates a new API key for authenticating with the API. The response includes the one-time raw API key value which will not be retrievable later.
76
+ * Creates a new API key for authenticating with the API. New keys start in ACTIVE status and can be used immediately for authentication. The response includes the one-time raw API key value which will not be retrievable later - clients must save this value as it cannot be recovered. Requires CREATE_APIKEY_OWN permission (or CREATE_APIKEY_ANY for admin users). Side effects include generating cryptographically secure key material, recording creation timestamp, and tracking creator ID. Returns INVALID_ARGUMENT if expires_at is set to a time in the past.
77
77
  * @param {module:model/CreateApiKeyRequest} createApiKeyRequest API key configuration
78
78
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateApiKeyResponse}
79
79
  */
@@ -87,7 +87,7 @@ var APIKeysApi = exports["default"] = /*#__PURE__*/function () {
87
87
 
88
88
  /**
89
89
  * Delete an API key
90
- * Deletes (revokes) an API key. This operation cannot be undone.
90
+ * Permanently deletes an API key. This operation cannot be undone and immediately invalidates the key for all future authentication attempts. TIP: For reversible deactivation, use PUT /v1/apikeys/{id} with status=INACTIVE instead. Requires DELETE_APIKEY_OWN permission for keys you own (or DELETE_APIKEY_ANY for admin users to delete any user's keys). Side effects include permanently removing the key record from the database and immediate authentication invalidation.
91
91
  * @param {String} id The unique identifier of the API key to delete
92
92
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
93
93
  */
@@ -114,7 +114,7 @@ var APIKeysApi = exports["default"] = /*#__PURE__*/function () {
114
114
 
115
115
  /**
116
116
  * Delete an API key
117
- * Deletes (revokes) an API key. This operation cannot be undone.
117
+ * Permanently deletes an API key. This operation cannot be undone and immediately invalidates the key for all future authentication attempts. TIP: For reversible deactivation, use PUT /v1/apikeys/{id} with status=INACTIVE instead. Requires DELETE_APIKEY_OWN permission for keys you own (or DELETE_APIKEY_ANY for admin users to delete any user's keys). Side effects include permanently removing the key record from the database and immediate authentication invalidation.
118
118
  * @param {String} id The unique identifier of the API key to delete
119
119
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}
120
120
  */
@@ -128,7 +128,7 @@ var APIKeysApi = exports["default"] = /*#__PURE__*/function () {
128
128
 
129
129
  /**
130
130
  * List API keys
131
- * Retrieves a list of API keys belonging to the authenticated user. The list includes metadata about each key but not the actual key values.
131
+ * Retrieves a list of API keys belonging to the authenticated user. The list includes metadata about each key but not the actual key values or key hashes for security reasons. Requires LIST_APIKEY_OWN permission (or LIST_APIKEY_ANY for admin users to view keys from any user). This is a read-only operation with no side effects.
132
132
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListApiKeysResponse} and HTTP response
133
133
  */
134
134
  }, {
@@ -148,7 +148,7 @@ var APIKeysApi = exports["default"] = /*#__PURE__*/function () {
148
148
 
149
149
  /**
150
150
  * List API keys
151
- * Retrieves a list of API keys belonging to the authenticated user. The list includes metadata about each key but not the actual key values.
151
+ * Retrieves a list of API keys belonging to the authenticated user. The list includes metadata about each key but not the actual key values or key hashes for security reasons. Requires LIST_APIKEY_OWN permission (or LIST_APIKEY_ANY for admin users to view keys from any user). This is a read-only operation with no side effects.
152
152
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListApiKeysResponse}
153
153
  */
154
154
  }, {
@@ -161,7 +161,7 @@ var APIKeysApi = exports["default"] = /*#__PURE__*/function () {
161
161
 
162
162
  /**
163
163
  * Update an API key
164
- * Updates an existing API key with new values for status or labels.
164
+ * Updates an existing API key with new values for status or labels. IMPORTANT: Key ID, user ownership, key material, and audit fields cannot be modified - only status (ACTIVE/INACTIVE) and labels are mutable. Requires UPDATE_APIKEY_OWN permission for keys you own (or UPDATE_APIKEY_ANY for admin users to modify any user's keys). Side effects include updating the updated_at timestamp and recording the updater's user ID. This operation is idempotent - repeated identical requests have no additional effect.
165
165
  * @param {String} id The unique identifier of the API key to update
166
166
  * @param {module:model/UpdateApiKeyRequest} updateApiKeyRequest API key update details
167
167
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ApiKeyResponse} and HTTP response
@@ -193,7 +193,7 @@ var APIKeysApi = exports["default"] = /*#__PURE__*/function () {
193
193
 
194
194
  /**
195
195
  * Update an API key
196
- * Updates an existing API key with new values for status or labels.
196
+ * Updates an existing API key with new values for status or labels. IMPORTANT: Key ID, user ownership, key material, and audit fields cannot be modified - only status (ACTIVE/INACTIVE) and labels are mutable. Requires UPDATE_APIKEY_OWN permission for keys you own (or UPDATE_APIKEY_ANY for admin users to modify any user's keys). Side effects include updating the updated_at timestamp and recording the updater's user ID. This operation is idempotent - repeated identical requests have no additional effect.
197
197
  * @param {String} id The unique identifier of the API key to update
198
198
  * @param {module:model/UpdateApiKeyRequest} updateApiKeyRequest API key update details
199
199
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ApiKeyResponse}
@@ -47,7 +47,7 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
47
47
 
48
48
  /**
49
49
  * Create a new embedder
50
- * Creates a new embedder configuration for vectorizing content. Embedders represent connections to different embedding API services (like OpenAI, vLLM, etc.) and include all the necessary configuration to use them with memory spaces.
50
+ * Creates a new embedder configuration for vectorizing content. Embedders represent connections to different embedding API services (like OpenAI, vLLM, etc.) and include all the necessary configuration to use them with memory spaces. DUPLICATE DETECTION: Returns ALREADY_EXISTS if another embedder exists with identical {owner_id, provider_type, endpoint_url, api_path, model_identifier, credentials_fingerprint} after URL canonicalization. Uniqueness is enforced per-owner, allowing different users to have identical configurations. Credentials are hashed (SHA-256) for uniqueness while remaining encrypted. The api_path field defaults to '/embeddings' if omitted. Requires CREATE_EMBEDDER_OWN permission (or CREATE_EMBEDDER_ANY for admin users).
51
51
  * @param {module:model/EmbedderCreationRequest} embedderCreationRequest Embedder configuration details
52
52
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/EmbedderResponse} and HTTP response
53
53
  */
@@ -72,7 +72,7 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
72
72
 
73
73
  /**
74
74
  * Create a new embedder
75
- * Creates a new embedder configuration for vectorizing content. Embedders represent connections to different embedding API services (like OpenAI, vLLM, etc.) and include all the necessary configuration to use them with memory spaces.
75
+ * Creates a new embedder configuration for vectorizing content. Embedders represent connections to different embedding API services (like OpenAI, vLLM, etc.) and include all the necessary configuration to use them with memory spaces. DUPLICATE DETECTION: Returns ALREADY_EXISTS if another embedder exists with identical {owner_id, provider_type, endpoint_url, api_path, model_identifier, credentials_fingerprint} after URL canonicalization. Uniqueness is enforced per-owner, allowing different users to have identical configurations. Credentials are hashed (SHA-256) for uniqueness while remaining encrypted. The api_path field defaults to '/embeddings' if omitted. Requires CREATE_EMBEDDER_OWN permission (or CREATE_EMBEDDER_ANY for admin users).
76
76
  * @param {module:model/EmbedderCreationRequest} embedderCreationRequest Embedder configuration details
77
77
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EmbedderResponse}
78
78
  */
@@ -86,7 +86,7 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
86
86
 
87
87
  /**
88
88
  * Delete an embedder
89
- * Deletes an embedder configuration. This operation cannot be undone.
89
+ * Permanently deletes an embedder configuration. This operation cannot be undone and removes the embedder record and securely deletes stored credentials. IMPORTANT: This does NOT invalidate or delete embeddings previously created with this embedder - existing embeddings remain accessible. Requires DELETE_EMBEDDER_OWN permission for embedders you own (or DELETE_EMBEDDER_ANY for admin users).
90
90
  * @param {String} id The unique identifier of the embedder to delete
91
91
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
92
92
  */
@@ -113,7 +113,7 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
113
113
 
114
114
  /**
115
115
  * Delete an embedder
116
- * Deletes an embedder configuration. This operation cannot be undone.
116
+ * Permanently deletes an embedder configuration. This operation cannot be undone and removes the embedder record and securely deletes stored credentials. IMPORTANT: This does NOT invalidate or delete embeddings previously created with this embedder - existing embeddings remain accessible. Requires DELETE_EMBEDDER_OWN permission for embedders you own (or DELETE_EMBEDDER_ANY for admin users).
117
117
  * @param {String} id The unique identifier of the embedder to delete
118
118
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}
119
119
  */
@@ -127,7 +127,7 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
127
127
 
128
128
  /**
129
129
  * Get an embedder by ID
130
- * Retrieves the details of a specific embedder configuration by its unique identifier.
130
+ * Retrieves the details of a specific embedder configuration by its unique identifier. Requires READ_EMBEDDER_OWN permission for embedders you own (or READ_EMBEDDER_ANY for admin users to view any user's embedders). This is a read-only operation with no side effects.
131
131
  * @param {String} id The unique identifier of the embedder to retrieve
132
132
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/EmbedderResponse} and HTTP response
133
133
  */
@@ -154,7 +154,7 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
154
154
 
155
155
  /**
156
156
  * Get an embedder by ID
157
- * Retrieves the details of a specific embedder configuration by its unique identifier.
157
+ * Retrieves the details of a specific embedder configuration by its unique identifier. Requires READ_EMBEDDER_OWN permission for embedders you own (or READ_EMBEDDER_ANY for admin users to view any user's embedders). This is a read-only operation with no side effects.
158
158
  * @param {String} id The unique identifier of the embedder to retrieve
159
159
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EmbedderResponse}
160
160
  */
@@ -168,9 +168,9 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
168
168
 
169
169
  /**
170
170
  * List embedders
171
- * Retrieves a list of embedder configurations accessible to the caller, with optional filtering.
171
+ * Retrieves a list of embedder configurations accessible to the caller, with optional filtering. PERMISSION-BASED FILTERING: With LIST_EMBEDDER_OWN permission, you can only see your own embedders (owner_id filter is ignored if set to another user). With LIST_EMBEDDER_ANY permission, you can see all embedders or filter by any owner_id. This is a read-only operation with no side effects.
172
172
  * @param {Object} opts Optional parameters
173
- * @param {String} [ownerId] Filter embedders by owner ID. If not provided, shows embedders based on permissions.
173
+ * @param {String} [ownerId] Filter embedders by owner ID. With LIST_EMBEDDER_ANY permission, omitting this shows all accessible embedders; providing it filters by that owner. With LIST_EMBEDDER_OWN permission, only your own embedders are shown regardless of this parameter.
174
174
  * @param {String} [providerType] Filter embedders by provider type (e.g., OPENAI, OPENAI_COMPATIBLE, COHERE, etc.)
175
175
  * @param {String} [label] Filter by label value. Multiple label filters can be specified (e.g., ?label.environment=production&label.team=nlp)
176
176
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListEmbeddersResponse} and HTTP response
@@ -197,9 +197,9 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
197
197
 
198
198
  /**
199
199
  * List embedders
200
- * Retrieves a list of embedder configurations accessible to the caller, with optional filtering.
200
+ * Retrieves a list of embedder configurations accessible to the caller, with optional filtering. PERMISSION-BASED FILTERING: With LIST_EMBEDDER_OWN permission, you can only see your own embedders (owner_id filter is ignored if set to another user). With LIST_EMBEDDER_ANY permission, you can see all embedders or filter by any owner_id. This is a read-only operation with no side effects.
201
201
  * @param {Object} opts Optional parameters
202
- * @param {String} opts.ownerId Filter embedders by owner ID. If not provided, shows embedders based on permissions.
202
+ * @param {String} opts.ownerId Filter embedders by owner ID. With LIST_EMBEDDER_ANY permission, omitting this shows all accessible embedders; providing it filters by that owner. With LIST_EMBEDDER_OWN permission, only your own embedders are shown regardless of this parameter.
203
203
  * @param {String} opts.providerType Filter embedders by provider type (e.g., OPENAI, OPENAI_COMPATIBLE, COHERE, etc.)
204
204
  * @param {String} opts.label Filter by label value. Multiple label filters can be specified (e.g., ?label.environment=production&label.team=nlp)
205
205
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListEmbeddersResponse}
@@ -214,7 +214,7 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
214
214
 
215
215
  /**
216
216
  * Update an embedder
217
- * Updates an existing embedder configuration with new values for the specified fields.
217
+ * Updates an existing embedder configuration including display information, endpoint configuration, model parameters, credentials, and labels. All fields are optional - only specified fields will be updated. IMPORTANT: provider_type is IMMUTABLE after creation and cannot be changed. CRITICAL: Returns FAILED_PRECONDITION if attempting to update core fields (dimensionality, distribution_type, model_identifier) while the embedder is actively referenced by spaces or ingestion jobs. Requires UPDATE_EMBEDDER_OWN permission for embedders you own (or UPDATE_EMBEDDER_ANY for admin users).
218
218
  * @param {String} id The unique identifier of the embedder to update
219
219
  * @param {module:model/UpdateEmbedderRequest} updateEmbedderRequest Embedder update details
220
220
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/EmbedderResponse} and HTTP response
@@ -246,7 +246,7 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
246
246
 
247
247
  /**
248
248
  * Update an embedder
249
- * Updates an existing embedder configuration with new values for the specified fields.
249
+ * Updates an existing embedder configuration including display information, endpoint configuration, model parameters, credentials, and labels. All fields are optional - only specified fields will be updated. IMPORTANT: provider_type is IMMUTABLE after creation and cannot be changed. CRITICAL: Returns FAILED_PRECONDITION if attempting to update core fields (dimensionality, distribution_type, model_identifier) while the embedder is actively referenced by spaces or ingestion jobs. Requires UPDATE_EMBEDDER_OWN permission for embedders you own (or UPDATE_EMBEDDER_ANY for admin users).
250
250
  * @param {String} id The unique identifier of the embedder to update
251
251
  * @param {module:model/UpdateEmbedderRequest} updateEmbedderRequest Embedder update details
252
252
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/EmbedderResponse}
@@ -12,6 +12,7 @@ var _Memory = _interopRequireDefault(require("../model/Memory"));
12
12
  var _MemoryCreationRequest = _interopRequireDefault(require("../model/MemoryCreationRequest"));
13
13
  var _MemoryListResponse = _interopRequireDefault(require("../model/MemoryListResponse"));
14
14
  var _RetrieveMemoryEvent = _interopRequireDefault(require("../model/RetrieveMemoryEvent"));
15
+ var _RetrieveMemoryRequest = _interopRequireDefault(require("../model/RetrieveMemoryRequest"));
15
16
  function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
16
17
  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); }
17
18
  function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
@@ -167,7 +168,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
167
168
 
168
169
  /**
169
170
  * Create a new memory
170
- * Creates a new memory with the provided content reference, metadata, and space assignment.
171
+ * Creates a new memory in a specified space and starts asynchronous processing. The memory begins in PENDING status while a background job performs chunking and embedding generation. IMPORTANT: This operation is NOT idempotent - each request creates a new memory record. Returns INVALID_ARGUMENT if space_id, original_content, or content_type is missing or invalid. Returns NOT_FOUND if the specified space does not exist. Requires CREATE_MEMORY_OWN permission for spaces you own (or CREATE_MEMORY_ANY for admin users to create in any space). Side effects include creating the memory record, generating a unique UUID, and enqueuing a background processing job.
171
172
  * @param {module:model/MemoryCreationRequest} memoryCreationRequest Memory creation details
172
173
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Memory} and HTTP response
173
174
  */
@@ -192,7 +193,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
192
193
 
193
194
  /**
194
195
  * Create a new memory
195
- * Creates a new memory with the provided content reference, metadata, and space assignment.
196
+ * Creates a new memory in a specified space and starts asynchronous processing. The memory begins in PENDING status while a background job performs chunking and embedding generation. IMPORTANT: This operation is NOT idempotent - each request creates a new memory record. Returns INVALID_ARGUMENT if space_id, original_content, or content_type is missing or invalid. Returns NOT_FOUND if the specified space does not exist. Requires CREATE_MEMORY_OWN permission for spaces you own (or CREATE_MEMORY_ANY for admin users to create in any space). Side effects include creating the memory record, generating a unique UUID, and enqueuing a background processing job.
196
197
  * @param {module:model/MemoryCreationRequest} memoryCreationRequest Memory creation details
197
198
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Memory}
198
199
  */
@@ -206,7 +207,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
206
207
 
207
208
  /**
208
209
  * Delete a memory
209
- * Deletes a memory. This operation cannot be undone.
210
+ * Permanently deletes a memory and its associated chunks. This operation cannot be undone and immediately removes the memory record from the database. IDEMPOTENCY: This operation is safe to retry - may return NOT_FOUND if the memory was already deleted or never existed. Requires DELETE_MEMORY_OWN permission for memories in spaces you own (or DELETE_MEMORY_ANY for admin users to delete any memory). Side effects include permanent removal of the memory record and all associated chunk data.
210
211
  * @param {String} id The unique identifier of the memory to delete
211
212
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
212
213
  */
@@ -233,7 +234,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
233
234
 
234
235
  /**
235
236
  * Delete a memory
236
- * Deletes a memory. This operation cannot be undone.
237
+ * Permanently deletes a memory and its associated chunks. This operation cannot be undone and immediately removes the memory record from the database. IDEMPOTENCY: This operation is safe to retry - may return NOT_FOUND if the memory was already deleted or never existed. Requires DELETE_MEMORY_OWN permission for memories in spaces you own (or DELETE_MEMORY_ANY for admin users to delete any memory). Side effects include permanent removal of the memory record and all associated chunk data.
237
238
  * @param {String} id The unique identifier of the memory to delete
238
239
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}
239
240
  */
@@ -247,13 +248,16 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
247
248
 
248
249
  /**
249
250
  * Get a memory by ID
250
- * Retrieves a specific memory by its unique identifier.
251
+ * Retrieves a single memory by its ID. PERMISSION CLARIFICATION: With READ_MEMORY_OWN permission, access is granted if you own the parent space OR if the parent space is public (public_read=true). With READ_MEMORY_ANY permission, you can access any memory regardless of ownership. This is a read-only operation with no side effects and is safe to retry. Returns NOT_FOUND if the memory or its parent space does not exist.
251
252
  * @param {String} id The unique identifier of the memory to retrieve
253
+ * @param {Object} opts Optional parameters
254
+ * @param {Boolean} [includeContent] Whether to include the original content in the response (defaults to false)
252
255
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Memory} and HTTP response
253
256
  */
254
257
  }, {
255
258
  key: "getMemoryWithHttpInfo",
256
- value: function getMemoryWithHttpInfo(id) {
259
+ value: function getMemoryWithHttpInfo(id, opts) {
260
+ opts = opts || {};
257
261
  var postBody = null;
258
262
  // verify the required parameter 'id' is set
259
263
  if (id === undefined || id === null) {
@@ -262,7 +266,9 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
262
266
  var pathParams = {
263
267
  'id': id
264
268
  };
265
- var queryParams = {};
269
+ var queryParams = {
270
+ 'includeContent': opts['includeContent']
271
+ };
266
272
  var headerParams = {};
267
273
  var formParams = {};
268
274
  var authNames = [];
@@ -274,27 +280,37 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
274
280
 
275
281
  /**
276
282
  * Get a memory by ID
277
- * Retrieves a specific memory by its unique identifier.
283
+ * Retrieves a single memory by its ID. PERMISSION CLARIFICATION: With READ_MEMORY_OWN permission, access is granted if you own the parent space OR if the parent space is public (public_read=true). With READ_MEMORY_ANY permission, you can access any memory regardless of ownership. This is a read-only operation with no side effects and is safe to retry. Returns NOT_FOUND if the memory or its parent space does not exist.
278
284
  * @param {String} id The unique identifier of the memory to retrieve
285
+ * @param {Object} opts Optional parameters
286
+ * @param {Boolean} opts.includeContent Whether to include the original content in the response (defaults to false)
279
287
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Memory}
280
288
  */
281
289
  }, {
282
290
  key: "getMemory",
283
- value: function getMemory(id) {
284
- return this.getMemoryWithHttpInfo(id).then(function (response_and_data) {
291
+ value: function getMemory(id, opts) {
292
+ return this.getMemoryWithHttpInfo(id, opts).then(function (response_and_data) {
285
293
  return response_and_data.data;
286
294
  });
287
295
  }
288
296
 
289
297
  /**
290
298
  * List memories in a space
291
- * Retrieves a list of memories contained within a specific space.
299
+ * Lists all memories within a given space. CRITICAL: The current server implementation does NOT support pagination - the max_results and next_token parameters are IGNORED and all matching memories are returned. This is a read-only operation with no side effects and is safe to retry. Requires LIST_MEMORY_OWN or LIST_MEMORY_ANY permission. Returns NOT_FOUND if the specified space does not exist.
292
300
  * @param {String} spaceId The unique identifier of the space containing the memories
301
+ * @param {Object} opts Optional parameters
302
+ * @param {Boolean} [includeContent] Whether to include the original content in the response (defaults to false)
303
+ * @param {String} [statusFilter] Filter memories by processing status (PENDING, PROCESSING, COMPLETED, FAILED)
304
+ * @param {Number} [maxResults] IGNORED: The current server implementation does not support pagination for this endpoint. This parameter is documented for future compatibility but will be ignored.
305
+ * @param {String} [nextToken] IGNORED: The current server implementation does not support pagination for this endpoint. This parameter is documented for future compatibility but will be ignored.
306
+ * @param {String} [sortBy] Field to sort by (e.g., 'created_at')
307
+ * @param {String} [sortOrder] Sort direction (ASCENDING or DESCENDING)
293
308
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/MemoryListResponse} and HTTP response
294
309
  */
295
310
  }, {
296
311
  key: "listMemoriesWithHttpInfo",
297
- value: function listMemoriesWithHttpInfo(spaceId) {
312
+ value: function listMemoriesWithHttpInfo(spaceId, opts) {
313
+ opts = opts || {};
298
314
  var postBody = null;
299
315
  // verify the required parameter 'spaceId' is set
300
316
  if (spaceId === undefined || spaceId === null) {
@@ -303,7 +319,14 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
303
319
  var pathParams = {
304
320
  'spaceId': spaceId
305
321
  };
306
- var queryParams = {};
322
+ var queryParams = {
323
+ 'includeContent': opts['includeContent'],
324
+ 'statusFilter': opts['statusFilter'],
325
+ 'maxResults': opts['maxResults'],
326
+ 'nextToken': opts['nextToken'],
327
+ 'sortBy': opts['sortBy'],
328
+ 'sortOrder': opts['sortOrder']
329
+ };
307
330
  var headerParams = {};
308
331
  var formParams = {};
309
332
  var authNames = [];
@@ -315,14 +338,21 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
315
338
 
316
339
  /**
317
340
  * List memories in a space
318
- * Retrieves a list of memories contained within a specific space.
341
+ * Lists all memories within a given space. CRITICAL: The current server implementation does NOT support pagination - the max_results and next_token parameters are IGNORED and all matching memories are returned. This is a read-only operation with no side effects and is safe to retry. Requires LIST_MEMORY_OWN or LIST_MEMORY_ANY permission. Returns NOT_FOUND if the specified space does not exist.
319
342
  * @param {String} spaceId The unique identifier of the space containing the memories
343
+ * @param {Object} opts Optional parameters
344
+ * @param {Boolean} opts.includeContent Whether to include the original content in the response (defaults to false)
345
+ * @param {String} opts.statusFilter Filter memories by processing status (PENDING, PROCESSING, COMPLETED, FAILED)
346
+ * @param {Number} opts.maxResults IGNORED: The current server implementation does not support pagination for this endpoint. This parameter is documented for future compatibility but will be ignored.
347
+ * @param {String} opts.nextToken IGNORED: The current server implementation does not support pagination for this endpoint. This parameter is documented for future compatibility but will be ignored.
348
+ * @param {String} opts.sortBy Field to sort by (e.g., 'created_at')
349
+ * @param {String} opts.sortOrder Sort direction (ASCENDING or DESCENDING)
320
350
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MemoryListResponse}
321
351
  */
322
352
  }, {
323
353
  key: "listMemories",
324
- value: function listMemories(spaceId) {
325
- return this.listMemoriesWithHttpInfo(spaceId).then(function (response_and_data) {
354
+ value: function listMemories(spaceId, opts) {
355
+ return this.listMemoriesWithHttpInfo(spaceId, opts).then(function (response_and_data) {
326
356
  return response_and_data.data;
327
357
  });
328
358
  }
@@ -336,7 +366,12 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
336
366
  * @param {Number} [requestedSize] Maximum number of memories to retrieve
337
367
  * @param {Boolean} [fetchMemory] Whether to fetch memory definitions (defaults to true)
338
368
  * @param {Boolean} [fetchMemoryContent] Whether to fetch original content for memories (defaults to false)
339
- * @param {Boolean} [generateAbstract] Whether to generate an abstract summary (defaults to true)
369
+ * @param {String} [ppRerankerId] UUID of reranker to use for ChatPostProcessor (enables post-processing)
370
+ * @param {String} [ppLlmId] UUID of LLM to use for ChatPostProcessor generation
371
+ * @param {Number} [ppRelevanceThreshold] Minimum relevance score for ChatPostProcessor (default: 0.5)
372
+ * @param {Number} [ppLlmTemp] LLM temperature for ChatPostProcessor generation (default: 0.3)
373
+ * @param {Number} [ppMaxResults] Maximum results for ChatPostProcessor (default: 10)
374
+ * @param {Boolean} [ppChronologicalResort] Whether ChatPostProcessor should resort by creation time (default: true)
340
375
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetrieveMemoryEvent} and HTTP response
341
376
  */
342
377
  }, {
@@ -355,7 +390,12 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
355
390
  'requestedSize': opts['requestedSize'],
356
391
  'fetchMemory': opts['fetchMemory'],
357
392
  'fetchMemoryContent': opts['fetchMemoryContent'],
358
- 'generateAbstract': opts['generateAbstract']
393
+ 'pp_reranker_id': opts['ppRerankerId'],
394
+ 'pp_llm_id': opts['ppLlmId'],
395
+ 'pp_relevance_threshold': opts['ppRelevanceThreshold'],
396
+ 'pp_llm_temp': opts['ppLlmTemp'],
397
+ 'pp_max_results': opts['ppMaxResults'],
398
+ 'pp_chronological_resort': opts['ppChronologicalResort']
359
399
  };
360
400
  var headerParams = {};
361
401
  var formParams = {};
@@ -375,7 +415,12 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
375
415
  * @param {Number} opts.requestedSize Maximum number of memories to retrieve
376
416
  * @param {Boolean} opts.fetchMemory Whether to fetch memory definitions (defaults to true)
377
417
  * @param {Boolean} opts.fetchMemoryContent Whether to fetch original content for memories (defaults to false)
378
- * @param {Boolean} opts.generateAbstract Whether to generate an abstract summary (defaults to true)
418
+ * @param {String} opts.ppRerankerId UUID of reranker to use for ChatPostProcessor (enables post-processing)
419
+ * @param {String} opts.ppLlmId UUID of LLM to use for ChatPostProcessor generation
420
+ * @param {Number} opts.ppRelevanceThreshold Minimum relevance score for ChatPostProcessor (default: 0.5)
421
+ * @param {Number} opts.ppLlmTemp LLM temperature for ChatPostProcessor generation (default: 0.3)
422
+ * @param {Number} opts.ppMaxResults Maximum results for ChatPostProcessor (default: 10)
423
+ * @param {Boolean} opts.ppChronologicalResort Whether ChatPostProcessor should resort by creation time (default: true)
379
424
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetrieveMemoryEvent}
380
425
  */
381
426
  }, {
@@ -385,5 +430,44 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
385
430
  return response_and_data.data;
386
431
  });
387
432
  }
433
+
434
+ /**
435
+ * Advanced semantic memory retrieval with JSON
436
+ * Streams semantic retrieval results with full feature support including context items and embedder weight overrides. Supports SSE (text/event-stream) and NDJSON (application/x-ndjson) formats.
437
+ * @param {module:model/RetrieveMemoryRequest} retrieveMemoryRequest Request body with query, context, and space configurations
438
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
439
+ */
440
+ }, {
441
+ key: "retrieveMemoryAdvancedWithHttpInfo",
442
+ value: function retrieveMemoryAdvancedWithHttpInfo(retrieveMemoryRequest) {
443
+ var postBody = retrieveMemoryRequest;
444
+ // verify the required parameter 'retrieveMemoryRequest' is set
445
+ if (retrieveMemoryRequest === undefined || retrieveMemoryRequest === null) {
446
+ throw new Error("Missing the required parameter 'retrieveMemoryRequest' when calling retrieveMemoryAdvanced");
447
+ }
448
+ var pathParams = {};
449
+ var queryParams = {};
450
+ var headerParams = {};
451
+ var formParams = {};
452
+ var authNames = [];
453
+ var contentTypes = ['application/json'];
454
+ var accepts = ['application/x-ndjson', 'text/event-stream'];
455
+ var returnType = null;
456
+ return this.apiClient.callApi('/v1/memories/retrieve', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
457
+ }
458
+
459
+ /**
460
+ * Advanced semantic memory retrieval with JSON
461
+ * Streams semantic retrieval results with full feature support including context items and embedder weight overrides. Supports SSE (text/event-stream) and NDJSON (application/x-ndjson) formats.
462
+ * @param {module:model/RetrieveMemoryRequest} retrieveMemoryRequest Request body with query, context, and space configurations
463
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}
464
+ */
465
+ }, {
466
+ key: "retrieveMemoryAdvanced",
467
+ value: function retrieveMemoryAdvanced(retrieveMemoryRequest) {
468
+ return this.retrieveMemoryAdvancedWithHttpInfo(retrieveMemoryRequest).then(function (response_and_data) {
469
+ return response_and_data.data;
470
+ });
471
+ }
388
472
  }]);
389
473
  }();
@@ -47,7 +47,7 @@ var RerankersApi = exports["default"] = /*#__PURE__*/function () {
47
47
 
48
48
  /**
49
49
  * Create a new reranker
50
- * Creates a new reranker configuration for ranking search results. Rerankers represent connections to different reranking API services (like TEI, OpenAI, etc.) and include all the necessary configuration to use them for result ranking.
50
+ * Creates a new reranker configuration for ranking search results. Rerankers represent connections to different reranking API services (like TEI, OpenAI, etc.) and include all the necessary configuration to use them for result ranking. DUPLICATE DETECTION: Returns ALREADY_EXISTS if another reranker exists with identical {owner_id, provider_type, endpoint_url, api_path, model_identifier, credentials_fingerprint} after URL canonicalization. Uniqueness is enforced per-owner, allowing different users to have identical configurations. Credentials are hashed (SHA-256) for uniqueness while remaining encrypted. DEFAULTS: api_path defaults to '/rerank' if omitted; supported_modalities defaults to [TEXT] if omitted. Requires CREATE_RERANKER_OWN permission (or CREATE_RERANKER_ANY for admin users). This operation is NOT idempotent - each request creates a new reranker record.
51
51
  * @param {module:model/RerankerCreationRequest} rerankerCreationRequest Reranker configuration details
52
52
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RerankerResponse} and HTTP response
53
53
  */
@@ -72,7 +72,7 @@ var RerankersApi = exports["default"] = /*#__PURE__*/function () {
72
72
 
73
73
  /**
74
74
  * Create a new reranker
75
- * Creates a new reranker configuration for ranking search results. Rerankers represent connections to different reranking API services (like TEI, OpenAI, etc.) and include all the necessary configuration to use them for result ranking.
75
+ * Creates a new reranker configuration for ranking search results. Rerankers represent connections to different reranking API services (like TEI, OpenAI, etc.) and include all the necessary configuration to use them for result ranking. DUPLICATE DETECTION: Returns ALREADY_EXISTS if another reranker exists with identical {owner_id, provider_type, endpoint_url, api_path, model_identifier, credentials_fingerprint} after URL canonicalization. Uniqueness is enforced per-owner, allowing different users to have identical configurations. Credentials are hashed (SHA-256) for uniqueness while remaining encrypted. DEFAULTS: api_path defaults to '/rerank' if omitted; supported_modalities defaults to [TEXT] if omitted. Requires CREATE_RERANKER_OWN permission (or CREATE_RERANKER_ANY for admin users). This operation is NOT idempotent - each request creates a new reranker record.
76
76
  * @param {module:model/RerankerCreationRequest} rerankerCreationRequest Reranker configuration details
77
77
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RerankerResponse}
78
78
  */
@@ -86,7 +86,7 @@ var RerankersApi = exports["default"] = /*#__PURE__*/function () {
86
86
 
87
87
  /**
88
88
  * Delete a reranker
89
- * Deletes an existing reranker configuration. This action cannot be undone.
89
+ * Permanently deletes a reranker configuration. This operation cannot be undone and immediately removes the reranker record from the database. SIDE EFFECTS: Invalidates any cached references to this reranker; does not affect historical usage data or audit logs. Requires DELETE_RERANKER_OWN permission for rerankers you own (or DELETE_RERANKER_ANY for admin users). This operation is safe to retry - may return NOT_FOUND if already deleted.
90
90
  * @param {String} id The unique identifier of the reranker to delete
91
91
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
92
92
  */
@@ -113,7 +113,7 @@ var RerankersApi = exports["default"] = /*#__PURE__*/function () {
113
113
 
114
114
  /**
115
115
  * Delete a reranker
116
- * Deletes an existing reranker configuration. This action cannot be undone.
116
+ * Permanently deletes a reranker configuration. This operation cannot be undone and immediately removes the reranker record from the database. SIDE EFFECTS: Invalidates any cached references to this reranker; does not affect historical usage data or audit logs. Requires DELETE_RERANKER_OWN permission for rerankers you own (or DELETE_RERANKER_ANY for admin users). This operation is safe to retry - may return NOT_FOUND if already deleted.
117
117
  * @param {String} id The unique identifier of the reranker to delete
118
118
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}
119
119
  */
@@ -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.
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.
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.
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.
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,9 +168,9 @@ 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.
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 owner_id. Specifying owner_id without LIST_RERANKER_ANY permission returns PERMISSION_DENIED.
172
172
  * @param {Object} opts Optional parameters
173
- * @param {String} [ownerId] Filter rerankers by owner ID. If not provided, shows rerankers based on permissions.
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.)
175
175
  * @param {String} [label] Filter by label value. Multiple label filters can be specified (e.g., ?label.environment=production&label.team=search)
176
176
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListRerankersResponse} and HTTP response
@@ -197,9 +197,9 @@ 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.
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 owner_id. Specifying owner_id without LIST_RERANKER_ANY permission returns PERMISSION_DENIED.
201
201
  * @param {Object} opts Optional parameters
202
- * @param {String} opts.ownerId Filter rerankers by owner ID. If not provided, shows rerankers based on permissions.
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.)
204
204
  * @param {String} opts.label Filter by label value. Multiple label filters can be specified (e.g., ?label.environment=production&label.team=search)
205
205
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListRerankersResponse}
@@ -214,7 +214,7 @@ var RerankersApi = exports["default"] = /*#__PURE__*/function () {
214
214
 
215
215
  /**
216
216
  * Update a reranker
217
- * Updates an existing reranker configuration. Only fields that are provided will be updated.
217
+ * Updates an existing reranker configuration including display information, endpoint configuration, model parameters, credentials, and labels. All fields are optional - only specified fields will be updated. IMMUTABLE FIELDS: provider_type and owner_id cannot be changed after creation. SUPPORTED_MODALITIES UPDATE: If the array contains ≥1 elements, it replaces the stored set; if empty or omitted, no change occurs. Returns ALREADY_EXISTS if update would create duplicate with same {endpoint_url, api_path, model_identifier}. Requires UPDATE_RERANKER_OWN permission for rerankers you own (or UPDATE_RERANKER_ANY for admin users). This operation is idempotent.
218
218
  * @param {String} id The unique identifier of the reranker to update
219
219
  * @param {module:model/UpdateRerankerRequest} updateRerankerRequest Updated reranker configuration details
220
220
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RerankerResponse} and HTTP response
@@ -246,7 +246,7 @@ var RerankersApi = exports["default"] = /*#__PURE__*/function () {
246
246
 
247
247
  /**
248
248
  * Update a reranker
249
- * Updates an existing reranker configuration. Only fields that are provided will be updated.
249
+ * Updates an existing reranker configuration including display information, endpoint configuration, model parameters, credentials, and labels. All fields are optional - only specified fields will be updated. IMMUTABLE FIELDS: provider_type and owner_id cannot be changed after creation. SUPPORTED_MODALITIES UPDATE: If the array contains ≥1 elements, it replaces the stored set; if empty or omitted, no change occurs. Returns ALREADY_EXISTS if update would create duplicate with same {endpoint_url, api_path, model_identifier}. Requires UPDATE_RERANKER_OWN permission for rerankers you own (or UPDATE_RERANKER_ANY for admin users). This operation is idempotent.
250
250
  * @param {String} id The unique identifier of the reranker to update
251
251
  * @param {module:model/UpdateRerankerRequest} updateRerankerRequest Updated reranker configuration details
252
252
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RerankerResponse}