@pairsystems/goodmem-client 1.0.5 → 1.0.7
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 +31 -2
- package/dist/api/EmbeddersApi.js +10 -10
- package/dist/api/LLMsApi.js +8 -8
- package/dist/api/MemoriesApi.js +62 -48
- package/dist/api/OCRApi.js +85 -0
- package/dist/api/PingApi.js +133 -0
- package/dist/api/RerankersApi.js +8 -8
- package/dist/api/SpacesApi.js +14 -14
- package/dist/index.js +196 -0
- package/dist/model/BatchMemoryCreationRequest.js +0 -8
- package/dist/model/BatchMemoryDeletionRequest.js +0 -8
- package/dist/model/BatchMemoryResponse.js +132 -0
- package/dist/model/BatchMemoryResult.js +151 -0
- package/dist/model/BatchMemoryRetrievalRequest.js +0 -8
- package/dist/model/BoundingBox.js +143 -0
- package/dist/model/CreateApiKeyRequest.js +13 -0
- package/dist/model/DocumentTimings.js +154 -0
- package/dist/model/EmbedderCreationRequest.js +14 -9
- package/dist/model/ErrorDetail.js +125 -0
- package/dist/model/ImageInfo.js +132 -0
- package/dist/model/LLMCreationRequest.js +20 -17
- package/dist/model/LLMResponse.js +2 -2
- package/dist/model/LLMUpdateRequest.js +1 -9
- package/dist/model/MemoryCreationRequest.js +22 -4
- package/dist/model/OcrCategory.js +118 -0
- package/dist/model/OcrCell.js +154 -0
- package/dist/model/OcrDocumentRequest.js +159 -0
- package/dist/model/OcrDocumentResponse.js +170 -0
- package/dist/model/OcrInputFormat.js +78 -0
- package/dist/model/OcrLayout.js +132 -0
- package/dist/model/OcrPage.js +173 -0
- package/dist/model/OcrPageResult.js +138 -0
- package/dist/model/PageTimings.js +143 -0
- package/dist/model/PingEndpointInfo.js +170 -0
- package/dist/model/PingEvent.js +120 -0
- package/dist/model/PingNotice.js +140 -0
- package/dist/model/PingOnceRequest.js +163 -0
- package/dist/model/PingPayloadType.js +68 -0
- package/dist/model/PingResult.js +221 -0
- package/dist/model/PingStreamRequest.js +210 -0
- package/dist/model/PingSummary.js +269 -0
- package/dist/model/PingTargetType.js +68 -0
- package/dist/model/PingTiming.js +143 -0
- package/dist/model/RerankerCreationRequest.js +14 -9
- package/dist/model/RpcStatus.js +123 -0
- package/dist/model/SpaceCreationRequest.js +20 -5
- package/dist/model/SpaceEmbedderConfig.js +5 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,8 +5,8 @@ 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.
|
|
9
|
-
- Generator version: 7.
|
|
8
|
+
- Package version: 1.0.7
|
|
9
|
+
- Generator version: 7.20.0-SNAPSHOT
|
|
10
10
|
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
|
|
11
11
|
|
|
12
12
|
## Installation
|
|
@@ -310,6 +310,9 @@ Class | Method | HTTP request | Description
|
|
|
310
310
|
*GoodMemClient.MemoriesApi* | [**listMemories**](docs/MemoriesApi.md#listMemories) | **GET** /v1/spaces/{spaceId}/memories | List memories in a space
|
|
311
311
|
*GoodMemClient.MemoriesApi* | [**retrieveMemory**](docs/MemoriesApi.md#retrieveMemory) | **GET** /v1/memories:retrieve | Stream semantic memory retrieval
|
|
312
312
|
*GoodMemClient.MemoriesApi* | [**retrieveMemoryAdvanced**](docs/MemoriesApi.md#retrieveMemoryAdvanced) | **POST** /v1/memories:retrieve | Advanced semantic memory retrieval with JSON
|
|
313
|
+
*GoodMemClient.OCRApi* | [**ocrDocument**](docs/OCRApi.md#ocrDocument) | **POST** /v1/ocr:document | Run OCR on a document or image
|
|
314
|
+
*GoodMemClient.PingApi* | [**pingOnce**](docs/PingApi.md#pingOnce) | **POST** /v1/ping:once | Run a single ping probe
|
|
315
|
+
*GoodMemClient.PingApi* | [**pingStream**](docs/PingApi.md#pingStream) | **POST** /v1/ping:stream | Stream ping probe results
|
|
313
316
|
*GoodMemClient.RerankersApi* | [**createReranker**](docs/RerankersApi.md#createReranker) | **POST** /v1/rerankers | Create a new reranker
|
|
314
317
|
*GoodMemClient.RerankersApi* | [**deleteReranker**](docs/RerankersApi.md#deleteReranker) | **DELETE** /v1/rerankers/{id} | Delete a reranker
|
|
315
318
|
*GoodMemClient.RerankersApi* | [**getReranker**](docs/RerankersApi.md#getReranker) | **GET** /v1/rerankers/{id} | Get a reranker by ID
|
|
@@ -342,8 +345,11 @@ Class | Method | HTTP request | Description
|
|
|
342
345
|
- [GoodMemClient.BackgroundJobSummary](docs/BackgroundJobSummary.md)
|
|
343
346
|
- [GoodMemClient.BatchMemoryCreationRequest](docs/BatchMemoryCreationRequest.md)
|
|
344
347
|
- [GoodMemClient.BatchMemoryDeletionRequest](docs/BatchMemoryDeletionRequest.md)
|
|
348
|
+
- [GoodMemClient.BatchMemoryResponse](docs/BatchMemoryResponse.md)
|
|
349
|
+
- [GoodMemClient.BatchMemoryResult](docs/BatchMemoryResult.md)
|
|
345
350
|
- [GoodMemClient.BatchMemoryRetrievalRequest](docs/BatchMemoryRetrievalRequest.md)
|
|
346
351
|
- [GoodMemClient.BinaryContent](docs/BinaryContent.md)
|
|
352
|
+
- [GoodMemClient.BoundingBox](docs/BoundingBox.md)
|
|
347
353
|
- [GoodMemClient.ChunkReference](docs/ChunkReference.md)
|
|
348
354
|
- [GoodMemClient.ChunkingConfiguration](docs/ChunkingConfiguration.md)
|
|
349
355
|
- [GoodMemClient.ContextItem](docs/ContextItem.md)
|
|
@@ -352,12 +358,15 @@ Class | Method | HTTP request | Description
|
|
|
352
358
|
- [GoodMemClient.CreateLLMResponse](docs/CreateLLMResponse.md)
|
|
353
359
|
- [GoodMemClient.CredentialKind](docs/CredentialKind.md)
|
|
354
360
|
- [GoodMemClient.DistributionType](docs/DistributionType.md)
|
|
361
|
+
- [GoodMemClient.DocumentTimings](docs/DocumentTimings.md)
|
|
355
362
|
- [GoodMemClient.EmbedderCreationRequest](docs/EmbedderCreationRequest.md)
|
|
356
363
|
- [GoodMemClient.EmbedderResponse](docs/EmbedderResponse.md)
|
|
357
364
|
- [GoodMemClient.EmbedderWeight](docs/EmbedderWeight.md)
|
|
358
365
|
- [GoodMemClient.EndpointAuthentication](docs/EndpointAuthentication.md)
|
|
366
|
+
- [GoodMemClient.ErrorDetail](docs/ErrorDetail.md)
|
|
359
367
|
- [GoodMemClient.GcpAdcAuth](docs/GcpAdcAuth.md)
|
|
360
368
|
- [GoodMemClient.GoodMemStatus](docs/GoodMemStatus.md)
|
|
369
|
+
- [GoodMemClient.ImageInfo](docs/ImageInfo.md)
|
|
361
370
|
- [GoodMemClient.LLMCapabilities](docs/LLMCapabilities.md)
|
|
362
371
|
- [GoodMemClient.LLMCreationRequest](docs/LLMCreationRequest.md)
|
|
363
372
|
- [GoodMemClient.LLMProviderType](docs/LLMProviderType.md)
|
|
@@ -375,6 +384,25 @@ Class | Method | HTTP request | Description
|
|
|
375
384
|
- [GoodMemClient.MemoryCreationRequest](docs/MemoryCreationRequest.md)
|
|
376
385
|
- [GoodMemClient.MemoryListResponse](docs/MemoryListResponse.md)
|
|
377
386
|
- [GoodMemClient.Modality](docs/Modality.md)
|
|
387
|
+
- [GoodMemClient.OcrCategory](docs/OcrCategory.md)
|
|
388
|
+
- [GoodMemClient.OcrCell](docs/OcrCell.md)
|
|
389
|
+
- [GoodMemClient.OcrDocumentRequest](docs/OcrDocumentRequest.md)
|
|
390
|
+
- [GoodMemClient.OcrDocumentResponse](docs/OcrDocumentResponse.md)
|
|
391
|
+
- [GoodMemClient.OcrInputFormat](docs/OcrInputFormat.md)
|
|
392
|
+
- [GoodMemClient.OcrLayout](docs/OcrLayout.md)
|
|
393
|
+
- [GoodMemClient.OcrPage](docs/OcrPage.md)
|
|
394
|
+
- [GoodMemClient.OcrPageResult](docs/OcrPageResult.md)
|
|
395
|
+
- [GoodMemClient.PageTimings](docs/PageTimings.md)
|
|
396
|
+
- [GoodMemClient.PingEndpointInfo](docs/PingEndpointInfo.md)
|
|
397
|
+
- [GoodMemClient.PingEvent](docs/PingEvent.md)
|
|
398
|
+
- [GoodMemClient.PingNotice](docs/PingNotice.md)
|
|
399
|
+
- [GoodMemClient.PingOnceRequest](docs/PingOnceRequest.md)
|
|
400
|
+
- [GoodMemClient.PingPayloadType](docs/PingPayloadType.md)
|
|
401
|
+
- [GoodMemClient.PingResult](docs/PingResult.md)
|
|
402
|
+
- [GoodMemClient.PingStreamRequest](docs/PingStreamRequest.md)
|
|
403
|
+
- [GoodMemClient.PingSummary](docs/PingSummary.md)
|
|
404
|
+
- [GoodMemClient.PingTargetType](docs/PingTargetType.md)
|
|
405
|
+
- [GoodMemClient.PingTiming](docs/PingTiming.md)
|
|
378
406
|
- [GoodMemClient.PostProcessor](docs/PostProcessor.md)
|
|
379
407
|
- [GoodMemClient.ProcessingHistory](docs/ProcessingHistory.md)
|
|
380
408
|
- [GoodMemClient.ProviderType](docs/ProviderType.md)
|
|
@@ -385,6 +413,7 @@ Class | Method | HTTP request | Description
|
|
|
385
413
|
- [GoodMemClient.RetrieveMemoryEvent](docs/RetrieveMemoryEvent.md)
|
|
386
414
|
- [GoodMemClient.RetrieveMemoryRequest](docs/RetrieveMemoryRequest.md)
|
|
387
415
|
- [GoodMemClient.RetrievedItem](docs/RetrievedItem.md)
|
|
416
|
+
- [GoodMemClient.RpcStatus](docs/RpcStatus.md)
|
|
388
417
|
- [GoodMemClient.SecretReference](docs/SecretReference.md)
|
|
389
418
|
- [GoodMemClient.SentenceChunkingConfiguration](docs/SentenceChunkingConfiguration.md)
|
|
390
419
|
- [GoodMemClient.SeparatorKeepStrategy](docs/SeparatorKeepStrategy.md)
|
package/dist/api/EmbeddersApi.js
CHANGED
|
@@ -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. DUPLICATE DETECTION: Returns ALREADY_EXISTS if another embedder exists with identical {
|
|
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 HTTP 409 Conflict (ALREADY_EXISTS) if another embedder exists with identical {ownerId, providerType, endpointUrl, apiPath, modelIdentifier, credentialsFingerprint} 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 apiPath field defaults to '/v2/embed' for Cohere, '/embed' for TEI, and '/embeddings' for other providers when 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. DUPLICATE DETECTION: Returns ALREADY_EXISTS if another embedder exists with identical {
|
|
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 HTTP 409 Conflict (ALREADY_EXISTS) if another embedder exists with identical {ownerId, providerType, endpointUrl, apiPath, modelIdentifier, credentialsFingerprint} 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 apiPath field defaults to '/v2/embed' for Cohere, '/embed' for TEI, and '/embeddings' for other providers when 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
|
-
* 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).
|
|
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. CONFLICT: Returns HTTP 409 Conflict if the embedder is still referenced by a space. 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
|
-
* 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).
|
|
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. CONFLICT: Returns HTTP 409 Conflict if the embedder is still referenced by a space. 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
|
*/
|
|
@@ -168,7 +168,7 @@ 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. PERMISSION-BASED FILTERING: With LIST_EMBEDDER_OWN permission, you can only see your own embedders (
|
|
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 (ownerId filter is ignored if set to another user). With LIST_EMBEDDER_ANY permission, you can see all embedders or filter by any ownerId. This is a read-only operation with no side effects.
|
|
172
172
|
* @param {Object} opts Optional parameters
|
|
173
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.)
|
|
@@ -182,8 +182,8 @@ var EmbeddersApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
182
182
|
var postBody = null;
|
|
183
183
|
var pathParams = {};
|
|
184
184
|
var queryParams = {
|
|
185
|
-
'
|
|
186
|
-
'
|
|
185
|
+
'ownerId': opts['ownerId'],
|
|
186
|
+
'providerType': opts['providerType'],
|
|
187
187
|
'label.*': opts['label']
|
|
188
188
|
};
|
|
189
189
|
var headerParams = {};
|
|
@@ -197,7 +197,7 @@ 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. PERMISSION-BASED FILTERING: With LIST_EMBEDDER_OWN permission, you can only see your own embedders (
|
|
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 (ownerId filter is ignored if set to another user). With LIST_EMBEDDER_ANY permission, you can see all embedders or filter by any ownerId. This is a read-only operation with no side effects.
|
|
201
201
|
* @param {Object} opts Optional parameters
|
|
202
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.)
|
|
@@ -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 including display information, endpoint configuration, model parameters, credentials, and labels. All fields are optional - only specified fields will be updated. IMPORTANT:
|
|
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: providerType is IMMUTABLE after creation and cannot be changed. CRITICAL: Returns HTTP 412 Precondition Failed (FAILED_PRECONDITION) if attempting to update core fields (dimensionality, distributionType, modelIdentifier) while the embedder is actively referenced by spaces or ingestion jobs. DUPLICATE DETECTION: Returns HTTP 409 Conflict (ALREADY_EXISTS) if the update would create a duplicate embedder with the same provider, endpoint, model, dimensionality, distribution, and credentials for this owner. 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 including display information, endpoint configuration, model parameters, credentials, and labels. All fields are optional - only specified fields will be updated. IMPORTANT:
|
|
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: providerType is IMMUTABLE after creation and cannot be changed. CRITICAL: Returns HTTP 412 Precondition Failed (FAILED_PRECONDITION) if attempting to update core fields (dimensionality, distributionType, modelIdentifier) while the embedder is actively referenced by spaces or ingestion jobs. DUPLICATE DETECTION: Returns HTTP 409 Conflict (ALREADY_EXISTS) if the update would create a duplicate embedder with the same provider, endpoint, model, dimensionality, distribution, and credentials for this owner. 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}
|
package/dist/api/LLMsApi.js
CHANGED
|
@@ -48,7 +48,7 @@ var LLMsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
48
48
|
|
|
49
49
|
/**
|
|
50
50
|
* Create a new LLM
|
|
51
|
-
* Creates a new LLM configuration for text generation services. LLMs represent connections to different language model API services (like OpenAI, vLLM, etc.) and include all the necessary configuration to use them for text generation. DUPLICATE DETECTION: Returns ALREADY_EXISTS if another LLM exists with identical {
|
|
51
|
+
* Creates a new LLM configuration for text generation services. LLMs represent connections to different language model API services (like OpenAI, vLLM, etc.) and include all the necessary configuration to use them for text generation. DUPLICATE DETECTION: Returns HTTP 409 Conflict (ALREADY_EXISTS) if another LLM exists with identical {ownerId, providerType, endpointUrl, apiPath, modelIdentifier, credentialsFingerprint} after URL canonicalization. Uniqueness is enforced per-owner. Credentials are hashed (SHA-256) for uniqueness while remaining encrypted. The apiPath field defaults to '/chat/completions' if omitted. Requires CREATE_LLM_OWN permission (or CREATE_LLM_ANY for admin users).
|
|
52
52
|
* @param {module:model/LLMCreationRequest} lLMCreationRequest LLM configuration details
|
|
53
53
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateLLMResponse} and HTTP response
|
|
54
54
|
*/
|
|
@@ -73,7 +73,7 @@ var LLMsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
73
73
|
|
|
74
74
|
/**
|
|
75
75
|
* Create a new LLM
|
|
76
|
-
* Creates a new LLM configuration for text generation services. LLMs represent connections to different language model API services (like OpenAI, vLLM, etc.) and include all the necessary configuration to use them for text generation. DUPLICATE DETECTION: Returns ALREADY_EXISTS if another LLM exists with identical {
|
|
76
|
+
* Creates a new LLM configuration for text generation services. LLMs represent connections to different language model API services (like OpenAI, vLLM, etc.) and include all the necessary configuration to use them for text generation. DUPLICATE DETECTION: Returns HTTP 409 Conflict (ALREADY_EXISTS) if another LLM exists with identical {ownerId, providerType, endpointUrl, apiPath, modelIdentifier, credentialsFingerprint} after URL canonicalization. Uniqueness is enforced per-owner. Credentials are hashed (SHA-256) for uniqueness while remaining encrypted. The apiPath field defaults to '/chat/completions' if omitted. Requires CREATE_LLM_OWN permission (or CREATE_LLM_ANY for admin users).
|
|
77
77
|
* @param {module:model/LLMCreationRequest} lLMCreationRequest LLM configuration details
|
|
78
78
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateLLMResponse}
|
|
79
79
|
*/
|
|
@@ -169,7 +169,7 @@ var LLMsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
169
169
|
|
|
170
170
|
/**
|
|
171
171
|
* List LLMs
|
|
172
|
-
* Retrieves a list of LLM configurations accessible to the caller, with optional filtering. PERMISSION-BASED FILTERING: With LIST_LLM_OWN permission, you can only see your own LLMs (
|
|
172
|
+
* Retrieves a list of LLM configurations accessible to the caller, with optional filtering. PERMISSION-BASED FILTERING: With LIST_LLM_OWN permission, you can only see your own LLMs (ownerId filter is ignored if set to another user). With LIST_LLM_ANY permission, you can see all LLMs or filter by any ownerId. This is a read-only operation with no side effects.
|
|
173
173
|
* @param {Object} opts Optional parameters
|
|
174
174
|
* @param {String} [ownerId] Filter LLMs by owner ID. With LIST_LLM_ANY permission, omitting this shows all accessible LLMs; providing it filters by that owner. With LIST_LLM_OWN permission, only your own LLMs are shown regardless of this parameter.
|
|
175
175
|
* @param {String} [providerType] Filter LLMs by provider type (e.g., OPENAI, VLLM, OLLAMA, etc.)
|
|
@@ -183,8 +183,8 @@ var LLMsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
183
183
|
var postBody = null;
|
|
184
184
|
var pathParams = {};
|
|
185
185
|
var queryParams = {
|
|
186
|
-
'
|
|
187
|
-
'
|
|
186
|
+
'ownerId': opts['ownerId'],
|
|
187
|
+
'providerType': opts['providerType'],
|
|
188
188
|
'label.*': opts['label']
|
|
189
189
|
};
|
|
190
190
|
var headerParams = {};
|
|
@@ -198,7 +198,7 @@ var LLMsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
198
198
|
|
|
199
199
|
/**
|
|
200
200
|
* List LLMs
|
|
201
|
-
* Retrieves a list of LLM configurations accessible to the caller, with optional filtering. PERMISSION-BASED FILTERING: With LIST_LLM_OWN permission, you can only see your own LLMs (
|
|
201
|
+
* Retrieves a list of LLM configurations accessible to the caller, with optional filtering. PERMISSION-BASED FILTERING: With LIST_LLM_OWN permission, you can only see your own LLMs (ownerId filter is ignored if set to another user). With LIST_LLM_ANY permission, you can see all LLMs or filter by any ownerId. This is a read-only operation with no side effects.
|
|
202
202
|
* @param {Object} opts Optional parameters
|
|
203
203
|
* @param {String} opts.ownerId Filter LLMs by owner ID. With LIST_LLM_ANY permission, omitting this shows all accessible LLMs; providing it filters by that owner. With LIST_LLM_OWN permission, only your own LLMs are shown regardless of this parameter.
|
|
204
204
|
* @param {String} opts.providerType Filter LLMs by provider type (e.g., OPENAI, VLLM, OLLAMA, etc.)
|
|
@@ -215,7 +215,7 @@ var LLMsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
215
215
|
|
|
216
216
|
/**
|
|
217
217
|
* Update an LLM
|
|
218
|
-
* Updates an existing LLM configuration including display information, endpoint configuration, model parameters, credentials, and labels. All fields are optional - only specified fields will be updated. IMPORTANT:
|
|
218
|
+
* Updates an existing LLM configuration including display information, endpoint configuration, model parameters, credentials, and labels. All fields are optional - only specified fields will be updated. IMPORTANT: providerType is IMMUTABLE after creation and cannot be changed. Requires UPDATE_LLM_OWN permission for LLMs you own (or UPDATE_LLM_ANY for admin users).
|
|
219
219
|
* @param {String} id The unique identifier of the LLM to update
|
|
220
220
|
* @param {module:model/LLMUpdateRequest} lLMUpdateRequest LLM update details
|
|
221
221
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/LLMResponse} and HTTP response
|
|
@@ -247,7 +247,7 @@ var LLMsApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
247
247
|
|
|
248
248
|
/**
|
|
249
249
|
* Update an LLM
|
|
250
|
-
* Updates an existing LLM configuration including display information, endpoint configuration, model parameters, credentials, and labels. All fields are optional - only specified fields will be updated. IMPORTANT:
|
|
250
|
+
* Updates an existing LLM configuration including display information, endpoint configuration, model parameters, credentials, and labels. All fields are optional - only specified fields will be updated. IMPORTANT: providerType is IMMUTABLE after creation and cannot be changed. Requires UPDATE_LLM_OWN permission for LLMs you own (or UPDATE_LLM_ANY for admin users).
|
|
251
251
|
* @param {String} id The unique identifier of the LLM to update
|
|
252
252
|
* @param {module:model/LLMUpdateRequest} lLMUpdateRequest LLM update details
|
|
253
253
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/LLMResponse}
|
package/dist/api/MemoriesApi.js
CHANGED
|
@@ -5,9 +5,12 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
|
+
var _BatchCreateMemoryRequest = _interopRequireDefault(require("../model/BatchCreateMemoryRequest"));
|
|
8
9
|
var _BatchMemoryCreationRequest = _interopRequireDefault(require("../model/BatchMemoryCreationRequest"));
|
|
9
10
|
var _BatchMemoryDeletionRequest = _interopRequireDefault(require("../model/BatchMemoryDeletionRequest"));
|
|
11
|
+
var _BatchMemoryResponse = _interopRequireDefault(require("../model/BatchMemoryResponse"));
|
|
10
12
|
var _BatchMemoryRetrievalRequest = _interopRequireDefault(require("../model/BatchMemoryRetrievalRequest"));
|
|
13
|
+
var _CreateMemoryRequest = _interopRequireDefault(require("../model/CreateMemoryRequest"));
|
|
11
14
|
var _Memory = _interopRequireDefault(require("../model/Memory"));
|
|
12
15
|
var _MemoryCreationRequest = _interopRequireDefault(require("../model/MemoryCreationRequest"));
|
|
13
16
|
var _MemoryListResponse = _interopRequireDefault(require("../model/MemoryListResponse"));
|
|
@@ -52,8 +55,8 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
52
55
|
/**
|
|
53
56
|
* Create multiple memories in a batch
|
|
54
57
|
* Creates multiple memories in a single operation, with individual success/failure results.
|
|
55
|
-
* @param {module:model/BatchMemoryCreationRequest} batchMemoryCreationRequest Batch memory creation details
|
|
56
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
58
|
+
* @param {module:model/BatchMemoryCreationRequest} batchMemoryCreationRequest Batch memory creation details. Accepts application/json or multipart/form-data with a requests part and one file part per request.
|
|
59
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/BatchMemoryResponse} and HTTP response
|
|
57
60
|
*/
|
|
58
61
|
return _createClass(MemoriesApi, [{
|
|
59
62
|
key: "batchCreateMemoryWithHttpInfo",
|
|
@@ -68,17 +71,17 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
68
71
|
var headerParams = {};
|
|
69
72
|
var formParams = {};
|
|
70
73
|
var authNames = [];
|
|
71
|
-
var contentTypes = ['application/json'];
|
|
74
|
+
var contentTypes = ['application/json', 'multipart/form-data'];
|
|
72
75
|
var accepts = ['application/json'];
|
|
73
|
-
var returnType =
|
|
76
|
+
var returnType = _BatchMemoryResponse["default"];
|
|
74
77
|
return this.apiClient.callApi('/v1/memories:batchCreate', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
75
78
|
}
|
|
76
79
|
|
|
77
80
|
/**
|
|
78
81
|
* Create multiple memories in a batch
|
|
79
82
|
* Creates multiple memories in a single operation, with individual success/failure results.
|
|
80
|
-
* @param {module:model/BatchMemoryCreationRequest} batchMemoryCreationRequest Batch memory creation details
|
|
81
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
83
|
+
* @param {module:model/BatchMemoryCreationRequest} batchMemoryCreationRequest Batch memory creation details. Accepts application/json or multipart/form-data with a requests part and one file part per request.
|
|
84
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/BatchMemoryResponse}
|
|
82
85
|
*/
|
|
83
86
|
}, {
|
|
84
87
|
key: "batchCreateMemory",
|
|
@@ -92,7 +95,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
92
95
|
* Delete multiple memories by ID
|
|
93
96
|
* Deletes multiple memories in a single operation, with success/failure results for each ID.
|
|
94
97
|
* @param {module:model/BatchMemoryDeletionRequest} batchMemoryDeletionRequest Batch memory deletion details
|
|
95
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
98
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/BatchMemoryResponse} and HTTP response
|
|
96
99
|
*/
|
|
97
100
|
}, {
|
|
98
101
|
key: "batchDeleteMemoryWithHttpInfo",
|
|
@@ -109,7 +112,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
109
112
|
var authNames = [];
|
|
110
113
|
var contentTypes = ['application/json'];
|
|
111
114
|
var accepts = ['application/json'];
|
|
112
|
-
var returnType =
|
|
115
|
+
var returnType = _BatchMemoryResponse["default"];
|
|
113
116
|
return this.apiClient.callApi('/v1/memories:batchDelete', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
114
117
|
}
|
|
115
118
|
|
|
@@ -117,7 +120,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
117
120
|
* Delete multiple memories by ID
|
|
118
121
|
* Deletes multiple memories in a single operation, with success/failure results for each ID.
|
|
119
122
|
* @param {module:model/BatchMemoryDeletionRequest} batchMemoryDeletionRequest Batch memory deletion details
|
|
120
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
123
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/BatchMemoryResponse}
|
|
121
124
|
*/
|
|
122
125
|
}, {
|
|
123
126
|
key: "batchDeleteMemory",
|
|
@@ -131,7 +134,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
131
134
|
* Get multiple memories by ID
|
|
132
135
|
* Retrieves multiple memories in a single operation, with individual success/failure results.
|
|
133
136
|
* @param {module:model/BatchMemoryRetrievalRequest} batchMemoryRetrievalRequest Batch memory retrieval details
|
|
134
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
137
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/BatchMemoryResponse} and HTTP response
|
|
135
138
|
*/
|
|
136
139
|
}, {
|
|
137
140
|
key: "batchGetMemoryWithHttpInfo",
|
|
@@ -148,7 +151,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
148
151
|
var authNames = [];
|
|
149
152
|
var contentTypes = ['application/json'];
|
|
150
153
|
var accepts = ['application/json'];
|
|
151
|
-
var returnType =
|
|
154
|
+
var returnType = _BatchMemoryResponse["default"];
|
|
152
155
|
return this.apiClient.callApi('/v1/memories:batchGet', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
153
156
|
}
|
|
154
157
|
|
|
@@ -156,7 +159,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
156
159
|
* Get multiple memories by ID
|
|
157
160
|
* Retrieves multiple memories in a single operation, with individual success/failure results.
|
|
158
161
|
* @param {module:model/BatchMemoryRetrievalRequest} batchMemoryRetrievalRequest Batch memory retrieval details
|
|
159
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
162
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/BatchMemoryResponse}
|
|
160
163
|
*/
|
|
161
164
|
}, {
|
|
162
165
|
key: "batchGetMemory",
|
|
@@ -169,7 +172,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
169
172
|
/**
|
|
170
173
|
* Create a new memory
|
|
171
174
|
* 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.
|
|
172
|
-
* @param {module:model/MemoryCreationRequest} memoryCreationRequest Memory creation details
|
|
175
|
+
* @param {module:model/MemoryCreationRequest} memoryCreationRequest Memory creation details. Accepts application/json or multipart/form-data with a JSON request part and a file part.
|
|
173
176
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Memory} and HTTP response
|
|
174
177
|
*/
|
|
175
178
|
}, {
|
|
@@ -185,7 +188,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
185
188
|
var headerParams = {};
|
|
186
189
|
var formParams = {};
|
|
187
190
|
var authNames = [];
|
|
188
|
-
var contentTypes = ['application/json'];
|
|
191
|
+
var contentTypes = ['application/json', 'multipart/form-data'];
|
|
189
192
|
var accepts = ['application/json'];
|
|
190
193
|
var returnType = _Memory["default"];
|
|
191
194
|
return this.apiClient.callApi('/v1/memories', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
@@ -194,7 +197,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
194
197
|
/**
|
|
195
198
|
* Create a new memory
|
|
196
199
|
* 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.
|
|
197
|
-
* @param {module:model/MemoryCreationRequest} memoryCreationRequest Memory creation details
|
|
200
|
+
* @param {module:model/MemoryCreationRequest} memoryCreationRequest Memory creation details. Accepts application/json or multipart/form-data with a JSON request part and a file part.
|
|
198
201
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Memory}
|
|
199
202
|
*/
|
|
200
203
|
}, {
|
|
@@ -340,13 +343,13 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
340
343
|
|
|
341
344
|
/**
|
|
342
345
|
* List memories in a space
|
|
343
|
-
* Lists all memories within a given space.
|
|
346
|
+
* Lists all memories within a given space. Pagination is supported via maxResults and nextToken (opaque). nextToken is a URL-safe Base64 string without padding; do not parse or construct it. 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.
|
|
344
347
|
* @param {String} spaceId The unique identifier of the space containing the memories
|
|
345
348
|
* @param {Object} opts Optional parameters
|
|
346
349
|
* @param {Boolean} [includeContent] Whether to include the original content in the response (defaults to false)
|
|
347
350
|
* @param {String} [statusFilter] Filter memories by processing status (PENDING, PROCESSING, COMPLETED, FAILED)
|
|
348
|
-
* @param {Number} [maxResults]
|
|
349
|
-
* @param {String} [nextToken]
|
|
351
|
+
* @param {Number} [maxResults] Maximum number of results per page (defaults to 50, clamped to [1, 500]).
|
|
352
|
+
* @param {String} [nextToken] Opaque pagination token for the next page. URL-safe Base64 without padding; do not parse or construct it.
|
|
350
353
|
* @param {String} [sortBy] Field to sort by (e.g., 'created_at')
|
|
351
354
|
* @param {String} [sortOrder] Sort direction (ASCENDING or DESCENDING)
|
|
352
355
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/MemoryListResponse} and HTTP response
|
|
@@ -382,13 +385,13 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
382
385
|
|
|
383
386
|
/**
|
|
384
387
|
* List memories in a space
|
|
385
|
-
* Lists all memories within a given space.
|
|
388
|
+
* Lists all memories within a given space. Pagination is supported via maxResults and nextToken (opaque). nextToken is a URL-safe Base64 string without padding; do not parse or construct it. 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.
|
|
386
389
|
* @param {String} spaceId The unique identifier of the space containing the memories
|
|
387
390
|
* @param {Object} opts Optional parameters
|
|
388
391
|
* @param {Boolean} opts.includeContent Whether to include the original content in the response (defaults to false)
|
|
389
392
|
* @param {String} opts.statusFilter Filter memories by processing status (PENDING, PROCESSING, COMPLETED, FAILED)
|
|
390
|
-
* @param {Number} opts.maxResults
|
|
391
|
-
* @param {String} opts.nextToken
|
|
393
|
+
* @param {Number} opts.maxResults Maximum number of results per page (defaults to 50, clamped to [1, 500]).
|
|
394
|
+
* @param {String} opts.nextToken Opaque pagination token for the next page. URL-safe Base64 without padding; do not parse or construct it.
|
|
392
395
|
* @param {String} opts.sortBy Field to sort by (e.g., 'created_at')
|
|
393
396
|
* @param {String} opts.sortOrder Sort direction (ASCENDING or DESCENDING)
|
|
394
397
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MemoryListResponse}
|
|
@@ -406,17 +409,18 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
406
409
|
* Streams semantic retrieval results based on query and context. Supports SSE (text/event-stream) and NDJSON (application/x-ndjson) formats.
|
|
407
410
|
* @param {String} message Primary query/message for semantic search
|
|
408
411
|
* @param {Object} opts Optional parameters
|
|
412
|
+
* @param {String} [accept] Response format: 'text/event-stream' for Server-Sent Events or 'application/x-ndjson' for newline-delimited JSON
|
|
409
413
|
* @param {String} [spaceIds] Comma-separated list of space UUIDs to search within
|
|
410
414
|
* @param {String} [filter] Optional filter expression applied to every space ID supplied via the query parameter. Use the POST variant if you need distinct filters per space.
|
|
411
415
|
* @param {Number} [requestedSize] Maximum number of memories to retrieve
|
|
412
416
|
* @param {Boolean} [fetchMemory] Whether to fetch memory definitions (defaults to true)
|
|
413
417
|
* @param {Boolean} [fetchMemoryContent] Whether to fetch original content for memories (defaults to false)
|
|
414
|
-
* @param {String} [
|
|
415
|
-
* @param {String} [
|
|
416
|
-
* @param {Number} [
|
|
417
|
-
* @param {Number} [
|
|
418
|
-
* @param {Number} [
|
|
419
|
-
* @param {Boolean} [
|
|
418
|
+
* @param {String} [postProcessorRerankerId] UUID of reranker to use for ChatPostProcessor (enables post-processing). Legacy alias: pp_reranker_id.
|
|
419
|
+
* @param {String} [postProcessorLlmId] UUID of LLM to use for ChatPostProcessor generation. Legacy alias: pp_llm_id.
|
|
420
|
+
* @param {Number} [postProcessorRelevanceThreshold] Minimum relevance score for ChatPostProcessor (default: 0.5). Legacy alias: pp_relevance_threshold.
|
|
421
|
+
* @param {Number} [postProcessorLlmTemp] LLM temperature for ChatPostProcessor generation (default: 0.3). Legacy alias: pp_llm_temp.
|
|
422
|
+
* @param {Number} [postProcessorMaxResults] Maximum results for ChatPostProcessor (default: 10). Legacy alias: pp_max_results.
|
|
423
|
+
* @param {Boolean} [postProcessorChronologicalResort] Whether ChatPostProcessor should resort by creation time (default: true). Legacy alias: pp_chronological_resort.
|
|
420
424
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetrieveMemoryEvent} and HTTP response
|
|
421
425
|
*/
|
|
422
426
|
}, {
|
|
@@ -436,18 +440,20 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
436
440
|
'requestedSize': opts['requestedSize'],
|
|
437
441
|
'fetchMemory': opts['fetchMemory'],
|
|
438
442
|
'fetchMemoryContent': opts['fetchMemoryContent'],
|
|
439
|
-
'
|
|
440
|
-
'
|
|
441
|
-
'
|
|
442
|
-
'
|
|
443
|
-
'
|
|
444
|
-
'
|
|
443
|
+
'postProcessorRerankerId': opts['postProcessorRerankerId'],
|
|
444
|
+
'postProcessorLlmId': opts['postProcessorLlmId'],
|
|
445
|
+
'postProcessorRelevanceThreshold': opts['postProcessorRelevanceThreshold'],
|
|
446
|
+
'postProcessorLlmTemp': opts['postProcessorLlmTemp'],
|
|
447
|
+
'postProcessorMaxResults': opts['postProcessorMaxResults'],
|
|
448
|
+
'postProcessorChronologicalResort': opts['postProcessorChronologicalResort']
|
|
449
|
+
};
|
|
450
|
+
var headerParams = {
|
|
451
|
+
'Accept': opts['accept']
|
|
445
452
|
};
|
|
446
|
-
var headerParams = {};
|
|
447
453
|
var formParams = {};
|
|
448
454
|
var authNames = [];
|
|
449
455
|
var contentTypes = [];
|
|
450
|
-
var accepts = ['application/
|
|
456
|
+
var accepts = ['application/x-ndjson', 'text/event-stream'];
|
|
451
457
|
var returnType = _RetrieveMemoryEvent["default"];
|
|
452
458
|
return this.apiClient.callApi('/v1/memories:retrieve', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
453
459
|
}
|
|
@@ -457,17 +463,18 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
457
463
|
* Streams semantic retrieval results based on query and context. Supports SSE (text/event-stream) and NDJSON (application/x-ndjson) formats.
|
|
458
464
|
* @param {String} message Primary query/message for semantic search
|
|
459
465
|
* @param {Object} opts Optional parameters
|
|
466
|
+
* @param {String} opts.accept Response format: 'text/event-stream' for Server-Sent Events or 'application/x-ndjson' for newline-delimited JSON
|
|
460
467
|
* @param {String} opts.spaceIds Comma-separated list of space UUIDs to search within
|
|
461
468
|
* @param {String} opts.filter Optional filter expression applied to every space ID supplied via the query parameter. Use the POST variant if you need distinct filters per space.
|
|
462
469
|
* @param {Number} opts.requestedSize Maximum number of memories to retrieve
|
|
463
470
|
* @param {Boolean} opts.fetchMemory Whether to fetch memory definitions (defaults to true)
|
|
464
471
|
* @param {Boolean} opts.fetchMemoryContent Whether to fetch original content for memories (defaults to false)
|
|
465
|
-
* @param {String} opts.
|
|
466
|
-
* @param {String} opts.
|
|
467
|
-
* @param {Number} opts.
|
|
468
|
-
* @param {Number} opts.
|
|
469
|
-
* @param {Number} opts.
|
|
470
|
-
* @param {Boolean} opts.
|
|
472
|
+
* @param {String} opts.postProcessorRerankerId UUID of reranker to use for ChatPostProcessor (enables post-processing). Legacy alias: pp_reranker_id.
|
|
473
|
+
* @param {String} opts.postProcessorLlmId UUID of LLM to use for ChatPostProcessor generation. Legacy alias: pp_llm_id.
|
|
474
|
+
* @param {Number} opts.postProcessorRelevanceThreshold Minimum relevance score for ChatPostProcessor (default: 0.5). Legacy alias: pp_relevance_threshold.
|
|
475
|
+
* @param {Number} opts.postProcessorLlmTemp LLM temperature for ChatPostProcessor generation (default: 0.3). Legacy alias: pp_llm_temp.
|
|
476
|
+
* @param {Number} opts.postProcessorMaxResults Maximum results for ChatPostProcessor (default: 10). Legacy alias: pp_max_results.
|
|
477
|
+
* @param {Boolean} opts.postProcessorChronologicalResort Whether ChatPostProcessor should resort by creation time (default: true). Legacy alias: pp_chronological_resort.
|
|
471
478
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetrieveMemoryEvent}
|
|
472
479
|
*/
|
|
473
480
|
}, {
|
|
@@ -482,11 +489,14 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
482
489
|
* Advanced semantic memory retrieval with JSON
|
|
483
490
|
* 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.
|
|
484
491
|
* @param {module:model/RetrieveMemoryRequest} retrieveMemoryRequest Request body with query, context, and space configurations
|
|
485
|
-
* @
|
|
492
|
+
* @param {Object} opts Optional parameters
|
|
493
|
+
* @param {String} [accept] Response format: 'text/event-stream' for Server-Sent Events or 'application/x-ndjson' for newline-delimited JSON
|
|
494
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetrieveMemoryEvent} and HTTP response
|
|
486
495
|
*/
|
|
487
496
|
}, {
|
|
488
497
|
key: "retrieveMemoryAdvancedWithHttpInfo",
|
|
489
|
-
value: function retrieveMemoryAdvancedWithHttpInfo(retrieveMemoryRequest) {
|
|
498
|
+
value: function retrieveMemoryAdvancedWithHttpInfo(retrieveMemoryRequest, opts) {
|
|
499
|
+
opts = opts || {};
|
|
490
500
|
var postBody = retrieveMemoryRequest;
|
|
491
501
|
// verify the required parameter 'retrieveMemoryRequest' is set
|
|
492
502
|
if (retrieveMemoryRequest === undefined || retrieveMemoryRequest === null) {
|
|
@@ -494,12 +504,14 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
494
504
|
}
|
|
495
505
|
var pathParams = {};
|
|
496
506
|
var queryParams = {};
|
|
497
|
-
var headerParams = {
|
|
507
|
+
var headerParams = {
|
|
508
|
+
'Accept': opts['accept']
|
|
509
|
+
};
|
|
498
510
|
var formParams = {};
|
|
499
511
|
var authNames = [];
|
|
500
512
|
var contentTypes = ['application/json'];
|
|
501
513
|
var accepts = ['application/x-ndjson', 'text/event-stream'];
|
|
502
|
-
var returnType =
|
|
514
|
+
var returnType = _RetrieveMemoryEvent["default"];
|
|
503
515
|
return this.apiClient.callApi('/v1/memories:retrieve', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
504
516
|
}
|
|
505
517
|
|
|
@@ -507,12 +519,14 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
507
519
|
* Advanced semantic memory retrieval with JSON
|
|
508
520
|
* 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.
|
|
509
521
|
* @param {module:model/RetrieveMemoryRequest} retrieveMemoryRequest Request body with query, context, and space configurations
|
|
510
|
-
* @
|
|
522
|
+
* @param {Object} opts Optional parameters
|
|
523
|
+
* @param {String} opts.accept Response format: 'text/event-stream' for Server-Sent Events or 'application/x-ndjson' for newline-delimited JSON
|
|
524
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetrieveMemoryEvent}
|
|
511
525
|
*/
|
|
512
526
|
}, {
|
|
513
527
|
key: "retrieveMemoryAdvanced",
|
|
514
|
-
value: function retrieveMemoryAdvanced(retrieveMemoryRequest) {
|
|
515
|
-
return this.retrieveMemoryAdvancedWithHttpInfo(retrieveMemoryRequest).then(function (response_and_data) {
|
|
528
|
+
value: function retrieveMemoryAdvanced(retrieveMemoryRequest, opts) {
|
|
529
|
+
return this.retrieveMemoryAdvancedWithHttpInfo(retrieveMemoryRequest, opts).then(function (response_and_data) {
|
|
516
530
|
return response_and_data.data;
|
|
517
531
|
});
|
|
518
532
|
}
|