@wildix/wim-knowledge-base-client 0.0.47 → 0.0.49
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/dist-cjs/KnowledgeBase.js +16 -8
- package/dist-cjs/commands/{QueryKnowledgeBaseCommand.js → GenerateSearchAnswerCommand.js} +7 -7
- package/dist-cjs/commands/{SearchHistoryCommand.js → GetDataSourceSyncStatusCommand.js} +7 -7
- package/dist-cjs/commands/{GetSyncLogsCommand.js → GetDocumentChunksCommand.js} +7 -7
- package/dist-cjs/commands/{GetSyncStatusCommand.js → GetDocumentMarkdownCommand.js} +7 -7
- package/dist-cjs/commands/GetDocumentWithContentAndChunksCommand.js +21 -0
- package/dist-cjs/commands/ListDataSourceStatisticsCommand.js +21 -0
- package/dist-cjs/commands/ListDataSourceSynchronizationLogsCommand.js +21 -0
- package/dist-cjs/commands/ListSearchQueriesHistoryCommand.js +21 -0
- package/dist-cjs/commands/index.js +8 -4
- package/dist-cjs/models/models_0.js +15 -27
- package/dist-cjs/protocols/Aws_restJson1.js +228 -140
- package/dist-es/KnowledgeBase.js +16 -8
- package/dist-es/commands/GenerateSearchAnswerCommand.js +17 -0
- package/dist-es/commands/GetDataSourceSyncStatusCommand.js +17 -0
- package/dist-es/commands/GetDocumentChunksCommand.js +17 -0
- package/dist-es/commands/GetDocumentMarkdownCommand.js +17 -0
- package/dist-es/commands/GetDocumentWithContentAndChunksCommand.js +17 -0
- package/dist-es/commands/ListDataSourceStatisticsCommand.js +17 -0
- package/dist-es/commands/ListDataSourceSynchronizationLogsCommand.js +17 -0
- package/dist-es/commands/ListSearchQueriesHistoryCommand.js +17 -0
- package/dist-es/commands/index.js +8 -4
- package/dist-es/models/models_0.js +14 -26
- package/dist-es/protocols/Aws_restJson1.js +203 -123
- package/dist-types/KnowledgeBase.d.ts +54 -26
- package/dist-types/KnowledgeBaseClient.d.ts +10 -6
- package/dist-types/commands/ConfigureDataSourceCommand.d.ts +1 -36
- package/dist-types/commands/CreateDataSourceCommand.d.ts +2 -22
- package/dist-types/commands/CreateDocumentCommand.d.ts +0 -2
- package/dist-types/commands/GenerateSearchAnswerCommand.d.ts +105 -0
- package/dist-types/commands/GetDataSourceCommand.d.ts +1 -21
- package/dist-types/commands/GetDataSourceSyncStatusCommand.d.ts +88 -0
- package/dist-types/commands/GetDocumentChunksCommand.d.ts +94 -0
- package/dist-types/commands/GetDocumentCommand.d.ts +0 -4
- package/dist-types/commands/GetDocumentMarkdownCommand.d.ts +86 -0
- package/dist-types/commands/GetDocumentWithContentAndChunksCommand.d.ts +113 -0
- package/dist-types/commands/ListDataSourceStatisticsCommand.d.ts +86 -0
- package/dist-types/commands/ListDataSourceSynchronizationLogsCommand.d.ts +96 -0
- package/dist-types/commands/ListDataSourcesCommand.d.ts +1 -21
- package/dist-types/commands/ListDocumentsCommand.d.ts +0 -2
- package/dist-types/commands/ListSearchQueriesHistoryCommand.d.ts +97 -0
- package/dist-types/commands/SearchKnowledgeBaseCommand.d.ts +7 -9
- package/dist-types/commands/StartSyncDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +1 -21
- package/dist-types/commands/UpdateDocumentCommand.d.ts +0 -2
- package/dist-types/commands/index.d.ts +8 -4
- package/dist-types/models/models_0.d.ts +253 -346
- package/dist-types/protocols/Aws_restJson1.d.ts +64 -28
- package/package.json +1 -1
- package/dist-es/commands/GetSyncLogsCommand.js +0 -17
- package/dist-es/commands/GetSyncStatusCommand.js +0 -17
- package/dist-es/commands/QueryKnowledgeBaseCommand.js +0 -17
- package/dist-es/commands/SearchHistoryCommand.js +0 -17
- package/dist-types/commands/GetSyncLogsCommand.d.ts +0 -96
- package/dist-types/commands/GetSyncStatusCommand.d.ts +0 -94
- package/dist-types/commands/QueryKnowledgeBaseCommand.d.ts +0 -103
- package/dist-types/commands/SearchHistoryCommand.d.ts +0 -98
|
@@ -9,18 +9,22 @@ import { DeleteDataSourceCommandInput, DeleteDataSourceCommandOutput } from "./c
|
|
|
9
9
|
import { DeleteDocumentCommandInput, DeleteDocumentCommandOutput } from "./commands/DeleteDocumentCommand";
|
|
10
10
|
import { DeleteKnowledgeBaseCommandInput, DeleteKnowledgeBaseCommandOutput } from "./commands/DeleteKnowledgeBaseCommand";
|
|
11
11
|
import { DescribeDataSourceCommandInput, DescribeDataSourceCommandOutput } from "./commands/DescribeDataSourceCommand";
|
|
12
|
+
import { GenerateSearchAnswerCommandInput, GenerateSearchAnswerCommandOutput } from "./commands/GenerateSearchAnswerCommand";
|
|
12
13
|
import { GetDataSourceCommandInput, GetDataSourceCommandOutput } from "./commands/GetDataSourceCommand";
|
|
14
|
+
import { GetDataSourceSyncStatusCommandInput, GetDataSourceSyncStatusCommandOutput } from "./commands/GetDataSourceSyncStatusCommand";
|
|
15
|
+
import { GetDocumentChunksCommandInput, GetDocumentChunksCommandOutput } from "./commands/GetDocumentChunksCommand";
|
|
13
16
|
import { GetDocumentCommandInput, GetDocumentCommandOutput } from "./commands/GetDocumentCommand";
|
|
14
17
|
import { GetDocumentDownloadUrlCommandInput, GetDocumentDownloadUrlCommandOutput } from "./commands/GetDocumentDownloadUrlCommand";
|
|
18
|
+
import { GetDocumentMarkdownCommandInput, GetDocumentMarkdownCommandOutput } from "./commands/GetDocumentMarkdownCommand";
|
|
15
19
|
import { GetDocumentUploadUrlCommandInput, GetDocumentUploadUrlCommandOutput } from "./commands/GetDocumentUploadUrlCommand";
|
|
20
|
+
import { GetDocumentWithContentAndChunksCommandInput, GetDocumentWithContentAndChunksCommandOutput } from "./commands/GetDocumentWithContentAndChunksCommand";
|
|
16
21
|
import { GetKnowledgeBaseCommandInput, GetKnowledgeBaseCommandOutput } from "./commands/GetKnowledgeBaseCommand";
|
|
17
|
-
import {
|
|
18
|
-
import {
|
|
22
|
+
import { ListDataSourceStatisticsCommandInput, ListDataSourceStatisticsCommandOutput } from "./commands/ListDataSourceStatisticsCommand";
|
|
23
|
+
import { ListDataSourceSynchronizationLogsCommandInput, ListDataSourceSynchronizationLogsCommandOutput } from "./commands/ListDataSourceSynchronizationLogsCommand";
|
|
19
24
|
import { ListDataSourcesCommandInput, ListDataSourcesCommandOutput } from "./commands/ListDataSourcesCommand";
|
|
20
25
|
import { ListDocumentsCommandInput, ListDocumentsCommandOutput } from "./commands/ListDocumentsCommand";
|
|
21
26
|
import { ListKnowledgeBasesCommandInput, ListKnowledgeBasesCommandOutput } from "./commands/ListKnowledgeBasesCommand";
|
|
22
|
-
import {
|
|
23
|
-
import { SearchHistoryCommandInput, SearchHistoryCommandOutput } from "./commands/SearchHistoryCommand";
|
|
27
|
+
import { ListSearchQueriesHistoryCommandInput, ListSearchQueriesHistoryCommandOutput } from "./commands/ListSearchQueriesHistoryCommand";
|
|
24
28
|
import { SearchKnowledgeBaseCommandInput, SearchKnowledgeBaseCommandOutput } from "./commands/SearchKnowledgeBaseCommand";
|
|
25
29
|
import { StartSyncDataSourceCommandInput, StartSyncDataSourceCommandOutput } from "./commands/StartSyncDataSourceCommand";
|
|
26
30
|
import { StopSyncDataSourceCommandInput, StopSyncDataSourceCommandOutput } from "./commands/StopSyncDataSourceCommand";
|
|
@@ -89,48 +93,66 @@ export interface KnowledgeBase {
|
|
|
89
93
|
describeDataSource(args: DescribeDataSourceCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDataSourceCommandOutput>;
|
|
90
94
|
describeDataSource(args: DescribeDataSourceCommandInput, cb: (err: any, data?: DescribeDataSourceCommandOutput) => void): void;
|
|
91
95
|
describeDataSource(args: DescribeDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataSourceCommandOutput) => void): void;
|
|
96
|
+
/**
|
|
97
|
+
* @see {@link GenerateSearchAnswerCommand}
|
|
98
|
+
*/
|
|
99
|
+
generateSearchAnswer(args: GenerateSearchAnswerCommandInput, options?: __HttpHandlerOptions): Promise<GenerateSearchAnswerCommandOutput>;
|
|
100
|
+
generateSearchAnswer(args: GenerateSearchAnswerCommandInput, cb: (err: any, data?: GenerateSearchAnswerCommandOutput) => void): void;
|
|
101
|
+
generateSearchAnswer(args: GenerateSearchAnswerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateSearchAnswerCommandOutput) => void): void;
|
|
92
102
|
/**
|
|
93
103
|
* @see {@link GetDataSourceCommand}
|
|
94
104
|
*/
|
|
95
105
|
getDataSource(args: GetDataSourceCommandInput, options?: __HttpHandlerOptions): Promise<GetDataSourceCommandOutput>;
|
|
96
106
|
getDataSource(args: GetDataSourceCommandInput, cb: (err: any, data?: GetDataSourceCommandOutput) => void): void;
|
|
97
107
|
getDataSource(args: GetDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataSourceCommandOutput) => void): void;
|
|
108
|
+
/**
|
|
109
|
+
* @see {@link GetDataSourceSyncStatusCommand}
|
|
110
|
+
*/
|
|
111
|
+
getDataSourceSyncStatus(args: GetDataSourceSyncStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetDataSourceSyncStatusCommandOutput>;
|
|
112
|
+
getDataSourceSyncStatus(args: GetDataSourceSyncStatusCommandInput, cb: (err: any, data?: GetDataSourceSyncStatusCommandOutput) => void): void;
|
|
113
|
+
getDataSourceSyncStatus(args: GetDataSourceSyncStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDataSourceSyncStatusCommandOutput) => void): void;
|
|
98
114
|
/**
|
|
99
115
|
* @see {@link GetDocumentCommand}
|
|
100
116
|
*/
|
|
101
117
|
getDocument(args: GetDocumentCommandInput, options?: __HttpHandlerOptions): Promise<GetDocumentCommandOutput>;
|
|
102
118
|
getDocument(args: GetDocumentCommandInput, cb: (err: any, data?: GetDocumentCommandOutput) => void): void;
|
|
103
119
|
getDocument(args: GetDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentCommandOutput) => void): void;
|
|
120
|
+
/**
|
|
121
|
+
* @see {@link GetDocumentChunksCommand}
|
|
122
|
+
*/
|
|
123
|
+
getDocumentChunks(args: GetDocumentChunksCommandInput, options?: __HttpHandlerOptions): Promise<GetDocumentChunksCommandOutput>;
|
|
124
|
+
getDocumentChunks(args: GetDocumentChunksCommandInput, cb: (err: any, data?: GetDocumentChunksCommandOutput) => void): void;
|
|
125
|
+
getDocumentChunks(args: GetDocumentChunksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentChunksCommandOutput) => void): void;
|
|
104
126
|
/**
|
|
105
127
|
* @see {@link GetDocumentDownloadUrlCommand}
|
|
106
128
|
*/
|
|
107
129
|
getDocumentDownloadUrl(args: GetDocumentDownloadUrlCommandInput, options?: __HttpHandlerOptions): Promise<GetDocumentDownloadUrlCommandOutput>;
|
|
108
130
|
getDocumentDownloadUrl(args: GetDocumentDownloadUrlCommandInput, cb: (err: any, data?: GetDocumentDownloadUrlCommandOutput) => void): void;
|
|
109
131
|
getDocumentDownloadUrl(args: GetDocumentDownloadUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentDownloadUrlCommandOutput) => void): void;
|
|
132
|
+
/**
|
|
133
|
+
* @see {@link GetDocumentMarkdownCommand}
|
|
134
|
+
*/
|
|
135
|
+
getDocumentMarkdown(args: GetDocumentMarkdownCommandInput, options?: __HttpHandlerOptions): Promise<GetDocumentMarkdownCommandOutput>;
|
|
136
|
+
getDocumentMarkdown(args: GetDocumentMarkdownCommandInput, cb: (err: any, data?: GetDocumentMarkdownCommandOutput) => void): void;
|
|
137
|
+
getDocumentMarkdown(args: GetDocumentMarkdownCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentMarkdownCommandOutput) => void): void;
|
|
110
138
|
/**
|
|
111
139
|
* @see {@link GetDocumentUploadUrlCommand}
|
|
112
140
|
*/
|
|
113
141
|
getDocumentUploadUrl(args: GetDocumentUploadUrlCommandInput, options?: __HttpHandlerOptions): Promise<GetDocumentUploadUrlCommandOutput>;
|
|
114
142
|
getDocumentUploadUrl(args: GetDocumentUploadUrlCommandInput, cb: (err: any, data?: GetDocumentUploadUrlCommandOutput) => void): void;
|
|
115
143
|
getDocumentUploadUrl(args: GetDocumentUploadUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentUploadUrlCommandOutput) => void): void;
|
|
144
|
+
/**
|
|
145
|
+
* @see {@link GetDocumentWithContentAndChunksCommand}
|
|
146
|
+
*/
|
|
147
|
+
getDocumentWithContentAndChunks(args: GetDocumentWithContentAndChunksCommandInput, options?: __HttpHandlerOptions): Promise<GetDocumentWithContentAndChunksCommandOutput>;
|
|
148
|
+
getDocumentWithContentAndChunks(args: GetDocumentWithContentAndChunksCommandInput, cb: (err: any, data?: GetDocumentWithContentAndChunksCommandOutput) => void): void;
|
|
149
|
+
getDocumentWithContentAndChunks(args: GetDocumentWithContentAndChunksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentWithContentAndChunksCommandOutput) => void): void;
|
|
116
150
|
/**
|
|
117
151
|
* @see {@link GetKnowledgeBaseCommand}
|
|
118
152
|
*/
|
|
119
153
|
getKnowledgeBase(args: GetKnowledgeBaseCommandInput, options?: __HttpHandlerOptions): Promise<GetKnowledgeBaseCommandOutput>;
|
|
120
154
|
getKnowledgeBase(args: GetKnowledgeBaseCommandInput, cb: (err: any, data?: GetKnowledgeBaseCommandOutput) => void): void;
|
|
121
155
|
getKnowledgeBase(args: GetKnowledgeBaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetKnowledgeBaseCommandOutput) => void): void;
|
|
122
|
-
/**
|
|
123
|
-
* @see {@link GetSyncLogsCommand}
|
|
124
|
-
*/
|
|
125
|
-
getSyncLogs(args: GetSyncLogsCommandInput, options?: __HttpHandlerOptions): Promise<GetSyncLogsCommandOutput>;
|
|
126
|
-
getSyncLogs(args: GetSyncLogsCommandInput, cb: (err: any, data?: GetSyncLogsCommandOutput) => void): void;
|
|
127
|
-
getSyncLogs(args: GetSyncLogsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSyncLogsCommandOutput) => void): void;
|
|
128
|
-
/**
|
|
129
|
-
* @see {@link GetSyncStatusCommand}
|
|
130
|
-
*/
|
|
131
|
-
getSyncStatus(args: GetSyncStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetSyncStatusCommandOutput>;
|
|
132
|
-
getSyncStatus(args: GetSyncStatusCommandInput, cb: (err: any, data?: GetSyncStatusCommandOutput) => void): void;
|
|
133
|
-
getSyncStatus(args: GetSyncStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSyncStatusCommandOutput) => void): void;
|
|
134
156
|
/**
|
|
135
157
|
* @see {@link ListDataSourcesCommand}
|
|
136
158
|
*/
|
|
@@ -138,6 +160,18 @@ export interface KnowledgeBase {
|
|
|
138
160
|
listDataSources(args: ListDataSourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListDataSourcesCommandOutput>;
|
|
139
161
|
listDataSources(args: ListDataSourcesCommandInput, cb: (err: any, data?: ListDataSourcesCommandOutput) => void): void;
|
|
140
162
|
listDataSources(args: ListDataSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataSourcesCommandOutput) => void): void;
|
|
163
|
+
/**
|
|
164
|
+
* @see {@link ListDataSourceStatisticsCommand}
|
|
165
|
+
*/
|
|
166
|
+
listDataSourceStatistics(args: ListDataSourceStatisticsCommandInput, options?: __HttpHandlerOptions): Promise<ListDataSourceStatisticsCommandOutput>;
|
|
167
|
+
listDataSourceStatistics(args: ListDataSourceStatisticsCommandInput, cb: (err: any, data?: ListDataSourceStatisticsCommandOutput) => void): void;
|
|
168
|
+
listDataSourceStatistics(args: ListDataSourceStatisticsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataSourceStatisticsCommandOutput) => void): void;
|
|
169
|
+
/**
|
|
170
|
+
* @see {@link ListDataSourceSynchronizationLogsCommand}
|
|
171
|
+
*/
|
|
172
|
+
listDataSourceSynchronizationLogs(args: ListDataSourceSynchronizationLogsCommandInput, options?: __HttpHandlerOptions): Promise<ListDataSourceSynchronizationLogsCommandOutput>;
|
|
173
|
+
listDataSourceSynchronizationLogs(args: ListDataSourceSynchronizationLogsCommandInput, cb: (err: any, data?: ListDataSourceSynchronizationLogsCommandOutput) => void): void;
|
|
174
|
+
listDataSourceSynchronizationLogs(args: ListDataSourceSynchronizationLogsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataSourceSynchronizationLogsCommandOutput) => void): void;
|
|
141
175
|
/**
|
|
142
176
|
* @see {@link ListDocumentsCommand}
|
|
143
177
|
*/
|
|
@@ -152,17 +186,11 @@ export interface KnowledgeBase {
|
|
|
152
186
|
listKnowledgeBases(args: ListKnowledgeBasesCommandInput, cb: (err: any, data?: ListKnowledgeBasesCommandOutput) => void): void;
|
|
153
187
|
listKnowledgeBases(args: ListKnowledgeBasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListKnowledgeBasesCommandOutput) => void): void;
|
|
154
188
|
/**
|
|
155
|
-
* @see {@link
|
|
156
|
-
*/
|
|
157
|
-
queryKnowledgeBase(args: QueryKnowledgeBaseCommandInput, options?: __HttpHandlerOptions): Promise<QueryKnowledgeBaseCommandOutput>;
|
|
158
|
-
queryKnowledgeBase(args: QueryKnowledgeBaseCommandInput, cb: (err: any, data?: QueryKnowledgeBaseCommandOutput) => void): void;
|
|
159
|
-
queryKnowledgeBase(args: QueryKnowledgeBaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryKnowledgeBaseCommandOutput) => void): void;
|
|
160
|
-
/**
|
|
161
|
-
* @see {@link SearchHistoryCommand}
|
|
189
|
+
* @see {@link ListSearchQueriesHistoryCommand}
|
|
162
190
|
*/
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
191
|
+
listSearchQueriesHistory(args: ListSearchQueriesHistoryCommandInput, options?: __HttpHandlerOptions): Promise<ListSearchQueriesHistoryCommandOutput>;
|
|
192
|
+
listSearchQueriesHistory(args: ListSearchQueriesHistoryCommandInput, cb: (err: any, data?: ListSearchQueriesHistoryCommandOutput) => void): void;
|
|
193
|
+
listSearchQueriesHistory(args: ListSearchQueriesHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSearchQueriesHistoryCommandOutput) => void): void;
|
|
166
194
|
/**
|
|
167
195
|
* @see {@link SearchKnowledgeBaseCommand}
|
|
168
196
|
*/
|
|
@@ -8,18 +8,22 @@ import { DeleteDataSourceCommandInput, DeleteDataSourceCommandOutput } from "./c
|
|
|
8
8
|
import { DeleteDocumentCommandInput, DeleteDocumentCommandOutput } from "./commands/DeleteDocumentCommand";
|
|
9
9
|
import { DeleteKnowledgeBaseCommandInput, DeleteKnowledgeBaseCommandOutput } from "./commands/DeleteKnowledgeBaseCommand";
|
|
10
10
|
import { DescribeDataSourceCommandInput, DescribeDataSourceCommandOutput } from "./commands/DescribeDataSourceCommand";
|
|
11
|
+
import { GenerateSearchAnswerCommandInput, GenerateSearchAnswerCommandOutput } from "./commands/GenerateSearchAnswerCommand";
|
|
11
12
|
import { GetDataSourceCommandInput, GetDataSourceCommandOutput } from "./commands/GetDataSourceCommand";
|
|
13
|
+
import { GetDataSourceSyncStatusCommandInput, GetDataSourceSyncStatusCommandOutput } from "./commands/GetDataSourceSyncStatusCommand";
|
|
14
|
+
import { GetDocumentChunksCommandInput, GetDocumentChunksCommandOutput } from "./commands/GetDocumentChunksCommand";
|
|
12
15
|
import { GetDocumentCommandInput, GetDocumentCommandOutput } from "./commands/GetDocumentCommand";
|
|
13
16
|
import { GetDocumentDownloadUrlCommandInput, GetDocumentDownloadUrlCommandOutput } from "./commands/GetDocumentDownloadUrlCommand";
|
|
17
|
+
import { GetDocumentMarkdownCommandInput, GetDocumentMarkdownCommandOutput } from "./commands/GetDocumentMarkdownCommand";
|
|
14
18
|
import { GetDocumentUploadUrlCommandInput, GetDocumentUploadUrlCommandOutput } from "./commands/GetDocumentUploadUrlCommand";
|
|
19
|
+
import { GetDocumentWithContentAndChunksCommandInput, GetDocumentWithContentAndChunksCommandOutput } from "./commands/GetDocumentWithContentAndChunksCommand";
|
|
15
20
|
import { GetKnowledgeBaseCommandInput, GetKnowledgeBaseCommandOutput } from "./commands/GetKnowledgeBaseCommand";
|
|
16
|
-
import {
|
|
17
|
-
import {
|
|
21
|
+
import { ListDataSourceStatisticsCommandInput, ListDataSourceStatisticsCommandOutput } from "./commands/ListDataSourceStatisticsCommand";
|
|
22
|
+
import { ListDataSourceSynchronizationLogsCommandInput, ListDataSourceSynchronizationLogsCommandOutput } from "./commands/ListDataSourceSynchronizationLogsCommand";
|
|
18
23
|
import { ListDataSourcesCommandInput, ListDataSourcesCommandOutput } from "./commands/ListDataSourcesCommand";
|
|
19
24
|
import { ListDocumentsCommandInput, ListDocumentsCommandOutput } from "./commands/ListDocumentsCommand";
|
|
20
25
|
import { ListKnowledgeBasesCommandInput, ListKnowledgeBasesCommandOutput } from "./commands/ListKnowledgeBasesCommand";
|
|
21
|
-
import {
|
|
22
|
-
import { SearchHistoryCommandInput, SearchHistoryCommandOutput } from "./commands/SearchHistoryCommand";
|
|
26
|
+
import { ListSearchQueriesHistoryCommandInput, ListSearchQueriesHistoryCommandOutput } from "./commands/ListSearchQueriesHistoryCommand";
|
|
23
27
|
import { SearchKnowledgeBaseCommandInput, SearchKnowledgeBaseCommandOutput } from "./commands/SearchKnowledgeBaseCommand";
|
|
24
28
|
import { StartSyncDataSourceCommandInput, StartSyncDataSourceCommandOutput } from "./commands/StartSyncDataSourceCommand";
|
|
25
29
|
import { StopSyncDataSourceCommandInput, StopSyncDataSourceCommandOutput } from "./commands/StopSyncDataSourceCommand";
|
|
@@ -37,11 +41,11 @@ export { __Client };
|
|
|
37
41
|
/**
|
|
38
42
|
* @public
|
|
39
43
|
*/
|
|
40
|
-
export type ServiceInputTypes = CleanDataSourceCommandInput | CloneDataSourceCommandInput | ConfigureDataSourceCommandInput | CreateDataSourceCommandInput | CreateDocumentCommandInput | CreateKnowledgeBaseCommandInput | DeleteDataSourceCommandInput | DeleteDocumentCommandInput | DeleteKnowledgeBaseCommandInput | DescribeDataSourceCommandInput | GetDataSourceCommandInput | GetDocumentCommandInput | GetDocumentDownloadUrlCommandInput | GetDocumentUploadUrlCommandInput | GetKnowledgeBaseCommandInput |
|
|
44
|
+
export type ServiceInputTypes = CleanDataSourceCommandInput | CloneDataSourceCommandInput | ConfigureDataSourceCommandInput | CreateDataSourceCommandInput | CreateDocumentCommandInput | CreateKnowledgeBaseCommandInput | DeleteDataSourceCommandInput | DeleteDocumentCommandInput | DeleteKnowledgeBaseCommandInput | DescribeDataSourceCommandInput | GenerateSearchAnswerCommandInput | GetDataSourceCommandInput | GetDataSourceSyncStatusCommandInput | GetDocumentChunksCommandInput | GetDocumentCommandInput | GetDocumentDownloadUrlCommandInput | GetDocumentMarkdownCommandInput | GetDocumentUploadUrlCommandInput | GetDocumentWithContentAndChunksCommandInput | GetKnowledgeBaseCommandInput | ListDataSourceStatisticsCommandInput | ListDataSourceSynchronizationLogsCommandInput | ListDataSourcesCommandInput | ListDocumentsCommandInput | ListKnowledgeBasesCommandInput | ListSearchQueriesHistoryCommandInput | SearchKnowledgeBaseCommandInput | StartSyncDataSourceCommandInput | StopSyncDataSourceCommandInput | UpdateDataSourceCommandInput | UpdateDocumentCommandInput | UpdateKnowledgeBaseCommandInput;
|
|
41
45
|
/**
|
|
42
46
|
* @public
|
|
43
47
|
*/
|
|
44
|
-
export type ServiceOutputTypes = CleanDataSourceCommandOutput | CloneDataSourceCommandOutput | ConfigureDataSourceCommandOutput | CreateDataSourceCommandOutput | CreateDocumentCommandOutput | CreateKnowledgeBaseCommandOutput | DeleteDataSourceCommandOutput | DeleteDocumentCommandOutput | DeleteKnowledgeBaseCommandOutput | DescribeDataSourceCommandOutput | GetDataSourceCommandOutput | GetDocumentCommandOutput | GetDocumentDownloadUrlCommandOutput | GetDocumentUploadUrlCommandOutput | GetKnowledgeBaseCommandOutput |
|
|
48
|
+
export type ServiceOutputTypes = CleanDataSourceCommandOutput | CloneDataSourceCommandOutput | ConfigureDataSourceCommandOutput | CreateDataSourceCommandOutput | CreateDocumentCommandOutput | CreateKnowledgeBaseCommandOutput | DeleteDataSourceCommandOutput | DeleteDocumentCommandOutput | DeleteKnowledgeBaseCommandOutput | DescribeDataSourceCommandOutput | GenerateSearchAnswerCommandOutput | GetDataSourceCommandOutput | GetDataSourceSyncStatusCommandOutput | GetDocumentChunksCommandOutput | GetDocumentCommandOutput | GetDocumentDownloadUrlCommandOutput | GetDocumentMarkdownCommandOutput | GetDocumentUploadUrlCommandOutput | GetDocumentWithContentAndChunksCommandOutput | GetKnowledgeBaseCommandOutput | ListDataSourceStatisticsCommandOutput | ListDataSourceSynchronizationLogsCommandOutput | ListDataSourcesCommandOutput | ListDocumentsCommandOutput | ListKnowledgeBasesCommandOutput | ListSearchQueriesHistoryCommandOutput | SearchKnowledgeBaseCommandOutput | StartSyncDataSourceCommandOutput | StopSyncDataSourceCommandOutput | UpdateDataSourceCommandOutput | UpdateDocumentCommandOutput | UpdateKnowledgeBaseCommandOutput;
|
|
45
49
|
/**
|
|
46
50
|
* @public
|
|
47
51
|
*/
|
|
@@ -62,21 +62,6 @@ declare const ConfigureDataSourceCommand_base: {
|
|
|
62
62
|
* },
|
|
63
63
|
* },
|
|
64
64
|
* files: "DOCUMENT_VALUE",
|
|
65
|
-
* proxy: { // ProxyConfig
|
|
66
|
-
* url: "STRING_VALUE", // required
|
|
67
|
-
* method: "GET" || "POST",
|
|
68
|
-
* token: "STRING_VALUE",
|
|
69
|
-
* username: "STRING_VALUE",
|
|
70
|
-
* password: "STRING_VALUE",
|
|
71
|
-
* headers: [
|
|
72
|
-
* "STRING_VALUE",
|
|
73
|
-
* ],
|
|
74
|
-
* body: "DOCUMENT_VALUE",
|
|
75
|
-
* timeoutMs: Number("int"),
|
|
76
|
-
* responseMapping: [
|
|
77
|
-
* "STRING_VALUE",
|
|
78
|
-
* ],
|
|
79
|
-
* },
|
|
80
65
|
* },
|
|
81
66
|
* syncSchedule: "DISABLED" || "EVERY_SIX_HOURS" || "EVERY_TWELVE_HOURS" || "EVERY_DAY" || "EVERY_WEEK",
|
|
82
67
|
* companyId: "STRING_VALUE",
|
|
@@ -88,7 +73,7 @@ declare const ConfigureDataSourceCommand_base: {
|
|
|
88
73
|
* // dataSource: { // DataSourceItem
|
|
89
74
|
* // name: "STRING_VALUE", // required
|
|
90
75
|
* // description: "STRING_VALUE",
|
|
91
|
-
* // type: "files" || "confluence" || "gdrive"
|
|
76
|
+
* // type: "files" || "confluence" || "gdrive", // required
|
|
92
77
|
* // config: { // DataSourceConfig Union: only one key present
|
|
93
78
|
* // confluence: { // ConfluenceConfig
|
|
94
79
|
* // baseUrl: "STRING_VALUE", // required
|
|
@@ -116,32 +101,12 @@ declare const ConfigureDataSourceCommand_base: {
|
|
|
116
101
|
* // },
|
|
117
102
|
* // },
|
|
118
103
|
* // files: "DOCUMENT_VALUE",
|
|
119
|
-
* // proxy: { // ProxyConfig
|
|
120
|
-
* // url: "STRING_VALUE", // required
|
|
121
|
-
* // method: "GET" || "POST",
|
|
122
|
-
* // token: "STRING_VALUE",
|
|
123
|
-
* // username: "STRING_VALUE",
|
|
124
|
-
* // password: "STRING_VALUE",
|
|
125
|
-
* // headers: [
|
|
126
|
-
* // "STRING_VALUE",
|
|
127
|
-
* // ],
|
|
128
|
-
* // body: "DOCUMENT_VALUE",
|
|
129
|
-
* // timeoutMs: Number("int"),
|
|
130
|
-
* // responseMapping: [
|
|
131
|
-
* // "STRING_VALUE",
|
|
132
|
-
* // ],
|
|
133
|
-
* // },
|
|
134
104
|
* // },
|
|
135
105
|
* // syncSchedule: "DISABLED" || "EVERY_SIX_HOURS" || "EVERY_TWELVE_HOURS" || "EVERY_DAY" || "EVERY_WEEK",
|
|
136
106
|
* // id: "STRING_VALUE", // required
|
|
137
107
|
* // companyId: "STRING_VALUE", // required
|
|
138
|
-
* // documentsCount: Number("int"), // required
|
|
139
108
|
* // createdAt: "STRING_VALUE", // required
|
|
140
109
|
* // updatedAt: "STRING_VALUE", // required
|
|
141
|
-
* // syncStatus: "idle" || "running" || "success" || "failed", // required
|
|
142
|
-
* // lastSyncedAt: "STRING_VALUE",
|
|
143
|
-
* // lastSyncMode: "full" || "incremental" || "unknown",
|
|
144
|
-
* // lastSyncErrorMessage: "STRING_VALUE",
|
|
145
110
|
* // },
|
|
146
111
|
* // };
|
|
147
112
|
*
|
|
@@ -37,7 +37,7 @@ declare const CreateDataSourceCommand_base: {
|
|
|
37
37
|
* const input = { // CreateDataSourceInput
|
|
38
38
|
* name: "STRING_VALUE", // required
|
|
39
39
|
* description: "STRING_VALUE",
|
|
40
|
-
* type: "files" || "confluence" || "gdrive"
|
|
40
|
+
* type: "files" || "confluence" || "gdrive", // required
|
|
41
41
|
* companyId: "STRING_VALUE",
|
|
42
42
|
* };
|
|
43
43
|
* const command = new CreateDataSourceCommand(input);
|
|
@@ -46,7 +46,7 @@ declare const CreateDataSourceCommand_base: {
|
|
|
46
46
|
* // dataSource: { // DataSourceItem
|
|
47
47
|
* // name: "STRING_VALUE", // required
|
|
48
48
|
* // description: "STRING_VALUE",
|
|
49
|
-
* // type: "files" || "confluence" || "gdrive"
|
|
49
|
+
* // type: "files" || "confluence" || "gdrive", // required
|
|
50
50
|
* // config: { // DataSourceConfig Union: only one key present
|
|
51
51
|
* // confluence: { // ConfluenceConfig
|
|
52
52
|
* // baseUrl: "STRING_VALUE", // required
|
|
@@ -74,32 +74,12 @@ declare const CreateDataSourceCommand_base: {
|
|
|
74
74
|
* // },
|
|
75
75
|
* // },
|
|
76
76
|
* // files: "DOCUMENT_VALUE",
|
|
77
|
-
* // proxy: { // ProxyConfig
|
|
78
|
-
* // url: "STRING_VALUE", // required
|
|
79
|
-
* // method: "GET" || "POST",
|
|
80
|
-
* // token: "STRING_VALUE",
|
|
81
|
-
* // username: "STRING_VALUE",
|
|
82
|
-
* // password: "STRING_VALUE",
|
|
83
|
-
* // headers: [
|
|
84
|
-
* // "STRING_VALUE",
|
|
85
|
-
* // ],
|
|
86
|
-
* // body: "DOCUMENT_VALUE",
|
|
87
|
-
* // timeoutMs: Number("int"),
|
|
88
|
-
* // responseMapping: [
|
|
89
|
-
* // "STRING_VALUE",
|
|
90
|
-
* // ],
|
|
91
|
-
* // },
|
|
92
77
|
* // },
|
|
93
78
|
* // syncSchedule: "DISABLED" || "EVERY_SIX_HOURS" || "EVERY_TWELVE_HOURS" || "EVERY_DAY" || "EVERY_WEEK",
|
|
94
79
|
* // id: "STRING_VALUE", // required
|
|
95
80
|
* // companyId: "STRING_VALUE", // required
|
|
96
|
-
* // documentsCount: Number("int"), // required
|
|
97
81
|
* // createdAt: "STRING_VALUE", // required
|
|
98
82
|
* // updatedAt: "STRING_VALUE", // required
|
|
99
|
-
* // syncStatus: "idle" || "running" || "success" || "failed", // required
|
|
100
|
-
* // lastSyncedAt: "STRING_VALUE",
|
|
101
|
-
* // lastSyncMode: "full" || "incremental" || "unknown",
|
|
102
|
-
* // lastSyncErrorMessage: "STRING_VALUE",
|
|
103
83
|
* // },
|
|
104
84
|
* // };
|
|
105
85
|
*
|
|
@@ -58,8 +58,6 @@ declare const CreateDocumentCommand_base: {
|
|
|
58
58
|
* // id: "STRING_VALUE", // required
|
|
59
59
|
* // companyId: "STRING_VALUE", // required
|
|
60
60
|
* // dataSourceId: "STRING_VALUE", // required
|
|
61
|
-
* // s3OriginalKey: "STRING_VALUE",
|
|
62
|
-
* // s3MarkdownKey: "STRING_VALUE",
|
|
63
61
|
* // createdAt: "STRING_VALUE", // required
|
|
64
62
|
* // updatedAt: "STRING_VALUE", // required
|
|
65
63
|
* // status: "draft" || "pending" || "processing" || "completed" || "failed", // required
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
import { KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KnowledgeBaseClient";
|
|
2
|
+
import { GenerateSearchAnswerInput, GenerateSearchAnswerOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GenerateSearchAnswerCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GenerateSearchAnswerCommandInput extends GenerateSearchAnswerInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GenerateSearchAnswerCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GenerateSearchAnswerCommandOutput extends GenerateSearchAnswerOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GenerateSearchAnswerCommand_base: {
|
|
25
|
+
new (input: GenerateSearchAnswerCommandInput): import("@smithy/smithy-client").CommandImpl<GenerateSearchAnswerCommandInput, GenerateSearchAnswerCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GenerateSearchAnswerCommandInput): import("@smithy/smithy-client").CommandImpl<GenerateSearchAnswerCommandInput, GenerateSearchAnswerCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Query a knowledge base by its ID and return the answer from the LLM
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { KnowledgeBaseClient, GenerateSearchAnswerCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
|
|
35
|
+
* // const { KnowledgeBaseClient, GenerateSearchAnswerCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
|
|
36
|
+
* const client = new KnowledgeBaseClient(config);
|
|
37
|
+
* const input = { // GenerateSearchAnswerInput
|
|
38
|
+
* companyId: "STRING_VALUE",
|
|
39
|
+
* searchQuery: "STRING_VALUE", // required
|
|
40
|
+
* searchResults: [ // SearchKnowledgeBaseResults // required
|
|
41
|
+
* { // SearchKnowledgeBaseResult
|
|
42
|
+
* documentId: "STRING_VALUE", // required
|
|
43
|
+
* documentTitle: "STRING_VALUE", // required
|
|
44
|
+
* documentUrl: "STRING_VALUE", // required
|
|
45
|
+
* dataSourceId: "STRING_VALUE", // required
|
|
46
|
+
* dataSourceType: "files" || "confluence" || "gdrive", // required
|
|
47
|
+
* content: "STRING_VALUE", // required
|
|
48
|
+
* score: Number("double"), // required
|
|
49
|
+
* documentHierarchy: [ // StringList
|
|
50
|
+
* "STRING_VALUE",
|
|
51
|
+
* ],
|
|
52
|
+
* },
|
|
53
|
+
* ],
|
|
54
|
+
* model: "STRING_VALUE",
|
|
55
|
+
* temperature: Number("double"),
|
|
56
|
+
* maxOutputTokens: Number("int"),
|
|
57
|
+
* systemPrompt: "STRING_VALUE",
|
|
58
|
+
* };
|
|
59
|
+
* const command = new GenerateSearchAnswerCommand(input);
|
|
60
|
+
* const response = await client.send(command);
|
|
61
|
+
* // { // GenerateSearchAnswerOutput
|
|
62
|
+
* // answer: "STRING_VALUE", // required
|
|
63
|
+
* // metadata: "DOCUMENT_VALUE", // required
|
|
64
|
+
* // sources: "DOCUMENT_VALUE", // required
|
|
65
|
+
* // };
|
|
66
|
+
*
|
|
67
|
+
* ```
|
|
68
|
+
*
|
|
69
|
+
* @param GenerateSearchAnswerCommandInput - {@link GenerateSearchAnswerCommandInput}
|
|
70
|
+
* @returns {@link GenerateSearchAnswerCommandOutput}
|
|
71
|
+
* @see {@link GenerateSearchAnswerCommandInput} for command's `input` shape.
|
|
72
|
+
* @see {@link GenerateSearchAnswerCommandOutput} for command's `response` shape.
|
|
73
|
+
* @see {@link KnowledgeBaseClientResolvedConfig | config} for KnowledgeBaseClient's `config` shape.
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link KnowledgeBaseNotFoundException} (client fault)
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ValidationException} (client fault)
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link DataSourceNotFoundException} (client fault)
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link DocumentNotFoundException} (client fault)
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link KnowledgeBaseServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from KnowledgeBase service.</p>
|
|
89
|
+
*
|
|
90
|
+
*
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
export declare class GenerateSearchAnswerCommand extends GenerateSearchAnswerCommand_base {
|
|
94
|
+
/** @internal type navigation helper, not in runtime. */
|
|
95
|
+
protected static __types: {
|
|
96
|
+
api: {
|
|
97
|
+
input: GenerateSearchAnswerInput;
|
|
98
|
+
output: GenerateSearchAnswerOutput;
|
|
99
|
+
};
|
|
100
|
+
sdk: {
|
|
101
|
+
input: GenerateSearchAnswerCommandInput;
|
|
102
|
+
output: GenerateSearchAnswerCommandOutput;
|
|
103
|
+
};
|
|
104
|
+
};
|
|
105
|
+
}
|
|
@@ -44,7 +44,7 @@ declare const GetDataSourceCommand_base: {
|
|
|
44
44
|
* // dataSource: { // DataSourceItem
|
|
45
45
|
* // name: "STRING_VALUE", // required
|
|
46
46
|
* // description: "STRING_VALUE",
|
|
47
|
-
* // type: "files" || "confluence" || "gdrive"
|
|
47
|
+
* // type: "files" || "confluence" || "gdrive", // required
|
|
48
48
|
* // config: { // DataSourceConfig Union: only one key present
|
|
49
49
|
* // confluence: { // ConfluenceConfig
|
|
50
50
|
* // baseUrl: "STRING_VALUE", // required
|
|
@@ -72,32 +72,12 @@ declare const GetDataSourceCommand_base: {
|
|
|
72
72
|
* // },
|
|
73
73
|
* // },
|
|
74
74
|
* // files: "DOCUMENT_VALUE",
|
|
75
|
-
* // proxy: { // ProxyConfig
|
|
76
|
-
* // url: "STRING_VALUE", // required
|
|
77
|
-
* // method: "GET" || "POST",
|
|
78
|
-
* // token: "STRING_VALUE",
|
|
79
|
-
* // username: "STRING_VALUE",
|
|
80
|
-
* // password: "STRING_VALUE",
|
|
81
|
-
* // headers: [
|
|
82
|
-
* // "STRING_VALUE",
|
|
83
|
-
* // ],
|
|
84
|
-
* // body: "DOCUMENT_VALUE",
|
|
85
|
-
* // timeoutMs: Number("int"),
|
|
86
|
-
* // responseMapping: [
|
|
87
|
-
* // "STRING_VALUE",
|
|
88
|
-
* // ],
|
|
89
|
-
* // },
|
|
90
75
|
* // },
|
|
91
76
|
* // syncSchedule: "DISABLED" || "EVERY_SIX_HOURS" || "EVERY_TWELVE_HOURS" || "EVERY_DAY" || "EVERY_WEEK",
|
|
92
77
|
* // id: "STRING_VALUE", // required
|
|
93
78
|
* // companyId: "STRING_VALUE", // required
|
|
94
|
-
* // documentsCount: Number("int"), // required
|
|
95
79
|
* // createdAt: "STRING_VALUE", // required
|
|
96
80
|
* // updatedAt: "STRING_VALUE", // required
|
|
97
|
-
* // syncStatus: "idle" || "running" || "success" || "failed", // required
|
|
98
|
-
* // lastSyncedAt: "STRING_VALUE",
|
|
99
|
-
* // lastSyncMode: "full" || "incremental" || "unknown",
|
|
100
|
-
* // lastSyncErrorMessage: "STRING_VALUE",
|
|
101
81
|
* // },
|
|
102
82
|
* // };
|
|
103
83
|
*
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
import { KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KnowledgeBaseClient";
|
|
2
|
+
import { GetDataSourceSyncStatusInput, GetDataSourceSyncStatusOutput } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetDataSourceSyncStatusCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetDataSourceSyncStatusCommandInput extends GetDataSourceSyncStatusInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetDataSourceSyncStatusCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetDataSourceSyncStatusCommandOutput extends GetDataSourceSyncStatusOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetDataSourceSyncStatusCommand_base: {
|
|
25
|
+
new (input: GetDataSourceSyncStatusCommandInput): import("@smithy/smithy-client").CommandImpl<GetDataSourceSyncStatusCommandInput, GetDataSourceSyncStatusCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetDataSourceSyncStatusCommandInput): import("@smithy/smithy-client").CommandImpl<GetDataSourceSyncStatusCommandInput, GetDataSourceSyncStatusCommandOutput, KnowledgeBaseClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Get the sync status of a data source by its ID
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { KnowledgeBaseClient, GetDataSourceSyncStatusCommand } from "@wildix/wim-knowledge-base-client"; // ES Modules import
|
|
35
|
+
* // const { KnowledgeBaseClient, GetDataSourceSyncStatusCommand } = require("@wildix/wim-knowledge-base-client"); // CommonJS import
|
|
36
|
+
* const client = new KnowledgeBaseClient(config);
|
|
37
|
+
* const input = { // GetDataSourceSyncStatusInput
|
|
38
|
+
* companyId: "STRING_VALUE",
|
|
39
|
+
* dataSourceId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new GetDataSourceSyncStatusCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // GetDataSourceSyncStatusOutput
|
|
44
|
+
* // syncStatus: "idle" || "running" || "success" || "failed", // required
|
|
45
|
+
* // lastSyncedAt: "STRING_VALUE", // required
|
|
46
|
+
* // lastSyncMode: "full" || "incremental", // required
|
|
47
|
+
* // lastSyncErrorMessage: "STRING_VALUE", // required
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @param GetDataSourceSyncStatusCommandInput - {@link GetDataSourceSyncStatusCommandInput}
|
|
53
|
+
* @returns {@link GetDataSourceSyncStatusCommandOutput}
|
|
54
|
+
* @see {@link GetDataSourceSyncStatusCommandInput} for command's `input` shape.
|
|
55
|
+
* @see {@link GetDataSourceSyncStatusCommandOutput} for command's `response` shape.
|
|
56
|
+
* @see {@link KnowledgeBaseClientResolvedConfig | config} for KnowledgeBaseClient's `config` shape.
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link DataSourceNotFoundException} (client fault)
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link ForbiddenException} (client fault)
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ValidationException} (client fault)
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link KnowledgeBaseNotFoundException} (client fault)
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link DocumentNotFoundException} (client fault)
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link KnowledgeBaseServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from KnowledgeBase service.</p>
|
|
72
|
+
*
|
|
73
|
+
*
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
export declare class GetDataSourceSyncStatusCommand extends GetDataSourceSyncStatusCommand_base {
|
|
77
|
+
/** @internal type navigation helper, not in runtime. */
|
|
78
|
+
protected static __types: {
|
|
79
|
+
api: {
|
|
80
|
+
input: GetDataSourceSyncStatusInput;
|
|
81
|
+
output: GetDataSourceSyncStatusOutput;
|
|
82
|
+
};
|
|
83
|
+
sdk: {
|
|
84
|
+
input: GetDataSourceSyncStatusCommandInput;
|
|
85
|
+
output: GetDataSourceSyncStatusCommandOutput;
|
|
86
|
+
};
|
|
87
|
+
};
|
|
88
|
+
}
|