@knowledge-stack/ksapi 1.118.0 → 1.119.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 +38 -4
- package/README.md +25 -4
- package/dist/apis/DataSourcesApi.d.ts +170 -9
- package/dist/apis/DataSourcesApi.js +207 -4
- package/dist/apis/DocumentVersionsApi.d.ts +4 -4
- package/dist/apis/DocumentVersionsApi.js +2 -2
- package/dist/apis/FoldersApi.d.ts +9 -9
- package/dist/apis/FoldersApi.js +2 -2
- package/dist/esm/apis/DataSourcesApi.d.ts +170 -9
- package/dist/esm/apis/DataSourcesApi.js +208 -5
- package/dist/esm/apis/DocumentVersionsApi.d.ts +4 -4
- package/dist/esm/apis/DocumentVersionsApi.js +2 -2
- package/dist/esm/apis/FoldersApi.d.ts +9 -9
- package/dist/esm/apis/FoldersApi.js +3 -3
- package/dist/esm/models/BlockChangeType.d.ts +26 -0
- package/dist/esm/models/BlockChangeType.js +44 -0
- package/dist/esm/models/BlockKind.d.ts +28 -0
- package/dist/esm/models/BlockKind.js +46 -0
- package/dist/esm/models/BulkModelTablesRequest.d.ts +48 -0
- package/dist/esm/models/BulkModelTablesRequest.js +50 -0
- package/dist/esm/models/BulkModelTablesResponse.d.ts +48 -0
- package/dist/esm/models/BulkModelTablesResponse.js +45 -0
- package/dist/esm/models/CellChange.d.ts +47 -0
- package/dist/esm/models/CellChange.js +14 -0
- package/dist/esm/models/CellDiff.d.ts +7 -0
- package/dist/esm/models/CellDiff.js +5 -0
- package/dist/esm/models/ChangeClass.d.ts +29 -0
- package/dist/esm/models/ChangeClass.js +47 -0
- package/dist/esm/models/DataSourceDescriptionResponse.d.ts +53 -0
- package/dist/esm/models/DataSourceDescriptionResponse.js +48 -0
- package/dist/esm/models/DataSourceDetailResponse.d.ts +13 -4
- package/dist/esm/models/DataSourceDetailResponse.js +6 -4
- package/dist/esm/models/DataSourceSchemaListItem.d.ts +53 -0
- package/dist/esm/models/DataSourceSchemaListItem.js +48 -0
- package/dist/esm/models/DataSourceSchemaListResponse.d.ts +3 -3
- package/dist/esm/models/DataSourceSchemaListResponse.js +3 -3
- package/dist/esm/models/DataSourceSchemaResponse.d.ts +95 -1
- package/dist/esm/models/DataSourceSchemaResponse.js +61 -0
- package/dist/esm/models/DataSourceTableResponse.d.ts +8 -5
- package/dist/esm/models/DataSourceTableResponse.js +4 -2
- package/dist/esm/models/DiffFormat.d.ts +2 -0
- package/dist/esm/models/DiffFormat.js +3 -1
- package/dist/esm/models/DocumentBlockChange.d.ts +174 -0
- package/dist/esm/models/DocumentBlockChange.js +97 -0
- package/dist/esm/models/DocumentDiff.d.ts +102 -0
- package/dist/esm/models/DocumentDiff.js +77 -0
- package/dist/esm/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts} +9 -6
- package/dist/esm/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.js} +11 -6
- package/dist/esm/models/ModelTableResult.d.ts +81 -0
- package/dist/esm/models/ModelTableResult.js +63 -0
- package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +66 -0
- package/dist/esm/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js} +12 -12
- package/dist/esm/models/PartType.d.ts +1 -0
- package/dist/esm/models/PartType.js +1 -0
- package/dist/esm/models/PixelRegion.d.ts +65 -0
- package/dist/esm/models/PixelRegion.js +56 -0
- package/dist/esm/models/ReferenceType.d.ts +1 -0
- package/dist/esm/models/ReferenceType.js +1 -0
- package/dist/esm/models/RevisionEdit.d.ts +71 -0
- package/dist/esm/models/RevisionEdit.js +57 -0
- package/dist/esm/models/SearchablePartType.d.ts +2 -0
- package/dist/esm/models/SearchablePartType.js +2 -0
- package/dist/esm/models/SheetVisibilityChange.d.ts +63 -0
- package/dist/esm/models/SheetVisibilityChange.js +52 -0
- package/dist/esm/models/StructuredChange.d.ts +69 -0
- package/dist/esm/models/StructuredChange.js +57 -0
- package/dist/esm/models/StructuredChangeType.d.ts +26 -0
- package/dist/esm/models/StructuredChangeType.js +44 -0
- package/dist/esm/models/StructuredDiff.d.ts +82 -0
- package/dist/esm/models/StructuredDiff.js +65 -0
- package/dist/esm/models/TableCellChange.d.ts +72 -0
- package/dist/esm/models/TableCellChange.js +61 -0
- package/dist/esm/models/VersionDiffResponse.d.ts +72 -1
- package/dist/esm/models/VersionDiffResponse.js +25 -0
- package/dist/esm/models/index.d.ts +19 -2
- package/dist/esm/models/index.js +19 -2
- package/dist/models/BlockChangeType.d.ts +26 -0
- package/dist/models/BlockChangeType.js +52 -0
- package/dist/models/BlockKind.d.ts +28 -0
- package/dist/models/BlockKind.js +54 -0
- package/dist/models/BulkModelTablesRequest.d.ts +48 -0
- package/dist/models/BulkModelTablesRequest.js +58 -0
- package/dist/models/BulkModelTablesResponse.d.ts +48 -0
- package/dist/models/BulkModelTablesResponse.js +53 -0
- package/dist/models/CellChange.d.ts +47 -0
- package/dist/models/CellChange.js +14 -0
- package/dist/models/CellDiff.d.ts +7 -0
- package/dist/models/CellDiff.js +5 -0
- package/dist/models/ChangeClass.d.ts +29 -0
- package/dist/models/ChangeClass.js +55 -0
- package/dist/models/DataSourceDescriptionResponse.d.ts +53 -0
- package/dist/models/DataSourceDescriptionResponse.js +56 -0
- package/dist/models/DataSourceDetailResponse.d.ts +13 -4
- package/dist/models/DataSourceDetailResponse.js +6 -4
- package/dist/models/DataSourceSchemaListItem.d.ts +53 -0
- package/dist/models/DataSourceSchemaListItem.js +56 -0
- package/dist/models/DataSourceSchemaListResponse.d.ts +3 -3
- package/dist/models/DataSourceSchemaListResponse.js +3 -3
- package/dist/models/DataSourceSchemaResponse.d.ts +95 -1
- package/dist/models/DataSourceSchemaResponse.js +62 -1
- package/dist/models/DataSourceTableResponse.d.ts +8 -5
- package/dist/models/DataSourceTableResponse.js +4 -2
- package/dist/models/DiffFormat.d.ts +2 -0
- package/dist/models/DiffFormat.js +3 -1
- package/dist/models/DocumentBlockChange.d.ts +174 -0
- package/dist/models/DocumentBlockChange.js +105 -0
- package/dist/models/DocumentDiff.d.ts +102 -0
- package/dist/models/DocumentDiff.js +85 -0
- package/dist/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.d.ts} +9 -6
- package/dist/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.js → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.js} +15 -10
- package/dist/models/ModelTableResult.d.ts +81 -0
- package/dist/models/ModelTableResult.js +71 -0
- package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +66 -0
- package/dist/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.js} +18 -18
- package/dist/models/PartType.d.ts +1 -0
- package/dist/models/PartType.js +1 -0
- package/dist/models/PixelRegion.d.ts +65 -0
- package/dist/models/PixelRegion.js +64 -0
- package/dist/models/ReferenceType.d.ts +1 -0
- package/dist/models/ReferenceType.js +1 -0
- package/dist/models/RevisionEdit.d.ts +71 -0
- package/dist/models/RevisionEdit.js +65 -0
- package/dist/models/SearchablePartType.d.ts +2 -0
- package/dist/models/SearchablePartType.js +2 -0
- package/dist/models/SheetVisibilityChange.d.ts +63 -0
- package/dist/models/SheetVisibilityChange.js +60 -0
- package/dist/models/StructuredChange.d.ts +69 -0
- package/dist/models/StructuredChange.js +65 -0
- package/dist/models/StructuredChangeType.d.ts +26 -0
- package/dist/models/StructuredChangeType.js +52 -0
- package/dist/models/StructuredDiff.d.ts +82 -0
- package/dist/models/StructuredDiff.js +73 -0
- package/dist/models/TableCellChange.d.ts +72 -0
- package/dist/models/TableCellChange.js +69 -0
- package/dist/models/VersionDiffResponse.d.ts +72 -1
- package/dist/models/VersionDiffResponse.js +25 -0
- package/dist/models/index.d.ts +19 -2
- package/dist/models/index.js +19 -2
- package/docs/BlockChangeType.md +32 -0
- package/docs/BlockKind.md +32 -0
- package/docs/BulkModelTablesRequest.md +35 -0
- package/docs/BulkModelTablesResponse.md +35 -0
- package/docs/CellChange.md +15 -1
- package/docs/CellDiff.md +2 -0
- package/docs/ChangeClass.md +33 -0
- package/docs/ChunksApi.md +1 -1
- package/docs/DataSourceDescriptionResponse.md +37 -0
- package/docs/DataSourceDetailResponse.md +5 -3
- package/docs/DataSourceSchemaListItem.md +37 -0
- package/docs/DataSourceSchemaListResponse.md +1 -1
- package/docs/DataSourceSchemaResponse.md +29 -0
- package/docs/DataSourceTableResponse.md +3 -3
- package/docs/DataSourcesApi.md +315 -2
- package/docs/DocumentBlockChange.md +73 -0
- package/docs/DocumentDiff.md +51 -0
- package/docs/DocumentVersionsApi.md +1 -1
- package/docs/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.md → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.md} +12 -6
- package/docs/FoldersApi.md +5 -5
- package/docs/ModelTableResult.md +43 -0
- package/docs/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.md} +5 -5
- package/docs/PixelRegion.md +41 -0
- package/docs/RevisionEdit.md +41 -0
- package/docs/SheetVisibilityChange.md +39 -0
- package/docs/StructuredChange.md +41 -0
- package/docs/StructuredChangeType.md +32 -0
- package/docs/StructuredDiff.md +45 -0
- package/docs/TableCellChange.md +43 -0
- package/docs/VersionDiffResponse.md +23 -1
- package/package.json +1 -1
- package/src/apis/DataSourcesApi.ts +382 -8
- package/src/apis/DocumentVersionsApi.ts +4 -4
- package/src/apis/FoldersApi.ts +13 -13
- package/src/models/BlockChangeType.ts +54 -0
- package/src/models/BlockKind.ts +56 -0
- package/src/models/BulkModelTablesRequest.ts +95 -0
- package/src/models/BulkModelTablesResponse.ts +91 -0
- package/src/models/CellChange.ts +61 -0
- package/src/models/CellDiff.ts +16 -0
- package/src/models/ChangeClass.ts +57 -0
- package/src/models/DataSourceDescriptionResponse.ts +92 -0
- package/src/models/DataSourceDetailResponse.ts +24 -13
- package/src/models/DataSourceSchemaListItem.ts +92 -0
- package/src/models/DataSourceSchemaListResponse.ts +10 -10
- package/src/models/DataSourceSchemaResponse.ts +157 -1
- package/src/models/DataSourceTableResponse.ts +11 -7
- package/src/models/DiffFormat.ts +3 -1
- package/src/models/DocumentBlockChange.ts +297 -0
- package/src/models/DocumentDiff.ts +169 -0
- package/src/models/{FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceTableResponseOrApiConnectionResponse.ts → FolderResponseOrDocumentResponseOrWorkflowDefinitionResponseOrWorkflowRunResponseOrDataSourceResponseOrDataSourceSchemaResponseOrDataSourceTableResponseOrApiConnectionResponse.ts} +19 -8
- package/src/models/ModelTableResult.ts +136 -0
- package/src/models/{PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.ts → PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceSchemaResponseDataSourceTableResponseApiConnectionResponseDiscriminator.ts} +25 -25
- package/src/models/PartType.ts +1 -0
- package/src/models/PixelRegion.ts +110 -0
- package/src/models/ReferenceType.ts +1 -0
- package/src/models/RevisionEdit.ts +125 -0
- package/src/models/SearchablePartType.ts +2 -0
- package/src/models/SheetVisibilityChange.ts +105 -0
- package/src/models/StructuredChange.ts +123 -0
- package/src/models/StructuredChangeType.ts +54 -0
- package/src/models/StructuredDiff.ts +140 -0
- package/src/models/TableCellChange.ts +129 -0
- package/src/models/VersionDiffResponse.ts +112 -1
- package/src/models/index.ts +19 -2
- package/dist/esm/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +0 -66
- package/dist/models/PaginatedResponseAnnotatedUnionFolderResponseDocumentResponseWorkflowDefinitionResponseWorkflowRunResponseDataSourceResponseDataSourceTableResponseApiConnectionResponseDiscriminator.d.ts +0 -66
package/docs/CellDiff.md
CHANGED
|
@@ -12,6 +12,7 @@ Name | Type
|
|
|
12
12
|
`removed` | number
|
|
13
13
|
`modified` | number
|
|
14
14
|
`truncated` | boolean
|
|
15
|
+
`sheetVisibilityChanges` | [Array<SheetVisibilityChange>](SheetVisibilityChange.md)
|
|
15
16
|
|
|
16
17
|
## Example
|
|
17
18
|
|
|
@@ -25,6 +26,7 @@ const example = {
|
|
|
25
26
|
"removed": null,
|
|
26
27
|
"modified": null,
|
|
27
28
|
"truncated": null,
|
|
29
|
+
"sheetVisibilityChanges": null,
|
|
28
30
|
} satisfies CellDiff
|
|
29
31
|
|
|
30
32
|
console.log(example)
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
|
|
2
|
+
# ChangeClass
|
|
3
|
+
|
|
4
|
+
What kind of change this is, so an auditor can filter (numbers move money).
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { ChangeClass } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
} satisfies ChangeClass
|
|
19
|
+
|
|
20
|
+
console.log(example)
|
|
21
|
+
|
|
22
|
+
// Convert the instance to a JSON string
|
|
23
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
24
|
+
console.log(exampleJSON)
|
|
25
|
+
|
|
26
|
+
// Parse the JSON string back to an object
|
|
27
|
+
const exampleParsed = JSON.parse(exampleJSON) as ChangeClass
|
|
28
|
+
console.log(exampleParsed)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
32
|
+
|
|
33
|
+
|
package/docs/ChunksApi.md
CHANGED
|
@@ -304,7 +304,7 @@ example().catch(console.error);
|
|
|
304
304
|
| **chunkId** | `string` | | [Defaults to `undefined`] |
|
|
305
305
|
| **prev** | `number` | Number of preceding items to include (max 50). | [Optional] [Defaults to `1`] |
|
|
306
306
|
| **next** | `number` | Number of succeeding items to include (max 50). | [Optional] [Defaults to `1`] |
|
|
307
|
-
| **contentType** | `PartType` | Filter by content type: SECTION or CHUNK. Omit to return both. SECTION is rejected when the anchor is a chunk (always). | [Optional] [Defaults to `undefined`] [Enum: FOLDER, DOCUMENT, DOCUMENT_VERSION, SECTION, CHUNK, THREAD, THREAD_MESSAGE, WORKFLOW_DEFINITION, WORKFLOW_RUN, DATA_SOURCE, DATA_SOURCE_TABLE, API_CONNECTION] |
|
|
307
|
+
| **contentType** | `PartType` | Filter by content type: SECTION or CHUNK. Omit to return both. SECTION is rejected when the anchor is a chunk (always). | [Optional] [Defaults to `undefined`] [Enum: FOLDER, DOCUMENT, DOCUMENT_VERSION, SECTION, CHUNK, THREAD, THREAD_MESSAGE, WORKFLOW_DEFINITION, WORKFLOW_RUN, DATA_SOURCE, DATA_SOURCE_SCHEMA, DATA_SOURCE_TABLE, API_CONNECTION] |
|
|
308
308
|
| **withinSection** | `boolean` | When true (default), traverse only the anchor\'s sibling chain under the same parent. When false, traverse the entire document version in DFS order, crossing section boundaries. | [Optional] [Defaults to `true`] |
|
|
309
309
|
|
|
310
310
|
### Return type
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
|
|
2
|
+
# DataSourceDescriptionResponse
|
|
3
|
+
|
|
4
|
+
Result of (re)generating a connector\'s searchable description Document.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`dataSourceId` | string
|
|
11
|
+
`descriptionDocumentId` | string
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { DataSourceDescriptionResponse } from '@knowledge-stack/ksapi'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"dataSourceId": null,
|
|
21
|
+
"descriptionDocumentId": null,
|
|
22
|
+
} satisfies DataSourceDescriptionResponse
|
|
23
|
+
|
|
24
|
+
console.log(example)
|
|
25
|
+
|
|
26
|
+
// Convert the instance to a JSON string
|
|
27
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
28
|
+
console.log(exampleJSON)
|
|
29
|
+
|
|
30
|
+
// Parse the JSON string back to an object
|
|
31
|
+
const exampleParsed = JSON.parse(exampleJSON) as DataSourceDescriptionResponse
|
|
32
|
+
console.log(exampleParsed)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
36
|
+
|
|
37
|
+
|
|
@@ -1,14 +1,15 @@
|
|
|
1
1
|
|
|
2
2
|
# DataSourceDetailResponse
|
|
3
3
|
|
|
4
|
-
A connector plus the
|
|
4
|
+
A connector plus the schemas (and their readable tables) the caller sees. ``description_document_id`` points at the connector\'s generated, ingested \"Database overview\" Document (a hidden system file); null until generated.
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
8
8
|
Name | Type
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`dataSource` | [DataSourceResponse](DataSourceResponse.md)
|
|
11
|
-
`
|
|
11
|
+
`schemas` | [Array<DataSourceSchemaResponse>](DataSourceSchemaResponse.md)
|
|
12
|
+
`descriptionDocumentId` | string
|
|
12
13
|
|
|
13
14
|
## Example
|
|
14
15
|
|
|
@@ -18,7 +19,8 @@ import type { DataSourceDetailResponse } from '@knowledge-stack/ksapi'
|
|
|
18
19
|
// TODO: Update the object below with actual values
|
|
19
20
|
const example = {
|
|
20
21
|
"dataSource": null,
|
|
21
|
-
"
|
|
22
|
+
"schemas": null,
|
|
23
|
+
"descriptionDocumentId": null,
|
|
22
24
|
} satisfies DataSourceDetailResponse
|
|
23
25
|
|
|
24
26
|
console.log(example)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
|
|
2
|
+
# DataSourceSchemaListItem
|
|
3
|
+
|
|
4
|
+
A namespace discovered by live introspection (not a persisted PDO).
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`name` | string
|
|
11
|
+
`isDefault` | boolean
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { DataSourceSchemaListItem } from '@knowledge-stack/ksapi'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"name": null,
|
|
21
|
+
"isDefault": null,
|
|
22
|
+
} satisfies DataSourceSchemaListItem
|
|
23
|
+
|
|
24
|
+
console.log(example)
|
|
25
|
+
|
|
26
|
+
// Convert the instance to a JSON string
|
|
27
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
28
|
+
console.log(exampleJSON)
|
|
29
|
+
|
|
30
|
+
// Parse the JSON string back to an object
|
|
31
|
+
const exampleParsed = JSON.parse(exampleJSON) as DataSourceSchemaListItem
|
|
32
|
+
console.log(exampleParsed)
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
36
|
+
|
|
37
|
+
|
|
@@ -7,7 +7,7 @@ The source\'s user namespaces (PG schemas / MySQL databases).
|
|
|
7
7
|
|
|
8
8
|
Name | Type
|
|
9
9
|
------------ | -------------
|
|
10
|
-
`schemas` | [Array<
|
|
10
|
+
`schemas` | [Array<DataSourceSchemaListItem>](DataSourceSchemaListItem.md)
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -1,13 +1,28 @@
|
|
|
1
1
|
|
|
2
2
|
# DataSourceSchemaResponse
|
|
3
3
|
|
|
4
|
+
A schema PDO under a connector, with the readable tables it contains.
|
|
4
5
|
|
|
5
6
|
## Properties
|
|
6
7
|
|
|
7
8
|
Name | Type
|
|
8
9
|
------------ | -------------
|
|
10
|
+
`partType` | string
|
|
11
|
+
`id` | string
|
|
12
|
+
`pathPartId` | string
|
|
13
|
+
`parentPathPartId` | string
|
|
14
|
+
`materializedPath` | string
|
|
15
|
+
`tenantId` | string
|
|
9
16
|
`name` | string
|
|
17
|
+
`dataSourceId` | string
|
|
18
|
+
`schemaName` | string
|
|
10
19
|
`isDefault` | boolean
|
|
20
|
+
`description` | string
|
|
21
|
+
`approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
|
|
22
|
+
`permissions` | [ItemPermissions](ItemPermissions.md)
|
|
23
|
+
`createdAt` | Date
|
|
24
|
+
`updatedAt` | Date
|
|
25
|
+
`tables` | [Array<DataSourceTableResponse>](DataSourceTableResponse.md)
|
|
11
26
|
|
|
12
27
|
## Example
|
|
13
28
|
|
|
@@ -16,8 +31,22 @@ import type { DataSourceSchemaResponse } from '@knowledge-stack/ksapi'
|
|
|
16
31
|
|
|
17
32
|
// TODO: Update the object below with actual values
|
|
18
33
|
const example = {
|
|
34
|
+
"partType": null,
|
|
35
|
+
"id": null,
|
|
36
|
+
"pathPartId": null,
|
|
37
|
+
"parentPathPartId": null,
|
|
38
|
+
"materializedPath": null,
|
|
39
|
+
"tenantId": null,
|
|
19
40
|
"name": null,
|
|
41
|
+
"dataSourceId": null,
|
|
42
|
+
"schemaName": null,
|
|
20
43
|
"isDefault": null,
|
|
44
|
+
"description": null,
|
|
45
|
+
"approvalState": null,
|
|
46
|
+
"permissions": null,
|
|
47
|
+
"createdAt": null,
|
|
48
|
+
"updatedAt": null,
|
|
49
|
+
"tables": null,
|
|
21
50
|
} satisfies DataSourceSchemaResponse
|
|
22
51
|
|
|
23
52
|
console.log(example)
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# DataSourceTableResponse
|
|
3
3
|
|
|
4
|
-
Modeled-table response; a discriminated-union variant for listings.
|
|
4
|
+
Modeled-table response; a discriminated-union variant for listings. The table\'s schema is its parent ``DataSourceSchema`` PDO; the table no longer carries a ``schema_name`` of its own.
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
@@ -15,8 +15,8 @@ Name | Type
|
|
|
15
15
|
`tenantId` | string
|
|
16
16
|
`name` | string
|
|
17
17
|
`dataSourceId` | string
|
|
18
|
+
`dataSourceSchemaId` | string
|
|
18
19
|
`tableName` | string
|
|
19
|
-
`schemaName` | string
|
|
20
20
|
`description` | string
|
|
21
21
|
`columnConfig` | Array<{ [key: string]: any; }>
|
|
22
22
|
`approvalState` | [PathPartApprovalState](PathPartApprovalState.md)
|
|
@@ -39,8 +39,8 @@ const example = {
|
|
|
39
39
|
"tenantId": null,
|
|
40
40
|
"name": null,
|
|
41
41
|
"dataSourceId": null,
|
|
42
|
+
"dataSourceSchemaId": null,
|
|
42
43
|
"tableName": null,
|
|
43
|
-
"schemaName": null,
|
|
44
44
|
"description": null,
|
|
45
45
|
"columnConfig": null,
|
|
46
46
|
"approvalState": null,
|
package/docs/DataSourcesApi.md
CHANGED
|
@@ -6,10 +6,14 @@ All URIs are relative to *http://localhost:8000*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
| [**createDataSource**](DataSourcesApi.md#createdatasourceoperation) | **POST** /v1/data-sources | Create Data Source Handler |
|
|
8
8
|
| [**deleteDataSource**](DataSourcesApi.md#deletedatasource) | **DELETE** /v1/data-sources/{data_source_id} | Delete Data Source Handler |
|
|
9
|
+
| [**deleteDataSourceSchema**](DataSourcesApi.md#deletedatasourceschema) | **DELETE** /v1/data-sources/{data_source_id}/schemas/{schema_id} | Delete Data Source Schema Handler |
|
|
10
|
+
| [**deleteDataSourceTable**](DataSourcesApi.md#deletedatasourcetable) | **DELETE** /v1/data-sources/{data_source_id}/tables/{table_id} | Delete Data Source Table Handler |
|
|
11
|
+
| [**generateDataSourceDescription**](DataSourcesApi.md#generatedatasourcedescription) | **POST** /v1/data-sources/{data_source_id}/describe | Generate Data Source Description Handler |
|
|
9
12
|
| [**getDataSource**](DataSourcesApi.md#getdatasource) | **GET** /v1/data-sources/{data_source_id} | Get Data Source Handler |
|
|
10
13
|
| [**getDataSourceCatalog**](DataSourcesApi.md#getdatasourcecatalog) | **GET** /v1/data-sources/{data_source_id}/catalog | Get Data Source Catalog Handler |
|
|
11
14
|
| [**listDataSourceSchemas**](DataSourcesApi.md#listdatasourceschemas) | **GET** /v1/data-sources/{data_source_id}/schemas | List Data Source Schemas Handler |
|
|
12
15
|
| [**modelDataSourceTable**](DataSourcesApi.md#modeldatasourcetable) | **POST** /v1/data-sources/{data_source_id}/tables | Model Data Source Table Handler |
|
|
16
|
+
| [**modelDataSourceTables**](DataSourcesApi.md#modeldatasourcetables) | **POST** /v1/data-sources/{data_source_id}/tables/batch | Model Data Source Tables Handler |
|
|
13
17
|
| [**queryDataSource**](DataSourcesApi.md#querydatasource) | **POST** /v1/data-sources/{data_source_id}/query | Query Data Source Handler |
|
|
14
18
|
| [**testDataSourceConnection**](DataSourcesApi.md#testdatasourceconnection) | **POST** /v1/data-sources/{data_source_id}/test | Test Data Source Connection Handler |
|
|
15
19
|
| [**updateDataSource**](DataSourcesApi.md#updatedatasourceoperation) | **PATCH** /v1/data-sources/{data_source_id} | Update Data Source Handler |
|
|
@@ -98,7 +102,7 @@ example().catch(console.error);
|
|
|
98
102
|
|
|
99
103
|
Delete Data Source Handler
|
|
100
104
|
|
|
101
|
-
Move a connector and its
|
|
105
|
+
Move a connector and its schemas/tables to trash. Soft-delete via the path_part subtree (schemas + tables are children, so they trash with it). The connector\'s generated ``.overview`` description Document IS ingested, so its Qdrant points are flipped to trashed via the set-trashed workflow (best-effort, mirrors the document delete path).
|
|
102
106
|
|
|
103
107
|
### Example
|
|
104
108
|
|
|
@@ -167,6 +171,237 @@ example().catch(console.error);
|
|
|
167
171
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
168
172
|
|
|
169
173
|
|
|
174
|
+
## deleteDataSourceSchema
|
|
175
|
+
|
|
176
|
+
> deleteDataSourceSchema(dataSourceId, schemaId)
|
|
177
|
+
|
|
178
|
+
Delete Data Source Schema Handler
|
|
179
|
+
|
|
180
|
+
Un-model a schema and the tables under it (hard-delete the namespace).
|
|
181
|
+
|
|
182
|
+
### Example
|
|
183
|
+
|
|
184
|
+
```ts
|
|
185
|
+
import {
|
|
186
|
+
Configuration,
|
|
187
|
+
DataSourcesApi,
|
|
188
|
+
} from '@knowledge-stack/ksapi';
|
|
189
|
+
import type { DeleteDataSourceSchemaRequest } from '@knowledge-stack/ksapi';
|
|
190
|
+
|
|
191
|
+
async function example() {
|
|
192
|
+
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
193
|
+
const config = new Configuration({
|
|
194
|
+
// To configure API key authorization: cookieAuth
|
|
195
|
+
apiKey: "YOUR API KEY",
|
|
196
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
197
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
198
|
+
});
|
|
199
|
+
const api = new DataSourcesApi(config);
|
|
200
|
+
|
|
201
|
+
const body = {
|
|
202
|
+
// string
|
|
203
|
+
dataSourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
204
|
+
// string
|
|
205
|
+
schemaId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
206
|
+
} satisfies DeleteDataSourceSchemaRequest;
|
|
207
|
+
|
|
208
|
+
try {
|
|
209
|
+
const data = await api.deleteDataSourceSchema(body);
|
|
210
|
+
console.log(data);
|
|
211
|
+
} catch (error) {
|
|
212
|
+
console.error(error);
|
|
213
|
+
}
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
// Run the test
|
|
217
|
+
example().catch(console.error);
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
### Parameters
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
| Name | Type | Description | Notes |
|
|
224
|
+
|------------- | ------------- | ------------- | -------------|
|
|
225
|
+
| **dataSourceId** | `string` | | [Defaults to `undefined`] |
|
|
226
|
+
| **schemaId** | `string` | | [Defaults to `undefined`] |
|
|
227
|
+
|
|
228
|
+
### Return type
|
|
229
|
+
|
|
230
|
+
`void` (Empty response body)
|
|
231
|
+
|
|
232
|
+
### Authorization
|
|
233
|
+
|
|
234
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
235
|
+
|
|
236
|
+
### HTTP request headers
|
|
237
|
+
|
|
238
|
+
- **Content-Type**: Not defined
|
|
239
|
+
- **Accept**: `application/json`
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
### HTTP response details
|
|
243
|
+
| Status code | Description | Response headers |
|
|
244
|
+
|-------------|-------------|------------------|
|
|
245
|
+
| **204** | Successful Response | - |
|
|
246
|
+
| **422** | Validation Error | - |
|
|
247
|
+
| **0** | Error response. | - |
|
|
248
|
+
|
|
249
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
## deleteDataSourceTable
|
|
253
|
+
|
|
254
|
+
> deleteDataSourceTable(dataSourceId, tableId)
|
|
255
|
+
|
|
256
|
+
Delete Data Source Table Handler
|
|
257
|
+
|
|
258
|
+
Un-model a single table (hard-delete it from its schema).
|
|
259
|
+
|
|
260
|
+
### Example
|
|
261
|
+
|
|
262
|
+
```ts
|
|
263
|
+
import {
|
|
264
|
+
Configuration,
|
|
265
|
+
DataSourcesApi,
|
|
266
|
+
} from '@knowledge-stack/ksapi';
|
|
267
|
+
import type { DeleteDataSourceTableRequest } from '@knowledge-stack/ksapi';
|
|
268
|
+
|
|
269
|
+
async function example() {
|
|
270
|
+
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
271
|
+
const config = new Configuration({
|
|
272
|
+
// To configure API key authorization: cookieAuth
|
|
273
|
+
apiKey: "YOUR API KEY",
|
|
274
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
275
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
276
|
+
});
|
|
277
|
+
const api = new DataSourcesApi(config);
|
|
278
|
+
|
|
279
|
+
const body = {
|
|
280
|
+
// string
|
|
281
|
+
dataSourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
282
|
+
// string
|
|
283
|
+
tableId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
284
|
+
} satisfies DeleteDataSourceTableRequest;
|
|
285
|
+
|
|
286
|
+
try {
|
|
287
|
+
const data = await api.deleteDataSourceTable(body);
|
|
288
|
+
console.log(data);
|
|
289
|
+
} catch (error) {
|
|
290
|
+
console.error(error);
|
|
291
|
+
}
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
// Run the test
|
|
295
|
+
example().catch(console.error);
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
### Parameters
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
| Name | Type | Description | Notes |
|
|
302
|
+
|------------- | ------------- | ------------- | -------------|
|
|
303
|
+
| **dataSourceId** | `string` | | [Defaults to `undefined`] |
|
|
304
|
+
| **tableId** | `string` | | [Defaults to `undefined`] |
|
|
305
|
+
|
|
306
|
+
### Return type
|
|
307
|
+
|
|
308
|
+
`void` (Empty response body)
|
|
309
|
+
|
|
310
|
+
### Authorization
|
|
311
|
+
|
|
312
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
313
|
+
|
|
314
|
+
### HTTP request headers
|
|
315
|
+
|
|
316
|
+
- **Content-Type**: Not defined
|
|
317
|
+
- **Accept**: `application/json`
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
### HTTP response details
|
|
321
|
+
| Status code | Description | Response headers |
|
|
322
|
+
|-------------|-------------|------------------|
|
|
323
|
+
| **204** | Successful Response | - |
|
|
324
|
+
| **422** | Validation Error | - |
|
|
325
|
+
| **0** | Error response. | - |
|
|
326
|
+
|
|
327
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
## generateDataSourceDescription
|
|
331
|
+
|
|
332
|
+
> DataSourceDescriptionResponse generateDataSourceDescription(dataSourceId)
|
|
333
|
+
|
|
334
|
+
Generate Data Source Description Handler
|
|
335
|
+
|
|
336
|
+
(Re)generate the connector\'s hidden, searchable \'Database overview\' Document. Requires ``can_write`` on the connector. The structural overview is deterministic; an LLM prose summary is prepended best-effort. The document ingests through the normal pipeline so the agent\'s semantic search finds it.
|
|
337
|
+
|
|
338
|
+
### Example
|
|
339
|
+
|
|
340
|
+
```ts
|
|
341
|
+
import {
|
|
342
|
+
Configuration,
|
|
343
|
+
DataSourcesApi,
|
|
344
|
+
} from '@knowledge-stack/ksapi';
|
|
345
|
+
import type { GenerateDataSourceDescriptionRequest } from '@knowledge-stack/ksapi';
|
|
346
|
+
|
|
347
|
+
async function example() {
|
|
348
|
+
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
349
|
+
const config = new Configuration({
|
|
350
|
+
// To configure API key authorization: cookieAuth
|
|
351
|
+
apiKey: "YOUR API KEY",
|
|
352
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
353
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
354
|
+
});
|
|
355
|
+
const api = new DataSourcesApi(config);
|
|
356
|
+
|
|
357
|
+
const body = {
|
|
358
|
+
// string
|
|
359
|
+
dataSourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
360
|
+
} satisfies GenerateDataSourceDescriptionRequest;
|
|
361
|
+
|
|
362
|
+
try {
|
|
363
|
+
const data = await api.generateDataSourceDescription(body);
|
|
364
|
+
console.log(data);
|
|
365
|
+
} catch (error) {
|
|
366
|
+
console.error(error);
|
|
367
|
+
}
|
|
368
|
+
}
|
|
369
|
+
|
|
370
|
+
// Run the test
|
|
371
|
+
example().catch(console.error);
|
|
372
|
+
```
|
|
373
|
+
|
|
374
|
+
### Parameters
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
| Name | Type | Description | Notes |
|
|
378
|
+
|------------- | ------------- | ------------- | -------------|
|
|
379
|
+
| **dataSourceId** | `string` | | [Defaults to `undefined`] |
|
|
380
|
+
|
|
381
|
+
### Return type
|
|
382
|
+
|
|
383
|
+
[**DataSourceDescriptionResponse**](DataSourceDescriptionResponse.md)
|
|
384
|
+
|
|
385
|
+
### Authorization
|
|
386
|
+
|
|
387
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
388
|
+
|
|
389
|
+
### HTTP request headers
|
|
390
|
+
|
|
391
|
+
- **Content-Type**: Not defined
|
|
392
|
+
- **Accept**: `application/json`
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
### HTTP response details
|
|
396
|
+
| Status code | Description | Response headers |
|
|
397
|
+
|-------------|-------------|------------------|
|
|
398
|
+
| **200** | Successful Response | - |
|
|
399
|
+
| **422** | Validation Error | - |
|
|
400
|
+
| **0** | Error response. | - |
|
|
401
|
+
|
|
402
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
403
|
+
|
|
404
|
+
|
|
170
405
|
## getDataSource
|
|
171
406
|
|
|
172
407
|
> DataSourceDetailResponse getDataSource(dataSourceId)
|
|
@@ -401,7 +636,7 @@ example().catch(console.error);
|
|
|
401
636
|
|
|
402
637
|
Model Data Source Table Handler
|
|
403
638
|
|
|
404
|
-
Model a table
|
|
639
|
+
Model a table under its (auto-created) Schema PDO; auto-introspect columns.
|
|
405
640
|
|
|
406
641
|
### Example
|
|
407
642
|
|
|
@@ -473,6 +708,84 @@ example().catch(console.error);
|
|
|
473
708
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
474
709
|
|
|
475
710
|
|
|
711
|
+
## modelDataSourceTables
|
|
712
|
+
|
|
713
|
+
> BulkModelTablesResponse modelDataSourceTables(dataSourceId, bulkModelTablesRequest)
|
|
714
|
+
|
|
715
|
+
Model Data Source Tables Handler
|
|
716
|
+
|
|
717
|
+
Import several tables across one or more schemas; per-item results. Schemas are auto find-or-created. Duplicates are pre-checked against the already-modeled tables and earlier items in the same batch (so a conflict never triggers a failed INSERT, which would otherwise roll back the batch\'s prior writes); introspection failures are reported per item. One bad item never aborts the batch.
|
|
718
|
+
|
|
719
|
+
### Example
|
|
720
|
+
|
|
721
|
+
```ts
|
|
722
|
+
import {
|
|
723
|
+
Configuration,
|
|
724
|
+
DataSourcesApi,
|
|
725
|
+
} from '@knowledge-stack/ksapi';
|
|
726
|
+
import type { ModelDataSourceTablesRequest } from '@knowledge-stack/ksapi';
|
|
727
|
+
|
|
728
|
+
async function example() {
|
|
729
|
+
console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
|
|
730
|
+
const config = new Configuration({
|
|
731
|
+
// To configure API key authorization: cookieAuth
|
|
732
|
+
apiKey: "YOUR API KEY",
|
|
733
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
734
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
735
|
+
});
|
|
736
|
+
const api = new DataSourcesApi(config);
|
|
737
|
+
|
|
738
|
+
const body = {
|
|
739
|
+
// string
|
|
740
|
+
dataSourceId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
741
|
+
// BulkModelTablesRequest
|
|
742
|
+
bulkModelTablesRequest: ...,
|
|
743
|
+
} satisfies ModelDataSourceTablesRequest;
|
|
744
|
+
|
|
745
|
+
try {
|
|
746
|
+
const data = await api.modelDataSourceTables(body);
|
|
747
|
+
console.log(data);
|
|
748
|
+
} catch (error) {
|
|
749
|
+
console.error(error);
|
|
750
|
+
}
|
|
751
|
+
}
|
|
752
|
+
|
|
753
|
+
// Run the test
|
|
754
|
+
example().catch(console.error);
|
|
755
|
+
```
|
|
756
|
+
|
|
757
|
+
### Parameters
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
| Name | Type | Description | Notes |
|
|
761
|
+
|------------- | ------------- | ------------- | -------------|
|
|
762
|
+
| **dataSourceId** | `string` | | [Defaults to `undefined`] |
|
|
763
|
+
| **bulkModelTablesRequest** | [BulkModelTablesRequest](BulkModelTablesRequest.md) | | |
|
|
764
|
+
|
|
765
|
+
### Return type
|
|
766
|
+
|
|
767
|
+
[**BulkModelTablesResponse**](BulkModelTablesResponse.md)
|
|
768
|
+
|
|
769
|
+
### Authorization
|
|
770
|
+
|
|
771
|
+
[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
|
|
772
|
+
|
|
773
|
+
### HTTP request headers
|
|
774
|
+
|
|
775
|
+
- **Content-Type**: `application/json`
|
|
776
|
+
- **Accept**: `application/json`
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
### HTTP response details
|
|
780
|
+
| Status code | Description | Response headers |
|
|
781
|
+
|-------------|-------------|------------------|
|
|
782
|
+
| **201** | Successful Response | - |
|
|
783
|
+
| **422** | Validation Error | - |
|
|
784
|
+
| **0** | Error response. | - |
|
|
785
|
+
|
|
786
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
787
|
+
|
|
788
|
+
|
|
476
789
|
## queryDataSource
|
|
477
790
|
|
|
478
791
|
> DataSourceQueryResponse queryDataSource(dataSourceId, dataSourceQueryRequest)
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
|
|
2
|
+
# DocumentBlockChange
|
|
3
|
+
|
|
4
|
+
One changed block in a Word document, ordered by position. ``from_paragraph_index``/``to_paragraph_index`` are the 0-based position of the ``<w:p>`` in ``word/document.xml`` body (the same index citation anchors use, so the frontend aligns changes to its docx render). ``anchor_text`` is a text-match fallback for that alignment. ``old``/``new`` are null on the absent side; ``*_spans`` mark changed word ranges (CJK-aware).
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`type` | [BlockChangeType](BlockChangeType.md)
|
|
11
|
+
`kind` | [BlockKind](BlockKind.md)
|
|
12
|
+
`changeClass` | [ChangeClass](ChangeClass.md)
|
|
13
|
+
`fromParagraphIndex` | number
|
|
14
|
+
`toParagraphIndex` | number
|
|
15
|
+
`oldText` | string
|
|
16
|
+
`newText` | string
|
|
17
|
+
`oldSpans` | [Array<DiffSpan>](DiffSpan.md)
|
|
18
|
+
`newSpans` | [Array<DiffSpan>](DiffSpan.md)
|
|
19
|
+
`formattingChanged` | boolean
|
|
20
|
+
`numericDelta` | string
|
|
21
|
+
`numericPct` | string
|
|
22
|
+
`anchorText` | string
|
|
23
|
+
`surface` | string
|
|
24
|
+
`cellChanges` | [Array<TableCellChange>](TableCellChange.md)
|
|
25
|
+
`revisions` | [Array<RevisionEdit>](RevisionEdit.md)
|
|
26
|
+
`oldImageRef` | string
|
|
27
|
+
`newImageRef` | string
|
|
28
|
+
`imageRegions` | [Array<PixelRegion>](PixelRegion.md)
|
|
29
|
+
`imageNote` | string
|
|
30
|
+
|
|
31
|
+
## Example
|
|
32
|
+
|
|
33
|
+
```typescript
|
|
34
|
+
import type { DocumentBlockChange } from '@knowledge-stack/ksapi'
|
|
35
|
+
|
|
36
|
+
// TODO: Update the object below with actual values
|
|
37
|
+
const example = {
|
|
38
|
+
"type": null,
|
|
39
|
+
"kind": null,
|
|
40
|
+
"changeClass": null,
|
|
41
|
+
"fromParagraphIndex": null,
|
|
42
|
+
"toParagraphIndex": null,
|
|
43
|
+
"oldText": null,
|
|
44
|
+
"newText": null,
|
|
45
|
+
"oldSpans": null,
|
|
46
|
+
"newSpans": null,
|
|
47
|
+
"formattingChanged": null,
|
|
48
|
+
"numericDelta": null,
|
|
49
|
+
"numericPct": null,
|
|
50
|
+
"anchorText": null,
|
|
51
|
+
"surface": null,
|
|
52
|
+
"cellChanges": null,
|
|
53
|
+
"revisions": null,
|
|
54
|
+
"oldImageRef": null,
|
|
55
|
+
"newImageRef": null,
|
|
56
|
+
"imageRegions": null,
|
|
57
|
+
"imageNote": null,
|
|
58
|
+
} satisfies DocumentBlockChange
|
|
59
|
+
|
|
60
|
+
console.log(example)
|
|
61
|
+
|
|
62
|
+
// Convert the instance to a JSON string
|
|
63
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
64
|
+
console.log(exampleJSON)
|
|
65
|
+
|
|
66
|
+
// Parse the JSON string back to an object
|
|
67
|
+
const exampleParsed = JSON.parse(exampleJSON) as DocumentBlockChange
|
|
68
|
+
console.log(exampleParsed)
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
72
|
+
|
|
73
|
+
|