@pairsystems/goodmem-client 1.0.6 → 1.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -2
- package/dist/api/EmbeddersApi.js +8 -8
- package/dist/api/LLMsApi.js +8 -8
- package/dist/api/MemoriesApi.js +36 -34
- package/dist/api/OCRApi.js +85 -0
- package/dist/api/PingApi.js +133 -0
- package/dist/api/RerankersApi.js +10 -10
- package/dist/api/SpacesApi.js +14 -14
- package/dist/index.js +175 -0
- package/dist/model/BatchMemoryCreationRequest.js +0 -8
- package/dist/model/BatchMemoryDeletionRequest.js +0 -8
- package/dist/model/BatchMemoryRetrievalRequest.js +0 -8
- package/dist/model/BoundingBox.js +143 -0
- package/dist/model/DocumentTimings.js +154 -0
- package/dist/model/EmbedderCreationRequest.js +0 -8
- package/dist/model/EmbedderResponse.js +14 -0
- package/dist/model/ImageInfo.js +132 -0
- package/dist/model/LLMCreationRequest.js +3 -11
- package/dist/model/LLMResponse.js +16 -2
- package/dist/model/LLMUpdateRequest.js +1 -9
- package/dist/model/MemoryCreationRequest.js +13 -8
- 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 +1 -9
- package/dist/model/RerankerResponse.js +14 -0
- package/dist/model/RpcStatus.js +123 -0
- package/dist/model/SpaceCreationRequest.js +7 -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.8
|
|
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
|
|
@@ -346,6 +349,7 @@ Class | Method | HTTP request | Description
|
|
|
346
349
|
- [GoodMemClient.BatchMemoryResult](docs/BatchMemoryResult.md)
|
|
347
350
|
- [GoodMemClient.BatchMemoryRetrievalRequest](docs/BatchMemoryRetrievalRequest.md)
|
|
348
351
|
- [GoodMemClient.BinaryContent](docs/BinaryContent.md)
|
|
352
|
+
- [GoodMemClient.BoundingBox](docs/BoundingBox.md)
|
|
349
353
|
- [GoodMemClient.ChunkReference](docs/ChunkReference.md)
|
|
350
354
|
- [GoodMemClient.ChunkingConfiguration](docs/ChunkingConfiguration.md)
|
|
351
355
|
- [GoodMemClient.ContextItem](docs/ContextItem.md)
|
|
@@ -354,6 +358,7 @@ Class | Method | HTTP request | Description
|
|
|
354
358
|
- [GoodMemClient.CreateLLMResponse](docs/CreateLLMResponse.md)
|
|
355
359
|
- [GoodMemClient.CredentialKind](docs/CredentialKind.md)
|
|
356
360
|
- [GoodMemClient.DistributionType](docs/DistributionType.md)
|
|
361
|
+
- [GoodMemClient.DocumentTimings](docs/DocumentTimings.md)
|
|
357
362
|
- [GoodMemClient.EmbedderCreationRequest](docs/EmbedderCreationRequest.md)
|
|
358
363
|
- [GoodMemClient.EmbedderResponse](docs/EmbedderResponse.md)
|
|
359
364
|
- [GoodMemClient.EmbedderWeight](docs/EmbedderWeight.md)
|
|
@@ -361,6 +366,7 @@ Class | Method | HTTP request | Description
|
|
|
361
366
|
- [GoodMemClient.ErrorDetail](docs/ErrorDetail.md)
|
|
362
367
|
- [GoodMemClient.GcpAdcAuth](docs/GcpAdcAuth.md)
|
|
363
368
|
- [GoodMemClient.GoodMemStatus](docs/GoodMemStatus.md)
|
|
369
|
+
- [GoodMemClient.ImageInfo](docs/ImageInfo.md)
|
|
364
370
|
- [GoodMemClient.LLMCapabilities](docs/LLMCapabilities.md)
|
|
365
371
|
- [GoodMemClient.LLMCreationRequest](docs/LLMCreationRequest.md)
|
|
366
372
|
- [GoodMemClient.LLMProviderType](docs/LLMProviderType.md)
|
|
@@ -378,6 +384,25 @@ Class | Method | HTTP request | Description
|
|
|
378
384
|
- [GoodMemClient.MemoryCreationRequest](docs/MemoryCreationRequest.md)
|
|
379
385
|
- [GoodMemClient.MemoryListResponse](docs/MemoryListResponse.md)
|
|
380
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)
|
|
381
406
|
- [GoodMemClient.PostProcessor](docs/PostProcessor.md)
|
|
382
407
|
- [GoodMemClient.ProcessingHistory](docs/ProcessingHistory.md)
|
|
383
408
|
- [GoodMemClient.ProviderType](docs/ProviderType.md)
|
|
@@ -388,6 +413,7 @@ Class | Method | HTTP request | Description
|
|
|
388
413
|
- [GoodMemClient.RetrieveMemoryEvent](docs/RetrieveMemoryEvent.md)
|
|
389
414
|
- [GoodMemClient.RetrieveMemoryRequest](docs/RetrieveMemoryRequest.md)
|
|
390
415
|
- [GoodMemClient.RetrievedItem](docs/RetrievedItem.md)
|
|
416
|
+
- [GoodMemClient.RpcStatus](docs/RpcStatus.md)
|
|
391
417
|
- [GoodMemClient.SecretReference](docs/SecretReference.md)
|
|
392
418
|
- [GoodMemClient.SentenceChunkingConfiguration](docs/SentenceChunkingConfiguration.md)
|
|
393
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 HTTP 409 Conflict (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 HTTP 409 Conflict (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
|
*/
|
|
@@ -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 HTTP 409 Conflict (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 HTTP 409 Conflict (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,10 +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"));
|
|
10
11
|
var _BatchMemoryResponse = _interopRequireDefault(require("../model/BatchMemoryResponse"));
|
|
11
12
|
var _BatchMemoryRetrievalRequest = _interopRequireDefault(require("../model/BatchMemoryRetrievalRequest"));
|
|
13
|
+
var _CreateMemoryRequest = _interopRequireDefault(require("../model/CreateMemoryRequest"));
|
|
12
14
|
var _Memory = _interopRequireDefault(require("../model/Memory"));
|
|
13
15
|
var _MemoryCreationRequest = _interopRequireDefault(require("../model/MemoryCreationRequest"));
|
|
14
16
|
var _MemoryListResponse = _interopRequireDefault(require("../model/MemoryListResponse"));
|
|
@@ -53,7 +55,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
53
55
|
/**
|
|
54
56
|
* Create multiple memories in a batch
|
|
55
57
|
* Creates multiple memories in a single operation, with individual success/failure results.
|
|
56
|
-
* @param {module:model/BatchMemoryCreationRequest} batchMemoryCreationRequest Batch memory creation details
|
|
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.
|
|
57
59
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/BatchMemoryResponse} and HTTP response
|
|
58
60
|
*/
|
|
59
61
|
return _createClass(MemoriesApi, [{
|
|
@@ -69,7 +71,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
69
71
|
var headerParams = {};
|
|
70
72
|
var formParams = {};
|
|
71
73
|
var authNames = [];
|
|
72
|
-
var contentTypes = ['application/json'];
|
|
74
|
+
var contentTypes = ['application/json', 'multipart/form-data'];
|
|
73
75
|
var accepts = ['application/json'];
|
|
74
76
|
var returnType = _BatchMemoryResponse["default"];
|
|
75
77
|
return this.apiClient.callApi('/v1/memories:batchCreate', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
@@ -78,7 +80,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
78
80
|
/**
|
|
79
81
|
* Create multiple memories in a batch
|
|
80
82
|
* Creates multiple memories in a single operation, with individual success/failure results.
|
|
81
|
-
* @param {module:model/BatchMemoryCreationRequest} batchMemoryCreationRequest Batch memory creation details
|
|
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.
|
|
82
84
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/BatchMemoryResponse}
|
|
83
85
|
*/
|
|
84
86
|
}, {
|
|
@@ -170,7 +172,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
170
172
|
/**
|
|
171
173
|
* Create a new memory
|
|
172
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.
|
|
173
|
-
* @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.
|
|
174
176
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Memory} and HTTP response
|
|
175
177
|
*/
|
|
176
178
|
}, {
|
|
@@ -186,7 +188,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
186
188
|
var headerParams = {};
|
|
187
189
|
var formParams = {};
|
|
188
190
|
var authNames = [];
|
|
189
|
-
var contentTypes = ['application/json'];
|
|
191
|
+
var contentTypes = ['application/json', 'multipart/form-data'];
|
|
190
192
|
var accepts = ['application/json'];
|
|
191
193
|
var returnType = _Memory["default"];
|
|
192
194
|
return this.apiClient.callApi('/v1/memories', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
@@ -195,7 +197,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
195
197
|
/**
|
|
196
198
|
* Create a new memory
|
|
197
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.
|
|
198
|
-
* @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.
|
|
199
201
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Memory}
|
|
200
202
|
*/
|
|
201
203
|
}, {
|
|
@@ -341,13 +343,13 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
341
343
|
|
|
342
344
|
/**
|
|
343
345
|
* List memories in a space
|
|
344
|
-
* 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.
|
|
345
347
|
* @param {String} spaceId The unique identifier of the space containing the memories
|
|
346
348
|
* @param {Object} opts Optional parameters
|
|
347
349
|
* @param {Boolean} [includeContent] Whether to include the original content in the response (defaults to false)
|
|
348
350
|
* @param {String} [statusFilter] Filter memories by processing status (PENDING, PROCESSING, COMPLETED, FAILED)
|
|
349
|
-
* @param {Number} [maxResults]
|
|
350
|
-
* @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.
|
|
351
353
|
* @param {String} [sortBy] Field to sort by (e.g., 'created_at')
|
|
352
354
|
* @param {String} [sortOrder] Sort direction (ASCENDING or DESCENDING)
|
|
353
355
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/MemoryListResponse} and HTTP response
|
|
@@ -383,13 +385,13 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
383
385
|
|
|
384
386
|
/**
|
|
385
387
|
* List memories in a space
|
|
386
|
-
* 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.
|
|
387
389
|
* @param {String} spaceId The unique identifier of the space containing the memories
|
|
388
390
|
* @param {Object} opts Optional parameters
|
|
389
391
|
* @param {Boolean} opts.includeContent Whether to include the original content in the response (defaults to false)
|
|
390
392
|
* @param {String} opts.statusFilter Filter memories by processing status (PENDING, PROCESSING, COMPLETED, FAILED)
|
|
391
|
-
* @param {Number} opts.maxResults
|
|
392
|
-
* @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.
|
|
393
395
|
* @param {String} opts.sortBy Field to sort by (e.g., 'created_at')
|
|
394
396
|
* @param {String} opts.sortOrder Sort direction (ASCENDING or DESCENDING)
|
|
395
397
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/MemoryListResponse}
|
|
@@ -413,12 +415,12 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
413
415
|
* @param {Number} [requestedSize] Maximum number of memories to retrieve
|
|
414
416
|
* @param {Boolean} [fetchMemory] Whether to fetch memory definitions (defaults to true)
|
|
415
417
|
* @param {Boolean} [fetchMemoryContent] Whether to fetch original content for memories (defaults to false)
|
|
416
|
-
* @param {String} [
|
|
417
|
-
* @param {String} [
|
|
418
|
-
* @param {Number} [
|
|
419
|
-
* @param {Number} [
|
|
420
|
-
* @param {Number} [
|
|
421
|
-
* @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.
|
|
422
424
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetrieveMemoryEvent} and HTTP response
|
|
423
425
|
*/
|
|
424
426
|
}, {
|
|
@@ -438,12 +440,12 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
438
440
|
'requestedSize': opts['requestedSize'],
|
|
439
441
|
'fetchMemory': opts['fetchMemory'],
|
|
440
442
|
'fetchMemoryContent': opts['fetchMemoryContent'],
|
|
441
|
-
'
|
|
442
|
-
'
|
|
443
|
-
'
|
|
444
|
-
'
|
|
445
|
-
'
|
|
446
|
-
'
|
|
443
|
+
'postProcessorRerankerId': opts['postProcessorRerankerId'],
|
|
444
|
+
'postProcessorLlmId': opts['postProcessorLlmId'],
|
|
445
|
+
'postProcessorRelevanceThreshold': opts['postProcessorRelevanceThreshold'],
|
|
446
|
+
'postProcessorLlmTemp': opts['postProcessorLlmTemp'],
|
|
447
|
+
'postProcessorMaxResults': opts['postProcessorMaxResults'],
|
|
448
|
+
'postProcessorChronologicalResort': opts['postProcessorChronologicalResort']
|
|
447
449
|
};
|
|
448
450
|
var headerParams = {
|
|
449
451
|
'Accept': opts['accept']
|
|
@@ -451,7 +453,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
451
453
|
var formParams = {};
|
|
452
454
|
var authNames = [];
|
|
453
455
|
var contentTypes = [];
|
|
454
|
-
var accepts = ['application/
|
|
456
|
+
var accepts = ['application/x-ndjson', 'text/event-stream'];
|
|
455
457
|
var returnType = _RetrieveMemoryEvent["default"];
|
|
456
458
|
return this.apiClient.callApi('/v1/memories:retrieve', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
457
459
|
}
|
|
@@ -467,12 +469,12 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
467
469
|
* @param {Number} opts.requestedSize Maximum number of memories to retrieve
|
|
468
470
|
* @param {Boolean} opts.fetchMemory Whether to fetch memory definitions (defaults to true)
|
|
469
471
|
* @param {Boolean} opts.fetchMemoryContent Whether to fetch original content for memories (defaults to false)
|
|
470
|
-
* @param {String} opts.
|
|
471
|
-
* @param {String} opts.
|
|
472
|
-
* @param {Number} opts.
|
|
473
|
-
* @param {Number} opts.
|
|
474
|
-
* @param {Number} opts.
|
|
475
|
-
* @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.
|
|
476
478
|
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetrieveMemoryEvent}
|
|
477
479
|
*/
|
|
478
480
|
}, {
|
|
@@ -489,7 +491,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
489
491
|
* @param {module:model/RetrieveMemoryRequest} retrieveMemoryRequest Request body with query, context, and space configurations
|
|
490
492
|
* @param {Object} opts Optional parameters
|
|
491
493
|
* @param {String} [accept] Response format: 'text/event-stream' for Server-Sent Events or 'application/x-ndjson' for newline-delimited JSON
|
|
492
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
|
|
494
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetrieveMemoryEvent} and HTTP response
|
|
493
495
|
*/
|
|
494
496
|
}, {
|
|
495
497
|
key: "retrieveMemoryAdvancedWithHttpInfo",
|
|
@@ -509,7 +511,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
509
511
|
var authNames = [];
|
|
510
512
|
var contentTypes = ['application/json'];
|
|
511
513
|
var accepts = ['application/x-ndjson', 'text/event-stream'];
|
|
512
|
-
var returnType =
|
|
514
|
+
var returnType = _RetrieveMemoryEvent["default"];
|
|
513
515
|
return this.apiClient.callApi('/v1/memories:retrieve', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
514
516
|
}
|
|
515
517
|
|
|
@@ -519,7 +521,7 @@ var MemoriesApi = exports["default"] = /*#__PURE__*/function () {
|
|
|
519
521
|
* @param {module:model/RetrieveMemoryRequest} retrieveMemoryRequest Request body with query, context, and space configurations
|
|
520
522
|
* @param {Object} opts Optional parameters
|
|
521
523
|
* @param {String} opts.accept Response format: 'text/event-stream' for Server-Sent Events or 'application/x-ndjson' for newline-delimited JSON
|
|
522
|
-
* @return {Promise} a {@link https://www.promisejs.org/|Promise}
|
|
524
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetrieveMemoryEvent}
|
|
523
525
|
*/
|
|
524
526
|
}, {
|
|
525
527
|
key: "retrieveMemoryAdvanced",
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports["default"] = void 0;
|
|
7
|
+
var _ApiClient = _interopRequireDefault(require("../ApiClient"));
|
|
8
|
+
var _OcrDocumentRequest = _interopRequireDefault(require("../model/OcrDocumentRequest"));
|
|
9
|
+
var _OcrDocumentResponse = _interopRequireDefault(require("../model/OcrDocumentResponse"));
|
|
10
|
+
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
|
|
11
|
+
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
|
|
12
|
+
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
13
|
+
function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
|
|
14
|
+
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
|
|
15
|
+
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
16
|
+
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
|
|
17
|
+
*
|
|
18
|
+
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
19
|
+
*
|
|
20
|
+
* The version of the OpenAPI document:
|
|
21
|
+
*
|
|
22
|
+
*
|
|
23
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
24
|
+
* https://openapi-generator.tech
|
|
25
|
+
* Do not edit the class manually.
|
|
26
|
+
*
|
|
27
|
+
*/
|
|
28
|
+
/**
|
|
29
|
+
* OCR service.
|
|
30
|
+
* @module api/OCRApi
|
|
31
|
+
* @version 1.0.0
|
|
32
|
+
*/
|
|
33
|
+
var OCRApi = exports["default"] = /*#__PURE__*/function () {
|
|
34
|
+
/**
|
|
35
|
+
* Constructs a new OCRApi.
|
|
36
|
+
* @alias module:api/OCRApi
|
|
37
|
+
* @class
|
|
38
|
+
* @param {module:ApiClient} [apiClient] Optional API client implementation to use,
|
|
39
|
+
* default to {@link module:ApiClient#instance} if unspecified.
|
|
40
|
+
*/
|
|
41
|
+
function OCRApi(apiClient) {
|
|
42
|
+
_classCallCheck(this, OCRApi);
|
|
43
|
+
this.apiClient = apiClient || _ApiClient["default"].instance;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
/**
|
|
47
|
+
* Run OCR on a document or image
|
|
48
|
+
* Runs layout-aware OCR on the provided document bytes and returns per-page results. When a page range is provided, only the inclusive subset is processed. Requires OCR_DOCUMENT permission.
|
|
49
|
+
* @param {module:model/OcrDocumentRequest} ocrDocumentRequest OCR request payload
|
|
50
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/OcrDocumentResponse} and HTTP response
|
|
51
|
+
*/
|
|
52
|
+
return _createClass(OCRApi, [{
|
|
53
|
+
key: "ocrDocumentWithHttpInfo",
|
|
54
|
+
value: function ocrDocumentWithHttpInfo(ocrDocumentRequest) {
|
|
55
|
+
var postBody = ocrDocumentRequest;
|
|
56
|
+
// verify the required parameter 'ocrDocumentRequest' is set
|
|
57
|
+
if (ocrDocumentRequest === undefined || ocrDocumentRequest === null) {
|
|
58
|
+
throw new Error("Missing the required parameter 'ocrDocumentRequest' when calling ocrDocument");
|
|
59
|
+
}
|
|
60
|
+
var pathParams = {};
|
|
61
|
+
var queryParams = {};
|
|
62
|
+
var headerParams = {};
|
|
63
|
+
var formParams = {};
|
|
64
|
+
var authNames = [];
|
|
65
|
+
var contentTypes = ['application/json'];
|
|
66
|
+
var accepts = ['application/json'];
|
|
67
|
+
var returnType = _OcrDocumentResponse["default"];
|
|
68
|
+
return this.apiClient.callApi('/v1/ocr:document', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* Run OCR on a document or image
|
|
73
|
+
* Runs layout-aware OCR on the provided document bytes and returns per-page results. When a page range is provided, only the inclusive subset is processed. Requires OCR_DOCUMENT permission.
|
|
74
|
+
* @param {module:model/OcrDocumentRequest} ocrDocumentRequest OCR request payload
|
|
75
|
+
* @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/OcrDocumentResponse}
|
|
76
|
+
*/
|
|
77
|
+
}, {
|
|
78
|
+
key: "ocrDocument",
|
|
79
|
+
value: function ocrDocument(ocrDocumentRequest) {
|
|
80
|
+
return this.ocrDocumentWithHttpInfo(ocrDocumentRequest).then(function (response_and_data) {
|
|
81
|
+
return response_and_data.data;
|
|
82
|
+
});
|
|
83
|
+
}
|
|
84
|
+
}]);
|
|
85
|
+
}();
|