@knowledge-stack/ksapi 3.6.2 → 3.8.0
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/.openapi-generator/FILES +0 -4
- package/README.md +2 -4
- package/dist/apis/DocumentsApi.d.ts +4 -7
- package/dist/apis/DocumentsApi.js +2 -5
- package/dist/apis/SystemJobsApi.d.ts +4 -4
- package/dist/apis/SystemJobsApi.js +2 -2
- package/dist/esm/apis/DocumentsApi.d.ts +4 -7
- package/dist/esm/apis/DocumentsApi.js +2 -5
- package/dist/esm/apis/SystemJobsApi.d.ts +4 -4
- package/dist/esm/apis/SystemJobsApi.js +2 -2
- package/dist/esm/models/AskRequest.d.ts +7 -0
- package/dist/esm/models/AskRequest.js +3 -0
- package/dist/esm/models/DocumentVersionMetadata.d.ts +0 -7
- package/dist/esm/models/DocumentVersionMetadata.js +0 -3
- package/dist/esm/models/DocumentVersionMetadataUpdate.d.ts +0 -7
- package/dist/esm/models/DocumentVersionMetadataUpdate.js +0 -3
- package/dist/esm/models/IngestDocumentResponse.d.ts +0 -18
- package/dist/esm/models/IngestDocumentResponse.js +0 -6
- package/dist/esm/models/PipelineState.d.ts +8 -1
- package/dist/esm/models/PipelineState.js +3 -0
- package/dist/esm/models/UploadFormat.d.ts +6 -0
- package/dist/esm/models/UploadFormat.js +4 -0
- package/dist/esm/models/UserMessageRequest.d.ts +7 -0
- package/dist/esm/models/UserMessageRequest.js +3 -0
- package/dist/esm/models/index.d.ts +0 -2
- package/dist/esm/models/index.js +0 -2
- package/dist/models/AskRequest.d.ts +7 -0
- package/dist/models/AskRequest.js +3 -0
- package/dist/models/DocumentVersionMetadata.d.ts +0 -7
- package/dist/models/DocumentVersionMetadata.js +0 -3
- package/dist/models/DocumentVersionMetadataUpdate.d.ts +0 -7
- package/dist/models/DocumentVersionMetadataUpdate.js +0 -3
- package/dist/models/IngestDocumentResponse.d.ts +0 -18
- package/dist/models/IngestDocumentResponse.js +0 -6
- package/dist/models/PipelineState.d.ts +8 -1
- package/dist/models/PipelineState.js +3 -0
- package/dist/models/UploadFormat.d.ts +6 -0
- package/dist/models/UploadFormat.js +4 -0
- package/dist/models/UserMessageRequest.d.ts +7 -0
- package/dist/models/UserMessageRequest.js +3 -0
- package/dist/models/index.d.ts +0 -2
- package/dist/models/index.js +0 -2
- package/docs/AskRequest.md +2 -0
- package/docs/DocumentVersionMetadata.md +0 -2
- package/docs/DocumentVersionMetadataUpdate.md +0 -2
- package/docs/DocumentsApi.md +2 -5
- package/docs/IngestDocumentResponse.md +0 -6
- package/docs/PipelineState.md +2 -0
- package/docs/SystemJobsApi.md +1 -1
- package/docs/UploadFormat.md +2 -0
- package/docs/UserMessageRequest.md +2 -0
- package/package.json +1 -1
- package/src/apis/DocumentsApi.ts +4 -11
- package/src/apis/SystemJobsApi.ts +4 -4
- package/src/models/AskRequest.ts +18 -0
- package/src/models/DocumentVersionMetadata.ts +0 -15
- package/src/models/DocumentVersionMetadataUpdate.ts +0 -15
- package/src/models/IngestDocumentResponse.ts +0 -24
- package/src/models/PipelineState.ts +16 -1
- package/src/models/UploadFormat.ts +9 -0
- package/src/models/UserMessageRequest.ts +18 -0
- package/src/models/index.ts +0 -2
- package/dist/esm/models/EmailMetadata.d.ts +0 -119
- package/dist/esm/models/EmailMetadata.js +0 -65
- package/dist/esm/models/EmailParty.d.ts +0 -53
- package/dist/esm/models/EmailParty.js +0 -46
- package/dist/models/EmailMetadata.d.ts +0 -119
- package/dist/models/EmailMetadata.js +0 -73
- package/dist/models/EmailParty.d.ts +0 -53
- package/dist/models/EmailParty.js +0 -54
- package/docs/EmailMetadata.md +0 -57
- package/docs/EmailParty.md +0 -37
- package/src/models/EmailMetadata.ts +0 -183
- package/src/models/EmailParty.ts +0 -91
package/.openapi-generator/FILES
CHANGED
|
@@ -155,8 +155,6 @@ docs/DocxParagraphAnchorInput.md
|
|
|
155
155
|
docs/DocxParagraphAnchorOutput.md
|
|
156
156
|
docs/DownloadArtifact.md
|
|
157
157
|
docs/EditMemoryChunkRequest.md
|
|
158
|
-
docs/EmailMetadata.md
|
|
159
|
-
docs/EmailParty.md
|
|
160
158
|
docs/EmailSentResponse.md
|
|
161
159
|
docs/EmailVerificationRequest.md
|
|
162
160
|
docs/EnrichedCitation.md
|
|
@@ -632,8 +630,6 @@ src/models/DocxParagraphAnchorInput.ts
|
|
|
632
630
|
src/models/DocxParagraphAnchorOutput.ts
|
|
633
631
|
src/models/DownloadArtifact.ts
|
|
634
632
|
src/models/EditMemoryChunkRequest.ts
|
|
635
|
-
src/models/EmailMetadata.ts
|
|
636
|
-
src/models/EmailParty.ts
|
|
637
633
|
src/models/EmailSentResponse.ts
|
|
638
634
|
src/models/EmailVerificationRequest.ts
|
|
639
635
|
src/models/EnrichedCitation.ts
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @knowledge-stack/ksapi@3.
|
|
1
|
+
# @knowledge-stack/ksapi@3.8.0
|
|
2
2
|
|
|
3
3
|
A TypeScript SDK client for the localhost API.
|
|
4
4
|
|
|
@@ -442,8 +442,6 @@ All URIs are relative to *http://localhost:8000*
|
|
|
442
442
|
- [DocxParagraphAnchorOutput](docs/DocxParagraphAnchorOutput.md)
|
|
443
443
|
- [DownloadArtifact](docs/DownloadArtifact.md)
|
|
444
444
|
- [EditMemoryChunkRequest](docs/EditMemoryChunkRequest.md)
|
|
445
|
-
- [EmailMetadata](docs/EmailMetadata.md)
|
|
446
|
-
- [EmailParty](docs/EmailParty.md)
|
|
447
445
|
- [EmailSentResponse](docs/EmailSentResponse.md)
|
|
448
446
|
- [EmailVerificationRequest](docs/EmailVerificationRequest.md)
|
|
449
447
|
- [EnrichedCitation](docs/EnrichedCitation.md)
|
|
@@ -740,7 +738,7 @@ and is automatically generated by the
|
|
|
740
738
|
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
741
739
|
|
|
742
740
|
- API version: `0.1.0`
|
|
743
|
-
- Package version: `3.
|
|
741
|
+
- Package version: `3.8.0`
|
|
744
742
|
- Generator version: `7.21.0`
|
|
745
743
|
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
746
744
|
|
|
@@ -43,7 +43,6 @@ export interface IngestDocumentRequest {
|
|
|
43
43
|
name?: string | null;
|
|
44
44
|
tagIds?: Array<string>;
|
|
45
45
|
idempotencyKey?: string | null;
|
|
46
|
-
emailNestingDepth?: number;
|
|
47
46
|
ingestionMode?: IngestionMode;
|
|
48
47
|
chunkType?: ChunkType;
|
|
49
48
|
secondaryTaxonomy?: ImageTaxonomy;
|
|
@@ -277,7 +276,6 @@ export interface DocumentsApiInterface {
|
|
|
277
276
|
* @param {string} [name] Document name (defaults to filename)
|
|
278
277
|
* @param {Array<string>} [tagIds] Tag IDs applied to the created document.
|
|
279
278
|
* @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
|
|
280
|
-
* @param {number} [emailNestingDepth] Internal: set by the email member fan-out when a nested email re-enters this endpoint. Leave at 0 for direct uploads.
|
|
281
279
|
* @param {IngestionMode} [ingestionMode]
|
|
282
280
|
* @param {ChunkType} [chunkType]
|
|
283
281
|
* @param {ImageTaxonomy} [secondaryTaxonomy]
|
|
@@ -296,7 +294,6 @@ export interface DocumentsApiInterface {
|
|
|
296
294
|
* @param {string} [name] Document name (defaults to filename)
|
|
297
295
|
* @param {Array<string>} [tagIds] Tag IDs applied to the created document.
|
|
298
296
|
* @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
|
|
299
|
-
* @param {number} [emailNestingDepth] Internal: set by the email member fan-out when a nested email re-enters this endpoint. Leave at 0 for direct uploads.
|
|
300
297
|
* @param {IngestionMode} [ingestionMode]
|
|
301
298
|
* @param {ChunkType} [chunkType]
|
|
302
299
|
* @param {ImageTaxonomy} [secondaryTaxonomy]
|
|
@@ -328,7 +325,7 @@ export interface DocumentsApiInterface {
|
|
|
328
325
|
*/
|
|
329
326
|
ingestDocumentVersionRequestOpts(requestParameters: IngestDocumentVersionRequest): Promise<runtime.RequestOpts>;
|
|
330
327
|
/**
|
|
331
|
-
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
328
|
+
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). The file must be the document\'s type (a PDF document takes only PDF versions; ``.md`` and ``.txt`` are both PLAINTEXT); any other type is a 400. Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
332
329
|
* @summary Ingest Document Version Handler
|
|
333
330
|
* @param {string} documentId Document ID
|
|
334
331
|
* @param {Blob} file
|
|
@@ -344,7 +341,7 @@ export interface DocumentsApiInterface {
|
|
|
344
341
|
*/
|
|
345
342
|
ingestDocumentVersionRaw(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestDocumentResponse>>;
|
|
346
343
|
/**
|
|
347
|
-
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
344
|
+
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). The file must be the document\'s type (a PDF document takes only PDF versions; ``.md`` and ``.txt`` are both PLAINTEXT); any other type is a 400. Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
348
345
|
* Ingest Document Version Handler
|
|
349
346
|
*/
|
|
350
347
|
ingestDocumentVersion(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
|
|
@@ -604,12 +601,12 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
|
|
|
604
601
|
*/
|
|
605
602
|
ingestDocumentVersionRequestOpts(requestParameters: IngestDocumentVersionRequest): Promise<runtime.RequestOpts>;
|
|
606
603
|
/**
|
|
607
|
-
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
604
|
+
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). The file must be the document\'s type (a PDF document takes only PDF versions; ``.md`` and ``.txt`` are both PLAINTEXT); any other type is a 400. Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
608
605
|
* Ingest Document Version Handler
|
|
609
606
|
*/
|
|
610
607
|
ingestDocumentVersionRaw(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestDocumentResponse>>;
|
|
611
608
|
/**
|
|
612
|
-
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
609
|
+
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). The file must be the document\'s type (a PDF document takes only PDF versions; ``.md`` and ``.txt`` are both PLAINTEXT); any other type is a 400. Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
613
610
|
* Ingest Document Version Handler
|
|
614
611
|
*/
|
|
615
612
|
ingestDocumentVersion(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
|
|
@@ -505,9 +505,6 @@ class DocumentsApi extends runtime.BaseAPI {
|
|
|
505
505
|
if (requestParameters['idempotencyKey'] != null) {
|
|
506
506
|
formParams.append('idempotency_key', requestParameters['idempotencyKey']);
|
|
507
507
|
}
|
|
508
|
-
if (requestParameters['emailNestingDepth'] != null) {
|
|
509
|
-
formParams.append('email_nesting_depth', requestParameters['emailNestingDepth']);
|
|
510
|
-
}
|
|
511
508
|
if (requestParameters['ingestionMode'] != null) {
|
|
512
509
|
formParams.append('ingestion_mode', requestParameters['ingestionMode']);
|
|
513
510
|
}
|
|
@@ -625,7 +622,7 @@ class DocumentsApi extends runtime.BaseAPI {
|
|
|
625
622
|
});
|
|
626
623
|
}
|
|
627
624
|
/**
|
|
628
|
-
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
625
|
+
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). The file must be the document\'s type (a PDF document takes only PDF versions; ``.md`` and ``.txt`` are both PLAINTEXT); any other type is a 400. Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
629
626
|
* Ingest Document Version Handler
|
|
630
627
|
*/
|
|
631
628
|
ingestDocumentVersionRaw(requestParameters, initOverrides) {
|
|
@@ -636,7 +633,7 @@ class DocumentsApi extends runtime.BaseAPI {
|
|
|
636
633
|
});
|
|
637
634
|
}
|
|
638
635
|
/**
|
|
639
|
-
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
636
|
+
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). The file must be the document\'s type (a PDF document takes only PDF versions; ``.md`` and ``.txt`` are both PLAINTEXT); any other type is a 400. Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
640
637
|
* Ingest Document Version Handler
|
|
641
638
|
*/
|
|
642
639
|
ingestDocumentVersion(requestParameters, initOverrides) {
|
|
@@ -129,7 +129,7 @@ export interface SystemJobsApiInterface {
|
|
|
129
129
|
*/
|
|
130
130
|
getZipIngestionStatusRequestOpts(requestParameters: GetZipIngestionStatusRequest): Promise<runtime.RequestOpts>;
|
|
131
131
|
/**
|
|
132
|
-
* Get a fan-out\'s live status + per-member outcomes.
|
|
132
|
+
* Get a ZIP fan-out\'s live status + per-member outcomes. Tenant-scoped via the TenantId search attribute (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s.
|
|
133
133
|
* @summary Get Zip Ingestion Status Handler
|
|
134
134
|
* @param {string} workflowId
|
|
135
135
|
* @param {*} [options] Override http request option.
|
|
@@ -138,7 +138,7 @@ export interface SystemJobsApiInterface {
|
|
|
138
138
|
*/
|
|
139
139
|
getZipIngestionStatusRaw(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZipIngestionStatusResponse>>;
|
|
140
140
|
/**
|
|
141
|
-
* Get a fan-out\'s live status + per-member outcomes.
|
|
141
|
+
* Get a ZIP fan-out\'s live status + per-member outcomes. Tenant-scoped via the TenantId search attribute (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s.
|
|
142
142
|
* Get Zip Ingestion Status Handler
|
|
143
143
|
*/
|
|
144
144
|
getZipIngestionStatus(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZipIngestionStatusResponse>;
|
|
@@ -231,12 +231,12 @@ export declare class SystemJobsApi extends runtime.BaseAPI implements SystemJobs
|
|
|
231
231
|
*/
|
|
232
232
|
getZipIngestionStatusRequestOpts(requestParameters: GetZipIngestionStatusRequest): Promise<runtime.RequestOpts>;
|
|
233
233
|
/**
|
|
234
|
-
* Get a fan-out\'s live status + per-member outcomes.
|
|
234
|
+
* Get a ZIP fan-out\'s live status + per-member outcomes. Tenant-scoped via the TenantId search attribute (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s.
|
|
235
235
|
* Get Zip Ingestion Status Handler
|
|
236
236
|
*/
|
|
237
237
|
getZipIngestionStatusRaw(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZipIngestionStatusResponse>>;
|
|
238
238
|
/**
|
|
239
|
-
* Get a fan-out\'s live status + per-member outcomes.
|
|
239
|
+
* Get a ZIP fan-out\'s live status + per-member outcomes. Tenant-scoped via the TenantId search attribute (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s.
|
|
240
240
|
* Get Zip Ingestion Status Handler
|
|
241
241
|
*/
|
|
242
242
|
getZipIngestionStatus(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZipIngestionStatusResponse>;
|
|
@@ -282,7 +282,7 @@ class SystemJobsApi extends runtime.BaseAPI {
|
|
|
282
282
|
});
|
|
283
283
|
}
|
|
284
284
|
/**
|
|
285
|
-
* Get a fan-out\'s live status + per-member outcomes.
|
|
285
|
+
* Get a ZIP fan-out\'s live status + per-member outcomes. Tenant-scoped via the TenantId search attribute (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s.
|
|
286
286
|
* Get Zip Ingestion Status Handler
|
|
287
287
|
*/
|
|
288
288
|
getZipIngestionStatusRaw(requestParameters, initOverrides) {
|
|
@@ -293,7 +293,7 @@ class SystemJobsApi extends runtime.BaseAPI {
|
|
|
293
293
|
});
|
|
294
294
|
}
|
|
295
295
|
/**
|
|
296
|
-
* Get a fan-out\'s live status + per-member outcomes.
|
|
296
|
+
* Get a ZIP fan-out\'s live status + per-member outcomes. Tenant-scoped via the TenantId search attribute (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s.
|
|
297
297
|
* Get Zip Ingestion Status Handler
|
|
298
298
|
*/
|
|
299
299
|
getZipIngestionStatus(requestParameters, initOverrides) {
|
|
@@ -43,7 +43,6 @@ export interface IngestDocumentRequest {
|
|
|
43
43
|
name?: string | null;
|
|
44
44
|
tagIds?: Array<string>;
|
|
45
45
|
idempotencyKey?: string | null;
|
|
46
|
-
emailNestingDepth?: number;
|
|
47
46
|
ingestionMode?: IngestionMode;
|
|
48
47
|
chunkType?: ChunkType;
|
|
49
48
|
secondaryTaxonomy?: ImageTaxonomy;
|
|
@@ -277,7 +276,6 @@ export interface DocumentsApiInterface {
|
|
|
277
276
|
* @param {string} [name] Document name (defaults to filename)
|
|
278
277
|
* @param {Array<string>} [tagIds] Tag IDs applied to the created document.
|
|
279
278
|
* @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
|
|
280
|
-
* @param {number} [emailNestingDepth] Internal: set by the email member fan-out when a nested email re-enters this endpoint. Leave at 0 for direct uploads.
|
|
281
279
|
* @param {IngestionMode} [ingestionMode]
|
|
282
280
|
* @param {ChunkType} [chunkType]
|
|
283
281
|
* @param {ImageTaxonomy} [secondaryTaxonomy]
|
|
@@ -296,7 +294,6 @@ export interface DocumentsApiInterface {
|
|
|
296
294
|
* @param {string} [name] Document name (defaults to filename)
|
|
297
295
|
* @param {Array<string>} [tagIds] Tag IDs applied to the created document.
|
|
298
296
|
* @param {string} [idempotencyKey] Opt-in key: a repeat with the same key at the same (parent, name) replays the existing document instead of a 409.
|
|
299
|
-
* @param {number} [emailNestingDepth] Internal: set by the email member fan-out when a nested email re-enters this endpoint. Leave at 0 for direct uploads.
|
|
300
297
|
* @param {IngestionMode} [ingestionMode]
|
|
301
298
|
* @param {ChunkType} [chunkType]
|
|
302
299
|
* @param {ImageTaxonomy} [secondaryTaxonomy]
|
|
@@ -328,7 +325,7 @@ export interface DocumentsApiInterface {
|
|
|
328
325
|
*/
|
|
329
326
|
ingestDocumentVersionRequestOpts(requestParameters: IngestDocumentVersionRequest): Promise<runtime.RequestOpts>;
|
|
330
327
|
/**
|
|
331
|
-
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
328
|
+
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). The file must be the document\'s type (a PDF document takes only PDF versions; ``.md`` and ``.txt`` are both PLAINTEXT); any other type is a 400. Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
332
329
|
* @summary Ingest Document Version Handler
|
|
333
330
|
* @param {string} documentId Document ID
|
|
334
331
|
* @param {Blob} file
|
|
@@ -344,7 +341,7 @@ export interface DocumentsApiInterface {
|
|
|
344
341
|
*/
|
|
345
342
|
ingestDocumentVersionRaw(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestDocumentResponse>>;
|
|
346
343
|
/**
|
|
347
|
-
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
344
|
+
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). The file must be the document\'s type (a PDF document takes only PDF versions; ``.md`` and ``.txt`` are both PLAINTEXT); any other type is a 400. Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
348
345
|
* Ingest Document Version Handler
|
|
349
346
|
*/
|
|
350
347
|
ingestDocumentVersion(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
|
|
@@ -604,12 +601,12 @@ export declare class DocumentsApi extends runtime.BaseAPI implements DocumentsAp
|
|
|
604
601
|
*/
|
|
605
602
|
ingestDocumentVersionRequestOpts(requestParameters: IngestDocumentVersionRequest): Promise<runtime.RequestOpts>;
|
|
606
603
|
/**
|
|
607
|
-
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
604
|
+
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). The file must be the document\'s type (a PDF document takes only PDF versions; ``.md`` and ``.txt`` are both PLAINTEXT); any other type is a 400. Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
608
605
|
* Ingest Document Version Handler
|
|
609
606
|
*/
|
|
610
607
|
ingestDocumentVersionRaw(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<IngestDocumentResponse>>;
|
|
611
608
|
/**
|
|
612
|
-
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
609
|
+
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). The file must be the document\'s type (a PDF document takes only PDF versions; ``.md`` and ``.txt`` are both PLAINTEXT); any other type is a 400. Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
613
610
|
* Ingest Document Version Handler
|
|
614
611
|
*/
|
|
615
612
|
ingestDocumentVersion(requestParameters: IngestDocumentVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<IngestDocumentResponse>;
|
|
@@ -469,9 +469,6 @@ export class DocumentsApi extends runtime.BaseAPI {
|
|
|
469
469
|
if (requestParameters['idempotencyKey'] != null) {
|
|
470
470
|
formParams.append('idempotency_key', requestParameters['idempotencyKey']);
|
|
471
471
|
}
|
|
472
|
-
if (requestParameters['emailNestingDepth'] != null) {
|
|
473
|
-
formParams.append('email_nesting_depth', requestParameters['emailNestingDepth']);
|
|
474
|
-
}
|
|
475
472
|
if (requestParameters['ingestionMode'] != null) {
|
|
476
473
|
formParams.append('ingestion_mode', requestParameters['ingestionMode']);
|
|
477
474
|
}
|
|
@@ -589,7 +586,7 @@ export class DocumentsApi extends runtime.BaseAPI {
|
|
|
589
586
|
});
|
|
590
587
|
}
|
|
591
588
|
/**
|
|
592
|
-
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
589
|
+
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). The file must be the document\'s type (a PDF document takes only PDF versions; ``.md`` and ``.txt`` are both PLAINTEXT); any other type is a 400. Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
593
590
|
* Ingest Document Version Handler
|
|
594
591
|
*/
|
|
595
592
|
ingestDocumentVersionRaw(requestParameters, initOverrides) {
|
|
@@ -600,7 +597,7 @@ export class DocumentsApi extends runtime.BaseAPI {
|
|
|
600
597
|
});
|
|
601
598
|
}
|
|
602
599
|
/**
|
|
603
|
-
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
600
|
+
* Upload a new file for an existing document, creating a new version and triggering ingestion. Requires an active document checkout held by the caller. Acquire one via ``POST /v1/documents/{id}/checkout`` first and release it after; otherwise this returns 409 Conflict (\"A document checkout is required to edit this document.\"). The file must be the document\'s type (a PDF document takes only PDF versions; ``.md`` and ``.txt`` are both PLAINTEXT); any other type is a 400. Creates a new document version (incrementing the highest version number), uploads the file to S3, and starts the ingestion workflow. Upon successful ingestion, the new version is automatically activated (set as the document\'s active_version) and the old version\'s Qdrant points are deactivated. Returns 201 immediately with the Temporal ``workflow_id``. Ingestion runs in the background — poll ``GET /v1/system-jobs/document_versions/{workflow_id}`` (also given in the ``Location`` header) until ``status`` is terminal.
|
|
604
601
|
* Ingest Document Version Handler
|
|
605
602
|
*/
|
|
606
603
|
ingestDocumentVersion(requestParameters, initOverrides) {
|
|
@@ -129,7 +129,7 @@ export interface SystemJobsApiInterface {
|
|
|
129
129
|
*/
|
|
130
130
|
getZipIngestionStatusRequestOpts(requestParameters: GetZipIngestionStatusRequest): Promise<runtime.RequestOpts>;
|
|
131
131
|
/**
|
|
132
|
-
* Get a fan-out\'s live status + per-member outcomes.
|
|
132
|
+
* Get a ZIP fan-out\'s live status + per-member outcomes. Tenant-scoped via the TenantId search attribute (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s.
|
|
133
133
|
* @summary Get Zip Ingestion Status Handler
|
|
134
134
|
* @param {string} workflowId
|
|
135
135
|
* @param {*} [options] Override http request option.
|
|
@@ -138,7 +138,7 @@ export interface SystemJobsApiInterface {
|
|
|
138
138
|
*/
|
|
139
139
|
getZipIngestionStatusRaw(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZipIngestionStatusResponse>>;
|
|
140
140
|
/**
|
|
141
|
-
* Get a fan-out\'s live status + per-member outcomes.
|
|
141
|
+
* Get a ZIP fan-out\'s live status + per-member outcomes. Tenant-scoped via the TenantId search attribute (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s.
|
|
142
142
|
* Get Zip Ingestion Status Handler
|
|
143
143
|
*/
|
|
144
144
|
getZipIngestionStatus(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZipIngestionStatusResponse>;
|
|
@@ -231,12 +231,12 @@ export declare class SystemJobsApi extends runtime.BaseAPI implements SystemJobs
|
|
|
231
231
|
*/
|
|
232
232
|
getZipIngestionStatusRequestOpts(requestParameters: GetZipIngestionStatusRequest): Promise<runtime.RequestOpts>;
|
|
233
233
|
/**
|
|
234
|
-
* Get a fan-out\'s live status + per-member outcomes.
|
|
234
|
+
* Get a ZIP fan-out\'s live status + per-member outcomes. Tenant-scoped via the TenantId search attribute (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s.
|
|
235
235
|
* Get Zip Ingestion Status Handler
|
|
236
236
|
*/
|
|
237
237
|
getZipIngestionStatusRaw(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ZipIngestionStatusResponse>>;
|
|
238
238
|
/**
|
|
239
|
-
* Get a fan-out\'s live status + per-member outcomes.
|
|
239
|
+
* Get a ZIP fan-out\'s live status + per-member outcomes. Tenant-scoped via the TenantId search attribute (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s.
|
|
240
240
|
* Get Zip Ingestion Status Handler
|
|
241
241
|
*/
|
|
242
242
|
getZipIngestionStatus(requestParameters: GetZipIngestionStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ZipIngestionStatusResponse>;
|
|
@@ -246,7 +246,7 @@ export class SystemJobsApi extends runtime.BaseAPI {
|
|
|
246
246
|
});
|
|
247
247
|
}
|
|
248
248
|
/**
|
|
249
|
-
* Get a fan-out\'s live status + per-member outcomes.
|
|
249
|
+
* Get a ZIP fan-out\'s live status + per-member outcomes. Tenant-scoped via the TenantId search attribute (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s.
|
|
250
250
|
* Get Zip Ingestion Status Handler
|
|
251
251
|
*/
|
|
252
252
|
getZipIngestionStatusRaw(requestParameters, initOverrides) {
|
|
@@ -257,7 +257,7 @@ export class SystemJobsApi extends runtime.BaseAPI {
|
|
|
257
257
|
});
|
|
258
258
|
}
|
|
259
259
|
/**
|
|
260
|
-
* Get a fan-out\'s live status + per-member outcomes.
|
|
260
|
+
* Get a ZIP fan-out\'s live status + per-member outcomes. Tenant-scoped via the TenantId search attribute (no per-path can_read check — intentionally consistent with the sibling generic Temporal endpoints below; the opaque workflow_id is only handed to the uploader, who had can_write on the target). The per-member results come from the workflow\'s ``results`` query (served from retained history), so once Temporal retention expires this 404s.
|
|
261
261
|
* Get Zip Ingestion Status Handler
|
|
262
262
|
*/
|
|
263
263
|
getZipIngestionStatus(requestParameters, initOverrides) {
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { SupportedLanguage } from './SupportedLanguage';
|
|
12
13
|
/**
|
|
13
14
|
* Request body for POST /v1/agent/ask.
|
|
14
15
|
* @export
|
|
@@ -21,6 +22,12 @@ export interface AskRequest {
|
|
|
21
22
|
* @memberof AskRequest
|
|
22
23
|
*/
|
|
23
24
|
prompt: string;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {SupportedLanguage}
|
|
28
|
+
* @memberof AskRequest
|
|
29
|
+
*/
|
|
30
|
+
outputLanguage?: SupportedLanguage;
|
|
24
31
|
}
|
|
25
32
|
export declare const AskRequestPropertyValidationAttributesMap: {
|
|
26
33
|
[property: string]: {
|
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
+
import { SupportedLanguageFromJSON, SupportedLanguageToJSON, } from './SupportedLanguage';
|
|
14
15
|
export const AskRequestPropertyValidationAttributesMap = {};
|
|
15
16
|
/**
|
|
16
17
|
* Check if a given object implements the AskRequest interface.
|
|
@@ -29,6 +30,7 @@ export function AskRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
29
30
|
}
|
|
30
31
|
return {
|
|
31
32
|
'prompt': json['prompt'],
|
|
33
|
+
'outputLanguage': json['output_language'] == null ? undefined : SupportedLanguageFromJSON(json['output_language']),
|
|
32
34
|
};
|
|
33
35
|
}
|
|
34
36
|
export function AskRequestToJSON(json) {
|
|
@@ -40,5 +42,6 @@ export function AskRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
40
42
|
}
|
|
41
43
|
return {
|
|
42
44
|
'prompt': value['prompt'],
|
|
45
|
+
'output_language': SupportedLanguageToJSON(value['outputLanguage']),
|
|
43
46
|
};
|
|
44
47
|
}
|
|
@@ -12,7 +12,6 @@
|
|
|
12
12
|
import type { PipelineState } from './PipelineState';
|
|
13
13
|
import type { XlsxCellAnchorOutputOrDocxParagraphAnchorOutput } from './XlsxCellAnchorOutputOrDocxParagraphAnchorOutput';
|
|
14
14
|
import type { InformationStatistics } from './InformationStatistics';
|
|
15
|
-
import type { EmailMetadata } from './EmailMetadata';
|
|
16
15
|
/**
|
|
17
16
|
* Schema for document_version.system_metadata JSONB field.
|
|
18
17
|
*
|
|
@@ -112,12 +111,6 @@ export interface DocumentVersionMetadata {
|
|
|
112
111
|
* @memberof DocumentVersionMetadata
|
|
113
112
|
*/
|
|
114
113
|
segmentCount?: number | null;
|
|
115
|
-
/**
|
|
116
|
-
* Structured email headers; null for non-email documents
|
|
117
|
-
* @type {EmailMetadata}
|
|
118
|
-
* @memberof DocumentVersionMetadata
|
|
119
|
-
*/
|
|
120
|
-
email?: EmailMetadata | null;
|
|
121
114
|
/**
|
|
122
115
|
* Total formula cells in the workbook (XLSX only)
|
|
123
116
|
* @type {number}
|
|
@@ -14,7 +14,6 @@
|
|
|
14
14
|
import { PipelineStateFromJSON, PipelineStateToJSON, } from './PipelineState';
|
|
15
15
|
import { XlsxCellAnchorOutputOrDocxParagraphAnchorOutputFromJSON, XlsxCellAnchorOutputOrDocxParagraphAnchorOutputToJSON, } from './XlsxCellAnchorOutputOrDocxParagraphAnchorOutput';
|
|
16
16
|
import { InformationStatisticsFromJSON, InformationStatisticsToJSON, } from './InformationStatistics';
|
|
17
|
-
import { EmailMetadataFromJSON, EmailMetadataToJSON, } from './EmailMetadata';
|
|
18
17
|
export const DocumentVersionMetadataPropertyValidationAttributesMap = {};
|
|
19
18
|
/**
|
|
20
19
|
* Check if a given object implements the DocumentVersionMetadata interface.
|
|
@@ -44,7 +43,6 @@ export function DocumentVersionMetadataFromJSONTyped(json, ignoreDiscriminator)
|
|
|
44
43
|
'durationMs': json['duration_ms'] == null ? undefined : json['duration_ms'],
|
|
45
44
|
'language': json['language'] == null ? undefined : json['language'],
|
|
46
45
|
'segmentCount': json['segment_count'] == null ? undefined : json['segment_count'],
|
|
47
|
-
'email': json['email'] == null ? undefined : EmailMetadataFromJSON(json['email']),
|
|
48
46
|
'totalFormulas': json['total_formulas'] == null ? undefined : json['total_formulas'],
|
|
49
47
|
'xlsxParseResultS3': json['xlsx_parse_result_s3'] == null ? undefined : json['xlsx_parse_result_s3'],
|
|
50
48
|
'xlsxNamedRanges': json['xlsx_named_ranges'] == null ? undefined : json['xlsx_named_ranges'],
|
|
@@ -81,7 +79,6 @@ export function DocumentVersionMetadataToJSONTyped(value, ignoreDiscriminator =
|
|
|
81
79
|
'duration_ms': value['durationMs'],
|
|
82
80
|
'language': value['language'],
|
|
83
81
|
'segment_count': value['segmentCount'],
|
|
84
|
-
'email': EmailMetadataToJSON(value['email']),
|
|
85
82
|
'total_formulas': value['totalFormulas'],
|
|
86
83
|
'xlsx_parse_result_s3': value['xlsxParseResultS3'],
|
|
87
84
|
'xlsx_named_ranges': value['xlsxNamedRanges'],
|
|
@@ -12,7 +12,6 @@
|
|
|
12
12
|
import type { PipelineState } from './PipelineState';
|
|
13
13
|
import type { XlsxCellAnchorInputOrDocxParagraphAnchorInput } from './XlsxCellAnchorInputOrDocxParagraphAnchorInput';
|
|
14
14
|
import type { InformationStatistics } from './InformationStatistics';
|
|
15
|
-
import type { EmailMetadata } from './EmailMetadata';
|
|
16
15
|
/**
|
|
17
16
|
* Partial update schema for document version metadata.
|
|
18
17
|
*
|
|
@@ -124,12 +123,6 @@ export interface DocumentVersionMetadataUpdate {
|
|
|
124
123
|
* @memberof DocumentVersionMetadataUpdate
|
|
125
124
|
*/
|
|
126
125
|
segmentCount?: number | null;
|
|
127
|
-
/**
|
|
128
|
-
*
|
|
129
|
-
* @type {EmailMetadata}
|
|
130
|
-
* @memberof DocumentVersionMetadataUpdate
|
|
131
|
-
*/
|
|
132
|
-
email?: EmailMetadata | null;
|
|
133
126
|
/**
|
|
134
127
|
*
|
|
135
128
|
* @type {number}
|
|
@@ -14,7 +14,6 @@
|
|
|
14
14
|
import { PipelineStateFromJSON, PipelineStateToJSON, } from './PipelineState';
|
|
15
15
|
import { XlsxCellAnchorInputOrDocxParagraphAnchorInputFromJSON, XlsxCellAnchorInputOrDocxParagraphAnchorInputToJSON, } from './XlsxCellAnchorInputOrDocxParagraphAnchorInput';
|
|
16
16
|
import { InformationStatisticsFromJSON, InformationStatisticsToJSON, } from './InformationStatistics';
|
|
17
|
-
import { EmailMetadataFromJSON, EmailMetadataToJSON, } from './EmailMetadata';
|
|
18
17
|
export const DocumentVersionMetadataUpdatePropertyValidationAttributesMap = {};
|
|
19
18
|
/**
|
|
20
19
|
* Check if a given object implements the DocumentVersionMetadataUpdate interface.
|
|
@@ -47,7 +46,6 @@ export function DocumentVersionMetadataUpdateFromJSONTyped(json, ignoreDiscrimin
|
|
|
47
46
|
'durationMs': json['duration_ms'] == null ? undefined : json['duration_ms'],
|
|
48
47
|
'language': json['language'] == null ? undefined : json['language'],
|
|
49
48
|
'segmentCount': json['segment_count'] == null ? undefined : json['segment_count'],
|
|
50
|
-
'email': json['email'] == null ? undefined : EmailMetadataFromJSON(json['email']),
|
|
51
49
|
'totalFormulas': json['total_formulas'] == null ? undefined : json['total_formulas'],
|
|
52
50
|
'xlsxParseResultS3': json['xlsx_parse_result_s3'] == null ? undefined : json['xlsx_parse_result_s3'],
|
|
53
51
|
'xlsxNamedRanges': json['xlsx_named_ranges'] == null ? undefined : json['xlsx_named_ranges'],
|
|
@@ -86,7 +84,6 @@ export function DocumentVersionMetadataUpdateToJSONTyped(value, ignoreDiscrimina
|
|
|
86
84
|
'duration_ms': value['durationMs'],
|
|
87
85
|
'language': value['language'],
|
|
88
86
|
'segment_count': value['segmentCount'],
|
|
89
|
-
'email': EmailMetadataToJSON(value['email']),
|
|
90
87
|
'total_formulas': value['totalFormulas'],
|
|
91
88
|
'xlsx_parse_result_s3': value['xlsxParseResultS3'],
|
|
92
89
|
'xlsx_named_ranges': value['xlsxNamedRanges'],
|
|
@@ -33,24 +33,6 @@ export interface IngestDocumentResponse {
|
|
|
33
33
|
* @memberof IngestDocumentResponse
|
|
34
34
|
*/
|
|
35
35
|
documentVersionId: string;
|
|
36
|
-
/**
|
|
37
|
-
* Folder created to hold this upload and its members. Set for email uploads, which always nest inside their own folder; null for every other type, which ingest directly into path_part_id.
|
|
38
|
-
* @type {string}
|
|
39
|
-
* @memberof IngestDocumentResponse
|
|
40
|
-
*/
|
|
41
|
-
folderId?: string | null;
|
|
42
|
-
/**
|
|
43
|
-
* Members found on an email upload, each becoming its own document beside the email: the attachments of a single message, or the messages of an .mbox archive (whose own attachments are then expanded one level deeper). Always 0 for non-email uploads. Null for a .pst, whose members are enumerated only by the worker fan-out — poll attachment_workflow_id for per-member outcomes.
|
|
44
|
-
* @type {number}
|
|
45
|
-
* @memberof IngestDocumentResponse
|
|
46
|
-
*/
|
|
47
|
-
attachmentCount?: number | null;
|
|
48
|
-
/**
|
|
49
|
-
* Fan-out workflow ingesting the members. Poll GET /v1/system-jobs/zip-ingestions/{id} for per-member outcomes. Null when the upload had no ingestible members.
|
|
50
|
-
* @type {string}
|
|
51
|
-
* @memberof IngestDocumentResponse
|
|
52
|
-
*/
|
|
53
|
-
attachmentWorkflowId?: string | null;
|
|
54
36
|
}
|
|
55
37
|
export declare const IngestDocumentResponsePropertyValidationAttributesMap: {
|
|
56
38
|
[property: string]: {
|
|
@@ -35,9 +35,6 @@ export function IngestDocumentResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
35
35
|
'workflowId': json['workflow_id'],
|
|
36
36
|
'documentId': json['document_id'],
|
|
37
37
|
'documentVersionId': json['document_version_id'],
|
|
38
|
-
'folderId': json['folder_id'] == null ? undefined : json['folder_id'],
|
|
39
|
-
'attachmentCount': json['attachment_count'] == null ? undefined : json['attachment_count'],
|
|
40
|
-
'attachmentWorkflowId': json['attachment_workflow_id'] == null ? undefined : json['attachment_workflow_id'],
|
|
41
38
|
};
|
|
42
39
|
}
|
|
43
40
|
export function IngestDocumentResponseToJSON(json) {
|
|
@@ -51,8 +48,5 @@ export function IngestDocumentResponseToJSONTyped(value, ignoreDiscriminator = f
|
|
|
51
48
|
'workflow_id': value['workflowId'],
|
|
52
49
|
'document_id': value['documentId'],
|
|
53
50
|
'document_version_id': value['documentVersionId'],
|
|
54
|
-
'folder_id': value['folderId'],
|
|
55
|
-
'attachment_count': value['attachmentCount'],
|
|
56
|
-
'attachment_workflow_id': value['attachmentWorkflowId'],
|
|
57
51
|
};
|
|
58
52
|
}
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { PipelineStatus } from './PipelineStatus';
|
|
13
|
+
import type { ImageTaxonomy } from './ImageTaxonomy';
|
|
13
14
|
import type { IngestionMode } from './IngestionMode';
|
|
14
15
|
import type { ChunkType } from './ChunkType';
|
|
15
16
|
/**
|
|
@@ -37,7 +38,7 @@ export interface PipelineState {
|
|
|
37
38
|
*/
|
|
38
39
|
lastStateUpdateTimestamp?: Date | null;
|
|
39
40
|
/**
|
|
40
|
-
* Name of the last activity that executed (e.g., '
|
|
41
|
+
* Name of the last activity that executed (e.g., 'pdf_preparation_activity')
|
|
41
42
|
* @type {string}
|
|
42
43
|
* @memberof PipelineState
|
|
43
44
|
*/
|
|
@@ -78,6 +79,12 @@ export interface PipelineState {
|
|
|
78
79
|
* @memberof PipelineState
|
|
79
80
|
*/
|
|
80
81
|
chunkType?: ChunkType;
|
|
82
|
+
/**
|
|
83
|
+
*
|
|
84
|
+
* @type {ImageTaxonomy}
|
|
85
|
+
* @memberof PipelineState
|
|
86
|
+
*/
|
|
87
|
+
secondaryTaxonomy?: ImageTaxonomy;
|
|
81
88
|
}
|
|
82
89
|
export declare const PipelineStatePropertyValidationAttributesMap: {
|
|
83
90
|
[property: string]: {
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
14
|
import { PipelineStatusFromJSON, PipelineStatusToJSON, } from './PipelineStatus';
|
|
15
|
+
import { ImageTaxonomyFromJSON, ImageTaxonomyToJSON, } from './ImageTaxonomy';
|
|
15
16
|
import { IngestionModeFromJSON, IngestionModeToJSON, } from './IngestionMode';
|
|
16
17
|
import { ChunkTypeFromJSON, ChunkTypeToJSON, } from './ChunkType';
|
|
17
18
|
export const PipelineStatePropertyValidationAttributesMap = {};
|
|
@@ -41,6 +42,7 @@ export function PipelineStateFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
41
42
|
'pageDpi': json['page_dpi'] == null ? undefined : json['page_dpi'],
|
|
42
43
|
'ingestionMode': json['ingestion_mode'] == null ? undefined : IngestionModeFromJSON(json['ingestion_mode']),
|
|
43
44
|
'chunkType': json['chunk_type'] == null ? undefined : ChunkTypeFromJSON(json['chunk_type']),
|
|
45
|
+
'secondaryTaxonomy': json['secondary_taxonomy'] == null ? undefined : ImageTaxonomyFromJSON(json['secondary_taxonomy']),
|
|
44
46
|
};
|
|
45
47
|
}
|
|
46
48
|
export function PipelineStateToJSON(json) {
|
|
@@ -61,5 +63,6 @@ export function PipelineStateToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
61
63
|
'page_dpi': value['pageDpi'],
|
|
62
64
|
'ingestion_mode': IngestionModeToJSON(value['ingestionMode']),
|
|
63
65
|
'chunk_type': ChunkTypeToJSON(value['chunkType']),
|
|
66
|
+
'secondary_taxonomy': ImageTaxonomyToJSON(value['secondaryTaxonomy']),
|
|
64
67
|
};
|
|
65
68
|
}
|